This is the mail archive of the
java@gcc.gnu.org
mailing list for the Java project.
[RFC] generate man pages for classpath tools
- From: Matthias Klose <doko at cs dot tu-berlin dot de>
- To: java at gcc dot gnu dot org
- Date: Fri, 9 Feb 2007 13:25:25 +0100
- Subject: [RFC] generate man pages for classpath tools
The attached patch allows generation of man pages for the classpath
tools. Currently only three man pages are useful (jarsigner, keytool and
gappletviewer). The conversion programs are used from the gcc tree,
maybe a copy of the script should go into the classpath repository?
Stubs for all other man pages are created.
--- libjava/classpath/doc/Makefile.am~ 2006-05-24 04:13:22.000000000 +0200
+++ libjava/classpath/doc/Makefile.am 2007-02-09 13:15:12.960777000 +0100
@@ -4,6 +4,10 @@
## GCJ LOCAL: we don't want to install Classpath's info files.
## info_TEXINFOS = hacking.texinfo vmintegration.texinfo
+## info_TEXINFOS = tools.texinfo
+##tools_TEXINFOS = \
+## $(top_srcdir)/../../gcc/doc/include/gcc-common.texi \
+## gcc-vers.texi
%.dvi : %.texinfo
texi2dvi $<
@@ -12,3 +16,114 @@
dvips -o $@ $<
docs: hacking.ps vmintegration.ps tools.ps
+
+TOOLS_MANFILES = \
+ gappletviewer.1 \
+ gjar.1 \
+ gjarsigner.1 \
+ gjavah.1 \
+ gkeytool.1 \
+ gnative2ascii.1 \
+ gorbd.1 \
+ grmid.1 \
+ grmiregistry.1 \
+ gserialver.1 \
+ gtnameserv.1
+
+BASEVER = $(top_srcdir)/../../gcc/BASE-VER
+DEVPHASE = $(top_srcdir)/../../gcc/DEV-PHASE
+
+POD2MAN = pod2man --center="GNU" --release="gcc-$(shell cat $(BASEVER))"
+TEXI2POD = perl $(top_srcdir)/../../contrib/texi2pod.pl
+STAMP = echo timestamp >
+
+%.1: %.pod
+ $(STAMP) $@
+ -($(POD2MAN) --section=1 $< > $(@).T$$$$ && \
+ mv -f $(@).T$$$$ $@) || \
+ (rm -f $(@).T$$$$ && exit 1)
+
+.INTERMEDIATE: gappletviewer.pod gjarsigner.pod gjar.pod gjavah.pod \
+ gkeytool.pod gnative2ascii.pod gorbd.pod grmid.pod grmiregistry.pod \
+ gserialver.pod gtnameserv.pod
+
+gappletviewer.pod: $(srcdir)/tools.texinfo gcc-vers.texi
+ -$(TEXI2POD) -D gappletviewer < $< > $@
+
+gjarsigner.pod: $(srcdir)/tools.texinfo gcc-vers.texi
+ -$(TEXI2POD) -D gjarsigner < $< > $@
+
+gjar.pod: $(srcdir)/tools.texinfo gcc-vers.texi
+ -$(TEXI2POD) -D gjar < $< > $@
+
+gjavah.pod: $(srcdir)/tools.texinfo gcc-vers.texi
+ -$(TEXI2POD) -D gjavah < $< > $@
+
+# hack around the cross references and the enumeration
+gkeytool.pod: $(srcdir)/tools.texinfo gcc-vers.texi
+ -$(TEXI2POD) -D gkeytool < $< > $@
+ sed -i -e 's/^For more details.*/See I<Common Options> for more details./' \
+ -e 's/1\.<\([^>]*\)>/- \1/' \
+ $@
+
+gnative2ascii.pod: $(srcdir)/tools.texinfo gcc-vers.texi
+ -$(TEXI2POD) -D gnative2ascii < $< > $@
+
+gorbd.pod: $(srcdir)/tools.texinfo gcc-vers.texi
+ -$(TEXI2POD) -D gorbd < $< > $@
+
+grmid.pod: $(srcdir)/tools.texinfo gcc-vers.texi
+ -$(TEXI2POD) -D grmid < $< > $@
+
+grmiregistry.pod: $(srcdir)/tools.texinfo gcc-vers.texi
+ -$(TEXI2POD) -D grmiregistry < $< > $@
+
+gserialver.pod: $(srcdir)/tools.texinfo gcc-vers.texi
+ -$(TEXI2POD) -D gserialver < $< > $@
+
+gtnameserv.pod: $(srcdir)/tools.texinfo gcc-vers.texi
+ -$(TEXI2POD) -D gtnameserv < $< > $@
+
+man_MANS = $(TOOLS_MANFILES)
+EXTRA_DIST += $(man_MANS)
+
+# gcc-vers.texi is generated from the version files.
+gcc-vers.texi: $(BASEVER) $(DEVPHASE)
+ (echo "@set version-GCC $(shell cat $(BASEVER))"; \
+ if [ "$(shell cat $(DEVPHASE))" = "experimental" ]; \
+ then echo "@set DEVELOPMENT"; \
+ else echo "@clear DEVELOPMENT"; \
+ fi) > $@T
+ mv -f $@T $@
+
+# GCC LOCAL CHANGE
+# The following commands allow us to release tarballs with the man pages
+# and info documentation prebuilt. This feature is enabled via
+# --enable-generated-files-in-srcdir in the configure script.
+
+#if GENINSRC
+#STAMP_GENINSRC = stamp-geninsrc
+#else
+#STAMP_GENINSRC =
+#endif
+
+all-local: $(STAMP_GENINSRC)
+
+stamp-geninsrc: $(man_MANS)
+ -cp -p $^ $(srcdir)
+ touch $@
+
+CLEANFILES = stamp-geninsrc tools.info
+MAINTAINERCLEANFILES = \
+ $(srcdir)/gappletviewer.1 \
+ $(srcdir)/gjar.1 \
+ $(srcdir)/gjarsigner.1 \
+ $(srcdir)/gjavah.1 \
+ $(srcdir)/gkeytool.1 \
+ $(srcdir)/gnative2ascii.1 \
+ $(srcdir)/gorbd.1 \
+ $(srcdir)/grmid.1 \
+ $(srcdir)/grmiregistry.1 \
+ $(srcdir)/gserialver.1 \
+ $(srcdir)/gtnameserv.1 \
+ $(srcdir)/tools.info
--- libjava/classpath/doc/tools.texinfo~ 2006-08-15 01:34:26.000000000 +0200
+++ libjava/classpath/doc/tools.texinfo 2007-02-09 13:16:10.650777000 +0100
@@ -6,6 +6,7 @@
@c %**end of header
@setchapternewpage on
+@include gcc-common.texi
@ifinfo
This file documents the Tools included in a standard distribution of the GNU
@@ -55,6 +56,7 @@
@menu
* Applet Tools:: Work with applets
* Security Tools:: Work securely with Java applications
+* More Tools:: Currently undocumented tools
* I18N Issues:: How to add support for non-English languages
@detailmenu
@@ -111,6 +113,17 @@
* Command -keypasswd:: Change the password protecting a Key Entry
* Command -delete:: Remove an entry in a Key Store
+More Tools
+
+* jar Tool:: Archive tool for Java archives
+* javah Tool:: A java header compiler
+* native2ascii Tool:: An encoding converter
+* orbd Tool:: A tool
+* serialver Tool:: Print serialVersionUID of specified classes
+* rmid Tool:: A tool
+* rmiregistry Tool:: Remote object registry
+* tnameserv Tool:: Naming service
+
I18N Issues
* Language Resources:: Where resources are located
@@ -143,15 +156,20 @@
@node appletviewer Tool, gcjwebplugin, Applet Tools, Applet Tools
@comment node-name, next, previous, up
@section The @code{appletviewer} Tool
+@c man title gappletviewer Load and runs an applet
+
+SYNOPSIS
+
+@c man begin SYNOPSIS gappletviewer
+appletviewer [@option{OPTION}]@dots{} @var{URL}@dots{} @var{@*}
-@table @b
+appletviewer [@option{OPTION}]@dots{} @option{-code} @var{CODE} @var{@*}
-@item SYNOPSIS
-@code{appletviewer [OPTION]... URL...}@*
-@code{appletviewer [OPTION]... -code CODE}@*
-@code{appletviewer [OPTION]... -plugin INPUT,OUTPUT}
+appletviewer [@option{OPTION}]@dots{} @option{-plugin} @var{INPUT,OUTPUT}
+@c man end
-@item DESCRIPTION
+DESCRIPTION
+@c man begin DESCRIPTION gappletviewer
The @code{appletviewer} tool loads and runs an applet.
Use the first form to test applets specified by tag. The URL should
@@ -179,9 +197,11 @@
@code{gcjwebplugin} uses the third form to communicate with the
@code{appletviewer} through named pipes.
+@c man end
-@item URL OPTIONS
-@table @b
+@c man begin OPTIONS gappletviewer
+URL OPTIONS
+@table @gcctabopt
@item -debug
This option is not yet implemented but is provided for compatibility.
@@ -191,8 +211,8 @@
@end table
-@item APPLET TAG OPTIONS
-@table @b
+APPLET TAG OPTIONS
+@table @gcctabopt
@item -code CODE
Use the @code{-code} option to specify the value of the applet tag
CODE attribute.
@@ -219,8 +239,8 @@
@end table
-@item PLUGIN OPTION
-@table @b
+PLUGIN OPTION
+@table @gcctabopt
@item -plugin INPUT,OUTPUT
@code{gcjwebplugin} uses the @code{-plugin} option to specify the
named pipe the @code{appletviewer} should use for receiving commands
@@ -229,16 +249,17 @@
@end table
-@item DEBUGGING OPTION
-@table @b
+DEBUGGING OPTION
+@table @gcctabopt
@item -verbose
Use the @code{-verbose} option to have the @code{appletviewer} print
debugging messages.
@end table
-@item STANDARD OPTIONS
-@table @b
+STANDARD OPTIONS
+
+@table @gcctabopt
@item -help
Use the @code{-help} option to have the @code{appletviewer} print a
usage message, then exit.
@@ -253,7 +274,7 @@
not be a space between the -J and OPTION.
@end table
-@end table
+@c man end
@comment ----------------------------------------------------------------------
@@ -267,7 +288,7 @@
@comment ----------------------------------------------------------------------
-@node Security Tools, I18N Issues, Applet Tools, Top
+@node Security Tools, More Tools, Applet Tools, Top
@comment node-name, next, previous, up
@chapter Security Tools
@@ -289,19 +310,25 @@
@node jarsigner Tool, keytool Tool, Security Tools, Security Tools
@comment node-name, next, previous, up
@section The @code{jarsigner} Tool
+@c man title gjarsigner Java ARchive (JAR) file signing and verification tool
The @b{jarsigner} tool is invoked from the command line, in one of two forms, as follows:
@example
-@code{jarsigner [OPTION]... FILE ALIAS}
-@code{jarsigner -verify [OPTION]... FILE}
+@c man begin SYNOPSIS gjarsigner
+jarsigner @option{[OPTION]}@dots{} @var{FILE} @var{ALIAS}
+
+jarsigner @option{-verify} @option{[OPTION]}@dots{} @var{FILE}
+@c man end
@end example
+@c man begin DESCRIPTION gjarsigner
When the first form is used, the tool signs the designated JAR file. The second form, on the other hand, is used to verify a previously signed JAR file.
@code{FILE} is the .JAR file to process; i.e. to sign if the first syntax form is used, or to verify if the second syntax form is used instead.
@code{ALIAS} must be a known @i{Alias} of a @i{Key Entry} in the designated @i{Key Store}. The private key material associated with this @i{Alias} is then used for signing the designated .JAR file.
+@c man end
@menu
* Common jarsigner Options:: Options used when signing or verifying a file
@@ -313,11 +340,12 @@
@node Common jarsigner Options, Signing Options, jarsigner Tool, jarsigner Tool
@comment node-name, next, previous, up
+@c man begin OPTIONS gjarsigner
@subsection Common options
The following options may be used when the tool is used for either signing, or verifying, a .JAR file.
-@table @b
+@table @gcctabopt
@item -verbose
Use this option to force the tool to generate more verbose messages, during its processing.
@@ -334,16 +362,18 @@
Prints a help text similar to this one.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Signing Options, Verification Options, Common jarsigner Options, jarsigner Tool
@comment node-name, next, previous, up
+@c man begin OPTIONS gjarsigner
@subsection Signing options
The following options may be specified when using the tool for signing purposes.
-@table @b
+@table @gcctabopt
@item -keystore URL
Use this option to specify the location of the key store to use. The default value is a file URL referencing the file named @file{.keystore} located in the path returned by the call to @code{java.lang.System#getProperty(String)} using @code{user.home} as argument.
@@ -369,16 +399,18 @@
Use this option to specify the file name of the signed JAR. If this option is omitted, then the signed JAR will be named the same as @code{FILE}; i.e. the input JAR file will be replaced with the signed copy.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Verification Options, , Signing Options, jarsigner Tool
@comment node-name, next, previous, up
+@c man begin OPTIONS gjarsigner
@subsection Verification options
The following options may be specified when using the tool for verification purposes.
-@table @b
+@table @gcctabopt
@item -verify
Use this option to indicate that the tool is to be used for verification purposes.
@@ -386,13 +418,22 @@
This option is used in conjunction with the @code{-verbose} option. When present, along with the @code{-verbose} option, the tool will print more detailed information about the certificates of the signer(s) being processed.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node keytool Tool, , jarsigner Tool, Security Tools
@comment node-name, next, previous, up
@section The @code{keytool} Tool
+@c man title gkeytool Manage private keys and public certificates
+
+@ignore
+@c man begin SYNOPSIS gkeytool
+keytool @option{[COMMAND]} @dots{}
+@c man end
+@end ignore
+@c man begin DESCRIPTION gkeytool
Cryptographic credentials, in a Java environment, are usually stored in a @i{Key Store}. The Java SDK specifies a @i{Key Store} as a persistent container of two types of objects: @i{Key Entries} and @i{Trusted Certificates}. The security tool @b{keytool} is a Java-based application for managing those types of objects.
A @i{Key Entry} represents the private key part of a key-pair used in Public-Key Cryptography, and a signed X.509 certificate which authenticates the public key part for a known entity; i.e. the owner of the key-pair. The X.509 certificate itself contains the public key part of the key-pair.
@@ -412,12 +453,14 @@
@example
@code{keytool -list -- -printcert -alias mykey}
@end example
+@c man end
Here is a summary of the commands supported by the tool:
+@c man begin OPTIONS gkeytool
@enumerate
@item Add/Update commands
-@itemize @bullet
+@table @gcctabopt
@item -genkey [OPTION]@dots{}
Generate a new @i{Key Entry}, eventually creating a new key store.
@@ -433,28 +476,28 @@
@item -identitydb [OPTION]@dots{}
@b{NOT IMPLEMENTED YET}.@*
Import a JDK 1.1 style Identity Database.
-@end itemize
+@end table
@item Export commands
-@itemize @bullet
+@table @gcctabopt
@item -certreq [OPTION]@dots{}
Issue a @i{Certificate Signing Request} (CSR) which can be then sent to a @i{Certification Authority} (CA) to issue a certificate signed (by the CA) and authenticating the @i{Subject} of the request.
@item -export [OPTION]@dots{}
Export a certificate from a key store.
-@end itemize
+@end table
-@item Display commands
-@itemize @bullet
+@item Display commands
+@table @gcctabopt
@item -list [OPTION]@dots{}
Print one or all certificates in a key store to @code{STDOUT}.
@item -printcert [OPTION]@dots{}
Print a human-readable form of a certificate, in a designated file, to @code{STDOUT}.
-@end itemize
+@end table
@item Management commands
-@itemize @bullet
+@table @gcctabopt
@item -keyclone [OPTION]@dots{}
Clone a @i{Key Entry} in a key store.
@@ -466,9 +509,9 @@
@item -delete [OPTION]@dots{}
Delete a @i{Key Entry} or a @i{Trusted Certificate} from a key store.
-@end itemize
-
+@end table
@end enumerate
+@c man end
@menu
* Getting Help:: How to get help with keytool commands
@@ -506,11 +549,12 @@
@node Common keytool Options, Distinguished Names, Getting Help, keytool Tool
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsection Common options
The following @code{OPTION}s are used in more than one @code{COMMAND}. They are described here to reduce redundancy.
-@table @b
+@table @gcctabopt
@anchor{alias}
@item -alias ALIAS
Every entry, be it a @i{Key Entry} or a @i{Trusted Certificate}, in a key store is uniquely identified by a user-defined @i{Alias} string. Use this option to specify the @i{Alias} to use when referring to an entry in the key store. Unless specified otherwise, a default value of @code{mykey} shall be used when this option is omitted from the command line.
@@ -554,6 +598,7 @@
Unless specified otherwise, use this option to enable more verbose output.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@@ -591,7 +636,9 @@
@node Add/Update Commands, Export Commands, Distinguished Names, keytool Tool
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsection Add/Update commands
+@c man end
@menu
* Command -genkey:: Generate private key and self-signed certificate
@@ -605,13 +652,14 @@
@node Command -genkey, Command -import, Add/Update Commands, Add/Update Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-genkey} command
Use this command to generate a new key-pair (both private and public keys), and save these credentials in the key store as a @i{Key Entry}, associated with the designated (if was specified with the @code{-alias} option) or default (if the @code{-alias} option is omitted) @i{Alias}.
The private key material will be protected with a user-defined password (see @code{-keypass} option). The public key on the other hand will be part of a self-signed X.509 certificate, which will form a 1-element chain and will be saved in the key store.
-@table @b
+@table @gcctabopt
@item -alias ALIAS
For more details @pxref{alias,, ALIAS}.
@@ -653,11 +701,13 @@
For more details @pxref{verbose}.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Command -import, Command -selfcert, Command -genkey, Add/Update Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-import} command
Use this command to read an X.509 certificate, or a PKCS#7 @i{Certificate Reply} from a designated input source and incorporate the certificates into the key store.
@@ -666,7 +716,7 @@
If @i{Alias} exists in the key store, the tool will treat the certificate(s) read from the input source as a @i{Certificate Reply}, which can be a chain of certificates, that eventually would replace the chain of certificates associated with the @i{Key Entry} of that @i{Alias}. The substitution of the certificates only occurs if a chain-of-trust can be established between the bottom certificate of the chain read from the input file and the @i{Trusted Certificates} already present in the key store. Again, if the @code{-trustcacerts} option is specified, additional @i{Trusted Certificates} in the same @file{cacerts} key store will be considered. If no chain-of-trust can be established, the operation will abort.
-@table @b
+@table @gcctabopt
@item -alias ALIAS
For more details @pxref{alias,, ALIAS}.
@@ -700,16 +750,18 @@
For more details @pxref{verbose}.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Command -selfcert, Command -cacert, Command -import, Add/Update Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-selfcert} command
Use this command to generate a self-signed X.509 version 1 certificate. The newly generated certificate will form a chain of one element which will replace the previous chain associated with the designated @i{Alias} (if @code{-alias} option was specified), or the default @i{Alias} (if @code{-alias} option was omitted).
-@table @b
+@table @gcctabopt
@item -alias ALIAS
For more details @pxref{alias,, ALIAS}.
@@ -745,18 +797,20 @@
For more details @pxref{verbose}.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Command -cacert, Command -identitydb, Command -selfcert, Add/Update Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-cacert} command
Use this command to import, a CA certificate and add it to the key store as a @i{Trusted Certificate}. The @i{Alias} for this new entry will be constructed from the FILE's base-name after replacing hyphens and dots with underscores.
This command is useful when used in a script that recursively visits a directory of CA certificates to populate a @code{cacerts.gkr} @i{Key Store} of trusted certificates which can then be used commands that specify the @code{-trustcacerts} option.
-@table @b
+@table @gcctabopt
@item -file FILE
For more details @pxref{file,, FILE}.
@@ -776,18 +830,20 @@
For more details @pxref{verbose}.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Command -identitydb, , Command -cacert, Add/Update Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-identitydb} command
@b{NOT IMPLEMENTED YET}.
Use this command to import a JDK 1.1 style Identity Database.
-@table @b
+@table @gcctabopt
@item -file FILE
For more details @pxref{file,, FILE}.
@@ -807,12 +863,15 @@
For more details @pxref{verbose}.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Export Commands, Display Commands, Add/Update Commands, keytool Tool
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsection Export commands
+@c man end
@menu
* Command -certreq:: Generate Certificate Signing Requests (CSR)
@@ -823,6 +882,7 @@
@node Command -certreq, Command -export, Export Commands, Export Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-certreq} command
Use this command to generate a PKCS#10 @i{Certificate Signing Request} (CSR) and write it to a designated output destination. The contents of the destination should look something like the following:
@@ -838,7 +898,7 @@
@b{IMPORTANT}: Some documentation (e.g. RSA examples) claims that the @code{Attributes} field, in the CSR is @code{OPTIONAL} while RFC-2986 implies the opposite. This implementation considers this field, by default, as @code{OPTIONAL}, unless the option @code{-attributes} is specified on the command line.
-@table @b
+@table @gcctabopt
@item -alias ALIAS
For more details @pxref{alias,, ALIAS}.
@@ -872,16 +932,18 @@
Use this option to force the tool to encode a @code{NULL} DER value in the CSR as the value of the @code{Attributes} field.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Command -export, , Command -certreq, Export Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-export} command
Use this command to export a certificate stored in a key store to a designated output destination, either in binary format (if the @code{-v} option is specified), or in RFC-1421 compliant encoding (if the @code{-rfc} option is specified instead).
-@table @b
+@table @gcctabopt
@item -alias ALIAS
For more details @pxref{alias,, ALIAS}.
@@ -907,12 +969,15 @@
Output the certificate in binary DER encoding. This is the default output format of the command if neither @code{-rfc} nor @code{-v} options were detected on the command line. If both this option and the @code{-rfc} option are detected on the command line, the tool will opt for the RFC-1421 style encoding.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Display Commands, Management Commands, Export Commands, keytool Tool
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsection Display commands
+@c man end
@menu
* Command -list:: Display information about one or all Aliases
@@ -923,11 +988,12 @@
@node Command -list, Command -printcert, Display Commands, Display Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-list} command
Use this command to print one or all of a key store entries to @code{STDOUT}. Usually this command will only print a @i{fingerprint} of the certificate, unless either the @code{-rfc} or the @code{-v} option is specified.
-@table @b
+@table @gcctabopt
@item -alias ALIAS
If this option is omitted, the tool will print ALL the entries found in the key store.
@@ -952,16 +1018,18 @@
Output the certificate in human-readable format. If both this option and the @code{-rfc} option are detected on the command line, the tool will opt for the human-readable form and will not abort the command.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Command -printcert, , Command -list, Display Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-printcert} command
Use this command to read a certificate from a designated input source and print it to @code{STDOUT} in a human-readable form.
-@table @b
+@table @gcctabopt
@item -file FILE
For more details @pxref{file,, FILE}.
@@ -969,12 +1037,15 @@
For more details @pxref{verbose}.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Management Commands, , Display Commands, keytool Tool
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsection Management commands
+@c man end
@menu
* Command -keyclone:: Clone a Key Entry in a Key Store
@@ -987,11 +1058,12 @@
@node Command -keyclone, Command -storepasswd, Management Commands, Management Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-keyclone} command
Use this command to clone an existing @i{Key Entry} and store it under a new (different) @i{Alias} protecting, its private key material with possibly a new password.
-@table @b
+@table @gcctabopt
@item -alias ALIAS
For more details @pxref{alias,, ALIAS}.
@@ -1022,16 +1094,18 @@
For more details @pxref{verbose}.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Command -storepasswd, Command -keypasswd, Command -keyclone, Management Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-storepasswd} command
Use this command to change the password protecting a key store.
-@table @b
+@table @gcctabopt
@item -new PASSWORD
The new, and different, password which will be used to protect the designated key store.
@@ -1051,16 +1125,18 @@
For more details @pxref{verbose}.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Command -keypasswd, Command -delete, Command -storepasswd, Management Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-keypasswd} command
Use this command to change the password protecting the private key material of a designated @i{Key Entry}.
-@table @b
+@table @gcctabopt
@item -alias ALIAS
For more details @pxref{alias,, ALIAS}.
@@ -1087,16 +1163,18 @@
For more details @pxref{verbose}.
@end table
+@c man end
@comment ----------------------------------------------------------------------
@node Command -delete, , Command -keypasswd, Management Commands
@comment node-name, next, previous, up
+@c man begin OPTIONS gkeytool
@subsubsection @code{-delete} command
Use this command to delete a designated key store entry.
-@table @b
+@table @gcctabopt
@item -alias ALIAS
For more details @pxref{alias,, ALIAS}.
@@ -1116,6 +1194,288 @@
For more details @pxref{verbose}.
@end table
+@c man end
+
+@comment ----------------------------------------------------------------------
+
+@node More Tools, I18N Issues, Security Tools, Top
+@comment node-name, next, previous, up
+@chapter More Tools
+
+This is a list of currently undocumented classpath tools: @b{jar},
+@b{javah}, @b{native2ascii}, @b{orbd}, @b{serialver}, @b{rmid}, @b{rmiregistry}
+and @b{tnameserv}.
+
+@menu
+* jar Tool:: Archive tool for Java archives
+* javah Tool:: A java header compiler
+* native2ascii Tool:: An encoding converter
+* orbd Tool:: A tool
+* serialver Tool:: Print serialVersionUID of specified classes
+* rmid Tool:: A tool
+* rmiregistry Tool:: Remote object registry
+* tnameserv Tool:: Naming service
+@end menu
+
+@comment ----------------------------------------------------------------------
+
+@node jar Tool, javah Tool, More Tools, More Tools
+@comment node-name, next, previous, up
+@section The @code{jar} Tool
+@c man title gjar Archive tool for Java archives
+
+@c man begin DESCRIPTION gjar
+
+To be written @dots{}
+
+@c man end
+
+@ignore
+@c man begin SYNOPSIS gjar
+gjar @dots{}
+@c man end
+
+@c man begin OPTIONS gjar
+To be written @dots{}
+@table @gcctabopt
+@item -help
+Print help text, then exit.
+@item -version
+Print version number, then exit.
+@end table
+@c man end
+
+@c man begin SEEALSO gjar
+gcj(1), @dots{}
+@c man end
+
+@comment ----------------------------------------------------------------------
+
+@node javah Tool, native2ascii Tool, jar Tool, More Tools
+@comment node-name, next, previous, up
+@section The @code{javah} Tool
+@c man title gjavah generate header files from Java class files
+
+@c man begin DESCRIPTION gjavah
+
+The @code{gjavah} program is used to generate header files from class
+files. It can generate both CNI and JNI header files, as well as stub
+implementation files which can be used as a basis for implementing the
+required native methods.
+
+@c man end
+
+@ignore
+@c man begin SYNOPSIS gjavah
+gjavah @dots{}
+@c man end
+
+@c man begin OPTIONS gjavah
+To be written @dots{}
+@table @gcctabopt
+@item -help
+Print help text, then exit.
+@item -version
+Print version number, then exit.
+@end table
+@c man end
+
+@c man begin SEEALSO gjavah
+gcj(1), @dots{}
+@c man end
+
+@comment ----------------------------------------------------------------------
+
+@node native2ascii Tool, orbd Tool, javah Tool, More Tools
+@comment node-name, next, previous, up
+@section The @code{native2ascii} Tool
+@c man title gnative2ascii An encoding converter
+
+@c man begin DESCRIPTION gnative2ascii
+
+To be written @dots{}
+
+@c man end
+
+@ignore
+@c man begin SYNOPSIS gnative2ascii
+gjar @dots{}
+@c man end
+
+@c man begin OPTIONS gnative2ascii
+To be written @dots{}
+@table @gcctabopt
+@item -help
+Print help text, then exit.
+@item -version
+Print version number, then exit.
+@end table
+@c man end
+
+@c man begin SEEALSO gnative2ascii
+gcj(1), @dots{}
+@c man end
+
+@comment ----------------------------------------------------------------------
+
+@node orbd Tool, serialver Tool, native2ascii Tool, More Tools
+@comment node-name, next, previous, up
+@section The @code{orbd} Tool
+@c man title gorbd A tool
+
+@c man begin DESCRIPTION gorbd
+
+To be written @dots{}
+
+@c man end
+
+@ignore
+@c man begin SYNOPSIS gorbd
+gorbd @dots{}
+@c man end
+
+@c man begin OPTIONS gorbd
+To be written @dots{}
+@table @gcctabopt
+@item -help
+Print help text, then exit.
+@item -version
+Print version number, then exit.
+@end table
+@c man end
+
+@c man begin SEEALSO gorbd
+gcj(1), @dots{}
+@c man end
+
+@comment ----------------------------------------------------------------------
+
+@node serialver Tool, rmid Tool, orbd Tool, More Tools
+@comment node-name, next, previous, up
+@section The @code{serialver} Tool
+@c man title gserialver
+
+@c man begin DESCRIPTION gserialver
+
+To be written @dots{}
+
+@c man end
+
+@ignore
+@c man begin SYNOPSIS gserialver
+gserialver @dots{}
+@c man end
+
+@c man begin OPTIONS gserialver
+To be written @dots{}
+@table @gcctabopt
+@item -help
+Print help text, then exit.
+@item -version
+Print version number, then exit.
+@end table
+@c man end
+
+@c man begin SEEALSO gserialver
+gcj(1), @dots{}
+@c man end
+
+@comment ----------------------------------------------------------------------
+
+@node rmid Tool, rmiregistry Tool, serialver Tool, More Tools
+@comment node-name, next, previous, up
+@section The @code{rmid} Tool
+@c man title grmid A tool
+
+@c man begin DESCRIPTION grmid
+
+To be written @dots{}
+
+@c man end
+
+@ignore
+@c man begin SYNOPSIS grmid
+grmid @dots{}
+@c man end
+
+@c man begin OPTIONS grmid
+To be written @dots{}
+@table @gcctabopt
+@item -help
+Print help text, then exit.
+@item -version
+Print version number, then exit.
+@end table
+@c man end
+
+@c man begin SEEALSO grmid
+gcj(1), @dots{}
+@c man end
+
+@comment ----------------------------------------------------------------------
+
+@node rmiregistry Tool, tnameserv Tool, rmid Tool, More Tools
+@comment node-name, next, previous, up
+@section The @code{rmiregistry} Tool
+@c man title grmiregistry Remote object registry
+
+@c man begin DESCRIPTION grmiregistry
+
+@command{grmiregistry} starts a remote object registry on the current
+host. If no port number is specified, then port 1099 is used.
+
+@c man end
+
+@ignore
+@c man begin SYNOPSIS grmiregistry
+grmiregistry @dots{}
+@c man end
+
+@c man begin OPTIONS grmiregistry
+To be written @dots{}
+@table @gcctabopt
+@item -help
+Print help text, then exit.
+@item -version
+Print version number, then exit.
+@end table
+@c man end
+
+@c man begin SEEALSO grmiregistry
+gcj(1), @dots{}
+@c man end
+
+@comment ----------------------------------------------------------------------
+
+@node tnameserv Tool, More Tools, rmigegistry Tool, More Tools
+@comment node-name, next, previous, up
+@section The @code{tnameserv} Tool
+@c man title gtnameserv Naming service
+
+@c man begin DESCRIPTION gtnameserv
+
+To be written @dots{}
+
+@c man end
+
+@ignore
+@c man begin SYNOPSIS gtnameserv
+tnameserv @dots{}
+@c man end
+
+@c man begin OPTIONS gtnameserv
+To be written @dots{}
+@table @gcctabopt
+@item -help
+Print help text, then exit.
+@item -version
+Print version number, then exit.
+@end table
+@c man end
+
+@c man begin SEEALSO gtnameserv
+gcj(1), @dots{}
+@c man end
@comment ----------------------------------------------------------------------
--- contrib/texi2pod.pl~ 2006-06-01 00:42:09.000000000 +0200
+++ contrib/texi2pod.pl 2007-02-09 11:56:30.710777000 +0100
@@ -252,6 +252,8 @@
and $_ = "\n=head2 $1\n";
/^\@subsection\s+(.+)$/
and $_ = "\n=head3 $1\n";
+ /^\@subsubsection\s+(.+)$/
+ and $_ = "\n=head4 $1\n";
# Block command handlers:
/^\@itemize(?:\s+(\@[a-z]+|\*|-))?/ and do {
@@ -382,6 +384,9 @@
s/\@gol//g;
s/\@\*\s*\n?//g;
+ # Anchors are thrown away
+ s/\@anchor\{(?:[^\}]*)\}//g;
+
# @uref can take one, two, or three arguments, with different
# semantics each time. @url and @email are just like @uref with
# one argument, for our purposes.