[kaffe] CVS kaffe (robilad): Fixes for man pages

Kaffe CVS cvs-commits at kaffe.org
Mon Aug 8 15:52:52 PDT 2005 

PatchSet 6795 
Date: 2005/08/08 22:47:49
Author: robilad
Branch: HEAD
Tag: (none) 
Log:
Fixes for man pages

2005-08-08   Wolfgang Baer <WBaer at gmx.de>

        * kaffe/man/kaffe.1.xml,
        kaffe/man/kaffe.1.in: Fixes for manpages.

Members: 
	ChangeLog:1.4320->1.4321 
	kaffe/man/kaffe.1.in:INITIAL->1.10 
	kaffe/man/kaffe.1.xml:1.1->1.2 

Index: kaffe/ChangeLog
diff -u kaffe/ChangeLog:1.4320 kaffe/ChangeLog:1.4321
--- kaffe/ChangeLog:1.4320	Mon Aug  8 21:16:06 2005
+++ kaffe/ChangeLog	Mon Aug  8 22:47:49 2005
@@ -1,3 +1,8 @@
+2005-08-08   Wolfgang Baer <WBaer at gmx.de>
+
+	* kaffe/man/kaffe.1.xml,
+	kaffe/man/kaffe.1.in: Fixes for manpages.
+
 2005-08-08  Andreas Tobler  <toa at pop.agri.ch>
 
 	* config/sparc/trampolines.S: Set alignment to 8
