diff options
Diffstat (limited to 'libjava/classpath')
| -rw-r--r-- | libjava/classpath/ChangeLog | 4 | ||||
| -rw-r--r-- | libjava/classpath/doc/cp-tools.info | 1903 | ||||
| -rw-r--r-- | libjava/classpath/doc/gappletviewer.1 | 51 | ||||
| -rw-r--r-- | libjava/classpath/doc/gjar.1 | 41 | ||||
| -rw-r--r-- | libjava/classpath/doc/gjarsigner.1 | 43 | ||||
| -rw-r--r-- | libjava/classpath/doc/gjavah.1 | 39 | ||||
| -rw-r--r-- | libjava/classpath/doc/gjdoc.1 | 75 | ||||
| -rw-r--r-- | libjava/classpath/doc/gkeytool.1 | 47 | ||||
| -rw-r--r-- | libjava/classpath/doc/gnative2ascii.1 | 39 | ||||
| -rw-r--r-- | libjava/classpath/doc/gorbd.1 | 39 | ||||
| -rw-r--r-- | libjava/classpath/doc/grmid.1 | 39 | ||||
| -rw-r--r-- | libjava/classpath/doc/grmiregistry.1 | 39 | ||||
| -rw-r--r-- | libjava/classpath/doc/gserialver.1 | 39 | ||||
| -rw-r--r-- | libjava/classpath/doc/gtnameserv.1 | 39 |
14 files changed, 1237 insertions, 1200 deletions
diff --git a/libjava/classpath/ChangeLog b/libjava/classpath/ChangeLog index 7dff426ba8..e2ae481065 100644 --- a/libjava/classpath/ChangeLog +++ b/libjava/classpath/ChangeLog @@ -1,3 +1,7 @@ +2016-08-22 Release Manager + + * GCC 6.2.0 released. + 2016-04-27 Release Manager * GCC 6.1.0 released. diff --git a/libjava/classpath/doc/cp-tools.info b/libjava/classpath/doc/cp-tools.info index c8eab777fb..552ff63a07 100644 --- a/libjava/classpath/doc/cp-tools.info +++ b/libjava/classpath/doc/cp-tools.info @@ -1,8 +1,8 @@ -This is cp-tools.info, produced by makeinfo version 5.2 from -cp-tools.texinfo. +This is cp-tools.info, produced by makeinfo version 4.12 from +/space/rguenther/gcc-6.2.0/gcc-6.2.0/libjava/classpath/doc/cp-tools.texinfo. -This file documents the Tools included in a standard distribution of the -GNU Classpath project deliverables. +This file documents the Tools included in a standard distribution of +the GNU Classpath project deliverables. Copyright (C) 2006, 2007 Free Software Foundation, Inc. @@ -17,8 +17,9 @@ GNU Classpath project deliverables. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for - modified versions, except that this permission notice may be stated - in a translation approved by the Free Software Foundation. + modified versions, except that this permission notice may be + stated in a translation approved by the Free Software Foundation. + INFO-DIR-SECTION GNU Libraries START-INFO-DIR-ENTRY * Classpath Tools: (cp-tools). GNU Classpath Tools Guide @@ -44,7 +45,7 @@ behavior, to their counter-parts found in the Reference Implementation * Other Tools:: Other tools in classpath * I18N Issues:: How to add support for non-English languages - -- The Detailed Node Listing -- + --- The Detailed Node Listing --- Applet Tools @@ -167,7 +168,6 @@ I18N Issues * Language Resources:: Where resources are located * Message Formats:: How messages are internationalized - File: cp-tools.info, Node: Applet Tools, Next: Security Tools, Prev: Top, Up: Top @@ -192,109 +192,112 @@ report it at classpath-bugs File: cp-tools.info, Node: appletviewer Tool, Next: gcjwebplugin, Prev: Applet Tools, Up: Applet Tools -1.1 The 'appletviewer' Tool +1.1 The `appletviewer' Tool =========================== SYNOPSIS appletviewer [OPTION]... URL... +appletviewer [OPTION]... `-code' CODE +appletviewer [OPTION]... `-plugin' INPUT,OUTPUT - appletviewer [OPTION]... '-code' CODE - - appletviewer [OPTION]... '-plugin' INPUT,OUTPUT - - DESCRIPTION The 'appletviewer' tool loads and runs an applet. + DESCRIPTION The `appletviewer' tool loads and runs an applet. Use the first form to test applets specified by tag. The URL should -resolve to an HTML document from which the 'appletviewer' will extract +resolve to an HTML document from which the `appletviewer' will extract applet tags. The APPLET, EMBED and OBJECT tags are supported. If a given document contains multiple applet tags, all the applets will be loaded, with each applet appearing in its own window. Likewise, when multiple URLs are specified, each applet tag instance is given its own window. If a given document contains no recognized tags the -'appletviewer' does nothing. +`appletviewer' does nothing. appletviewer http://www.gnu.org/software/classpath/ Use the second form to test an applet in development. This form allows applet tag attributes to be supplied on the command line. Only -one applet may be specified using the '-code' option. The '-code' +one applet may be specified using the `-code' option. The `-code' option overrides the URL form - any URLs specified will be ignored. appletviewer -code Test.class -param datafile,data.txt - 'gcjwebplugin' uses the third form to communicate with the -'appletviewer' through named pipes. + `gcjwebplugin' uses the third form to communicate with the +`appletviewer' through named pipes. URL OPTIONS -'-debug' +`-debug' This option is not yet implemented but is provided for compatibility. -'-encoding CHARSET' +`-encoding CHARSET' Use this option to specify an alternate character encoding for the specified HTML page. + APPLET TAG OPTIONS -'-code CODE' - Use the '-code' option to specify the value of the applet tag CODE +`-code CODE' + Use the `-code' option to specify the value of the applet tag CODE attribute. -'-codebase CODEBASE' - Use the '-codebase' option to specify the value of the applet tag +`-codebase CODEBASE' + Use the `-codebase' option to specify the value of the applet tag CODEBASE attribute. -'-archive ARCHIVE' - Use the '-archive' option to specify the value of the applet tag +`-archive ARCHIVE' + Use the `-archive' option to specify the value of the applet tag ARCHIVE attribute. -'-width WIDTH' - Use the '-width' option to specify the value of the applet tag +`-width WIDTH' + Use the `-width' option to specify the value of the applet tag WIDTH attribute. -'-height HEIGHT' - Use the '-height' option to specify the value of the applet tag +`-height HEIGHT' + Use the `-height' option to specify the value of the applet tag HEIGHT attribute. -'-param NAME,VALUE' - Use the '-param' option to specify values for the NAME and VALUE +`-param NAME,VALUE' + Use the `-param' option to specify values for the NAME and VALUE attributes of an applet PARAM tag. + PLUGIN OPTION -'-plugin INPUT,OUTPUT' - 'gcjwebplugin' uses the '-plugin' option to specify the named pipe - the 'appletviewer' should use for receiving commands (INPUT) and - the one it should use for sending commands to 'gcjwebplugin' +`-plugin INPUT,OUTPUT' + `gcjwebplugin' uses the `-plugin' option to specify the named pipe + the `appletviewer' should use for receiving commands (INPUT) and + the one it should use for sending commands to `gcjwebplugin' (OUTPUT). + DEBUGGING OPTION -'-verbose' - Use the '-verbose' option to have the 'appletviewer' print +`-verbose' + Use the `-verbose' option to have the `appletviewer' print debugging messages. + STANDARD OPTIONS -'-help' - Use the '-help' option to have the 'appletviewer' print a usage +`-help' + Use the `-help' option to have the `appletviewer' print a usage message, then exit. -'-version' - Use the '-version' option to have the 'appletviewer' print its +`-version' + Use the `-version' option to have the `appletviewer' print its version, then exit. -'-JOPTION' - Use the '-J' option to pass OPTION to the virtual machine that will - run the 'appletviewer'. Unlike other options, there must not be a - space between the '-J' and OPTION. +`-JOPTION' + Use the `-J' option to pass OPTION to the virtual machine that + will run the `appletviewer'. Unlike other options, there must not + be a space between the `-J' and OPTION. + File: cp-tools.info, Node: gcjwebplugin, Prev: appletviewer Tool, Up: Applet Tools -1.2 The 'gcjwebplugin' Tool +1.2 The `gcjwebplugin' Tool =========================== -'gcjwebplugin' is a plugin that adds applet support to web browsers. -Currently 'gcjwebplugin' only supports Mozilla-based browsers (e.g., +`gcjwebplugin' is a plugin that adds applet support to web browsers. +Currently `gcjwebplugin' only supports Mozilla-based browsers (e.g., Firefox, Galeon, Mozilla). @@ -303,12 +306,12 @@ File: cp-tools.info, Node: Security Tools, Next: Other Tools, Prev: Applet To 2 Security Tools **************** -Two Security Tools are available with GNU Classpath: 'jarsigner' and -'keytool'. +Two Security Tools are available with GNU Classpath: `jarsigner' and +`keytool'. To avoid conflicts with other implementations, the jarsigner -executable is called 'gjarsigner' and the keytool executable is called -'gkeytool'. +executable is called `gjarsigner' and the keytool executable is called +`gkeytool'. * Menu: @@ -322,15 +325,15 @@ report it at classpath-bugs File: cp-tools.info, Node: jarsigner Tool, Next: keytool Tool, Prev: Security Tools, Up: Security Tools -2.1 The 'jarsigner' Tool +2.1 The `jarsigner' Tool ======================== -The 'jarsigner' tool is invoked from the command line, in one of two +The `jarsigner' tool is invoked from the command line, in one of two forms, as follows: jarsigner [OPTION]... FILE ALIAS - jarsigner -verify [OPTION]... FILE + jarsigner `-verify' [OPTION]... FILE 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 @@ -340,7 +343,7 @@ signed JAR file. form is used, or to verify if the second syntax form is used instead. ALIAS must be a known Alias of a Key Entry in the designated Key -Store. The private key material associated with this Alias is then used +Store. The private key material associated with this Alias is then used for signing the designated .JAR file. * Menu: @@ -358,32 +361,33 @@ File: cp-tools.info, Node: Common jarsigner Options, Next: Signing Options, P The following options may be used when the tool is used for either signing, or verifying, a .JAR file. -'-verbose' +`-verbose' Use this option to force the tool to generate more verbose messages, during its processing. -'-internalsf' +`-internalsf' When present, the tool will include -which otherwise it does not- - the '.SF' file in the '.DSA' generated file. + the `.SF' file in the `.DSA' generated file. -'-sectionsonly' - When present, the tool will include in the '.SF' generated file +`-sectionsonly' + When present, the tool will include in the `.SF' generated file -which otherwise it does not- a header containing a hash of the whole manifest file. When that header is included, the tool can quickly check, during verification, if the hash (in the header) matches or not the manifest file. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' A fully qualified class name of a Security Provider to add to the current list of Security Providers already installed in the JVM - in-use. If a provider class is specified with this option, and was + in-use. If a provider class is specified with this option, and was successfully added to the runtime -i.e. it was not already installed- then the tool will attempt to remove this Security Provider before exiting. -'-help' +`-help' Prints a help text similar to this one. + File: cp-tools.info, Node: Signing Options, Next: Verification Options, Prev: Common jarsigner Options, Up: jarsigner Tool @@ -393,57 +397,58 @@ File: cp-tools.info, Node: Signing Options, Next: Verification Options, Prev: The following options may be specified when using the tool for signing purposes. -'-keystore URL' +`-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 - '.keystore' located in the path returned by the call to - 'java.lang.System#getProperty(String)' using 'user.home' as + `.keystore' located in the path returned by the call to + `java.lang.System#getProperty(String)' using `user.home' as argument. - If a URL was specified, but was found to be malformed -e.g. missing - protocol element- the tool will attempt to use the URL value as a - file-name (with absolute or relative path-name) of a key store -as - if the protocol was 'file:'. + If a URL was specified, but was found to be malformed -e.g. + missing protocol element- the tool will attempt to use the URL + value as a file-name (with absolute or relative path-name) of a + key store -as if the protocol was `file:'. -'-storetype STORE_TYPE' - Use this option to specify the type of the key store to use. The +`-storetype STORE_TYPE' + Use this option to specify the type of the key store to use. The default value, if this option is omitted, is that of the property - 'keystore.type' in the security properties file, which is obtained - by invoking the static method call 'getDefaultType()' in - 'java.security.KeyStore'. + `keystore.type' in the security properties file, which is obtained + by invoking the static method call `getDefaultType()' in + `java.security.KeyStore'. -'-storepass PASSWORD' +`-storepass PASSWORD' Use this option to specify the password which will be used to - unlock the key store. If this option is missing, the User will be + unlock the key store. If this option is missing, the User will be prompted to provide a password. -'-keypass PASSWORD' +`-keypass PASSWORD' Use this option to specify the password which the tool will use to unlock the Key Entry associated with the designated Alias. If this option is omitted, the tool will first attempt to unlock - the Key Entry using the same password protecting the key store. If + the Key Entry using the same password protecting the key store. If this fails, you will then be prompted to provide a password. -'-sigfile NAME' +`-sigfile NAME' Use this option to designate a literal that will be used to - construct file names for both the '.SF' and '.DSA' signature files. - These files will be generated, by the tool, and placed in the - 'META-INF' directory of the signed JAR. Permissible characters for - NAME must be in the range "a-zA-Z0-9_-". All characters will be - converted to upper-case ones. + construct file names for both the `.SF' and `.DSA' signature + files. These files will be generated, by the tool, and placed in + the `META-INF' directory of the signed JAR. Permissible + characters for NAME must be in the range "a-zA-Z0-9_-". All + characters will be converted to upper-case ones. If this option is missing, the first eight characters of the ALIAS - argument will be used. When this is the case, any character in + argument will be used. When this is the case, any character in ALIAS that is outside the permissible range of characters will be replaced by an underscore. -'-signedjar FILE' - Use this option to specify the file name of the signed JAR. If +`-signedjar FILE' + 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 FILE; i.e., the input JAR file will be replaced with the signed copy. + File: cp-tools.info, Node: Verification Options, Prev: Signing Options, Up: jarsigner Tool @@ -453,114 +458,115 @@ File: cp-tools.info, Node: Verification Options, Prev: Signing Options, Up: j The following options may be specified when using the tool for verification purposes. -'-verify' +`-verify' Use this option to indicate that the tool is to be used for verification purposes. -'-certs' - This option is used in conjunction with the '-verbose' option. - When present, along with the '-verbose' option, the tool will print - more detailed information about the certificates of the signer(s) - being processed. +`-certs' + This option is used in conjunction with the `-verbose' option. + When present, along with the `-verbose' option, the tool will + print more detailed information about the certificates of the + signer(s) being processed. + File: cp-tools.info, Node: keytool Tool, Prev: jarsigner Tool, Up: Security Tools -2.2 The 'keytool' Tool +2.2 The `keytool' Tool ====================== Cryptographic credentials, in a Java environment, are usually stored in -a Key Store. The Java SDK specifies a Key Store as a persistent -container of two types of objects: Key Entries and Trusted Certificates. -The security tool 'keytool' is a Java-based application for managing -those types of objects. +a Key Store. The Java SDK specifies a Key Store as a persistent +container of two types of objects: Key Entries and Trusted +Certificates. The security tool `keytool' is a Java-based application +for managing those types of objects. A 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 +the key-pair. The X.509 certificate itself contains the public key part of the key-pair. A Trusted Certificate is a signed X.509 certificate issued by a -trusted entity. The Trust in this context is relative to the User of -the 'keytool'. In other words, the existence of a Trusted Certificate -in the Key Store processed by a 'keytool' command implies that the User +trusted entity. The Trust in this context is relative to the User of +the `keytool'. In other words, the existence of a Trusted Certificate +in the Key Store processed by a `keytool' command implies that the User trusts the Issuer of that Trusted Certificate to also sign, and hence authenticates, other Subjects the tool may process. Trusted Certificates are important because they allow the tool to mechanically construct Chains of Trust starting from one of the Trusted Certificates in a Key Store and ending with a certificate whose Issuer -is potentially unknown. A valid chain is an ordered list, starting with +is potentially unknown. A valid chain is an ordered list, starting with a Trusted Certificate (also called the anchor), ending with the target certificate, and satisfying the condition that the Subject of -certificate '#i' is the Issuer of certificate '#i + 1'. +certificate `#i' is the Issuer of certificate `#i + 1'. - The 'keytool' is invoked from the command line as follows: + The `keytool' is invoked from the command line as follows: keytool [COMMAND] ... Multiple COMMANDs may be specified at once, each complete with its -own options. 'keytool' will parse all the arguments, before processing, -and executing, each 'COMMAND'. If an exception occurs while executing -one COMMAND 'keytool' will abort. Note however that because the +own options. `keytool' will parse all the arguments, before processing, +and executing, each `COMMAND'. If an exception occurs while executing +one COMMAND `keytool' will abort. Note however that because the implementation of the tool uses code to parse command line options that -also supports GNU-style options, you have to separate each command group -with a double-hyphen; e.g +also supports GNU-style options, you have to separate each command +group with a double-hyphen; e.g keytool -list -- -printcert -alias mykey Here is a summary of the commands supported by the tool: 1. Add/Update commands - '-genkey [OPTION]...' + `-genkey [OPTION]...' Generate a new Key Entry, eventually creating a new key store. - '-import [OPTION]...' - Add, to a key store, Key Entries (private keys and certificate - chains authenticating the public keys) and Trusted - Certificates (3rd party certificates which can be used as - Trust Anchors when building chains-of-trust). + `-import [OPTION]...' + Add, to a key store, Key Entries (private keys and + certificate chains authenticating the public keys) and + Trusted Certificates (3rd party certificates which can be + used as Trust Anchors when building chains-of-trust). - '-selfcert [OPTION]...' + `-selfcert [OPTION]...' Generate a new self-signed Trusted Certificate. - '-cacert [OPTION]...' + `-cacert [OPTION]...' Import a CA Trusted Certificate. - '-identitydb [OPTION]...' + `-identitydb [OPTION]...' NOT IMPLEMENTED YET. Import a JDK 1.1 style Identity Database. 2. Export commands - '-certreq [OPTION]...' + `-certreq [OPTION]...' Issue a Certificate Signing Request (CSR) which can be then sent to a Certification Authority (CA) to issue a certificate signed (by the CA) and authenticating the Subject of the request. - '-export [OPTION]...' + `-export [OPTION]...' Export a certificate from a key store. 3. Display commands - '-list [OPTION]...' - Print one or all certificates in a key store to 'STDOUT'. + `-list [OPTION]...' + Print one or all certificates in a key store to `STDOUT'. - '-printcert [OPTION]...' + `-printcert [OPTION]...' Print a human-readable form of a certificate, in a designated - file, to 'STDOUT'. + file, to `STDOUT'. 4. Management commands - '-keyclone [OPTION]...' + `-keyclone [OPTION]...' Clone a Key Entry in a key store. - '-storepasswd [OPTION]...' + `-storepasswd [OPTION]...' Change the password protecting a key store. - '-keypasswd [OPTION]...' + `-keypasswd [OPTION]...' Change the password protecting a Key Entry in a key store. - '-delete [OPTION]...' + `-delete [OPTION]...' Delete a Key Entry or a Trusted Certificate from a key store. * Menu: @@ -579,20 +585,20 @@ File: cp-tools.info, Node: Getting Help, Next: Common keytool Options, Prev: 2.2.1 Getting help ------------------ -To get a general help text about the tool, use the '-help' option; e.g. +To get a general help text about the tool, use the `-help' option; e.g. - keytool -help + `keytool -help' To get more specific help text about one of the tool's command use -the '-help' option for that command; e.g. +the `-help' option for that command; e.g. - keytool -genkey -help + `keytool -genkey -help' - In both instances, the tool will print a help text and then will exit -the running JVM. + In both instances, the tool will print a help text and then will +exit the running JVM. It is worth noting here that the help messages printed by the tool -are I18N-ready. This means that if/when the contents of the tool's +are I18N-ready. This means that if/when the contents of the tool's Message Bundle properties file are available in languages other than English, you may see those messages in that language. @@ -602,78 +608,79 @@ File: cp-tools.info, Node: Common keytool Options, Next: Distinguished Names, 2.2.2 Common options -------------------- -The following 'OPTION's are used in more than one 'COMMAND'. They are +The following `OPTION's are used in more than one `COMMAND'. They are described here to reduce redundancy. -'-alias ALIAS' +`-alias ALIAS' Every entry, be it a Key Entry or a Trusted Certificate, in a key - store is uniquely identified by a user-defined ALIAS string. Use + store is uniquely identified by a user-defined ALIAS string. Use this option to specify the ALIAS to use when referring to an entry - in the key store. Unless specified otherwise, a default value of - 'mykey' shall be used when this option is omitted from the command + in the key store. Unless specified otherwise, a default value of + `mykey' shall be used when this option is omitted from the command line. -'-keyalg ALGORITHM' +`-keyalg ALGORITHM' Use this option to specify the canonical name of the key-pair - generation algorithm. The default value for this option is 'DSS' + generation algorithm. The default value for this option is `DSS' (a synonym for the Digital Signature Algorithm also known as DSA). -'-keysize SIZE' - Use this option to specify the number of bits of the shared modulus - (for both the public and private keys) to use when generating new - keys. A default value of '1024' will be used if this option is - omitted from the command line. +`-keysize SIZE' + Use this option to specify the number of bits of the shared + modulus (for both the public and private keys) to use when + generating new keys. A default value of `1024' will be used if + this option is omitted from the command line. -'-validity DAY_COUNT' +`-validity DAY_COUNT' Use this option to specify the number of days a newly generated - certificate will be valid for. The default value is '90' (days) if + certificate will be valid for. The default value is `90' (days) if this option is omitted from the command line. -'-storetype STORE_TYPE' - Use this option to specify the type of the key store to use. The +`-storetype STORE_TYPE' + Use this option to specify the type of the key store to use. The default value, if this option is omitted, is that of the property - 'keystore.type' in the security properties file, which is obtained - by invoking the static method call 'getDefaultType()' in - 'java.security.KeyStore'. + `keystore.type' in the security properties file, which is obtained + by invoking the static method call `getDefaultType()' in + `java.security.KeyStore'. -'-storepass PASSWORD' +`-storepass PASSWORD' Use this option to specify the password protecting the key store. If this option is omitted from the command line, you will be prompted to provide a password. -'-keystore URL' +`-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 - '.keystore' located in the path returned by the call to - 'java.lang.System#getProperty(String)' using 'user.home' as + `.keystore' located in the path returned by the call to + `java.lang.System#getProperty(String)' using `user.home' as argument. - If a URL was specified, but was found to be malformed -e.g. missing - protocol element- the tool will attempt to use the URL value as a - file-name (with absolute or relative path-name) of a key store -as - if the protocol was 'file:'. + If a URL was specified, but was found to be malformed -e.g. + missing protocol element- the tool will attempt to use the URL + value as a file-name (with absolute or relative path-name) of a + key store -as if the protocol was `file:'. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' A fully qualified class name of a Security Provider to add to the current list of Security Providers already installed in the JVM - in-use. If a provider class is specified with this option, and was + in-use. If a provider class is specified with this option, and was successfully added to the runtime -i.e. it was not already installed- then the tool will attempt to removed this Security Provider before exiting. -'-file FILE' - Use this option to designate a file to use with a command. When +`-file FILE' + Use this option to designate a file to use with a command. When specified with this option, the value is expected to be the fully - qualified path of a file accessible by the File System. Depending - on the command, the file may be used as input or as output. When - this option is omitted from the command line, 'STDIN' will be used - instead, as the source of input, and 'STDOUT' will be used instead + qualified path of a file accessible by the File System. Depending + on the command, the file may be used as input or as output. When + this option is omitted from the command line, `STDIN' will be used + instead, as the source of input, and `STDOUT' will be used instead as the output destination. -'-v' +`-v' Unless specified otherwise, use this option to enable more verbose output. + File: cp-tools.info, Node: Distinguished Names, Next: Add/Update Commands, Prev: Common keytool Options, Up: keytool Tool @@ -681,32 +688,36 @@ File: cp-tools.info, Node: Distinguished Names, Next: Add/Update Commands, Pr ------------------------------- A Distinguished Name (or DN) MUST be supplied with some of the -'COMMAND's using a '-dname' option. The syntax of a valid value for -this option MUST follow RFC-2253 specifications. Namely the following -components (with their accepted meaning) will be recognized. Note that +`COMMAND's using a `-dname' option. The syntax of a valid value for +this option MUST follow RFC-2253 specifications. Namely the following +components (with their accepted meaning) will be recognized. Note that the component name is case-insensitive: CN - The Common Name; e.g. 'host.domain.com' + The Common Name; e.g. `host.domain.com' + OU - The Organizational Unit; e.g. 'IT Department' + The Organizational Unit; e.g. `IT Department' + O - The Organization Name; e.g. 'The Sample Company' + The Organization Name; e.g. `The Sample Company' + L - The Locality Name; e.g. 'Sydney' + The Locality Name; e.g. `Sydney' + ST - The State Name; e.g. 'New South Wales' + The State Name; e.g. `New South Wales' + C - The 2-letter Country identifier; e.g. 'AU' + The 2-letter Country identifier; e.g. `AU' - When specified with a '-dname' option, each pair of component/value -will be separated from the other with a comma. Each component and value -pair MUST be separated by an equal sign. For example, the following is + When specified with a `-dname' option, each pair of component/value +will be separated from the other with a comma. Each component and value +pair MUST be separated by an equal sign. For example, the following is a valid DN value: - CN=host.domain.com, O=The Sample Company, L=Sydney, ST=NSW, C=AU - If the Distinguished Name is required, and no valid default value can +If the Distinguished Name is required, and no valid default value can be used, the tool will prompt you to enter the information through the console. @@ -727,267 +738,274 @@ File: cp-tools.info, Node: Add/Update Commands, Next: Export Commands, Prev: File: cp-tools.info, Node: Command -genkey, Next: Command -import, Prev: Add/Update Commands, Up: Add/Update Commands -2.2.4.1 The '-genkey' command +2.2.4.1 The `-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 Key Entry, -associated with the designated (if was specified with the '-alias' -option) or default (if the '-alias' option is omitted) Alias. +associated with the designated (if was specified with the `-alias' +option) or default (if the `-alias' option is omitted) Alias. The private key material will be protected with a user-defined -password (see '-keypass' option). The public key on the other hand will +password (see `-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. -'-alias ALIAS' +`-alias ALIAS' For more details *note ALIAS: alias. -'-keyalg ALGORITHM' +`-keyalg ALGORITHM' For more details *note ALGORITHM: keyalg. -'-keysize KEY_SIZE' +`-keysize KEY_SIZE' For more details *note KEY_SIZE: keysize. -'-sigalg ALGORITHM' +`-sigalg ALGORITHM' The canonical name of the digital signature algorithm to use for - signing certificates. If this option is omitted, a default value + signing certificates. If this option is omitted, a default value will be chosen based on the type of the key-pair; i.e., the - algorithm that ends up being used by the -keyalg option. If the - key-pair generation algorithm is 'DSA', the value for the signature - algorithm will be 'SHA1withDSA'. If on the other hand the key-pair - generation algorithm is 'RSA', then the tool will use 'MD5withRSA' - as the signature algorithm. - -'-dname NAME' - This a mandatory value for the command. If no value is specified - -i.e. the '-dname' option is omitted- the tool will prompt you to + algorithm that ends up being used by the -keyalg option. If the + key-pair generation algorithm is `DSA', the value for the + signature algorithm will be `SHA1withDSA'. If on the other hand + the key-pair generation algorithm is `RSA', then the tool will use + `MD5withRSA' as the signature algorithm. + +`-dname NAME' + This a mandatory value for the command. If no value is specified + -i.e. the `-dname' option is omitted- the tool will prompt you to enter a Distinguished Name to use as both the Owner and Issuer of the generated self-signed certificate. For more details *note X.500 DISTINGUISHED NAME: dn. -'-keypass PASSWORD' +`-keypass PASSWORD' Use this option to specify the password which the tool will use to protect the newly created Key Entry. If this option is omitted, you will be prompted to provide a password. -'-validity DAY_COUNT' +`-validity DAY_COUNT' For more details *note DAY_COUNT: validity. -'-storetype STORE_TYPE' +`-storetype STORE_TYPE' For more details *note STORE_TYPE: storetype. -'-keystore URL' +`-keystore URL' For more details *note URL: keystore. -'-storepass PASSWORD' +`-storepass PASSWORD' For more details *note PASSWORD: storepass. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' For more details *note PROVIDER_CLASS_NAME: provider. -'-v' +`-v' For more details *note verbose::. + File: cp-tools.info, Node: Command -import, Next: Command -selfcert, Prev: Command -genkey, Up: Add/Update Commands -2.2.4.2 The '-import' command +2.2.4.2 The `-import' command ............................. Use this command to read an X.509 certificate, or a PKCS#7 Certificate Reply from a designated input source and incorporate the certificates into the key store. - If the Alias does not already exist in the key store, the tool treats -the certificate read from the input source as a new Trusted Certificate. -It then attempts to discover a chain-of-trust, starting from that -certificate and ending at another Trusted Certificate, already stored in -the key store. If the '-trustcacerts' option is present, an additional -key store, of type 'JKS' named 'cacerts', and assumed to be present in -'${JAVA_HOME}/lib/security' will also be consulted if found --'${JAVA_HOME}' refers to the location of an installed Java Runtime -Environment (JRE). If no chain-of-trust can be established, and unless -the '-noprompt' option has been specified, the certificate is printed to -'STDOUT' and the user is prompted for a confirmation. + If the Alias does not already exist in the key store, the tool +treats the certificate read from the input source as a new Trusted +Certificate. It then attempts to discover a chain-of-trust, starting +from that certificate and ending at another Trusted Certificate, +already stored in the key store. If the `-trustcacerts' option is +present, an additional key store, of type `JKS' named `cacerts', and +assumed to be present in `${JAVA_HOME}/lib/security' will also be +consulted if found -`${JAVA_HOME}' refers to the location of an +installed Java Runtime Environment (JRE). If no chain-of-trust can be +established, and unless the `-noprompt' option has been specified, the +certificate is printed to `STDOUT' and the user is prompted for a +confirmation. If Alias exists in the key store, the tool will treat the certificate(s) read from the input source as a Certificate Reply, which can be a chain of certificates, that eventually would replace the chain -of certificates associated with the Key Entry of that Alias. The +of certificates associated with the Key Entry of that 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 Trusted Certificates already present in the key -store. Again, if the '-trustcacerts' option is specified, additional -Trusted Certificates in the same 'cacerts' key store will be considered. -If no chain-of-trust can be established, the operation will abort. +store. Again, if the `-trustcacerts' option is specified, additional +Trusted Certificates in the same `cacerts' key store will be +considered. If no chain-of-trust can be established, the operation will +abort. -'-alias ALIAS' +`-alias ALIAS' For more details *note ALIAS: alias. -'-file FILE' +`-file FILE' For more details *note FILE: file. -'-keypass PASSWORD' +`-keypass PASSWORD' Use this option to specify the password which the tool will use to protect the Key Entry associated with the designated Alias, when replacing this Alias' chain of certificates with that found in the certificate reply. If this option is omitted, and the chain-of-trust for the - certificate reply has been established, the tool will first attempt - to unlock the Key Entry using the same password protecting the key - store. If this fails, you will then be prompted to provide a - password. + certificate reply has been established, the tool will first + attempt to unlock the Key Entry using the same password protecting + the key store. If this fails, you will then be prompted to provide + a password. -'-noprompt' +`-noprompt' Use this option to prevent the tool from prompting the user. -'-trustcacerts' +`-trustcacerts' Use this option to indicate to the tool that a key store, of type - 'JKS', named 'cacerts', and usually located in 'lib/security' in an - installed Java Runtime Environment should be considered when trying - to establish chain-of-trusts. + `JKS', named `cacerts', and usually located in `lib/security' in + an installed Java Runtime Environment should be considered when + trying to establish chain-of-trusts. -'-storetype STORE_TYPE' +`-storetype STORE_TYPE' For more details *note STORE_TYPE: storetype. -'-keystore URL' +`-keystore URL' For more details *note URL: keystore. -'-storepass PASSWORD' +`-storepass PASSWORD' For more details *note PASSWORD: storepass. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' For more details *note PROVIDER_CLASS_NAME: provider. -'-v' +`-v' For more details *note verbose::. + File: cp-tools.info, Node: Command -selfcert, Next: Command -cacert, Prev: Command -import, Up: Add/Update Commands -2.2.4.3 The '-selfcert' command +2.2.4.3 The `-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 Alias (if -'-alias' option was specified), or the default Alias (if '-alias' option -was omitted). +will replace the previous chain associated with the designated Alias +(if `-alias' option was specified), or the default Alias (if `-alias' +option was omitted). -'-alias ALIAS' +`-alias ALIAS' For more details *note ALIAS: alias. -'-sigalg ALGORITHM' +`-sigalg ALGORITHM' The canonical name of the digital signature algorithm to use for - signing the certificate. If this option is omitted, a default + signing the certificate. If this option is omitted, a default value will be chosen based on the type of the private key - associated with the designated Alias. If the private key is a - 'DSA' one, the value for the signature algorithm will be - 'SHA1withDSA'. If on the other hand the private key is an 'RSA' - one, then the tool will use 'MD5withRSA' as the signature + associated with the designated Alias. If the private key is a + `DSA' one, the value for the signature algorithm will be + `SHA1withDSA'. If on the other hand the private key is an `RSA' + one, then the tool will use `MD5withRSA' as the signature algorithm. -'-dname NAME' +`-dname NAME' Use this option to specify the Distinguished Name of the newly - generated self-signed certificate. If this option is omitted, the + generated self-signed certificate. If this option is omitted, the existing Distinguished Name of the base certificate in the chain associated with the designated Alias will be used instead. For more details *note X.500 DISTINGUISHED NAME: dn. -'-validity DAY_COUNT' +`-validity DAY_COUNT' For more details *note DAY_COUNT: validity. -'-keypass PASSWORD' +`-keypass PASSWORD' Use this option to specify the password which the tool will use to unlock the Key Entry associated with the designated Alias. If this option is omitted, the tool will first attempt to unlock - the Key Entry using the same password protecting the key store. If + the Key Entry using the same password protecting the key store. If this fails, you will then be prompted to provide a password. -'-storetype STORE_TYPE' +`-storetype STORE_TYPE' For more details *note STORE_TYPE: storetype. -'-keystore URL' +`-keystore URL' For more details *note URL: keystore. -'-storepass PASSWORD' +`-storepass PASSWORD' For more details *note PASSWORD: storepass. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' For more details *note PROVIDER_CLASS_NAME: provider. -'-v' +`-v' For more details *note verbose::. + File: cp-tools.info, Node: Command -cacert, Next: Command -identitydb, Prev: Command -selfcert, Up: Add/Update Commands -2.2.4.4 The '-cacert' command +2.2.4.4 The `-cacert' command ............................. -Use this command to import, a CA certificate and add it to the key store -as a Trusted Certificate. The Alias for this new entry will be +Use this command to import, a CA certificate and add it to the key +store as a Trusted Certificate. The 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 'cacerts.gkr' Key Store of +a directory of CA certificates to populate a `cacerts.gkr' Key Store of trusted certificates which can then be used commands that specify the -'-trustcacerts' option. +`-trustcacerts' option. -'-file FILE' +`-file FILE' For more details *note FILE: file. -'-storetype STORE_TYPE' +`-storetype STORE_TYPE' For more details *note STORE_TYPE: storetype. -'-keystore URL' +`-keystore URL' For more details *note URL: keystore. -'-storepass PASSWORD' +`-storepass PASSWORD' For more details *note PASSWORD: storepass. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' For more details *note PROVIDER_CLASS_NAME: provider. -'-v' +`-v' For more details *note verbose::. + File: cp-tools.info, Node: Command -identitydb, Prev: Command -cacert, Up: Add/Update Commands -2.2.4.5 The '-identitydb' command +2.2.4.5 The `-identitydb' command ................................. NOT IMPLEMENTED YET. Use this command to import a JDK 1.1 style Identity Database. -'-file FILE' +`-file FILE' For more details *note FILE: file. -'-storetype STORE_TYPE' +`-storetype STORE_TYPE' For more details *note STORE_TYPE: storetype. -'-keystore URL' +`-keystore URL' For more details *note URL: keystore. -'-storepass PASSWORD' +`-storepass PASSWORD' For more details *note PASSWORD: storepass. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' For more details *note PROVIDER_CLASS_NAME: provider. -'-v' +`-v' For more details *note verbose::. + File: cp-tools.info, Node: Export Commands, Next: Display Commands, Prev: Add/Update Commands, Up: keytool Tool @@ -1002,12 +1020,12 @@ File: cp-tools.info, Node: Export Commands, Next: Display Commands, Prev: Add File: cp-tools.info, Node: Command -certreq, Next: Command -export, Prev: Export Commands, Up: Export Commands -2.2.5.1 The '-certreq' command +2.2.5.1 The `-certreq' command .............................. -Use this command to generate a PKCS#10 Certificate Signing Request (CSR) -and write it to a designated output destination. The contents of the -destination should look something like the following: +Use this command to generate a PKCS#10 Certificate Signing Request +(CSR) and write it to a designated output destination. The contents of +the destination should look something like the following: -----BEGIN NEW CERTIFICATE REQUEST----- MI...QAwXzEUMBIGA1UEAwwLcnNuQGdudS5vcmcxGzAZBgNVBAoMElUg @@ -1017,93 +1035,95 @@ destination should look something like the following: -----END NEW CERTIFICATE REQUEST----- IMPORTANT: Some documentation (e.g. RSA examples) claims that the -'Attributes' field, in the CSR is 'OPTIONAL' while RFC-2986 implies the -opposite. This implementation considers this field, by default, as -'OPTIONAL', unless the option '-attributes' is specified on the command +`Attributes' field, in the CSR is `OPTIONAL' while RFC-2986 implies the +opposite. This implementation considers this field, by default, as +`OPTIONAL', unless the option `-attributes' is specified on the command line. -'-alias ALIAS' +`-alias ALIAS' For more details *note ALIAS: alias. -'-sigalg ALGORITHM' +`-sigalg ALGORITHM' The canonical name of the digital signature algorithm to use for - signing the certificate. If this option is omitted, a default + signing the certificate. If this option is omitted, a default value will be chosen based on the type of the private key - associated with the designated Alias. If the private key is a - 'DSA' one, the value for the signature algorithm will be - 'SHA1withDSA'. If on the other hand the private key is an 'RSA' - one, then the tool will use 'MD5withRSA' as the signature + associated with the designated Alias. If the private key is a + `DSA' one, the value for the signature algorithm will be + `SHA1withDSA'. If on the other hand the private key is an `RSA' + one, then the tool will use `MD5withRSA' as the signature algorithm. -'-file FILE' +`-file FILE' For more details *note FILE: file. -'-keypass PASSWORD' +`-keypass PASSWORD' Use this option to specify the password which the tool will use to unlock the Key Entry associated with the designated Alias. If this option is omitted, the tool will first attempt to unlock - the Key Entry using the same password protecting the key store. If + the Key Entry using the same password protecting the key store. If this fails, you will then be prompted to provide a password. -'-storetype STORE_TYPE' +`-storetype STORE_TYPE' For more details *note STORE_TYPE: storetype. -'-keystore URL' +`-keystore URL' For more details *note URL: keystore. -'-storepass PASSWORD' +`-storepass PASSWORD' For more details *note PASSWORD: storepass. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' For more details *note PROVIDER_CLASS_NAME: provider. -'-v' +`-v' For more details *note verbose::. -'-attributes' - Use this option to force the tool to encode a 'NULL' DER value in - the CSR as the value of the 'Attributes' field. +`-attributes' + Use this option to force the tool to encode a `NULL' DER value in + the CSR as the value of the `Attributes' field. + File: cp-tools.info, Node: Command -export, Prev: Command -certreq, Up: Export Commands -2.2.5.2 The '-export' command +2.2.5.2 The `-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 '-v' -option is specified), or in RFC-1421 compliant encoding (if the '-rfc' +designated output destination, either in binary format (if the `-v' +option is specified), or in RFC-1421 compliant encoding (if the `-rfc' option is specified instead). -'-alias ALIAS' +`-alias ALIAS' For more details *note ALIAS: alias. -'-file FILE' +`-file FILE' For more details *note FILE: file. -'-storetype STORE_TYPE' +`-storetype STORE_TYPE' For more details *note STORE_TYPE: storetype. -'-keystore URL' +`-keystore URL' For more details *note URL: keystore. -'-storepass PASSWORD' +`-storepass PASSWORD' For more details *note PASSWORD: storepass. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' For more details *note PROVIDER_CLASS_NAME: provider. -'-rfc' +`-rfc' Use RFC-1421 specifications when encoding the output. -'-v' - Output the certificate in binary DER encoding. This is the default - output format of the command if neither '-rfc' nor '-v' options - were detected on the command line. If both this option and the - '-rfc' option are detected on the command line, the tool will opt +`-v' + Output the certificate in binary DER encoding. This is the default + output format of the command if neither `-rfc' nor `-v' options + were detected on the command line. If both this option and the + `-rfc' option are detected on the command line, the tool will opt for the RFC-1421 style encoding. + File: cp-tools.info, Node: Display Commands, Next: Management Commands, Prev: Export Commands, Up: keytool Tool @@ -1118,55 +1138,57 @@ File: cp-tools.info, Node: Display Commands, Next: Management Commands, Prev: File: cp-tools.info, Node: Command -list, Next: Command -printcert, Prev: Display Commands, Up: Display Commands -2.2.6.1 The '-list' command +2.2.6.1 The `-list' command ........................... -Use this command to print one or all of a key store entries to 'STDOUT'. -Usually this command will only print a fingerprint of the certificate, -unless either the '-rfc' or the '-v' option is specified. +Use this command to print one or all of a key store entries to +`STDOUT'. Usually this command will only print a fingerprint of the +certificate, unless either the `-rfc' or the `-v' option is specified. -'-alias ALIAS' +`-alias ALIAS' If this option is omitted, the tool will print ALL the entries found in the key store. For more details *note ALIAS: alias. -'-storetype STORE_TYPE' +`-storetype STORE_TYPE' For more details *note STORE_TYPE: storetype. -'-keystore URL' +`-keystore URL' For more details *note URL: keystore. -'-storepass PASSWORD' +`-storepass PASSWORD' For more details *note PASSWORD: storepass. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' For more details *note PROVIDER_CLASS_NAME: provider. -'-rfc' +`-rfc' Use RFC-1421 specifications when encoding the output. -'-v' - Output the certificate in human-readable format. If both this - option and the '-rfc' option are detected on the command line, the +`-v' + Output the certificate in human-readable format. If both this + option and the `-rfc' option are detected on the command line, the tool will opt for the human-readable form and will not abort the command. + File: cp-tools.info, Node: Command -printcert, Prev: Command -list, Up: Display Commands -2.2.6.2 The '-printcert' command +2.2.6.2 The `-printcert' command ................................ Use this command to read a certificate from a designated input source -and print it to 'STDOUT' in a human-readable form. +and print it to `STDOUT' in a human-readable form. -'-file FILE' +`-file FILE' For more details *note FILE: file. -'-v' +`-v' For more details *note verbose::. + File: cp-tools.info, Node: Management Commands, Prev: Display Commands, Up: keytool Tool @@ -1183,138 +1205,142 @@ File: cp-tools.info, Node: Management Commands, Prev: Display Commands, Up: k File: cp-tools.info, Node: Command -keyclone, Next: Command -storepasswd, Prev: Management Commands, Up: Management Commands -2.2.7.1 The '-keyclone' command +2.2.7.1 The `-keyclone' command ............................... -Use this command to clone an existing Key Entry and store it under a new -(different) Alias protecting, its private key material with possibly a -new password. +Use this command to clone an existing Key Entry and store it under a +new (different) Alias protecting, its private key material with +possibly a new password. -'-alias ALIAS' +`-alias ALIAS' For more details *note ALIAS: alias. -'-dest ALIAS' +`-dest ALIAS' Use this option to specify the new Alias which will be used to identify the cloned copy of the Key Entry. -'-keypass PASSWORD' +`-keypass PASSWORD' Use this option to specify the password which the tool will use to unlock the Key Entry associated with the designated Alias. If this option is omitted, the tool will first attempt to unlock - the Key Entry using the same password protecting the key store. If + the Key Entry using the same password protecting the key store. If this fails, you will then be prompted to provide a password. -'-new PASSWORD' +`-new PASSWORD' Use this option to specify the password protecting the private key material of the newly cloned copy of the Key Entry. -'-storetype STORE_TYPE' +`-storetype STORE_TYPE' For more details *note STORE_TYPE: storetype. -'-keystore URL' +`-keystore URL' For more details *note URL: keystore. -'-storepass PASSWORD' +`-storepass PASSWORD' For more details *note PASSWORD: storepass. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' For more details *note PROVIDER_CLASS_NAME: provider. -'-v' +`-v' For more details *note verbose::. + File: cp-tools.info, Node: Command -storepasswd, Next: Command -keypasswd, Prev: Command -keyclone, Up: Management Commands -2.2.7.2 The '-storepasswd' command +2.2.7.2 The `-storepasswd' command .................................. Use this command to change the password protecting a key store. -'-new PASSWORD' +`-new PASSWORD' The new, and different, password which will be used to protect the designated key store. -'-storetype STORE_TYPE' +`-storetype STORE_TYPE' For more details *note STORE_TYPE: storetype. -'-keystore URL' +`-keystore URL' For more details *note URL: keystore. -'-storepass PASSWORD' +`-storepass PASSWORD' For more details *note PASSWORD: storepass. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' For more details *note PROVIDER_CLASS_NAME: provider. -'-v' +`-v' For more details *note verbose::. + File: cp-tools.info, Node: Command -keypasswd, Next: Command -delete, Prev: Command -storepasswd, Up: Management Commands -2.2.7.3 The '-keypasswd' command +2.2.7.3 The `-keypasswd' command ................................ Use this command to change the password protecting the private key material of a designated Key Entry. -'-alias ALIAS' +`-alias ALIAS' For more details *note ALIAS: alias. Use this option to specify the password which the tool will use to unlock the Key Entry associated with the designated Alias. If this option is omitted, the tool will first attempt to unlock - the Key Entry using the same password protecting the key store. If + the Key Entry using the same password protecting the key store. If this fails, you will then be prompted to provide a password. -'-new PASSWORD' +`-new PASSWORD' The new, and different, password which will be used to protect the private key material of the designated Key Entry. -'-storetype STORE_TYPE' +`-storetype STORE_TYPE' For more details *note STORE_TYPE: storetype. -'-keystore URL' +`-keystore URL' For more details *note URL: keystore. -'-storepass PASSWORD' +`-storepass PASSWORD' For more details *note PASSWORD: storepass. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' For more details *note PROVIDER_CLASS_NAME: provider. -'-v' +`-v' For more details *note verbose::. + File: cp-tools.info, Node: Command -delete, Prev: Command -keypasswd, Up: Management Commands -2.2.7.4 The '-delete' command +2.2.7.4 The `-delete' command ............................. Use this command to delete a designated key store entry. -'-alias ALIAS' +`-alias ALIAS' For more details *note ALIAS: alias. -'-storetype STORE_TYPE' +`-storetype STORE_TYPE' For more details *note STORE_TYPE: storetype. -'-keystore URL' +`-keystore URL' For more details *note URL: keystore. -'-storepass PASSWORD' +`-storepass PASSWORD' For more details *note PASSWORD: storepass. -'-provider PROVIDER_CLASS_NAME' +`-provider PROVIDER_CLASS_NAME' For more details *note PROVIDER_CLASS_NAME: provider. -'-v' +`-v' For more details *note verbose::. + File: cp-tools.info, Node: Other Tools, Next: I18N Issues, Prev: Security Tools, Up: Top @@ -1340,67 +1366,69 @@ gcjh, native2ascii, orbd, serialver, rmid, rmiregistry and tnameserv. File: cp-tools.info, Node: jar Tool, Next: javah Tool, Up: Other Tools -3.1 The 'jar' Tool +3.1 The `jar' Tool ================== -'gjar' is an implementation of Sun's jar utility that comes with the +`gjar' is an implementation of Sun's jar utility that comes with the JDK. If any file is a directory then it is processed recursively. The manifest file name and the archive file name needs to be specified in -the same order the '-m' and '-f' flags are specified. +the same order the `-m' and `-f' flags are specified. Operation mode: -'-c' +`-c' Create new archive. -'-t' +`-t' List table of contents for archive. -'-x' +`-x' Extract named (or all) files from archive. -'-u' +`-u' Update existing archive. -'-i FILE' +`-i FILE' Compute archive index. Operation modifiers: -'-f FILE' +`-f FILE' Specify archive file name. -'-0' +`-0' Store only; use no ZIP compression. -'-v' +`-v' Generate verbose output on standard output. -'-M' +`-M' Do not create a manifest file for the entries. -'-m MANIFEST' +`-m MANIFEST' Include manifest information from specified MANIFEST file. File name selection: -'-C DIR FILE' +`-C DIR FILE' Change to the DIR and include the following FILE. -'-@' +`-@' Read the names of the files to add to the archive from stdin. This - option is supported only in combination with '-c' or '-u'. Non + option is supported only in combination with `-c' or `-u'. Non standard option added in the GCC version. Standard options: -'-help' +`-help' Print help text, then exit. -'-version' + +`-version' Print version number, then exit. -'-JOPTION' + +`-JOPTION' Pass argument to the Java runtime. java(1), ... @@ -1408,60 +1436,62 @@ the same order the '-m' and '-f' flags are specified. File: cp-tools.info, Node: javah Tool, Next: gcjh Tool, Prev: jar Tool, Up: Other Tools -3.2 The 'javah' Tool +3.2 The `javah' Tool ==================== -The 'gjavah' program is used to generate header files from class files. +The `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. -'-d DIR' +`-d DIR' Set output directory. -'-o FILE' - Set output file (only one of '-d' or '-o' may be used). +`-o FILE' + Set output file (only one of `-d' or `-o' may be used). -'-cmdfile FILE' +`-cmdfile FILE' Read command file. -'-all DIR' +`-all DIR' Operate on all class files under directory DIR. -'-stubs' +`-stubs' Emit stub implementation. -'-jni' +`-jni' Emit JNI stubs or header (default). -'-cni' +`-cni' Emit CNI stubs or header (default JNI). -'-verbose' +`-verbose' Set verbose mode. -'-force' +`-force' Output files should always be written. Class path options: -'-classpath PATH' +`-classpath PATH' Set the class path. -'-IDIR' +`-IDIR' Add directory to class path. -'-bootclasspath PATH' +`-bootclasspath PATH' Set the boot class path. -'-extdirs PATH' +`-extdirs PATH' Set the extension directory path. Standard options: -'-help' +`-help' Print help text, then exit. -'-version' + +`-version' Print version number, then exit. -'-JOPTION' + +`-JOPTION' Pass argument to the Java runtime. javac(1), ... @@ -1469,42 +1499,47 @@ required native methods. File: cp-tools.info, Node: gcjh Tool, Next: native2ascii Tool, Prev: javah Tool, Up: Other Tools -3.3 The 'gcjh' Tool +3.3 The `gcjh' Tool =================== -The 'gcjh' program is used to generate header files from class files. +The `gcjh' 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. It is similar to 'javah' but has slightly +required native methods. It is similar to `javah' but has slightly different command line options, and defaults to CNI. - See 'javah' for a full description; this page only lists the -additional options provided by 'gcjh'. + See `javah' for a full description; this page only lists the +additional options provided by `gcjh'. CNI text options -'-add TEXT' +`-add TEXT' Insert TEXT into class body. -'-append TEXT' + +`-append TEXT' Append TEXT after class declaration. -'-friend TEXT' - Insert TEXT as a 'friend' declaration. -'-prepend TEXT' + +`-friend TEXT' + Insert TEXT as a `friend' declaration. + +`-prepend TEXT' Insert TEXT before start of class. Compatibility options (unused) -'-td DIR' -'-M' -'-MM' -'-MD' -'-MMD' +`-td DIR' +`-M' +`-MM' +`-MD' +`-MMD' Unused compatibility option. Standard options: -'-help' +`-help' Print help text, then exit. -'-version' + +`-version' Print version number, then exit. -'-JOPTION' + +`-JOPTION' Pass argument to the Java runtime. javac(1), javah(1), ... @@ -1512,23 +1547,25 @@ additional options provided by 'gcjh'. File: cp-tools.info, Node: native2ascii Tool, Next: orbd Tool, Prev: gcjh Tool, Up: Other Tools -3.4 The 'native2ascii' Tool +3.4 The `native2ascii' Tool =========================== To be written ... -'-encoding NAME' +`-encoding NAME' Set the encoding to use. -'-reversed' +`-reversed' Convert from encoding to native. Standard options: -'-help' +`-help' Print help text, then exit. -'-version' + +`-version' Print version number, then exit. -'-JOPTION' + +`-JOPTION' Pass argument to the Java runtime. javac(1), ... @@ -1536,30 +1573,32 @@ To be written ... File: cp-tools.info, Node: orbd Tool, Next: serialver Tool, Prev: native2ascii Tool, Up: Other Tools -3.5 The 'orbd' object request broker daemon +3.5 The `orbd' object request broker daemon =========================================== To be written ... -'-ORBInitialPort PORT' +`-ORBInitialPort PORT' Port on which persistent naming service is to be started. -'-ior FILE' +`-ior FILE' File in which to store persistent naming service's IOR reference -'-directory DIR' +`-directory DIR' Directory in which to store persistent data. -'-restart' +`-restart' Restart persistent naming service, clearing persistent naming database. Standard options: -'-help' +`-help' Print help text, then exit. -'-version' + +`-version' Print version number, then exit. -'-JOPTION' + +`-JOPTION' Pass argument to the Java runtime. java(1), ... @@ -1567,20 +1606,22 @@ To be written ... File: cp-tools.info, Node: serialver Tool, Next: rmid Tool, Prev: orbd Tool, Up: Other Tools -3.6 The 'serialver' version command +3.6 The `serialver' version command =================================== Print the serialVersionUID of the specified classes. -'-classpath PATH' +`-classpath PATH' Class path to use to find classes. Standard options: -'-help' +`-help' Print help text, then exit. -'-version' + +`-version' Print version number, then exit. -'-JOPTION' + +`-JOPTION' Pass argument to the Java runtime. javac(1), ... @@ -1588,40 +1629,42 @@ Print the serialVersionUID of the specified classes. File: cp-tools.info, Node: rmid Tool, Next: rmiregistry Tool, Prev: serialver Tool, Up: Other Tools -3.7 The 'rmid' RMI activation system daemon +3.7 The `rmid' RMI activation system daemon =========================================== -'rmiregistry' starts a remote object registry on the current host. If +`rmiregistry' starts a remote object registry on the current host. If no port number is specified, then port 1099 is used. Activation process control: -'-port PORT' +`-port PORT' Port on which activation system is to be started. -'-restart' +`-restart' Restart activation system, clearing persistent naming database, if any. -'-stop' +`-stop' Stop activation system. Persistence: -'-persistent' +`-persistent' Make activation system persistent. -'-directory DIR' +`-directory DIR' Directory in which to store persistent data. Debugging: -'-verbose' +`-verbose' Log binding events to standard out. Standard options: -'-help' +`-help' Print help text, then exit. -'-version' + +`-version' Print version number, then exit. -'-JOPTION' + +`-JOPTION' Pass argument to the Java runtime. java(1), ... @@ -1629,37 +1672,39 @@ no port number is specified, then port 1099 is used. File: cp-tools.info, Node: rmiregistry Tool, Next: tnameserv Tool, Prev: rmid Tool, Up: Other Tools -3.8 The 'rmiregistry' Tool +3.8 The `rmiregistry' Tool ========================== -'grmiregistry' starts a remote object registry on the current host. If +`grmiregistry' starts a remote object registry on the current host. If no port number is specified, then port 1099 is used. Registry process control: -'-restart' +`-restart' Restart RMI naming service, clearing persistent naming database, if any. -'-stop' +`-stop' Stop RMI naming service. Persistence: -'-persistent' +`-persistent' Make RMI naming service persistent. -'-directory DIR' +`-directory DIR' Directory in which to store persistent data. Debugging: -'-verbose' +`-verbose' Log binding events to standard out. Standard options: -'-help' +`-help' Print help text, then exit. -'-version' + +`-version' Print version number, then exit. -'-JOPTION' + +`-JOPTION' Pass argument to the Java runtime. java(1), ... @@ -1667,29 +1712,31 @@ no port number is specified, then port 1099 is used. File: cp-tools.info, Node: tnameserv Tool, Next: gjdoc Tool, Prev: rmiregistry Tool, Up: Other Tools -3.9 The 'tnameserv' Tool +3.9 The `tnameserv' Tool ======================== To be written ... -'-ORBInitialPort PORT' +`-ORBInitialPort PORT' Port on which naming service is to be started. -'-ior FILE' +`-ior FILE' File in which to store naming service's IOR reference. Standard options: -'-help' +`-help' Print help text, then exit. -'-version' + +`-version' Print version number, then exit. -'-JOPTION' + +`-JOPTION' Pass argument to the Java runtime. java(1), ... - Info entry for 'gjdoc'. Please report bugs to -<http://savannah.gnu.org/bugs/?group=classpath>. Julian Scheid + Info entry for `gjdoc'. Please report bugs to +`http://savannah.gnu.org/bugs/?group=classpath'. Julian Scheid File: cp-tools.info, Node: gjdoc Tool, Prev: tnameserv Tool, Up: Other Tools @@ -1698,16 +1745,16 @@ File: cp-tools.info, Node: gjdoc Tool, Prev: tnameserv Tool, Up: Other Tools ******************************* Gjdoc can be used in two ways: as a stand-alone documentation tool, or -as a driver for a user-specified Doclet. *Note Other Doclets::. +as a driver for a user-specified Doclet. *Note Other Doclets::. - In the default mode, Gjdoc will use the Standard Doclet 'HtmlDoclet' + In the default mode, Gjdoc will use the Standard Doclet `HtmlDoclet' to generate a set of HTML pages. The canonical usage is: gjdoc -s src/java/ -all -d api-docs/ - Here, 'src/java/' is the root of your source code class hierarchy, -'-all' means that all valid Java files found under this root directory -should be processed, and 'api-docs/' is the directory where the + Here, `src/java/' is the root of your source code class hierarchy, +`-all' means that all valid Java files found under this root directory +should be processed, and `api-docs/' is the directory where the generated documentation should be placed. To learn more about running Doclets other than the Standard Doclet, @@ -1745,7 +1792,7 @@ File: cp-tools.info, Node: Invoking the Standard Doclet, Next: Invoking a Cust 4.1 Invoking the Standard Doclet ================================ -Running the Gjdoc Standard Doclet 'HtmlDoclet' is the default mode of +Running the Gjdoc Standard Doclet `HtmlDoclet' is the default mode of operation for Gjdoc. This section lists the command line options you can specify in this mode. It doesn't distinguish between general Gjdoc options and options specific to the Standard Doclet. @@ -1777,8 +1824,8 @@ Here is a summary of all the options of both Gjdoc and the Standard Doclet, grouped by type. Explanations are in the following sections. _Source Set Options_ - *Note Options For Specifying the Source Files To Operate on: Source - Set Options. + *Note Options For Specifying the Source Files To Operate on: + Source Set Options. -sourcepath PATHLIST -subpackages PKGLIST -exclude PKGLIST _Source Format Options_ @@ -1827,6 +1874,7 @@ _Virtual Machine Options_ *Note Options Controlling Gjdoc Behavior: Virtual Machine Options. -classpath -bootclasspath -J VMOPT + * Menu: * Virtual Machine Options:: Controlling the kind of output: @@ -1839,47 +1887,48 @@ File: cp-tools.info, Node: Source Set Options, Next: Source Format Options, P 4.3 Selecting which Source Files to Process =========================================== -'-s PATHLIST' -'-sourcepath PATHLIST' +`-s PATHLIST' + +`-sourcepath PATHLIST' Look for source files in the specified directory or directories. PATHLIST should be one or more directory paths separated by your - platform's path separator (usually ':' or ';'). + platform's path separator (usually `:' or `;'). - If this option is not given, 'gjdoc' will look for source files in + If this option is not given, `gjdoc' will look for source files in the current directory. The directories specified should be root directories in terms of the Java package system. For example, if you want to generate - documentation for classes in package 'foo.bar', you must specify - the directory containing the top-level ''foo'' sub-directory, not - the directory ''foo/bar/'' in which the Java source files reside. + documentation for classes in package `foo.bar', you must specify + the directory containing the top-level ``foo'' sub-directory, not + the directory ``foo/bar/'' in which the Java source files reside. - The short-hand alias '-s' is specific to 'gjdoc' and not compatible - to Sun 'javadoc'. + The short-hand alias `-s' is specific to `gjdoc' and not + compatible to Sun `javadoc'. -'-all' +`-all' _[EXPERIMENTAL]_ Process all valid Java source files found in the directories listed in the source path and their sub-directories. - This is an option specific to 'gjdoc' and not compatible to Sun - 'javadoc'. + This is an option specific to `gjdoc' and not compatible to Sun + `javadoc'. -'-subpackages PKG:PKG:...' +`-subpackages PKG:PKG:...' Process the classes in the given Java packages and all sub-packages, recursively. Note that multiple package names must be separated with colons instead of whitespace. -'-exclude PKG:PKG:...' +`-exclude PKG:PKG:...' Do not process classes in the given Java packages and all sub-packages, recursively. This option can be used in conjunction - with '-all' or '-subpackages' in order to exclude individual + with `-all' or `-subpackages' in order to exclude individual packages or package sub-trees from the output. -'PACKAGES...' +`PACKAGES...' Process all classes in the given Java packages. -'SOURCEFILES...' +`SOURCEFILES...' Process the classes in the given Java source files. @@ -1888,36 +1937,36 @@ File: cp-tools.info, Node: Source Format Options, Next: Interlinking Options, 4.4 Specifying the Format of Input Files ======================================== -'-source RELEASE' +`-source RELEASE' Assume that the source files are targeted at the given release of the Java platform. RELEASE should be the version number of a Java platform release in - the format MAJOR.MINOR, for example '1.4'. + the format MAJOR.MINOR, for example `1.4'. This option is currently ignored except that an error is raised if - a release number other than '1.2', '1.3' or '1.4' is specified. + a release number other than `1.2', `1.3' or `1.4' is specified. -'-encoding CHARSET' +`-encoding CHARSET' Assume that the source files are encoded using CHARSET. - Examples for CHARSET are 'US-ASCII', 'ISO-8859-1' or 'UTF-8'. + Examples for CHARSET are `US-ASCII', `ISO-8859-1' or `UTF-8'. The semantics of CHARSET are identical to those of - 'java.nio.charset.Charset.forName(String)'. + `java.nio.charset.Charset.forName(String)'. -'-breakiterator' +`-breakiterator' Use the locale's java.text.BreakIterator instead of the internal first sentence detector. - By default, 'gjdoc' uses an internal algorithm to determine where a - sentence ends. When this option is given, it will instead use the - 'java.text.BreakIterator' instance for the locale given with - '-locale' (or the default locale). + By default, `gjdoc' uses an internal algorithm to determine where + a sentence ends. When this option is given, it will instead use + the `java.text.BreakIterator' instance for the locale given with + `-locale' (or the default locale). - This option should be specified when applying 'gjdoc' to source + This option should be specified when applying `gjdoc' to source code commented in a non-latin language for which the default first - sentence detector does not work. For all other cases, the default + sentence detector does not work. For all other cases, the default (do not use BreakIterator) produces better results at the time of this writing. @@ -1927,95 +1976,90 @@ File: cp-tools.info, Node: Interlinking Options, Next: Output Control Options, 4.5 Interlinking with other Documentation Sets ============================================== -'-link URL' - +`-link URL' Create hyperlinks to another documentation set. - By default, 'gjdoc' will only create hyperlinks to classes in the + By default, `gjdoc' will only create hyperlinks to classes in the source set. Use this option to additionally create hyperlinks to classes covered by the specified documentation set. - URL should be the root URL of the other documentation set. For + URL should be the root URL of the other documentation set. For example, to add hyperlinks to GNU Classpath, specify the following: -link http://developer.classpath.org/doc/ - The '-link' option can be specified multiple times. + The `-link' option can be specified multiple times. - Note that specifying the '-link' option will cause an HTTP access - every time gjdoc is invoked. You can use '-linkoffline' instead to + Note that specifying the `-link' option will cause an HTTP access + every time gjdoc is invoked. You can use `-linkoffline' instead to avoid this access. -'-linkoffline URL FILE' - +`-linkoffline URL FILE' Create hyperlinks to another documentation set which is also present on the local file system. - This option works exactly like '-link', except that it accesses the - local file system instead of the network for determining which + This option works exactly like `-link', except that it accesses + the local file system instead of the network for determining which classes are covered by the linked documentation set. - When using '-linkoffline' the remote documentation set is not + When using `-linkoffline' the remote documentation set is not accessed at all, which can significantly speed up generation time depending on your network connection. The generated hyperlinks to the documentation set however refer to the remote set, not to the - local one, so that you can distribute the documentation without any - further dependencies. + local one, so that you can distribute the documentation without + any further dependencies. - The '-linkoffline' option can be specified multiple times. - -'-noqualifier PKG:PKG:...' + The `-linkoffline' option can be specified multiple times. +`-noqualifier PKG:PKG:...' Do not qualify names of classes in the given packages with their package name. - By default, a class name is displayed unqualified only if the class - is part of the source set or a linked documentation set, and + By default, a class name is displayed unqualified only if the + class is part of the source set or a linked documentation set, and qualified with the name of its containing package if it is not. - You can use this option to force unqualified names for classes even - if they are not part of the documentation set. + You can use this option to force unqualified names for classes + even if they are not part of the documentation set. For example, usually a reference to the String class is represented - fully-qualified as 'java.lang.String' (unless you link to the - appropriate documentation set using '-link') because it isn't part - of the documentation set. You can specify '-noqualifier java.lang' - to render the same references just as 'String'. + fully-qualified as `java.lang.String' (unless you link to the + appropriate documentation set using `-link') because it isn't part + of the documentation set. You can specify `-noqualifier + java.lang' to render the same references just as `String'. Note that for all unqualified class names, a tooltip is provided when you place your mouse pointer over it in the HTML documentation. -'-noqualifier 'all'' +`-noqualifier `all'' Omit package name qualifier from all class names. Specify this option to omit package name qualifiers altogether, + File: cp-tools.info, Node: Generation Options, Next: Decoration Options, Prev: Output Control Options, Up: gjdoc Tool 4.6 Selecting which Information to Generate =========================================== -'-public' +`-public' Only include public members of public classes in the output. By default, protected class members are included as well. -'-protected' - +`-protected' Include public or protected members of public classes in the output. This is the default. -'-package' - +`-package' Include public, protected and package-private members of public and package-private classes. -'-private' - +`-private' Include all classes and class members regardless of their access level. -'-splitindex' +`-splitindex' Generate one index page per letter instead of a single, monolithic index page. @@ -2023,15 +2067,15 @@ File: cp-tools.info, Node: Generation Options, Next: Decoration Options, Prev entries on a single page. This is fine for small documentation sets, but for large sets you should specify this option. -'-nosince' - Ignore '@since' tags in javadoc comments. +`-nosince' + Ignore `@since' tags in javadoc comments. By default, the generated output contains sections listing the version of your API since which the package, class or class member in question exists when this tag is encountered. Specify this option to omit this information. -'-notree' +`-notree' Do not generate any tree pages. By default, the generated output includes one inheritance tree per @@ -2039,7 +2083,7 @@ File: cp-tools.info, Node: Generation Options, Next: Decoration Options, Prev packages - a page with the full inheritance tree. Specify this option to omit generation of these pages. -'-noindex' +`-noindex' Do not output the alphabetical index. By default, gjdoc generates an alphabetical index of all program @@ -2047,21 +2091,21 @@ File: cp-tools.info, Node: Generation Options, Next: Decoration Options, Prev classes, constructors, methods, and fields). Specify this option to omit this information. -'-nohelp' +`-nohelp' Do not generate the help page. This option is currently ignored as the Standard Doclet doesn't provide a help page. -'-nodeprecated' - Do not output inline information about deprecated packages, classes - or class members. +`-nodeprecated' + Do not output inline information about deprecated packages, + classes or class members. By default, the Standard Doclet adds a highlighted paragraph with deprecation information to the description of each deprecated program element. Specify this option to omit this information. -'-nodeprecatedlist' +`-nodeprecatedlist' Do not output the summary page for deprecated API elements. By default, the Standard Doclet generates a page listing all @@ -2069,7 +2113,7 @@ File: cp-tools.info, Node: Generation Options, Next: Decoration Options, Prev usually includes the reason for deprecation and possible alternatives. Specify this option to omit this information. -'-nonavbar' +`-nonavbar' Do not output the navigation bar, header, and footer. By default, each output page is equipped with a top navigation bar @@ -2077,90 +2121,85 @@ File: cp-tools.info, Node: Generation Options, Next: Decoration Options, Prev bar (which may include a user-specified footer). Specify this option to omit this decoration. -'-nocomment' - +`-nocomment' Omit all documentation text from the generated files and output only declarations and program element relationships. - This option is here for compatibility with 'javadoc'. If you plan - on extracting information about your project via 'gjdoc', you - should consider using a different Doclet for your purposes instead, - for example XmlDoclet. You could also use the Doclet API directly - by implementing a new Doclet. - -'-linksource' + This option is here for compatibility with `javadoc'. If you plan + on extracting information about your project via `gjdoc', you + should consider using a different Doclet for your purposes + instead, for example XmlDoclet. You could also use the Doclet API + directly by implementing a new Doclet. +`-linksource' Generate a page with syntax-highlighted source code for each class. By default, this page is not generated. The source code can be accessed by clicking on the button labelled "Source" in the navigation bar, or by clicking on the name of a - constructor, field, method, or inner class in the detail section of - a class documentation page. - -'-use' + constructor, field, method, or inner class in the detail section + of a class documentation page. - Generate a page with cross-reference information. By default, this +`-use' + Generate a page with cross-reference information. By default, this page is not generated. The cross-reference information can be accessed by clicking on the - button labelled 'Use' in the navigation bar. + button labelled `Use' in the navigation bar. - The 'Use' page lists all classes/interfaces in the documentation + The `Use' page lists all classes/interfaces in the documentation set that extend/implement the class (type) in question; fields of the type; methods or constructors accepting a parameter of the type; methods returning the type; and methods or constructors throwing the type. -'-author' +`-author' Include author information in the output. - When specified, author information as specified using the '@author' - tag in javadoc comments is incorporated into the output. By - default, '@author' tags are ignored. + When specified, author information as specified using the + `@author' tag in javadoc comments is incorporated into the output. + By default, `@author' tags are ignored. -'-version' +`-version' Include version information in the output. When specified, version information as specified using the - '@version' tag in javadoc comments is incorporated into the output. - By default, '@version' tags are ignored. - -'-licensetext' + `@version' tag in javadoc comments is incorporated into the + output. By default, `@version' tags are ignored. +`-licensetext' Assume that the first comment in each source file contains the license text, and add license information to the footer of each generated class page. - This is an option specific to 'gjdoc' and not compatible to Sun - 'javadoc'. + This is an option specific to `gjdoc' and not compatible to Sun + `javadoc'. This option is intended for use with free and open source projects where source code is typically prefixed with a boilerplate license comment, when there are legal reasons for including the license in the documentation. -'-docfilessubdirs' - - Recursively copy all files in the 'doc-files' sub-directory of each +`-docfilessubdirs' + Recursively copy all files in the `doc-files' sub-directory of each package directory. - Usually, only the files in the 'doc-files' sub-directory are copied + Usually, only the files in the `doc-files' sub-directory are copied without descending recursively. *Note Adding Custom Resources::. -'-excludedocfilessubdir NAME:NAME:...' - - Do not copy some directories directly under the 'doc-files' +`-excludedocfilessubdir NAME:NAME:...' + Do not copy some directories directly under the `doc-files' sub-directories when descending recursively. The argument to this option should be a colon-separated list of directory names. - This option only makes sense if '-docfilessubdirs' is also + This option only makes sense if `-docfilessubdirs' is also specified. In this case, any sub-directory located directly - beneath a 'doc-files' directory is omitted if listed. + beneath a `doc-files' directory is omitted if listed. + File: cp-tools.info, Node: Taglet Options, Next: Virtual Machine Options, Prev: Decoration Options, Up: gjdoc Tool @@ -2168,32 +2207,32 @@ File: cp-tools.info, Node: Taglet Options, Next: Virtual Machine Options, Pre 4.7 Custom Documentation Tags ============================= -'-tagletpath PATHLIST' +`-tagletpath PATHLIST' Search PATHLIST when loading subsequent Taglet classes specified - using '-taglet'. + using `-taglet'. PATHLIST should be one or more paths to a directory or jar file, - separated by your platform's path separator (usually ':' or ';'). + separated by your platform's path separator (usually `:' or `;'). -'-taglet CLASSNAME' +`-taglet CLASSNAME' Register a Taglet. CLASSNAME should be the fully-qualified name of a Java class - implementing 'com.sun.tools.doclets.Taglet'. + implementing `com.sun.tools.doclets.Taglet'. The Taglet classes will be loaded from the classpath specified - using '-tagletpath', from the classpath specified using - '-classpath' and from the default classpath. + using `-tagletpath', from the classpath specified using + `-classpath' and from the default classpath. - See the documentation of 'com.sun.tools.doclets.Taglet' for further - information. + See the documentation of `com.sun.tools.doclets.Taglet' for + further information. - Note that for simple tags, there is also '-tag'. + Note that for simple tags, there is also `-tag'. -'-tag TAGSPEC' +`-tag TAGSPEC' Register a generic Taglet. - The format of TAGSPEC must be '<tagname>:<flags>:"<taghead>"'. + The format of TAGSPEC must be `<tagname>:<flags>:"<taghead>"'. TAGNAME is the tag name to match, without the leading @ sign. @@ -2201,30 +2240,37 @@ File: cp-tools.info, Node: Taglet Options, Next: Virtual Machine Options, Pre character specifies a source code context in which the tag is to be recognized. - 'a' + `a' all contexts - 'c' + + `c' constructors - 'f' + + `f' fields - 'm' + + `m' methods - 'o' + + `o' overview - 'p' + + `p' packages - 't' + + `t' types (classes, interfaces, exceptions, errors) - 'X' + + `X' special character which temporarily disables the Taglet altogether. TAGHEAD is the string to display in the header of the section devoted to the tag in question. - For example, to define a tag matching '@cvsid' which is to be + For example, to define a tag matching `@cvsid' which is to be accepted in overview, package and type pages and which is labelled - with the header 'CVS ID', you would specify: + with the header `CVS ID', you would specify: -tag cvsid:tpo:"CVS ID" @@ -2243,39 +2289,41 @@ File: cp-tools.info, Node: Doclet Options, Next: Other Doclets, Prev: Verbosi 4.8 Running Other Doclets ========================= -'-docletpath PATHLIST' - Search PATHLIST when loading classes for the Doclet specified using - '-doclet'. +`-docletpath PATHLIST' + Search PATHLIST when loading classes for the Doclet specified + using `-doclet'. PATHLIST should be one or more paths to a directory or jar file, - separated by your platform's path separator (usually ':' or ';'). + separated by your platform's path separator (usually `:' or `;'). -'-doclet CLASSNAME' +`-doclet CLASSNAME' Run the specified doclet instead of the standard HtmlDoclet. - CLASSNAME should be the fully-qualified name of a class which has a - public default constructor and contain a method with the following - signature: + CLASSNAME should be the fully-qualified name of a class which has + a public default constructor and contain a method with the + following signature: import com.sun.javadoc.RootDoc; public static boolean start(RootDoc rootDoc) The Doclet classes will be loaded from the classpath specified - using '-docletpath', from the classpath specified using - '-classpath' and from the default classpath. + using `-docletpath', from the classpath specified using + `-classpath' and from the default classpath. - The 'start' method should process the information exposed by the - Doclet API via 'rootDoc' and return 'true' on success, 'false' on + The `start' method should process the information exposed by the + Doclet API via `rootDoc' and return `true' on success, `false' on failure. If you are using a third-party doclet, refer to its documentation for further instructions. Note that support for third-party - doclets is experimental. Please report any problems you encounter, - or provide feedback when successfully running third-party applets. + doclets is experimental. Please report any problems you + encounter, or provide feedback when successfully running + third-party applets. This option can be specified multiple times, in which case all - doclets are executed with the same information tree exposed via the - Doclet API for each Doclet run. + doclets are executed with the same information tree exposed via + the Doclet API for each Doclet run. + File: cp-tools.info, Node: Decoration Options, Next: Taglet Options, Prev: Generation Options, Up: gjdoc Tool @@ -2283,16 +2331,16 @@ File: cp-tools.info, Node: Decoration Options, Next: Taglet Options, Prev: Ge 4.9 Adding Information to the Output ==================================== -'-windowtitle TEXT' +`-windowtitle TEXT' Use TEXT as the browser window title prefix. When specified, the browser window title for each page will be - prefixed with TEXT instead of the default string 'Generated API + prefixed with TEXT instead of the default string `Generated API Documentation'. TEXT should be plain text (it should not contain HTML tags). -'-doctitle TEXT' +`-doctitle TEXT' Set the header text of the overview page to TEXT. TEXT should be a short plain text string. @@ -2300,40 +2348,35 @@ File: cp-tools.info, Node: Decoration Options, Next: Taglet Options, Prev: Ge When generating documentation for a single package, specifying this option forces generation of the overview page. -'-header HTMLTEXT' - +`-header HTMLTEXT' Add HTMLTEXT to the right upper corner of every generated page. HTMLTEXT is usually set to the name of the project being documented. -'-footer HTMLTEXT' - +`-footer HTMLTEXT' Add HTMLTEXT to the right bottom corner of every generated page. - HTMLTEXT is often set to the same value as for '-header'. - -'-bottom HTMLTEXT' + HTMLTEXT is often set to the same value as for `-header'. +`-bottom HTMLTEXT' Add HTMLTEXT to the very bottom of every generated page, spanning the whole width of the page. When specified, HTMLTEXT usually consists of a copyright notice and/or links to other project pages. -'-addstylesheet FILE' - +`-addstylesheet FILE' Augment the default CSS style sheets with the user-specified stylesheet FILE. - The given stylesheet is simply loaded by each HTML page in addition - to the default ones, as the last stylesheet. + The given stylesheet is simply loaded by each HTML page in + addition to the default ones, as the last stylesheet. Note that the CSS cascading rules apply. That is, your style properties will only be assigned if they have a higher cascading - order than 'gjdoc''s default style. One simple way to make sure - that this is the case is to declare your overrides '!important'. - - See <http://www.w3.org/TR/REC-CSS2/cascade.html#cascading-order>. + order than `gjdoc''s default style. One simple way to make sure + that this is the case is to declare your overrides `!important'. -'-group HEADING PKGWILDCARD:PKGWILDCARD:...' + See `http://www.w3.org/TR/REC-CSS2/cascade.html#cascading-order'. +`-group HEADING PKGWILDCARD:PKGWILDCARD:...' Arrange the given packages in a separate group on the overview page. @@ -2343,11 +2386,11 @@ File: cp-tools.info, Node: Decoration Options, Next: Taglet Options, Prev: Ge of all packages in the documentation set whose name matches any of the given wildcards. - There is only one wildcard character, '*', which matches both - letters in package name components and the '.' separating package - name components. For example, 'j*regex' would match package - 'java.util.regex'. A more useful example would be 'javax.swing*' - to match 'javax.swing' and all of its sub-packages. + There is only one wildcard character, `*', which matches both + letters in package name components and the `.' separating package + name components. For example, `j*regex' would match package + `java.util.regex'. A more useful example would be `javax.swing*' + to match `javax.swing' and all of its sub-packages. This option can be given multiple times. @@ -2359,105 +2402,98 @@ File: cp-tools.info, Node: Decoration Options, Next: Taglet Options, Prev: Ge -group "Other Extensions" javax* \ ... -'-overview FILE' - +`-overview FILE' Add the XHTML body fragment from FILE to the overview page. - FILE should contain an XHTML fragment with the HTML 'body' tag as + FILE should contain an XHTML fragment with the HTML `body' tag as the root node. *Note XHTML Fragments::. This option can be used to supply a description of the documentation set as a whole. When specified, the first sentence of the fragment will be put - above the tables listing the documented packages, along with a link - to the full copy of the fragment which is put below the tables. - *Note First Sentence Detector::. + above the tables listing the documented packages, along with a + link to the full copy of the fragment which is put below the + tables. *Note First Sentence Detector::. When generating documentation for a single package, specifying this option forces generation of the overview page. -'-stylesheetfile FILE' - +`-stylesheetfile FILE' Use the CSS stylesheet in FILE instead of the default CSS stylesheets. If you only want to override parts of the default stylesheets, use - '-addstylesheet' instead. - -'-title TEXT' - - _Deprecated._ Use '-doctitle' TEXT instead. + `-addstylesheet' instead. -'-helpfile FILE' +`-title TEXT' + _Deprecated._ Use `-doctitle' TEXT instead. +`-helpfile FILE' This option is currently ignored. When implemented, it will use the XHTML fragment in FILE for the help page contents instead of the default help text. + File: cp-tools.info, Node: Output Control Options, Next: Generation Options, Prev: Interlinking Options, Up: gjdoc Tool 4.10 Controlling the Output. ============================ -'-d DIRECTORY' +`-d DIRECTORY' Place all output files into DIRECTORY (and sub-directories). DIRECTORY will be created if it does not exist, including all non-existing parent directories and all required sub-directories. If not specified, output will be placed into the current directory. -'-locale NAME' - +`-locale NAME' Use locale NAME instead of the default locale for all purposes. - NAME should be a locale specifier in the form 'll_CC[_VAR]' where - 'll' is a lowercase two-letter ISO-639 language code, 'CC' is an - optional uppercase two-letter ISO-3166 country code, and 'VAR' is - an optional variant code. For example, 'en' specifies English, - 'en_US' specifies US English, and 'en_US_WIN' specifies a deviant + NAME should be a locale specifier in the form `ll_CC[_VAR]' where + `ll' is a lowercase two-letter ISO-639 language code, `CC' is an + optional uppercase two-letter ISO-3166 country code, and `VAR' is + an optional variant code. For example, `en' specifies English, + `en_US' specifies US English, and `en_US_WIN' specifies a deviant variant of the US English locale. Note that the semantics of this option correspond exactly to those - of the constructors of class 'java.util.Locale'. + of the constructors of class `java.util.Locale'. This option currently only determines which Collator is being used for sorting output elements. This means that the locale will only have an effect when you are using non-ASCII characters in identifiers. -'-charset CHARSET' - - _Deprecated._ Override the specified encoding in output XHTML - files with the one given by 'charset'. +`-charset CHARSET' + _Deprecated._ Override the specified encoding in output XHTML + files with the one given by `charset'. If this option is not given, the encoding specification in output XHTML is chosen to match the encoding used when writing the file - (the encoding given with '-docencoding', or your platform's default + (the encoding given with `-docencoding', or your platform's default encoding). The semantics for CHARSET are specified here: - <http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. For all + `http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName'. For all practical purposes, they are identical to those of the other options accepting charset parameters. - This option is here for compatibility with 'javadoc' and should be + This option is here for compatibility with `javadoc' and should be avoided. -'-docencoding CHARSET' - +`-docencoding CHARSET' Use the given charset encoding when writing output files instead of your platform's default encoding. - Examples for CHARSET are 'US-ASCII', 'ISO-8859-1' or 'UTF-8'. + Examples for CHARSET are `US-ASCII', `ISO-8859-1' or `UTF-8'. The semantics of this option correspond exactly to those of the - constructors of class 'java.util.Locale'. - -'-validhtml' + constructors of class `java.util.Locale'. +`-validhtml' Force generation of valid XHTML code. This breaks compatibility to the traditional Javadoc tool to some extent. @@ -2471,11 +2507,10 @@ File: cp-tools.info, Node: Output Control Options, Next: Generation Options, the traditional format, for example: "foo(String,int[])". This is compatible to the traditional Javadoc tool, but according to both the HTML 4.0 and XHTML 1.0 and 1.1 specifications, this format - includes illegal characters. Parentheses, square brackets, and the - comma are not allowed in anchor names. - -'-baseurl URL' + includes illegal characters. Parentheses, square brackets, and + the comma are not allowed in anchor names. +`-baseurl URL' Hardwire a page URL relative to URL into each generated page. If you are generating documentation which will exclusively be @@ -2485,62 +2520,64 @@ File: cp-tools.info, Node: Output Control Options, Next: Generation Options, This can help avoid certain redirect attacks used by spammers, and it can be helpful for certain web clients. + File: cp-tools.info, Node: Verbosity Options, Next: Doclet Options, Prev: Virtual Machine Options, Up: gjdoc Tool 4.11 Verbosity Options ====================== -'-quiet' +`-quiet' Suppress all output except for warnings and error messages. -'-verbose' - Be very verbose about what 'gjdoc' is doing. +`-verbose' + Be very verbose about what `gjdoc' is doing. This option is currently ignored. + File: cp-tools.info, Node: Virtual Machine Options, Next: Verbosity Options, Prev: Taglet Options, Up: gjdoc Tool 4.12 Virtual Machine Options ============================ -Sun's 'javadoc' tool seems to be based on 'javac' and as such it seems -to operate on the VM level. 'gjdoc', in contrast, is a pure Java +Sun's `javadoc' tool seems to be based on `javac' and as such it seems +to operate on the VM level. `gjdoc', in contrast, is a pure Java application. - Therefore, 'gjdoc' can only fake, or simulate, the following VM-level -options. + Therefore, `gjdoc' can only fake, or simulate, the following +VM-level options. -'-classpath PATHLIST' - Set the Virtual Machine 'classpath' to PATHLIST. +`-classpath PATHLIST' + Set the Virtual Machine `classpath' to PATHLIST. - In most cases you should use '-docletpath' or '-tagletpath' instead - of this option. + In most cases you should use `-docletpath' or `-tagletpath' + instead of this option. PATHLIST should be one or more paths to a directory or jar file, - separated by your platform's path separator (usually ':' or ';'). + separated by your platform's path separator (usually `:' or `;'). - If this option is not intercepted at the wrapper level, 'gjdoc' + If this option is not intercepted at the wrapper level, `gjdoc' currently fakes it by calling - 'System.setProperty("java.class.path", PATHLIST);' and outputs a + `System.setProperty("java.class.path", PATHLIST);' and outputs a warning. -'-bootclasspath PATHLIST' - Set the Virtual Machine 'bootclasspath' to PATHLIST. +`-bootclasspath PATHLIST' + Set the Virtual Machine `bootclasspath' to PATHLIST. - If this option is not intercepted at the wrapper level, 'gjdoc' + If this option is not intercepted at the wrapper level, `gjdoc' outputs a warning. -'-JVMOPT' - - Pass an arbitrary parameter to the Virtual Machine 'gjdoc' runs on. +`-JVMOPT' + Pass an arbitrary parameter to the Virtual Machine `gjdoc' runs on. - If this option is not intercepted at the wrapper level, 'gjdoc' + If this option is not intercepted at the wrapper level, `gjdoc' tries to emulate the option and outputs a warning. - Currently, only the VM option '-D' for setting system properties is - emulated. + Currently, only the VM option `-D' for setting system properties + is emulated. + File: cp-tools.info, Node: Invoking a Custom Doclet, Next: Option Summary by Type, Prev: Invoking the Standard Doclet, Up: gjdoc Tool @@ -2548,16 +2585,16 @@ File: cp-tools.info, Node: Invoking a Custom Doclet, Next: Option Summary by T 4.13 Invoking a Custom Doclet ============================= -For invoking one of the other doclets shipping with 'gjdoc' or a +For invoking one of the other doclets shipping with `gjdoc' or a third-party doclet, the canonical usage is: gjdoc -s src/java/ -all \ -docletpath /path/to/doclet.jar -doclet foo.BarDoclet \ (more Gjdoc core options and Doclet-specific options here) - '/path/to/doclet.jar' is a placeholder for a class path specifying + `/path/to/doclet.jar' is a placeholder for a class path specifying where the Doclet classes and dependencies can be found and -'foo.BarDoclet' is the fully-qualified name of the Doclet's main class. +`foo.BarDoclet' is the fully-qualified name of the Doclet's main class. File: cp-tools.info, Node: Gjdoc Option Summary, Next: Source Set Options, Prev: Option Summary by Type, Up: gjdoc Tool @@ -2704,16 +2741,16 @@ A Doclet is a class that contains a method with the following signature: public static boolean start(RootDoc rootDoc); - ROOTDOC is the root of an object hierarchy containing the information -'gjdoc' extracted from the source files. See the Doclet API for more -details. + ROOTDOC is the root of an object hierarchy containing the +information `gjdoc' extracted from the source files. See the Doclet +API for more details. - 'start' should process all the information and return 'true' on -success, 'false' on failure. + `start' should process all the information and return `true' on +success, `false' on failure. For printing status information, the Doclet should use methods -'printNotice', 'printWarning' and 'printError' instead of 'System.err'. -The Doclet can opt to use 'System.out' for redirectable output. +`printNotice', `printWarning' and `printError' instead of `System.err'. +The Doclet can opt to use `System.out' for redirectable output. File: cp-tools.info, Node: Using AbstractDoclet, Next: GNU Doclet SPI, Prev: Doclet Invocation Interface, Up: Writing Doclets @@ -2721,32 +2758,32 @@ File: cp-tools.info, Node: Using AbstractDoclet, Next: GNU Doclet SPI, Prev: 6.2.2 Deriving Your Doclet from AbstractDoclet ---------------------------------------------- -You may want your Doclet to provide functionality similar to HtmlDoclet. -For example, you may want it to support Taglets, generate Index, Tree, -and Uses pages, or show other cross-reference information like -'Overrides' and 'All Implementing Classes'. +You may want your Doclet to provide functionality similar to +HtmlDoclet. For example, you may want it to support Taglets, generate +Index, Tree, and Uses pages, or show other cross-reference information +like `Overrides' and `All Implementing Classes'. This information is not directly provided by the Doclet API, so your -Doclet would normally have to assemble it itself. For example, it would -have to add the names of all program elements to a list and sort this -list in order to create the Index page. +Doclet would normally have to assemble it itself. For example, it +would have to add the names of all program elements to a list and sort +this list in order to create the Index page. If you want to provide this information or part of it, you should consider deriving your class from -'gnu.classpath.tools.doclets.AbstractDoclet'. This class provides the +`gnu.classpath.tools.doclets.AbstractDoclet'. This class provides the following benefits: - * Handles options '-tag', '-taglet', '-tagletpath' (Taglets) + * Handles options `-tag', `-taglet', `-tagletpath' (Taglets) * Provides standard taglets for @version, @author, @since, @serial, @deprecated, @see, @param, @return and handles all related options - ('-version', '-author', '-nosince', '-nodeprecated') + (`-version', `-author', `-nosince', `-nodeprecated') - * Handles option '-d' (destination directory) + * Handles option `-d' (destination directory) - * Handles option '-noqualifier' (classes to omit qualifier for) + * Handles option `-noqualifier' (classes to omit qualifier for) - * Handles options '-docfilessubdirs' and '-excludedocfilessubdir' + * Handles options `-docfilessubdirs' and `-excludedocfilessubdir' (resource copying) * Can generate a full index or an index split by first letter @@ -2764,31 +2801,32 @@ following benefits: * Provides various other convenience methods - If you derive from 'AbstractDoclet', there are a number of things you -need to take care of: - * - you should not implement the 'start(RootDoc)' method as it is already -defined by 'AbstractDoclet' so that it can care about parsing the -options. + If you derive from `AbstractDoclet', there are a number of things +you need to take care of: - Instead, you implement method 'run()', 'getOptions()' and the other + * + you should not implement the `start(RootDoc)' method as it is +already defined by `AbstractDoclet' so that it can care about parsing +the options. + + Instead, you implement method `run()', `getOptions()' and the other abstract methods to define your Doclet's behavior. - Note that all information provided by 'AbstractDoclet' is evaluated + Note that all information provided by `AbstractDoclet' is evaluated lazily. That is, if your Doclet doesn't need to create an Index page, -then 'AbstractDoclet' will not spend resources on creating the +then `AbstractDoclet' will not spend resources on creating the corresponding information. See the API documentation for -'gnu.classpath.tools.doclets.AbstractDoclet' for more details. +`gnu.classpath.tools.doclets.AbstractDoclet' for more details. - You should be aware that if you base your Doclet on 'AbstractDoclet' + You should be aware that if you base your Doclet on `AbstractDoclet' then you have to bundle this and all related classes with your Doclet, with all implications such as possible licensing issues. Otherwise, -your Doclet will only be runnable on 'gjdoc' and not on other -documentation systems. Also note that 'AbstractDoclet' has not been -extensively tested in environments other than 'gjdoc'. +your Doclet will only be runnable on `gjdoc' and not on other +documentation systems. Also note that `AbstractDoclet' has not been +extensively tested in environments other than `gjdoc'. File: cp-tools.info, Node: GNU Doclet SPI, Prev: Using AbstractDoclet, Up: Writing Doclets @@ -2796,20 +2834,21 @@ File: cp-tools.info, Node: GNU Doclet SPI, Prev: Using AbstractDoclet, Up: Wr 6.2.3 Preparing for the GNU Doclet Service Provider Interface ------------------------------------------------------------- -In addition to the standard Doclet invocation interface described above, -'gjdoc' also offers a Service Provider Interface conforming to the Java -standard. Adding support for this interface to your Doclet simplifies -usage for 'gjdoc' users because it makes your Doclet "discoverable". +In addition to the standard Doclet invocation interface described +above, `gjdoc' also offers a Service Provider Interface conforming to +the Java standard. Adding support for this interface to your Doclet +simplifies usage for `gjdoc' users because it makes your Doclet +"discoverable". In order to provide the alternate interface, you have to add a class -implementing 'gnu.classpath.tools.gjdoc.spi.DocletSpi' to your Doclet +implementing `gnu.classpath.tools.gjdoc.spi.DocletSpi' to your Doclet classes, and bundle all Doclet classes in a Jar file along with a file -named 'META_INF/services/gnu.classpath.tools.gjdoc.spi.DocletSpi' which +named `META_INF/services/gnu.classpath.tools.gjdoc.spi.DocletSpi' which contains the name of your class implementing DocletSpi on a single line. Note that if your Doclet depends on third-party classes bundled in separate Jar files, you can link in these classes using the -'Class-path:' Manifest attribute of your Doclet Jar. +`Class-path:' Manifest attribute of your Doclet Jar. Your Doclet can then be invoked in one of the following ways: gjdoc -docletjar /path/to/doclet.jar @@ -2817,10 +2856,10 @@ separate Jar files, you can link in these classes using the gjdoc -docletname DOCLETNAME Here, DOCLETNAME is the name of your doclet as returned by -'DocletSpi.getDocletName()'. +`DocletSpi.getDocletName()'. - The last example will only work if your Doclet Jar is in 'gjdoc''s -'doclets' directory or if it is on the classpath. + The last example will only work if your Doclet Jar is in `gjdoc''s +`doclets' directory or if it is on the classpath. File: cp-tools.info, Node: XHTML Fragments, Next: First Sentence Detector, Prev: Writing Doclets, Up: Gjdoc Concepts @@ -2837,7 +2876,7 @@ results in invalid files if the user-specified HTML isn't wellformed. HTML code, which means that every Doclet must deal with non-wellformed code as well. - The 'gjdoc' built-in Doclets deal with this problem by "fixing" the + The `gjdoc' built-in Doclets deal with this problem by "fixing" the HTML code - making sure that all tags are closed, attribute values are provided and quoted, tags are properly nested, etc. @@ -2859,42 +2898,42 @@ File: cp-tools.info, Node: First Sentence Detector, Next: Adding Custom Resour 6.4 How Gjdoc Determines where the First Sentence Ends ====================================================== -For a package, class or member summary, 'gjdoc' only shows the first -sentence of the documentation comment in question. Because 'gjdoc' is -not human, it is not always obvious to 'gjdoc' where the first sentence +For a package, class or member summary, `gjdoc' only shows the first +sentence of the documentation comment in question. Because `gjdoc' is +not human, it is not always obvious to `gjdoc' where the first sentence ends. You might be tempted to say that the first sentence ends at the first -occurrence of a punctuation character like '.' or '!'. However, +occurrence of a punctuation character like `.' or `!'. However, consider examples like this: This work, by Thomas J. Shahan et al., is about the middle ages. As you can see, it is not trivial to determine the end of the sentence. - 'gjdoc' gives you the choice between two approaches. By default it -uses built-in heuristics which should be compatible to Sun's 'javadoc' + `gjdoc' gives you the choice between two approaches. By default it +uses built-in heuristics which should be compatible to Sun's `javadoc' tool. This approach works quiet well in most cases, at least for english comments. - Alternatively, you can specify option '-breakiterator' in which case -'gjdoc' will use -'java.text.BreakIterator.getSentenceInstance(LOCALE).next()' to find the -end of sentence, where LOCALE is the locale specified by option -'-locale' or the default locale if none specified. + Alternatively, you can specify option `-breakiterator' in which case +`gjdoc' will use +`java.text.BreakIterator.getSentenceInstance(LOCALE).next()' to find +the end of sentence, where LOCALE is the locale specified by option +`-locale' or the default locale if none specified. _NOT YET IMPLEMENTED:_ - 'gjdoc' also allows you to explicitly delineate the first sentence by -putting it in a '<span>' tag with the CSS class 'first-sentence'. For -example: + `gjdoc' also allows you to explicitly delineate the first sentence +by putting it in a `<span>' tag with the CSS class `first-sentence'. +For example: /** * <span class="first-sentence">This. is. the. first. * sentence.</span> This is the second sentence. */ - Note that this will only work with 'gjdoc', but shouldn't hurt when -using another documentation system since the '<span>' tag usually + Note that this will only work with `gjdoc', but shouldn't hurt when +using another documentation system since the `<span>' tag usually doesn't show up in the output. @@ -2907,31 +2946,31 @@ Sometimes you want to decorate your documentation with secondary resources such as images, SVG graphics, applets, and so on. To do so, simply put the required files in a subdirectory 'doc-files' in the package directory corresponding to the documentation entry you want to -decorate, and refer to it with the URL 'doc-files/FILENAME'. +decorate, and refer to it with the URL `doc-files/FILENAME'. For example, if you want to add an image to the description of class -'baz.FooBar', create a directory 'doc-files' in the directory 'baz' -containing 'FooBar.java' and put your file, say 'diagram.png', into that -directory. Then, add the HTML code like this to a comment in -'FooBar.java': +`baz.FooBar', create a directory `doc-files' in the directory `baz' +containing `FooBar.java' and put your file, say `diagram.png', into +that directory. Then, add the HTML code like this to a comment in +`FooBar.java': <img src="doc-files/diagram.png" width="200" height="150" alt="Foo Diagram"/> - This works because the 'doc-files' subdirectories will be copied to + This works because the `doc-files' subdirectories will be copied to the target documentation directory every time you generate the documentation. - Note however that by default, the 'doc-files' directory will not be + Note however that by default, the `doc-files' directory will not be copied deeply. In other words, if you create subdirectories under -'doc-files' they will not be copied and any resources located in these +`doc-files' they will not be copied and any resources located in these subdirectories will not be accessible in your generated documentation. -You can specify option '-docfilessubdirs' to remove this limitation. +You can specify option `-docfilessubdirs' to remove this limitation. - Sometimes you want to use option '-docfilessubdirs', but there are + Sometimes you want to use option `-docfilessubdirs', but there are certain directories which you don't want to be copied, for example -because they contain source files for the resources in 'doc-files'. For -cases like this, use '-excludedocfilessubdir' to specify directories to -be omitted. +because they contain source files for the resources in `doc-files'. +For cases like this, use `-excludedocfilessubdir' to specify +directories to be omitted. File: cp-tools.info, Node: I18N Issues, Prev: Other Tools, Up: Top @@ -2955,80 +2994,86 @@ File: cp-tools.info, Node: Language Resources, Next: Message Formats, Prev: I 7.1 Language-specific resources =============================== -The Tools use Java 'ResourceBundle's to store messages, and message +The Tools use Java `ResourceBundle's to store messages, and message templates they use at runtime to generate the message text itself, depending on the locale in use at the time. The Resource Bundles these tools use are essentially Java Properties -files consisting of a set of Name/Value pairs. The Name is the Property +files consisting of a set of Name/Value pairs. The Name is the Property Name and the Value is a substitution string that is used when the code -references the associated Name. For example the following is a line in -a Resource Bundle used by the 'keytool' Tool: +references the associated Name. For example the following is a line in +a Resource Bundle used by the `keytool' Tool: Command.23=A correct key password MUST be provided When the tool needs to signal a mandatory but missing key password, -it would reference the property named 'Command.23' and the message "'A -correct key password MUST be provided'" will be used instead. This +it would reference the property named `Command.23' and the message "`A +correct key password MUST be provided'" will be used instead. This indirect referencing of "resources" permits replacing, as late as possible, the English strings with strings in other languages, provided of course Resource Bundles in those languages are provided. For the GNU Classpath Tools described in this Guide, the Resource -Bundles are files named 'messages[_ll[_CC[_VV]]].properties' where: +Bundles are files named `messages[_ll[_CC[_VV]]].properties' where: LL Is the 2-letter code for the Language, + CC Is the 2-letter code for the Region, and + VV Is the 2-letter code for the Variant of the language. The complete list of language codes can be found at Code for the representation of names of languages -(http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt). A similar +(http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt). A similar list for the region codes can be found at ISO 3166 Codes (Countries) (http://userpage.chemie.fu-berlin.de/diverse/doc/ISO_3166.html). The location of the Resource Bundles for the GNU Classpath Tools is -specific to each tool. The next table shows where these files are found +specific to each tool. The next table shows where these files are found in a standard GNU Classpath distribution: -'jarsigner' - 'gnu/classpath/tools/jarsigner' -'keytool' - 'gnu/classpath/tools/keytool' +`jarsigner' + `gnu/classpath/tools/jarsigner' + +`keytool' + `gnu/classpath/tools/keytool' The collection of Resource Bundles in a location act as an inverted -tree with a parent-child relationship. For example suppose in the -'gnu/classpath/tools/keytool' there are 3 message bundles named: +tree with a parent-child relationship. For example suppose in the +`gnu/classpath/tools/keytool' there are 3 message bundles named: + + 1. `messages.properties' + + 2. `messages_fr.properties' - 1. 'messages.properties' - 2. 'messages_fr.properties' - 3. 'messages_fr_FR.properties' + 3. `messages_fr_FR.properties' In the above example, bundle #1 will act as the parent of bundle #2, -which in turn will act as the parent for bundle #3. This ordering is +which in turn will act as the parent for bundle #3. This ordering is used by the Java runtime to choose which file to load based on the set -Locale. For example if the Locale is 'fr_CH', 'messages_fr.properties' -will be used because (a) 'messages_fr_CH.properties' does not exist, but -(b) 'messages_fr.properties' is the parent for the required bundle, and -it exists. As another example, suppose the Locale was set to 'en_AU'; -then the tool will end up using 'messages.properties' because (a) -'messages_en_AU.properties' does not exist, (b) 'messages_en.properties' -which is the parent for the required bundle does not exist, but (c) -'messages.properties' exists and is the root of the hierarchy. - - You can see from the examples above that 'messages.properties' is the -safety net that the Java runtime falls back to when failing to find a -specific bundle and its parent(s). This file is always provided with -the Tool. In time, more localized versions will be included to cater +Locale. For example if the Locale is `fr_CH', `messages_fr.properties' +will be used because (a) `messages_fr_CH.properties' does not exist, +but (b) `messages_fr.properties' is the parent for the required bundle, +and it exists. As another example, suppose the Locale was set to +`en_AU'; then the tool will end up using `messages.properties' because +(a) `messages_en_AU.properties' does not exist, (b) +`messages_en.properties' which is the parent for the required bundle +does not exist, but (c) `messages.properties' exists and is the root of +the hierarchy. + + You can see from the examples above that `messages.properties' is +the safety net that the Java runtime falls back to when failing to find +a specific bundle and its parent(s). This file is always provided with +the Tool. In time, more localized versions will be included to cater for other languages. In the meantime, if you are willing to contribute localized versions -of these resources, grab the 'messages.properties' for a specific tool; +of these resources, grab the `messages.properties' for a specific tool; translate it; save it with the appropriate language and region suffix -and mail it to 'classpath@gnu.org'. +and mail it to `classpath@gnu.org'. File: cp-tools.info, Node: Message Formats, Prev: Language Resources, Up: I18N Issues @@ -3036,7 +3081,7 @@ File: cp-tools.info, Node: Message Formats, Prev: Language Resources, Up: I18 7.2 Message formats =================== -If you open any of the 'messages.properties' described in the previous +If you open any of the `messages.properties' described in the previous section, you may see properties that look like so: Command.67=Issuer: {0} @@ -3048,99 +3093,99 @@ section, you may see properties that look like so: string that will then be used either as a prompt for User input or as output. - If you are translating a 'messages.properties' be careful not to + If you are translating a `messages.properties' be careful not to alter text between curly braces. Tag Table: -Node: Top1103 -Node: Applet Tools6822 -Node: appletviewer Tool7395 -Node: gcjwebplugin10513 -Node: Security Tools10825 -Node: jarsigner Tool11478 -Node: Common jarsigner Options12525 -Node: Signing Options13840 -Node: Verification Options16426 -Node: keytool Tool17013 -Node: Getting Help21462 -Node: Common keytool Options22203 -Ref: alias22477 -Ref: keyalg22861 -Ref: keysize23092 -Ref: validity23358 -Ref: storetype23574 -Ref: storepass23906 -Ref: keystore24103 -Ref: provider24646 -Ref: file25054 -Ref: verbose25528 -Node: Distinguished Names25619 -Ref: dn25813 -Node: Add/Update Commands26880 -Node: Command -genkey27408 -Node: Command -import29821 -Node: Command -selfcert32968 -Node: Command -cacert35151 -Node: Command -identitydb36204 -Node: Export Commands36861 -Node: Command -certreq37177 -Node: Command -export39588 -Node: Display Commands40786 -Node: Command -list41118 -Node: Command -printcert42251 -Node: Management Commands42634 -Node: Command -keyclone43066 -Node: Command -storepasswd44469 -Node: Command -keypasswd45197 -Node: Command -delete46391 -Node: Other Tools47013 -Node: jar Tool47855 -Node: javah Tool49245 -Node: gcjh Tool50462 -Node: native2ascii Tool51570 -Node: orbd Tool52029 -Node: serialver Tool52757 -Node: rmid Tool53224 -Node: rmiregistry Tool54163 -Node: tnameserv Tool55001 -Node: gjdoc Tool55623 -Node: Invoking the Standard Doclet57612 -Node: Option Summary by Type58767 -Node: Source Set Options61196 -Node: Source Format Options63059 -Node: Interlinking Options64575 -Node: Generation Options67356 -Node: Taglet Options73463 -Node: Doclet Options75691 -Node: Decoration Options77261 -Node: Output Control Options81360 -Node: Verbosity Options84897 -Node: Virtual Machine Options85242 -Node: Invoking a Custom Doclet86638 -Node: Gjdoc Option Summary87313 -Node: Other Doclets87493 -Node: Built-in Doclets87721 -Node: Using TexiDoclet87976 -Node: Using XmlDoclet88198 -Node: Using IspellDoclet88423 -Node: Using DebugDoclet88651 -Node: Third-party Doclets88851 -Node: DocBook Doclet89067 -Node: PDFDoclet89210 -Node: JUnitDoclet89363 -Node: Gjdoc Concepts89497 -Node: Taglets89741 -Node: Writing Doclets89924 -Node: Doclet Invocation Interface90264 -Node: Using AbstractDoclet91056 -Node: GNU Doclet SPI94049 -Node: XHTML Fragments95521 -Node: First Sentence Detector96954 -Node: Adding Custom Resources98718 -Node: I18N Issues100415 -Node: Language Resources100917 -Node: Message Formats104587 +Node: Top1164 +Node: Applet Tools6884 +Node: appletviewer Tool7457 +Node: gcjwebplugin10572 +Node: Security Tools10884 +Node: jarsigner Tool11537 +Node: Common jarsigner Options12585 +Node: Signing Options13900 +Node: Verification Options16483 +Node: keytool Tool17071 +Node: Getting Help21499 +Node: Common keytool Options22243 +Ref: alias22516 +Ref: keyalg22898 +Ref: keysize23128 +Ref: validity23393 +Ref: storetype23608 +Ref: storepass23939 +Ref: keystore24136 +Ref: provider24679 +Ref: file25086 +Ref: verbose25557 +Node: Distinguished Names25649 +Ref: dn25843 +Node: Add/Update Commands26906 +Node: Command -genkey27434 +Node: Command -import29843 +Node: Command -selfcert32987 +Node: Command -cacert35166 +Node: Command -identitydb36219 +Node: Export Commands36877 +Node: Command -certreq37193 +Node: Command -export39599 +Node: Display Commands40796 +Node: Command -list41128 +Node: Command -printcert42261 +Node: Management Commands42645 +Node: Command -keyclone43077 +Node: Command -storepasswd44480 +Node: Command -keypasswd45209 +Node: Command -delete46403 +Node: Other Tools47026 +Node: jar Tool47868 +Node: javah Tool49260 +Node: gcjh Tool50479 +Node: native2ascii Tool51592 +Node: orbd Tool52053 +Node: serialver Tool52783 +Node: rmid Tool53252 +Node: rmiregistry Tool54193 +Node: tnameserv Tool55033 +Node: gjdoc Tool55657 +Node: Invoking the Standard Doclet57645 +Node: Option Summary by Type58800 +Node: Source Set Options61230 +Node: Source Format Options63094 +Node: Interlinking Options64608 +Node: Generation Options67385 +Node: Taglet Options73482 +Node: Doclet Options75709 +Node: Decoration Options77285 +Node: Output Control Options81376 +Node: Verbosity Options84908 +Node: Virtual Machine Options85254 +Node: Invoking a Custom Doclet86650 +Node: Gjdoc Option Summary87325 +Node: Other Doclets87505 +Node: Built-in Doclets87733 +Node: Using TexiDoclet87988 +Node: Using XmlDoclet88210 +Node: Using IspellDoclet88435 +Node: Using DebugDoclet88663 +Node: Third-party Doclets88863 +Node: DocBook Doclet89079 +Node: PDFDoclet89222 +Node: JUnitDoclet89375 +Node: Gjdoc Concepts89509 +Node: Taglets89753 +Node: Writing Doclets89936 +Node: Doclet Invocation Interface90276 +Node: Using AbstractDoclet91068 +Node: GNU Doclet SPI94062 +Node: XHTML Fragments95534 +Node: First Sentence Detector96967 +Node: Adding Custom Resources98729 +Node: I18N Issues100425 +Node: Language Resources100927 +Node: Message Formats104591 End Tag Table diff --git a/libjava/classpath/doc/gappletviewer.1 b/libjava/classpath/doc/gappletviewer.1 index 94ae3d5abc..46eeeb98ba 100644 --- a/libjava/classpath/doc/gappletviewer.1 +++ b/libjava/classpath/doc/gappletviewer.1 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.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 @@ -38,8 +46,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -47,27 +53,20 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} -. \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +132,7 @@ .\" ======================================================================== .\" .IX Title "GAPPLETVIEWER 1" -.TH GAPPLETVIEWER 1 "2016-04-27" "0.99.1-pre" "GNU" +.TH GAPPLETVIEWER 1 "2016-08-22" "0.99.1-pre" "GNU" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -153,7 +152,7 @@ The \fBappletviewer\fR tool loads and runs an applet. .PP Use the first form to test applets specified by tag. The \s-1URL\s0 should resolve to an \s-1HTML\s0 document from which the \fBappletviewer\fR will -extract applet tags. The \s-1APPLET, EMBED\s0 and \s-1OBJECT\s0 tags are supported. +extract applet tags. The \s-1APPLET\s0, \s-1EMBED\s0 and \s-1OBJECT\s0 tags are supported. If a given document contains multiple applet tags, all the applets will be loaded, with each applet appearing in its own window. Likewise, when multiple URLs are specified, each applet tag instance @@ -178,7 +177,7 @@ be ignored. \&\fBappletviewer\fR through named pipes. .SH "OPTIONS" .IX Header "OPTIONS" -\&\s-1URL OPTIONS\s0 +\&\s-1URL\s0 \s-1OPTIONS\s0 .IP "\fB\-debug\fR" 4 .IX Item "-debug" This option is not yet implemented but is provided for compatibility. @@ -187,7 +186,7 @@ This option is not yet implemented but is provided for compatibility. Use this option to specify an alternate character encoding for the specified \s-1HTML\s0 page. .PP -\&\s-1APPLET TAG OPTIONS\s0 +\&\s-1APPLET\s0 \s-1TAG\s0 \s-1OPTIONS\s0 .IP "\fB\-code\fR \fI\s-1CODE\s0\fR" 4 .IX Item "-code CODE" Use the \fB\-code\fR option to specify the value of the applet tag @@ -213,7 +212,7 @@ Use the \fB\-height\fR option to specify the value of the applet tag Use the \fB\-param\fR option to specify values for the \fI\s-1NAME\s0\fR and \fI\s-1VALUE\s0\fR attributes of an applet \s-1PARAM\s0 tag. .PP -\&\s-1PLUGIN OPTION\s0 +\&\s-1PLUGIN\s0 \s-1OPTION\s0 .IP "\fB\-plugin\fR \fI\s-1INPUT\s0\fR\fB,\fR\fI\s-1OUTPUT\s0\fR" 4 .IX Item "-plugin INPUT,OUTPUT" \&\fBgcjwebplugin\fR uses the \fB\-plugin\fR option to specify the @@ -221,13 +220,13 @@ named pipe the \fBappletviewer\fR should use for receiving commands (\fI\s-1INPUT\s0\fR) and the one it should use for sending commands to \&\fBgcjwebplugin\fR (\fI\s-1OUTPUT\s0\fR). .PP -\&\s-1DEBUGGING OPTION\s0 +\&\s-1DEBUGGING\s0 \s-1OPTION\s0 .IP "\fB\-verbose\fR" 4 .IX Item "-verbose" Use the \fB\-verbose\fR option to have the \fBappletviewer\fR print debugging messages. .PP -\&\s-1STANDARD OPTIONS\s0 +\&\s-1STANDARD\s0 \s-1OPTIONS\s0 .IP "\fB\-help\fR" 4 .IX Item "-help" Use the \fB\-help\fR option to have the \fBappletviewer\fR print a diff --git a/libjava/classpath/doc/gjar.1 b/libjava/classpath/doc/gjar.1 index 6f8c92fbe6..146302459d 100644 --- a/libjava/classpath/doc/gjar.1 +++ b/libjava/classpath/doc/gjar.1 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.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 @@ -38,8 +46,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -47,27 +53,20 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} -. \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +132,7 @@ .\" ======================================================================== .\" .IX Title "GJAR 1" -.TH GJAR 1 "2016-04-27" "0.99.1-pre" "GNU" +.TH GJAR 1 "2016-08-22" "0.99.1-pre" "GNU" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -146,7 +145,7 @@ gjar \fB\-ctxui\fR [\fI\s-1OPTIONS\s0\fR] \fIjar-file\fR [\fB\-C\fR \fI\s-1DIR\s .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBgjar\fR is an implementation of Sun's jar utility that comes with -the \s-1JDK.\s0 +the \s-1JDK\s0. .PP If any file is a directory then it is processed recursively. The manifest file name and the archive file name needs to be specified in diff --git a/libjava/classpath/doc/gjarsigner.1 b/libjava/classpath/doc/gjarsigner.1 index 03a5dbb9d1..1c4e08153a 100644 --- a/libjava/classpath/doc/gjarsigner.1 +++ b/libjava/classpath/doc/gjarsigner.1 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.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 @@ -38,8 +46,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -47,27 +53,20 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} -. \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +132,7 @@ .\" ======================================================================== .\" .IX Title "GJARSIGNER 1" -.TH GJARSIGNER 1 "2016-04-27" "0.99.1-pre" "GNU" +.TH GJARSIGNER 1 "2016-08-22" "0.99.1-pre" "GNU" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -196,12 +195,12 @@ Use this option to specify the password which the tool will use to unlock the \f If this option is omitted, the tool will first attempt to unlock the \fIKey Entry\fR using the same password protecting the key store. If this fails, you will then be prompted to provide a password. .IP "\fB\-sigfile\fR \fI\s-1NAME\s0\fR" 4 .IX Item "-sigfile NAME" -Use this option to designate a literal that will be used to construct file names for both the \f(CW\*(C`.SF\*(C'\fR and \f(CW\*(C`.DSA\*(C'\fR signature files. These files will be generated, by the tool, and placed in the \fIMETA-INF\fR directory of the signed \s-1JAR. \s0 Permissible characters for \fI\s-1NAME\s0\fR must be in the range \*(L"a\-zA\-Z0\-9_\-\*(R". All characters will be converted to upper-case ones. +Use this option to designate a literal that will be used to construct file names for both the \f(CW\*(C`.SF\*(C'\fR and \f(CW\*(C`.DSA\*(C'\fR signature files. These files will be generated, by the tool, and placed in the \fIMETA-INF\fR directory of the signed \s-1JAR\s0. Permissible characters for \fI\s-1NAME\s0\fR must be in the range \*(L"a\-zA\-Z0\-9_\-\*(R". All characters will be converted to upper-case ones. .Sp If this option is missing, the first eight characters of the \fI\s-1ALIAS\s0\fR argument will be used. When this is the case, any character in \fI\s-1ALIAS\s0\fR that is outside the permissible range of characters will be replaced by an underscore. .IP "\fB\-signedjar\fR \fI\s-1FILE\s0\fR" 4 .IX Item "-signedjar FILE" -Use this option to specify the file name of the signed \s-1JAR.\s0 If this option is omitted, then the signed \s-1JAR\s0 will be named the same as \fI\s-1FILE\s0\fR; i.e., the input \s-1JAR\s0 file will be replaced with the signed copy. +Use this option to specify the file name of the signed \s-1JAR\s0. If this option is omitted, then the signed \s-1JAR\s0 will be named the same as \fI\s-1FILE\s0\fR; i.e., the input \s-1JAR\s0 file will be replaced with the signed copy. .PP \fIVerification options\fR .IX Subsection "Verification options" diff --git a/libjava/classpath/doc/gjavah.1 b/libjava/classpath/doc/gjavah.1 index ac66633a6a..374b9bdc61 100644 --- a/libjava/classpath/doc/gjavah.1 +++ b/libjava/classpath/doc/gjavah.1 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.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 @@ -38,8 +46,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -47,27 +53,20 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} -. \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +132,7 @@ .\" ======================================================================== .\" .IX Title "GJAVAH 1" -.TH GJAVAH 1 "2016-04-27" "0.99.1-pre" "GNU" +.TH GJAVAH 1 "2016-08-22" "0.99.1-pre" "GNU" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/libjava/classpath/doc/gjdoc.1 b/libjava/classpath/doc/gjdoc.1 index 35f014aa58..3f922c8195 100644 --- a/libjava/classpath/doc/gjdoc.1 +++ b/libjava/classpath/doc/gjdoc.1 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.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 @@ -38,8 +46,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -47,27 +53,20 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} -. \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +132,7 @@ .\" ======================================================================== .\" .IX Title "GJDOC 1" -.TH GJDOC 1 "2016-04-27" "0.99.1-pre" "GNU" +.TH GJDOC 1 "2016-08-22" "0.99.1-pre" "GNU" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -190,7 +189,7 @@ To learn more about running Doclets other than the Standard Doclet, refer to the manual. .SH "OPTIONS" .IX Header "OPTIONS" -.SS "Option Summary by Type" +.Sh "Option Summary by Type" .IX Subsection "Option Summary by Type" Here is a summary of all the options of both Gjdoc and the Standard Doclet, grouped by type. Explanations are in the following sections. @@ -232,7 +231,7 @@ Doclet, grouped by type. Explanations are in the following sections. .IP "\fIVirtual Machine Options\fR" 4 .IX Item "Virtual Machine Options" \&\fB\-classpath \-bootclasspath \-J\fR \fIvmopt\fR -.SS "Selecting which Source Files to Process" +.Sh "Selecting which Source Files to Process" .IX Subsection "Selecting which Source Files to Process" .IP "\fB\-s\fR \fIpathlist\fR" 4 .IX Item "-s pathlist" @@ -282,7 +281,7 @@ Process all classes in the given Java packages. .IP "\fIsourcefiles\fR\fB...\fR" 4 .IX Item "sourcefiles..." Process the classes in the given Java source files. -.SS "Specifying the Format of Input Files" +.Sh "Specifying the Format of Input Files" .IX Subsection "Specifying the Format of Input Files" .IP "\fB\-source\fR \fIrelease\fR" 4 .IX Item "-source release" @@ -290,7 +289,7 @@ Assume that the source files are targeted at the given release of the Java platform. .Sp \&\fIrelease\fR should be the version number of a Java platform release -in the format \s-1MAJOR.MINOR,\s0 for example \fB1.4\fR. +in the format \s-1MAJOR\s0.MINOR, for example \fB1.4\fR. .Sp This option is currently ignored except that an error is raised if a release number other than \fB1.2\fR, \fB1.3\fR or \fB1.4\fR is @@ -318,7 +317,7 @@ source code commented in a non-latin language for which the default first sentence detector does not work. For all other cases, the default (do not use BreakIterator) produces better results at the time of this writing. -.SS "Interlinking with other Documentation Sets" +.Sh "Interlinking with other Documentation Sets" .IX Subsection "Interlinking with other Documentation Sets" .IP "\fB\-link\fR \fIurl\fR" 4 .IX Item "-link url" @@ -381,7 +380,7 @@ you place your mouse pointer over it in the \s-1HTML\s0 documentation. Omit package name qualifier from all class names. .Sp Specify this option to omit package name qualifiers altogether, -.SS "Selecting which Information to Generate" +.Sh "Selecting which Information to Generate" .IX Subsection "Selecting which Information to Generate" .IP "\fB\-public\fR" 4 .IX Item "-public" @@ -538,7 +537,7 @@ directory names. This option only makes sense if \fB\-docfilessubdirs\fR is also specified. In this case, any sub-directory located directly beneath a \&\fIdoc-files\fR directory is omitted if listed. -.SS "Custom Documentation Tags" +.Sh "Custom Documentation Tags" .IX Subsection "Custom Documentation Tags" .IP "\fB\-tagletpath\fR \fIpathlist\fR" 4 .IX Item "-tagletpath pathlist" @@ -608,7 +607,7 @@ devoted to the tag in question. .Sp For example, to define a tag matching \fB\f(CB@cvsid\fB\fR which is to be accepted in overview, package and type pages and which is labelled -with the header \fB\s-1CVS ID\s0\fR, you would specify: +with the header \fB\s-1CVS\s0 \s-1ID\s0\fR, you would specify: .Sp .Vb 1 \& \-tag cvsid:tpo:"CVS ID" @@ -627,7 +626,7 @@ Then the \s-1HTML\s0 output will contain something like \& $Id: cp\-tools.texinfo,v 1.9 2012\-03\-07 15:27:27 gnu_andrew Exp $ .Ve .RE -.SS "Running Other Doclets" +.Sh "Running Other Doclets" .IX Subsection "Running Other Doclets" .IP "\fB\-docletpath\fR \fIpathlist\fR" 4 .IX Item "-docletpath pathlist" @@ -666,7 +665,7 @@ feedback when successfully running third-party applets. This option can be specified multiple times, in which case all doclets are executed with the same information tree exposed via the Doclet \s-1API\s0 for each Doclet run. -.SS "Adding Information to the Output" +.Sh "Adding Information to the Output" .IX Subsection "Adding Information to the Output" .IP "\fB\-windowtitle\fR \fItext\fR" 4 .IX Item "-windowtitle text" @@ -746,7 +745,7 @@ This option can be given multiple times. .IX Item "-overview file" Add the \s-1XHTML\s0 body fragment from \fIfile\fR to the overview page. .Sp -\&\fIfile\fR should contain an \s-1XHTML\s0 fragment with the \s-1HTML \s0\fBbody\fR +\&\fIfile\fR should contain an \s-1XHTML\s0 fragment with the \s-1HTML\s0 \fBbody\fR tag as the root node. .Sp This option can be used to supply a description of the documentation @@ -774,7 +773,7 @@ This option is currently ignored. .Sp When implemented, it will use the \s-1XHTML\s0 fragment in \fIfile\fR for the help page contents instead of the default help text. -.SS "Controlling the Output." +.Sh "Controlling the Output." .IX Subsection "Controlling the Output." .IP "\fB\-d\fR \fIdirectory\fR" 4 .IX Item "-d directory" @@ -834,7 +833,7 @@ Force generation of valid \s-1XHTML\s0 code. This breaks compatibility to the traditional Javadoc tool to some extent. .Sp If this option is specified, anchor names will be mangled so that they -are valid according to the \s-1XHTML 1.1\s0 specification. However, a +are valid according to the \s-1XHTML\s0 1.1 specification. However, a documentation set generated with this option cannot be linked to properly using the traditional Javadoc tool. It can be linked to just fine using Gjdoc, though. @@ -842,7 +841,7 @@ fine using Gjdoc, though. Without this option, anchor names for executable class members use the traditional format, for example: \*(L"foo(String,int[])\*(R". This is compatible to the traditional Javadoc tool, but according to both the -\&\s-1HTML 4.0\s0 and \s-1XHTML 1.0\s0 and 1.1 specifications, this format includes +\&\s-1HTML\s0 4.0 and \s-1XHTML\s0 1.0 and 1.1 specifications, this format includes illegal characters. Parentheses, square brackets, and the comma are not allowed in anchor names. .IP "\fB\-baseurl\fR \fIurl\fR" 4 @@ -850,12 +849,12 @@ not allowed in anchor names. Hardwire a page \s-1URL\s0 relative to \fIurl\fR into each generated page. .Sp If you are generating documentation which will exclusively be -available at a certain \s-1URL,\s0 you should use this option to specify this -\&\s-1URL.\s0 +available at a certain \s-1URL\s0, you should use this option to specify this +\&\s-1URL\s0. .Sp This can help avoid certain redirect attacks used by spammers, and it can be helpful for certain web clients. -.SS "Verbosity Options" +.Sh "Verbosity Options" .IX Subsection "Verbosity Options" .IP "\fB\-quiet\fR" 4 .IX Item "-quiet" @@ -865,7 +864,7 @@ Suppress all output except for warnings and error messages. Be very verbose about what \fBgjdoc\fR is doing. .Sp This option is currently ignored. -.SS "Virtual Machine Options" +.Sh "Virtual Machine Options" .IX Subsection "Virtual Machine Options" Sun's \fBjavadoc\fR tool seems to be based on \fBjavac\fR and as such it seems to operate on the \s-1VM\s0 level. \fBgjdoc\fR, in diff --git a/libjava/classpath/doc/gkeytool.1 b/libjava/classpath/doc/gkeytool.1 index 618f502b51..f8f682e719 100644 --- a/libjava/classpath/doc/gkeytool.1 +++ b/libjava/classpath/doc/gkeytool.1 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.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 @@ -38,8 +46,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -47,27 +53,20 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} -. \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +132,7 @@ .\" ======================================================================== .\" .IX Title "GKEYTOOL 1" -.TH GKEYTOOL 1 "2016-04-27" "0.99.1-pre" "GNU" +.TH GKEYTOOL 1 "2016-08-22" "0.99.1-pre" "GNU" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -182,10 +181,10 @@ Add, to a key store, \fIKey Entries\fR (private keys and certificate chains auth Generate a new self-signed \fITrusted Certificate\fR. .IP "\fB\-cacert [\fR\fI\s-1OPTION\s0\fR\fB]...\fR" 4 .IX Item "-cacert [OPTION]..." -Import a \s-1CA \s0\fITrusted Certificate\fR. +Import a \s-1CA\s0 \fITrusted Certificate\fR. .IP "\fB\-identitydb [\fR\fI\s-1OPTION\s0\fR\fB]...\fR" 4 .IX Item "-identitydb [OPTION]..." -\&\fB\s-1NOT IMPLEMENTED YET\s0\fR.Import a \s-1JDK 1.1\s0 style Identity Database. +\&\fB\s-1NOT\s0 \s-1IMPLEMENTED\s0 \s-1YET\s0\fR.Import a \s-1JDK\s0 1.1 style Identity Database. .RE .RS 4 .RE @@ -433,9 +432,9 @@ See \fICommon Options\fR for more details. The \fB\-identitydb\fR command .IX Subsection "The -identitydb command" .PP -\&\fB\s-1NOT IMPLEMENTED YET\s0\fR. +\&\fB\s-1NOT\s0 \s-1IMPLEMENTED\s0 \s-1YET\s0\fR. .PP -Use this command to import a \s-1JDK 1.1\s0 style Identity Database. +Use this command to import a \s-1JDK\s0 1.1 style Identity Database. .IP "\fB\-file\fR \fI\s-1FILE\s0\fR" 4 .IX Item "-file FILE" See \fICommon Options\fR for more details. diff --git a/libjava/classpath/doc/gnative2ascii.1 b/libjava/classpath/doc/gnative2ascii.1 index 76c178b72b..e5a8ff358a 100644 --- a/libjava/classpath/doc/gnative2ascii.1 +++ b/libjava/classpath/doc/gnative2ascii.1 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.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 @@ -38,8 +46,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -47,27 +53,20 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} -. \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +132,7 @@ .\" ======================================================================== .\" .IX Title "GNATIVE2ASCII 1" -.TH GNATIVE2ASCII 1 "2016-04-27" "0.99.1-pre" "GNU" +.TH GNATIVE2ASCII 1 "2016-08-22" "0.99.1-pre" "GNU" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/libjava/classpath/doc/gorbd.1 b/libjava/classpath/doc/gorbd.1 index 6c2fae1878..3aa4fbd1b8 100644 --- a/libjava/classpath/doc/gorbd.1 +++ b/libjava/classpath/doc/gorbd.1 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.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 @@ -38,8 +46,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -47,27 +53,20 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} -. \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +132,7 @@ .\" ======================================================================== .\" .IX Title "GORBD 1" -.TH GORBD 1 "2016-04-27" "0.99.1-pre" "GNU" +.TH GORBD 1 "2016-08-22" "0.99.1-pre" "GNU" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/libjava/classpath/doc/grmid.1 b/libjava/classpath/doc/grmid.1 index 8383fbe2f9..c28ddc4390 100644 --- a/libjava/classpath/doc/grmid.1 +++ b/libjava/classpath/doc/grmid.1 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.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 @@ -38,8 +46,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -47,27 +53,20 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} -. \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +132,7 @@ .\" ======================================================================== .\" .IX Title "GRMID 1" -.TH GRMID 1 "2016-04-27" "0.99.1-pre" "GNU" +.TH GRMID 1 "2016-08-22" "0.99.1-pre" "GNU" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/libjava/classpath/doc/grmiregistry.1 b/libjava/classpath/doc/grmiregistry.1 index 70753cda0e..bd6b09b6e0 100644 --- a/libjava/classpath/doc/grmiregistry.1 +++ b/libjava/classpath/doc/grmiregistry.1 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.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 @@ -38,8 +46,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -47,27 +53,20 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} -. \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +132,7 @@ .\" ======================================================================== .\" .IX Title "GRMIREGISTRY 1" -.TH GRMIREGISTRY 1 "2016-04-27" "0.99.1-pre" "GNU" +.TH GRMIREGISTRY 1 "2016-08-22" "0.99.1-pre" "GNU" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/libjava/classpath/doc/gserialver.1 b/libjava/classpath/doc/gserialver.1 index 0e80cb6998..a7048ba594 100644 --- a/libjava/classpath/doc/gserialver.1 +++ b/libjava/classpath/doc/gserialver.1 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.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 @@ -38,8 +46,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -47,27 +53,20 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} -. \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +132,7 @@ .\" ======================================================================== .\" .IX Title "GSERIALVER 1" -.TH GSERIALVER 1 "2016-04-27" "0.99.1-pre" "GNU" +.TH GSERIALVER 1 "2016-08-22" "0.99.1-pre" "GNU" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/libjava/classpath/doc/gtnameserv.1 b/libjava/classpath/doc/gtnameserv.1 index b1978e807b..02e290ca32 100644 --- a/libjava/classpath/doc/gtnameserv.1 +++ b/libjava/classpath/doc/gtnameserv.1 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.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 @@ -38,8 +46,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -47,27 +53,20 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} -. \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +132,7 @@ .\" ======================================================================== .\" .IX Title "GTNAMESERV 1" -.TH GTNAMESERV 1 "2016-04-27" "0.99.1-pre" "GNU" +.TH GTNAMESERV 1 "2016-08-22" "0.99.1-pre" "GNU" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l |