summaryrefslogtreecommitdiff
path: root/java/javavmwrapper
diff options
context:
space:
mode:
authorGreg Lewis <glewis@FreeBSD.org>2005-04-12 20:17:46 +0000
committerGreg Lewis <glewis@FreeBSD.org>2005-04-12 20:17:46 +0000
commit5729185ae1921e4760327718b61eacca4ae70eeb (patch)
treee4cbd37f01b000ba7e9f7091221db22c6d163468 /java/javavmwrapper
parent- Update to 1.0.1 (diff)
. A big mdoc fixup kindly provided by the mdoc police. Any problems should
be attributed to my merging of the mdoc fixes with some content changes I had made. Submitted by: simon
Notes
Notes: svn path=/head/; revision=133176
Diffstat (limited to 'java/javavmwrapper')
-rw-r--r--java/javavmwrapper/src/checkvms.12
-rw-r--r--java/javavmwrapper/src/javavm.190
-rw-r--r--java/javavmwrapper/src/javavms.59
-rw-r--r--java/javavmwrapper/src/registervm.14
4 files changed, 72 insertions, 33 deletions
diff --git a/java/javavmwrapper/src/checkvms.1 b/java/javavmwrapper/src/checkvms.1
index 7e1e44d781bd..472983b5ec2f 100644
--- a/java/javavmwrapper/src/checkvms.1
+++ b/java/javavmwrapper/src/checkvms.1
@@ -41,7 +41,7 @@ sort them by version and affinity with
.Fx .
.Sh FILES
.Bl -tag -width indent
-.It %%PREFIX%%/etc/javavms
+.It Pa %%PREFIX%%/etc/javavms
The location of the Java VM wrapper configuration file.
.El
.Sh SEE ALSO
diff --git a/java/javavmwrapper/src/javavm.1 b/java/javavmwrapper/src/javavm.1
index 3c53d0f6cc5b..dbfebb74d2bc 100644
--- a/java/javavmwrapper/src/javavm.1
+++ b/java/javavmwrapper/src/javavm.1
@@ -36,13 +36,19 @@
.Sh DESCRIPTION
The Java VM wrapper provides a convenient system for switching between
different Java VMs.
-It also provides symbolic links in %%LOCALBASE%%/bin to allow the use of
+It also provides symbolic links in
+.Pa %%LOCALBASE%%/bin
+to allow the use of
the Java executables without having to add the specific Java VM executable
-directories to the PATH environment variable.
+directories to the
+.Ev PATH
+environment variable.
.Pp
The
.Nm
-utility itself is currently a synonym for "java". However, this behaviour
+utility itself is currently a synonym for
+.Dq java .
+However, this behaviour
is deprecated and is provided only for compatibility with the previous
version of
.Nm .
@@ -51,73 +57,99 @@ relied upon.
.Pp
By default,
.Nm
-will select the most "native" and up to date version of the Java VM when
+will select the most
+.Dq native
+and up to date version of the Java VM when
a given symbolic link is used, invoking and passing the arguments to the
matching executable within the chosen Java VM.
The choice of Java VM may also be influenced by using environment variables
to constrain the version, vendor and operating system of the Java VM.
.Pp
This selection process is usually achieved through the use of
-%%PORTSDIR%%/Mk/bsd.java.mk.
+.Pa %%PORTSDIR%%/Mk/bsd.java.mk .
However, if this is not present then
.Nm
will use its own internal selection process which is
designed to behave almost identically.
.Sh ENVIRONMENT
.Bl -tag -width indent
-.It JAVA_HOME
+.It Ev JAVA_HOME
The presence of this variable in the environment when executing
.Nm
will override all other considerations regarding the Java VM to be used
-and the Java VM located at ${JAVA_HOME}/bin/java will be used.
+and the Java VM located at
+.Pa ${JAVA_HOME}/bin/java
+will be used.
.Pp
This variable is set by
.Nm
when executing the actual Java VM and will be available to it and all of
its child processes.
-.It JAVA_OS
+.It Ev JAVA_OS
A space delimited list of operating systems.
The selected Java VM must have been created for one of the operating systems
in the list.
.Pp
-Currently allowed operating system values are "native" and "linux".
-.It JAVA_VENDOR
+Currently allowed operating system values are
+.Ql native
+and
+.Ql linux .
+.It Ev JAVA_VENDOR
A space delimited list of Java VM vendors.
The selected Java VM must have been released by one of the vendors in the list.
.Pp
-Currently allowed vendors are "bsdjava", "freebsd", "blackdown", "ibm"
-and "sun".
-.It JAVA_VERSION
+Currently allowed vendors are
+.Ql bsdjava ,
+.Ql freebsd ,
+.Ql blackdown ,
+.Ql ibm
+and
+.Ql sun .
+.It Ev JAVA_VERSION
A space delimited list of versions of the Java VM that may be used.
-By appending a '+' to a version, any Java VM with a version greater than or
+By appending a
+.Ql +
+to a version, any Java VM with a version greater than or
equal to the given version will be used.
.Pp
-Currently allowed versions are 1.1, 1.1+, 1.2, 1.2+, 1.3, 1.3+, 1.4, 1.4+,
-1.5 and 1.5+.
+Currently allowed versions are
+.Ql 1.1 ,
+.Ql 1.1+ ,
+.Ql 1.2 ,
+.Ql 1.2+ ,
+.Ql 1.3 ,
+.Ql 1.3+ ,
+.Ql 1.4 ,
+.Ql 1.4+ ,
+.Ql 1.5
+and
+.Ql 1.5+ .
.El
.Sh FILES
.Bl -tag -width indent
-.It %%PREFIX%%/etc/javavms
+.It Pa %%PREFIX%%/etc/javavms
The location of the Java VM wrapper configuration file.
-.It %%PORTSDIR%%/Mk/bsd.java.mk
+.It Pa %%PORTSDIR%%/Mk/bsd.java.mk
The file usually used, along with
.Nm make ,
to select the Java VM to be used.
.El
.Sh EXAMPLES
.Bl -tag -width indent
-.It %%LOCALBASE%%/bin/java
-Execute the most up to date and "native" Java VM registered with
+.It Pa %%LOCALBASE%%/bin/java
+Execute the most up to date and
+.Dq native
+Java VM registered with
.Nm .
-.It JAVA_VERSION=1.4+ %%LOCALBASE%%/bin/javac MyClass.java
+.It Ev JAVA_VERSION=1.4+ Pa %%LOCALBASE%%/bin/javac MyClass.java
Compile MyClass.java with a registered Java VM's javac that is at least
version 1.4.
-.It JAVA_OS=native %%LOCALBASE%%/bin/java -jar MyApp.jar
+.It Ev JAVA_OS=native Pa %%LOCALBASE%%/bin/java Fl jar Pa MyApp.jar
Execute MyApp with the most up to date native Java VM that is registered
with
.Nm .
This is necessary if MyApp uses JNI, for instance.
-.It JAVA_VERSION="1.2 1.4" %%LOCALBASE%%/bin/java -jar MyApp.jar
+.It Ev JAVA_VERSION="1.2 1.4" Pa %%LOCALBASE%%/bin/java Fl jar Pa MyApp.jar
Execute MyApp with either a Java VM that is either version 1.2 or version 1.4.
.El
.Sh SEE ALSO
@@ -129,12 +161,16 @@ Execute MyApp with either a Java VM that is either version 1.2 or version 1.4.
.Sh BUGS
The internal selection procedure of
.Nm
-is not fully identical to that of %%PORTSDIR%%/Mk/bsd.java.mk.
+is not fully identical to that of
+.Pa %%PORTSDIR%%/Mk/bsd.java.mk .
In particular,
.Nm
does not respect environment variables such as
.Ev JAVA_PREFERRED_PORT
-which is used by %%PORTSDIR%%/Mk/bsd.java.mk and will not use the values
-of such variables if they are set up as
+which is used by
+.Pa %%PORTSDIR%%/Mk/bsd.java.mk
+and will not use the values of such variables if they are set up as
.Nm make
-variables in /etc/make.conf, for example.
+variables in
+.Pa /etc/make.conf ,
+for example.
diff --git a/java/javavmwrapper/src/javavms.5 b/java/javavmwrapper/src/javavms.5
index 01c6049d99ef..063f8835a169 100644
--- a/java/javavmwrapper/src/javavms.5
+++ b/java/javavmwrapper/src/javavms.5
@@ -36,18 +36,21 @@ The
file contains a list of the registered Java VMs which are available to be
used by
.Nm javavm .
-Each Java VM is listed by specifying the location of the main 'java'
+Each Java VM is listed by specifying the location of the main
+.Dq java
executable on a line.
.Pp
The
.Nm
file may also contains comments.
-Comments must start with the '#' character, and can be both lines by
+Comments must start with the
+.Sq #
+character, and can be both lines by
themselves or the trailing portion of a line containing a registered
Java VM.
.Sh FILES
.Bl -tag -width indent
-.It %%PREFIX%%/etc/javavms
+.It Pa %%PREFIX%%/etc/javavms
The location of the Java VM wrapper configuration file.
.El
.Sh SEE ALSO
diff --git a/java/javavmwrapper/src/registervm.1 b/java/javavmwrapper/src/registervm.1
index 12f9e9f24f96..4e50a0acab52 100644
--- a/java/javavmwrapper/src/registervm.1
+++ b/java/javavmwrapper/src/registervm.1
@@ -48,11 +48,11 @@ can use.
The registration process places the registered VM in the Java VM wrapper
configuration file in sorted order.
When unregistering the Java VM is removed from the Java VM wrapper
-configuration file and will no longer be a possible choice for
+configuration file and will no longer be a possible choice for
.Nm javavm .
.Sh FILES
.Bl -tag -width indent
-.It %%PREFIX%%/etc/javavms
+.It Pa %%PREFIX%%/etc/javavms
The location of the Java VM wrapper configuration file.
.El
.Sh EXAMPLES