===================================================================
Checking out kaffe/kaffe/man/kaffe.1.in
RCS:  /home/cvs/kaffe/kaffe/kaffe/man/kaffe.1.in,v
VERS: 1.10
***************
--- /dev/null	Sun Aug  4 19:57:58 2002
+++ kaffe/kaffe/man/kaffe.1.in	Mon Aug  8 22:52:52 2005
@@ -0,0 +1,331 @@
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "KAFFE" 1 "" "" ""
+.SH NAME
+kaffe \- a virtual machine to execute Java(tm) bytecode
+.SH "SYNOPSIS"
+.ad l
+.hy 0
+.HP 6
+\fBkaffe\fR [options] \fIclassname\fR [argument...]
+.ad
+.hy
+.ad l
+.hy 0
+.HP 6
+\fBkaffe\fR [options]\fB \-jar\fR \fIfilename\fR [argument...]
+.ad
+.hy
+
+.PP
+The provided options are passed to kaffe virtual machine\&. Available options are described in the section OPTIONS\&. The provided arguments are passed to the main function of the called class\&.
+
+.SH "DESCRIPTION"
+
+.PP
+\fBkaffe\fR executes Java(tm) bytecode, either as a pure bytecode interpreter, or by doing "just\-in\-time" code conversion from the abstract code to the host machine's native code\&.
+
+.PP
+The specified \fIclassname\fR has to be a fully\-qualified classname (e\&.g\&. foo\&.bar\&.ClassName)\&. If \fBkaffe\fR is used with the \fB\-jar\fR flag, the class to execute is determined through the manifest file included in the specified Jar\-File \fIfilename\fR\&.
+
+.PP
+\fBkaffe\fR searches for needed classes during program execution on the bootclasspath (see \fB\-Xbootclasspath\fR options) and the classpath given by the user (see the \fB\-classpath\fR option)\&.
+
+.SH "OPTIONS"
+
+.PP
+The options for the kaffe command are divided into general options (available on all kaffe installations), options provided for compatibility reasons and further options which are depending on the configuration during compilation of kaffe\&.
+
+.SS "GENERAL OPTIONS"
+
+.PP
+These options are available on all kaffe installations\&.
+
+.TP
+\fB\-help\fR
+Give a short usage message of all available options on your kaffe installation\&.
+
+.TP
+\fB\-version\fR
+Print the version number\&.
+
+.TP
+\fB\-fullversion\fR
+Same as \fB\-version\fR plus compile date and flags, changelog head\&.
+
+.TP
+\fB\-ss \fR\fIsize\fR
+Set the maximum stack size to \fIsize\fR\&.
+
+.TP
+\fB\-mx \fR\fIsize\fR
+Set the maximum heap size to \fIsize\fR\&. Kilobytes are indicated by the letters k or K and megabytes by m or M\&.
+
+.TP
+\fB\-ms \fR\fIsize\fR
+Set the initial heap size to \fIsize\fR\&. Kilobytes are indicated by the letters k or K and megabytes by m or M\&.
+
+.TP
+\fB\-as \fR\fIsize\fR
+Set the heap increment size to \fIsize\fR
+
+.TP
+\fB\-classpath \fR\fIpath\fR
+Set the path which is searched for compiled classes\&. This can be a list of directories and Jar\-Files containing compiled classes\&. The entries in this list are separated by colons (:)\&.
+
+.TP
+\fB\-addclasspath \fR\fIpath\fR
+Appends the given path to the current classpath setting\&. Multiple instances of this flag may be given\&.
+
+.TP
+\fB\-Xbootclasspath:\fR \fIbootclasspath\fR
+Set the bootclasspath to the given path\&.
+
+.TP
+\fB\-Xbootclasspath/a:\fR \fIbootclasspath\fR
+Appends the given path to the bootclasspath\&.
+
+.TP
+\fB\-Xbootclasspath/p:\fR \fIbootclasspath\fR
+Prepends the given path to the bootclasspath\&.
+
+.TP
+\fB\-Dproperty=value\fR
+Set a property to a given value\&.
+
+.TP
+\fB\-verifyremote *\fR
+Verify all classes not loaded from the bootclasspath\&. This is the default behavior\&.
+
+.TP
+\fB\-verify *\fR
+Verify all classes\&.
+
+.TP
+\fB\-noverify\fR
+Do not verify any classes\&.
+
+.TP
+\fB\-noclassgc\fR
+Disable class garbage collection\&.
+
+.TP
+\fB\-verbosegc\fR
+Print message during garbage collection\&.
+
+.TP
+\fB\-v, \-verbose\fR
+Enable verbose output\&.
+
+.TP
+\fB\-verbosemem\fR
+Print detailed memory allocation statistics\&.
+
+.TP
+\fB\-verbosejit\fR
+Print message during JIT code generation\&.
+
+.TP
+\fB\-verbosecall\fR
+Print detailed call flow information\&.
+
+.TP
+\fB\-nodeadlock\fR
+Disable deadlock detection\&.
+
+.TP
+\fB\-debug *\fR
+Trace method calls\&.
+
+.TP
+\fB\-noasyncgc *\fR
+Do not garbage collect asynchronously\&.
+
+.TP
+\fB\-cs, \-checksource *\fR
+Check source against class files\&.
+
+.TP
+\fB\-oss *\fR \fIsize\fR
+Maximum stack size\&.
+
+.TP
+\fB\-debug\-fd \fR\fIdescriptor\fR
+Descriptor to send debug info to\&.
+
+.TP
+\fB\-jar\fR \fIfile\fR
+Executes a Java(tm) program which is provided by the given Jar\-File file\&.
+
+.PP
+* Option currently ignored\&.
+
+.SS "COMPATIBILITY OPTIONS"
+
+.PP
+These options are provided for compatibility reasons with other Java(tm) runtime environments\&.
+
+.TP
+\fB\-Xss\fR \fIsize\fR
+Maximum native stack size (see \fB\-ss\fR)\&.
+
+.TP
+\fB\-Xmx\fR \fIsize\fR
+Maximum heap size (see \fB\-mx\fR)\&.
+
+.TP
+\fB\-Xms\fR \fIsize\fR
+Initial heap size (see \fB\-ms\fR)\&.
+
+.TP
+\fB\-cp\fR \fIpath\fR
+Set classpath (see \fB\-classpath\fR)\&.
+
+.SS "FURTHER OPTIONS"
+
+.PP
+Further options may be available based on the configuration of kaffe during compilation\&. To get a complete list of options available in your kaffe installation type \fBkaffe \-\-help\fR on the commandline\&.
+
+.TP
+\fB\-ia32\fR
+Execute the ia32 version of Kaffe\&.
+
+.TP
+\fB\-prof\fR
+Enable profiling of methods\&.
+
+.TP
+\fB\-Xxprof\fR
+Enable cross language profiling\&.
+
+.TP
+\fB\-Xxprof_syms\fR \fIfile\fR
+Name of the profiling symbols file [Default: kaffe\-jit\-symbols\&.s]\&.
+
+.TP
+\fB\-Xxprof_gmon\fR \fIfile\fR
+Base name for gmon files [Default: xgmon\&.out]
+
+.TP
+\fB\-Xxdebug_file\fR \fIfile\fR
+Name of the debugging symbols file\&.
+
+.TP
+\fB\-Xfeedback\fR
+The file name to write feedback data to\&.
+
+.TP
+\fB\-vmstats flag{,flag}\fR
+Print VM statistics\&. Set flag=all for all
+
+.TP
+\fB\-Xnative\-big\-math\fR
+Use GMP for faster, native bignum calculations\&.
+
+.TP
+\fB\-vmdebug flag{,flag}\fR
+Enable VM debugging\&. Set flag=list for a list\&.
+
+.TP
+\fB\-Xkaffe\-xlib\-awt\fR
+Use Kaffe's Xlib AWT backend\&.
+
+.TP
+\fB\-Xkaffe\-qt\-awt\fR
+Use Kaffe's Qt2/3/Embedded AWT backend\&.
+
+.TP
+\fB\-Xkaffe\-nanox\-awt\fR
+Use Kaffe's Nano\-X AWT backend\&.
+
+.SH "ENVIRONMENT"
+
+.TP
+\fBCLASSPATH\fR
+A colon\-separated list of directories and Jar\-Files in which to search for \&.class files\&. The entries have to be separated by colons (:)\&.
+
+.TP
+\fBKAFFEHOME\fR
+Base directory of kaffe installation\&.
+
+.TP
+\fBLD_LIBRARY_PATH\fR
+A colon\-separated list of directories in which to search for libraries\&. See \fBld\&.so\fR(1) for details\&. This needs to be set if Kaffe's shared libraries are installed in a location not part of the dynamic loader's default search path\&.
+
+.SH "FILES"
+
+.TP
+\fI at prefix@/share/kaffe/kafferc\fR
+System\-wide shell script read by kaffe script (optional)\&.
+
+.TP
+\fI${HOME}/\&.kafferc\fR
+Per\-user shell script read by kaffe script (optional)\&.
+
+.SH "DIAGNOSTICS"
+
+.PP
+Not documented yet\&.
+
+.SH "NOTES"
+
+.PP
+Java is a registered trademark of Sun Microsystems, Inc\&.
+
+.PP
+Kaffe is available from various sites, the primary one being <\fIhttp://www\&.kaffe\&.org: \fIhttp://www.kaffe.org\fR>\fR\&.
+
+.PP
+There are several mailing lists for Kaffe:
+
+.TP
+\fIkaffe at kaffe\&.org\fR
+General Kaffe discussions
+
+.TP
+\fIkaffe\-announce at kaffe\&.org\fR
+Kaffe related announcements
+
+.SH "BUGS"
+
+.PP
+See the file FAQ\&.Known\-Bugs for an updated list\&.
+
+.SH "AUTHOR"
+
+.PP
+Kaffe was originally written by Tim Wilkinson, 1996\&. Many others contributed to the Kaffe project\&. They are listed in the source distribution's \fIAUTHORS\fR file\&.
+
+.SH "COPYING"
+
+.PP
+Kaffe is distributed under the GNU GPL\&. For full details, see the file \fIlicense\&.terms\fR in the source distribution for full details\&.
+
+.PP
+The included DOM bindings are published under the W3C Software Copyright Notice and License\&. For full details, see the file \fIlicense\-w3c\&.terms\fR in the source distribution for full details\&.
+
+.SH "SEE ALSO"
+
+.PP
+\fIjikes\fR, a fast Java(tm) compiler
+
+.PP
+\fIgjdoc\fR, the GNU javadoc tool
+
Index: kaffe/kaffe/man/kaffe.1.xml
diff -u kaffe/kaffe/man/kaffe.1.xml:1.1 kaffe/kaffe/man/kaffe.1.xml:1.2
--- kaffe/kaffe/man/kaffe.1.xml:1.1	Fri Mar 25 16:24:22 2005
+++ kaffe/kaffe/man/kaffe.1.xml	Mon Aug  8 22:47:53 2005
@@ -339,8 +339,7 @@
 				<varlistentry>
 	        <term><option>-vmdebug flag{,flag}</option></term>
 	        <listitem>
-	          <para>Enable VM debugging. Set &ldquo;-vmdebug list&rdquo;
-	          for a list.</para>
+	          <para>Enable VM debugging. Set flag=list for a list.</para>
 	        </listitem>
 	      </varlistentry>
 				<varlistentry>

More information about the kaffe mailing list