[glewis at FreeBSD.org: cvs commit: ports/java/javavmwrapper Makefile ports/java/javavmwrapper/src checkvms.1 javavm.1 javavms.5 registervm.1]

Tue Apr 12 19:20:19 UTC 2005

On 2005.04.11 15:32:05 -0600, Greg Lewis wrote:
> Review by people with an actual mdoc clue very much appreciated.

A patch which fixes some stuff is attached.  Ruslan could probably
find more things, but at least it should be a step in the right
direction :-).

-- 
Simon L. Nielsen
-------------- next part --------------
Index: src/checkvms.1
===================================================================
RCS file: /home/ncvs/ports/java/javavmwrapper/src/checkvms.1,v
retrieving revision 1.1
diff -u -d -r1.1 checkvms.1

--- src/checkvms.1	11 Apr 2005 21:22:43 -0000	1.1
+++ src/checkvms.1	12 Apr 2005 18:59:39 -0000
@@ -41,7 +41,7 @@
 .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
Index: src/javavm.1
===================================================================
RCS file: /home/ncvs/ports/java/javavmwrapper/src/javavm.1,v
retrieving revision 1.1
diff -u -d -r1.1 javavm.1
--- src/javavm.1	11 Apr 2005 21:22:43 -0000	1.1
+++ src/javavm.1	12 Apr 2005 18:57:35 -0000
@@ -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,34 +57,49 @@
 .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.
 .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
 The operating system that the Java VM was created for.
 .Pp
-Currently allowed values are "native" and "linux".
-.It JAVA_VENDOR
+Currently allowed values are
+.Ql native
+and
+.Ql linux .
+.It Ev JAVA_VENDOR
 The vendor that created the Java VM.
 .Pp
-Currently allowed values are "bsdjava", "freebsd", "blackdown", "ibm" and
-"sun".
-.It JAVA_VERSION
-The version of the Java VM that should be used.  By appending a '+' to
+Currently allowed values are
+.Ql bsdjava ,
+.Ql freebsd ,
+.Ql blackdown ,
+.Ql ibm ,
+and
+.Ql sun .
+.It Ev JAVA_VERSION
+The version of the Java VM that should be used.
+By appending a
+.Ql +
+to
 the version, any Java VM with a version greater than or equals to the
 given version will be used.
 .Pp
@@ -87,13 +108,15 @@
 .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.
 .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
 Compile MyClass.java with a registered Java VM's javac that is at least
Index: src/javavms.5
===================================================================
RCS file: /home/ncvs/ports/java/javavmwrapper/src/javavms.5,v
retrieving revision 1.1
diff -u -d -r1.1 javavms.5
--- src/javavms.5	11 Apr 2005 21:22:43 -0000	1.1
+++ src/javavms.5	12 Apr 2005 18:52:01 -0000
@@ -36,18 +36,21 @@
 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
Index: src/registervm.1
===================================================================
RCS file: /home/ncvs/ports/java/javavmwrapper/src/registervm.1,v
retrieving revision 1.1
diff -u -d -r1.1 registervm.1
--- src/registervm.1	11 Apr 2005 21:22:43 -0000	1.1
+++ src/registervm.1	12 Apr 2005 18:53:03 -0000
@@ -48,11 +48,11 @@
 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
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20050412/e9c9ed20/attachment.sig>
