From: Nikos Mavrogiannopoulos Date: Sun, 5 May 2013 13:22:59 +0000 (+0300) Subject: updated for new autogen X-Git-Tag: gnutls_3_2_0~9 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c83d2a56ee6614fcb16336dd009feca524b98c6e;p=thirdparty%2Fgnutls.git updated for new autogen --- diff --git a/doc/invoke-certtool.texi b/doc/invoke-certtool.texi index fb36c380bd..fd47ed0f82 100644 --- a/doc/invoke-certtool.texi +++ b/doc/invoke-certtool.texi @@ -3,10 +3,10 @@ @pindex certtool @ignore # -*- buffer-read-only: t -*- vi: set ro: -# +# # DO NOT EDIT THIS FILE (invoke-certtool.texi) -# -# It has been AutoGen-ed March 14, 2013 at 04:18:00 PM by AutoGen 5.16 +# +# It has been AutoGen-ed May 5, 2013 at 03:51:56 PM by AutoGen 5.17.3 # From the definitions ../src/certtool-args.def # and the template file agtexi-cmd.tpl @end ignore @@ -22,11 +22,13 @@ This software is released under the GNU General Public License, version 3 or lat @anchor{certtool usage} -@subsubheading certtool help/usage (-h) +@subsubheading certtool help/usage (@option{--help}) @cindex certtool help This is the automatically generated usage text for certtool. -The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!). @code{more-help} will print + +The text printed is the same whether selected with the @code{help} option +(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print the usage text by passing it through a pager program. @code{more-help} is disabled on platforms without a working @code{fork(2)} function. The @code{PAGER} environment variable is @@ -35,11 +37,11 @@ with a status code of 0. @exampleindent 0 @example -certtool - GnuTLS certificate tool - Ver. @@VERSION@@ -USAGE: certtool [ - [] | --[@{=| @}] ]... +certtool - GnuTLS certificate tool +Usage: certtool [ - [] | --[@{=| @}] ]... -d, --debug=num Enable debugging. - - It must be in the range: + - it must be in the range: 0 to 9999 -V, --verbose More verbose output - may appear multiple times @@ -53,15 +55,12 @@ USAGE: certtool [ - [] | --[@{=| @}] ]... -u, --update-certificate Update a signed certificate -p, --generate-privkey Generate a private key -q, --generate-request Generate a PKCS #10 certificate request - - prohibits these options: - infile + - prohibits the option 'infile' -e, --verify-chain Verify a PEM encoded certificate chain. --verify Verify a PEM encoded certificate chain using a trusted list. - - requires these options: - load-ca-certificate + - requires the option 'load-ca-certificate' --verify-crl Verify a CRL using a trusted list. - - requires these options: - load-ca-certificate + - requires the option 'load-ca-certificate' --generate-dh-params Generate PKCS #3 encoded Diffie-Hellman parameters. --get-dh-params Get the included PKCS #3 encoded Diffie-Hellman parameters. --dh-info Print information PKCS #3 encoded Diffie-Hellman parameters @@ -91,41 +90,38 @@ USAGE: certtool [ - [] | --[@{=| @}] ]... --pubkey-info Print information on a public key --v1 Generate an X.509 version 1 certificate (with no extensions) --to-p12 Generate a PKCS #12 structure - - requires these options: - load-certificate + - requires the option 'load-certificate' --to-p8 Generate a PKCS #8 structure -8, --pkcs8 Use PKCS #8 format for private keys --rsa Generate RSA key --dsa Generate DSA key --ecc Generate ECC (ECDSA) key - --ecdsa This is an alias for 'ecc' + --ecdsa an alias for the 'ecc' option --hash=str Hash algorithm to use for signing. --inder Use DER format for input certificates and private keys. - - disabled as --no-inder - --inraw This is an alias for 'inder' + - disabled as '--no-inder' + --inraw an alias for the 'inder' option --outder Use DER format for output certificates and private keys - - disabled as --no-outder - --outraw This is an alias for 'outder' + - disabled as '--no-outder' + --outraw an alias for the 'outder' option --bits=num Specify the number of bits for key generate --sec-param=str Specify the security level [low, legacy, normal, high, ultra]. --disable-quick-random No effect --template=file Template file to use for non-interactive operation - file must pre-exist --pkcs-cipher=str Cipher to use for PKCS #8 and #12 operations - -v, --version[=arg] Output version information and exit - -h, --help Display extended usage information and exit - -!, --more-help Extended usage information passed thru pager + -v, --version[=arg] output version information and exit + -h, --help display extended usage information and exit + -!, --more-help extended usage information passed thru pager Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. - - Tool to parse and generate X.509 certificates, requests and private keys. It can be used interactively or non interactively by specifying the template command line option. -please send bug reports to: bug-gnutls@@gnu.org +Please send bug reports to: @end example @exampleindent 4 @@ -265,7 +261,7 @@ When combined with --generate-privkey generates an elliptic curve private key to @anchor{certtool ecdsa} @subsubheading ecdsa option -This is an alias for the ecc option, +This is an alias for the @code{ecc} option, @pxref{certtool ecc, the ecc option documentation}. @anchor{certtool hash} @@ -284,7 +280,7 @@ certificates), when reading in DER format a single data structure is read. @anchor{certtool inraw} @subsubheading inraw option -This is an alias for the inder option, +This is an alias for the @code{inder} option, @pxref{certtool inder, the inder option documentation}. @anchor{certtool outder} @@ -295,7 +291,7 @@ The output will be in DER or RAW format. @anchor{certtool outraw} @subsubheading outraw option -This is an alias for the outder option, +This is an alias for the @code{outder} option, @pxref{certtool outder, the outder option documentation}. @anchor{certtool sec-param} @@ -323,7 +319,6 @@ The operation failed or the command syntax was not valid. @anchor{certtool See Also} @subsubheading certtool See Also p11tool (1) - @anchor{certtool Examples} @subsubheading certtool Examples @subsubheading Generating private keys @@ -442,7 +437,6 @@ To verify a Certificate Revocation List (CRL) do: @example $ certtool --verify-crl --load-ca-certificate x509-ca.pem < crl.pem @end example - @anchor{certtool Files} @subsubheading certtool Files @subsubheading Certtool's template file format @@ -626,5 +620,3 @@ encryption_key #crl_number = 5 @end example - - diff --git a/doc/invoke-danetool.texi b/doc/invoke-danetool.texi index 527e7a0563..71a45eaa80 100644 --- a/doc/invoke-danetool.texi +++ b/doc/invoke-danetool.texi @@ -3,10 +3,10 @@ @pindex danetool @ignore # -*- buffer-read-only: t -*- vi: set ro: -# +# # DO NOT EDIT THIS FILE (invoke-danetool.texi) -# -# It has been AutoGen-ed March 14, 2013 at 04:18:00 PM by AutoGen 5.16 +# +# It has been AutoGen-ed May 5, 2013 at 03:51:58 PM by AutoGen 5.17.3 # From the definitions ../src/danetool-args.def # and the template file agtexi-cmd.tpl @end ignore @@ -20,11 +20,13 @@ This software is released under the GNU General Public License, version 3 or lat @anchor{danetool usage} -@subsubheading danetool help/usage (-h) +@subsubheading danetool help/usage (@option{--help}) @cindex danetool help This is the automatically generated usage text for danetool. -The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!). @code{more-help} will print + +The text printed is the same whether selected with the @code{help} option +(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print the usage text by passing it through a pager program. @code{more-help} is disabled on platforms without a working @code{fork(2)} function. The @code{PAGER} environment variable is @@ -33,11 +35,11 @@ with a status code of 0. @exampleindent 0 @example -danetool - GnuTLS DANE tool - Ver. @@VERSION@@ -USAGE: danetool [ - [] | --[@{=| @}] ]... +danetool - GnuTLS DANE tool +Usage: danetool [ - [] | --[@{=| @}] ]... -d, --debug=num Enable debugging. - - It must be in the range: + - it must be in the range: 0 to 9999 -V, --verbose More verbose output - may appear multiple times @@ -53,36 +55,33 @@ USAGE: danetool [ - [] | --[@{=| @}] ]... --check-ca Check only the CA's certificate. --insecure Do not verify any DNSSEC signature. --local-dns Use the local DNS server for DNSSEC resolving. - - disabled as --no-local-dns + - disabled as '--no-local-dns' --inder Use DER format for input certificates and private keys. - - disabled as --no-inder - --inraw This is an alias for 'inder' + - disabled as '--no-inder' + --inraw an alias for the 'inder' option --tlsa-rr Print the DANE RR data on a certificate or public key - - requires these options: - host + - requires the option 'host' --host=str Specify the hostname to be used in the DANE RR --proto=str The protocol set for DANE data (tcp, udp etc.) --port=num Specify the port number for the DANE data. --ca Whether the provided certificate or public key is a Certificate Authority. --x509 Use the hash of the X.509 certificate, rather than the public key. - --local This is an alias for 'domain' + --local an alias for the 'domain' option - enabled by default --domain The provided certificate or public key is issued by the local domain. - - disabled as --no-domain + - disabled as '--no-domain' - enabled by default - -v, --version[=arg] Output version information and exit - -h, --help Display extended usage information and exit - -!, --more-help Extended usage information passed thru pager + -v, --version[=arg] output version information and exit + -h, --help display extended usage information and exit + -!, --more-help extended usage information passed thru pager Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. - - Tool to generate and check DNS resource records for the DANE protocol. -please send bug reports to: bug-gnutls@@gnu.org +Please send bug reports to: @end example @exampleindent 4 @@ -153,7 +152,7 @@ certificates), when reading in DER format a single data structure is read. @anchor{danetool inraw} @subsubheading inraw option -This is an alias for the inder option, +This is an alias for the @code{inder} option, @pxref{danetool inder, the inder option documentation}. @anchor{danetool tlsa-rr} @@ -195,7 +194,7 @@ This option forces the generated record to contain the hash of the full X.509 ce @anchor{danetool local} @subsubheading local option -This is an alias for the domain option, +This is an alias for the @code{domain} option, @pxref{danetool domain, the domain option documentation}. @anchor{danetool domain} @@ -224,7 +223,6 @@ The operation failed or the command syntax was not valid. @anchor{danetool See Also} @subsubheading danetool See Also certtool (1) - @anchor{danetool Examples} @subsubheading danetool Examples @subsubheading DANE TLSA RR generation @@ -261,4 +259,3 @@ To verify a server's DANE TLSA entry, use: @example $ danetool --check www.example.com --proto tcp --port 443 --load-certificate chain.pem @end example - diff --git a/doc/invoke-gnutls-cli-debug.texi b/doc/invoke-gnutls-cli-debug.texi index f930641df6..70e2cb3cb9 100644 --- a/doc/invoke-gnutls-cli-debug.texi +++ b/doc/invoke-gnutls-cli-debug.texi @@ -3,10 +3,10 @@ @pindex gnutls-cli-debug @ignore # -*- buffer-read-only: t -*- vi: set ro: -# +# # DO NOT EDIT THIS FILE (invoke-gnutls-cli-debug.texi) -# -# It has been AutoGen-ed January 1, 2013 at 09:07:52 PM by AutoGen 5.16 +# +# It has been AutoGen-ed May 5, 2013 at 03:51:56 PM by AutoGen 5.17.3 # From the definitions ../src/cli-debug-args.def # and the template file agtexi-cmd.tpl @end ignore @@ -25,11 +25,13 @@ This software is released under the GNU General Public License, version 3 or lat @anchor{gnutls-cli-debug usage} -@subheading gnutls-cli-debug help/usage (-h) +@subheading gnutls-cli-debug help/usage (@option{--help}) @cindex gnutls-cli-debug help This is the automatically generated usage text for gnutls-cli-debug. -The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!). @code{more-help} will print + +The text printed is the same whether selected with the @code{help} option +(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print the usage text by passing it through a pager program. @code{more-help} is disabled on platforms without a working @code{fork(2)} function. The @code{PAGER} environment variable is @@ -38,27 +40,25 @@ with a status code of 0. @exampleindent 0 @example -gnutls-cli-debug - GnuTLS debug client - Ver. @@VERSION@@ -USAGE: gnutls-cli-debug [ - [] | --[@{=| @}] ]... +gnutls-cli-debug - GnuTLS debug client +Usage: gnutls-cli-debug [ - [] | --[@{=| @}] ]... -d, --debug=num Enable debugging. - - It must be in the range: + - it must be in the range: 0 to 9999 -V, --verbose More verbose output - may appear multiple times -p, --port=num The port to connect to - - It must be in the range: + - it must be in the range: 0 to 65536 - -v, --version[=arg] Output version information and exit - -h, --help Display extended usage information and exit - -!, --more-help Extended usage information passed thru pager + -v, --version[=arg] output version information and exit + -h, --help display extended usage information and exit + -!, --more-help extended usage information passed thru pager Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. Operands and options may be intermixed. They will be reordered. - - TLS debug client. It sets up multiple TLS connections to a server and queries its capabilities. It was created to assist in debugging GnuTLS, but it might be useful to extract a TLS server's capabilities. It connects @@ -66,7 +66,7 @@ to a TLS server, performs tests and print the server's capabilities. If called with the `-v' parameter more checks will be performed. Can be used to check for servers with special needs or bugs. -please send bug reports to: bug-gnutls@@gnu.org +Please send bug reports to: @end example @exampleindent 4 @@ -89,7 +89,6 @@ The operation failed or the command syntax was not valid. @anchor{gnutls-cli-debug See Also} @subheading gnutls-cli-debug See Also gnutls-cli(1), gnutls-serv(1) - @anchor{gnutls-cli-debug Examples} @subheading gnutls-cli-debug Examples @example @@ -139,4 +138,3 @@ Checking for ZLIB compression support... no Checking for max record size... no Checking for OpenPGP authentication support... no @end example - diff --git a/doc/invoke-gnutls-cli.texi b/doc/invoke-gnutls-cli.texi index 8cc59d7990..d02d52f9ad 100644 --- a/doc/invoke-gnutls-cli.texi +++ b/doc/invoke-gnutls-cli.texi @@ -3,10 +3,10 @@ @pindex gnutls-cli @ignore # -*- buffer-read-only: t -*- vi: set ro: -# +# # DO NOT EDIT THIS FILE (invoke-gnutls-cli.texi) -# -# It has been AutoGen-ed February 10, 2013 at 11:39:53 AM by AutoGen 5.16 +# +# It has been AutoGen-ed May 5, 2013 at 03:51:56 PM by AutoGen 5.17.3 # From the definitions ../src/cli-args.def # and the template file agtexi-cmd.tpl @end ignore @@ -21,11 +21,13 @@ This software is released under the GNU General Public License, version 3 or lat @anchor{gnutls-cli usage} -@subheading gnutls-cli help/usage (-h) +@subheading gnutls-cli help/usage (@option{--help}) @cindex gnutls-cli help This is the automatically generated usage text for gnutls-cli. -The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!). @code{more-help} will print + +The text printed is the same whether selected with the @code{help} option +(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print the usage text by passing it through a pager program. @code{more-help} is disabled on platforms without a working @code{fork(2)} function. The @code{PAGER} environment variable is @@ -34,43 +36,36 @@ with a status code of 0. @exampleindent 0 @example -gnutls-cli - GnuTLS client - Ver. @@VERSION@@ -USAGE: gnutls-cli [ - [] | --[@{=| @}] ]... [hostname] +gnutls-cli - GnuTLS client +Usage: gnutls-cli [ - [] | --[@{=| @}] ]... [hostname] -d, --debug=num Enable debugging. - - It must be in the range: + - it must be in the range: 0 to 9999 -V, --verbose More verbose output - may appear multiple times --tofu Enable trust on first use authentication - - disabled as --no-tofu + - disabled as '--no-tofu' --dane Enable DANE certificate verification (DNSSEC) - - disabled as --no-dane + - disabled as '--no-dane' --local-dns Use the local DNS server for DNSSEC resolving. - - disabled as --no-local-dns + - disabled as '--no-local-dns' --ca-verification Disable CA certificate verification - - disabled as --no-ca-verification + - disabled as '--no-ca-verification' - enabled by default --ocsp Enable OCSP certificate verification - - disabled as --no-ocsp + - disabled as '--no-ocsp' -r, --resume Establish a session and resume - -b, --heartbeat Activate heartbeat support -e, --rehandshake Establish a session and rehandshake - --noticket Don't accept session tickets -s, --starttls Connect, establish a plain session and start TLS. -u, --udp Use DTLS (datagram TLS) over UDP --mtu=num Set MTU for datagram TLS - - It must be in the range: + - it must be in the range: 0 to 17000 - --srtp-profiles=str Offer SRTP profiles --crlf Send CR LF instead of LF --x509fmtder Use DER format for certificates to read from -f, --fingerprint Send the openpgp fingerprint, instead of the key - --disable-extensions Disable all the TLS extensions --print-cert Print peer's certificate in PEM format - --recordsize=num The maximum record size to advertize - - It must be in the range: - 0 to 4096 --dh-bits=num The minimum number of bits allowed for DH --priority=str Priorities string --x509cafile=str Certificate file or PKCS #11 URL to use @@ -97,22 +92,29 @@ USAGE: gnutls-cli [ - [] | --[@{=| @}] ]... [hostname] --benchmark-tls-kx Benchmark TLS key exchange methods --benchmark-tls-ciphers Benchmark TLS ciphers -l, --list Print a list of the supported algorithms and modes + --noticket Don't allow session tickets + --srtp-profiles=str Offer SRTP profiles + --alpn=str Application layer protocol + - may appear multiple times + -b, --heartbeat Activate heartbeat support + --recordsize=num The maximum record size to advertize + - it must be in the range: + 0 to 4096 --disable-sni Do not send a Server Name Indication (SNI) - -v, --version[=arg] Output version information and exit - -h, --help Display extended usage information and exit - -!, --more-help Extended usage information passed thru pager + --disable-extensions Disable all the TLS extensions + -v, --version[=arg] output version information and exit + -h, --help display extended usage information and exit + -!, --more-help extended usage information passed thru pager Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. Operands and options may be intermixed. They will be reordered. - - Simple client program to set up a TLS connection to some other computer. It sets up a TLS connection and forwards data from the standard input to the secured socket and vice versa. -please send bug reports to: bug-gnutls@@gnu.org +Please send bug reports to: @end example @exampleindent 4 @@ -173,11 +175,6 @@ Connect, establish a session and rehandshake immediately. This is the ``connect, establish a plain session and start tls.'' option. The TLS session will be initiated when EOF or a SIGALRM is received. -@anchor{gnutls-cli disable-extensions} -@subheading disable-extensions option - -This is the ``disable all the tls extensions'' option. -This option disables all TLS extensions. Deprecated option. Use the priority string. @anchor{gnutls-cli dh-bits} @subheading dh-bits option @@ -205,6 +202,25 @@ When possible (e.g., when %NEW_PADDING is specified), use length-hiding padding This is the ``print a list of the supported algorithms and modes'' option. Print a list of the supported algorithms and modes. If a priority string is given then only the enabled ciphersuites are shown. +@anchor{gnutls-cli alpn} +@subheading alpn option + +This is the ``application layer protocol'' option. +This option takes an argument string. + +@noindent +This option has some usage constraints. It: +@itemize @bullet +@item +may appear an unlimited number of times. +@end itemize + +This option will set and enable the Application Layer Protocol Negotiation (ALPN) in the TLS protocol. +@anchor{gnutls-cli disable-extensions} +@subheading disable-extensions option + +This is the ``disable all the tls extensions'' option. +This option disables all TLS extensions. Deprecated option. Use the priority string. @anchor{gnutls-cli exit status} @subheading gnutls-cli exit status @@ -218,7 +234,6 @@ The operation failed or the command syntax was not valid. @anchor{gnutls-cli See Also} @subheading gnutls-cli See Also gnutls-cli-debug(1), gnutls-serv(1) - @anchor{gnutls-cli Examples} @subheading gnutls-cli Examples @subheading Connecting using PSK authentication @@ -259,4 +274,3 @@ Compression: COMP-NULL Elliptic curves: CURVE-SECP384R1, CURVE-SECP521R1 PK-signatures: SIGN-RSA-SHA384, SIGN-ECDSA-SHA384, SIGN-RSA-SHA512, SIGN-ECDSA-SHA512 @end example - diff --git a/doc/invoke-gnutls-serv.texi b/doc/invoke-gnutls-serv.texi index cb51df4aad..c299441fd2 100644 --- a/doc/invoke-gnutls-serv.texi +++ b/doc/invoke-gnutls-serv.texi @@ -3,10 +3,10 @@ @pindex gnutls-serv @ignore # -*- buffer-read-only: t -*- vi: set ro: -# +# # DO NOT EDIT THIS FILE (invoke-gnutls-serv.texi) -# -# It has been AutoGen-ed January 1, 2013 at 09:07:53 PM by AutoGen 5.16 +# +# It has been AutoGen-ed May 5, 2013 at 03:51:56 PM by AutoGen 5.17.3 # From the definitions ../src/serv-args.def # and the template file agtexi-cmd.tpl @end ignore @@ -20,11 +20,13 @@ This software is released under the GNU General Public License, version 3 or lat @anchor{gnutls-serv usage} -@subheading gnutls-serv help/usage (-h) +@subheading gnutls-serv help/usage (@option{--help}) @cindex gnutls-serv help This is the automatically generated usage text for gnutls-serv. -The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!). @code{more-help} will print + +The text printed is the same whether selected with the @code{help} option +(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print the usage text by passing it through a pager program. @code{more-help} is disabled on platforms without a working @code{fork(2)} function. The @code{PAGER} environment variable is @@ -33,11 +35,11 @@ with a status code of 0. @exampleindent 0 @example -gnutls-serv - GnuTLS server - Ver. @@VERSION@@ -USAGE: gnutls-serv [ - [] | --[@{=| @}] ]... +gnutls-serv - GnuTLS server +Usage: gnutls-serv [ - [] | --[@{=| @}] ]... -d, --debug=num Enable debugging. - - It must be in the range: + - it must be in the range: 0 to 9999 --noticket Don't accept session tickets -g, --generate Generate Diffie-Hellman and RSA-export parameters @@ -47,7 +49,7 @@ USAGE: gnutls-serv [ - [] | --[@{=| @}] ]... --echo Act as an Echo server -u, --udp Use DTLS (datagram TLS) over UDP --mtu=num Set MTU for datagram TLS - - It must be in the range: + - it must be in the range: 0 to 17000 --srtp-profiles=str Offer SRTP profiles -a, --disable-client-cert Do not request a client certificate @@ -84,18 +86,16 @@ USAGE: gnutls-serv [ - [] | --[@{=| @}] ]... - file must pre-exist -p, --port=num The port to connect to -l, --list Print a list of the supported algorithms and modes - -v, --version[=arg] Output version information and exit - -h, --help Display extended usage information and exit - -!, --more-help Extended usage information passed thru pager + -v, --version[=arg] output version information and exit + -h, --help display extended usage information and exit + -!, --more-help extended usage information passed thru pager Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. - - Server program that listens to incoming TLS connections. -please send bug reports to: bug-gnutls@@gnu.org +Please send bug reports to: @end example @exampleindent 4 @@ -145,7 +145,6 @@ The operation failed or the command syntax was not valid. @anchor{gnutls-serv See Also} @subheading gnutls-serv See Also gnutls-cli-debug(1), gnutls-cli(1) - @anchor{gnutls-serv Examples} @subheading gnutls-serv Examples Running your own TLS server based on GnuTLS can be useful when @@ -312,4 +311,3 @@ gnutls-serv --http \ --srppasswd srp-passwd.txt \ --pskpasswd psk-passwd.txt @end example - diff --git a/doc/invoke-ocsptool.texi b/doc/invoke-ocsptool.texi index c2f87d277c..b22545a921 100644 --- a/doc/invoke-ocsptool.texi +++ b/doc/invoke-ocsptool.texi @@ -3,10 +3,10 @@ @pindex ocsptool @ignore # -*- buffer-read-only: t -*- vi: set ro: -# +# # DO NOT EDIT THIS FILE (invoke-ocsptool.texi) -# -# It has been AutoGen-ed January 1, 2013 at 09:07:57 PM by AutoGen 5.16 +# +# It has been AutoGen-ed May 5, 2013 at 03:51:57 PM by AutoGen 5.17.3 # From the definitions ../src/ocsptool-args.def # and the template file agtexi-cmd.tpl @end ignore @@ -22,11 +22,13 @@ This software is released under the GNU General Public License, version 3 or lat @anchor{ocsptool usage} -@subsubheading ocsptool help/usage (-h) +@subsubheading ocsptool help/usage (@option{--help}) @cindex ocsptool help This is the automatically generated usage text for ocsptool. -The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!). @code{more-help} will print + +The text printed is the same whether selected with the @code{help} option +(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print the usage text by passing it through a pager program. @code{more-help} is disabled on platforms without a working @code{fork(2)} function. The @code{PAGER} environment variable is @@ -35,11 +37,11 @@ with a status code of 0. @exampleindent 0 @example -ocsptool - GnuTLS OCSP tool - Ver. @@VERSION@@ -USAGE: ocsptool [ - [] | --[@{=| @}] ]... +ocsptool - GnuTLS OCSP tool +Usage: ocsptool [ - [] | --[@{=| @}] ]... -d, --debug=num Enable debugging. - - It must be in the range: + - it must be in the range: 0 to 9999 -V, --verbose More verbose output - may appear multiple times @@ -55,38 +57,34 @@ USAGE: ocsptool [ - [] | --[@{=| @}] ]... -j, --response-info Print information on a OCSP response -q, --generate-request Generate an OCSP request --nonce Don't add nonce to OCSP request - - disabled as --no-nonce + - disabled as '--no-nonce' --load-issuer=file Read issuer certificate from file - file must pre-exist --load-cert=file Read certificate to check from file - file must pre-exist --load-trust=file Read OCSP trust anchors from file - - prohibits these options: - load-signer + - prohibits the option 'load-signer' - file must pre-exist --load-signer=file Read OCSP response signer from file - - prohibits these options: - load-trust + - prohibits the option 'load-trust' - file must pre-exist --inder Use DER format for input certificates and private keys - - disabled as --no-inder + - disabled as '--no-inder' -Q, --load-request=file Read DER encoded OCSP request from file - file must pre-exist -S, --load-response=file Read DER encoded OCSP response from file - file must pre-exist - -v, --version[=arg] Output version information and exit - -h, --help Display extended usage information and exit - -!, --more-help Extended usage information passed thru pager + -v, --version[=arg] output version information and exit + -h, --help display extended usage information and exit + -!, --more-help extended usage information passed thru pager Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. - - Ocsptool is a program that can parse and print information about OCSP requests/responses, generate requests and verify responses. -please send bug reports to: bug-gnutls@@gnu.org +Please send bug reports to: @end example @exampleindent 4 @@ -124,7 +122,6 @@ The operation failed or the command syntax was not valid. @anchor{ocsptool See Also} @subsubheading ocsptool See Also certtool (1) - @anchor{ocsptool Examples} @subsubheading ocsptool Examples @subsubheading Print information about an OCSP request @@ -255,5 +252,3 @@ $ ocsptool --ask ocsp.CAcert.org --load-issuer issuer.pem \ The request is sent via HTTP to the OCSP server address specified. If the address is ommited ocsptool will use the address stored in the certificate. - - diff --git a/doc/invoke-p11tool.texi b/doc/invoke-p11tool.texi index 278e1aa302..bf2271fb4e 100644 --- a/doc/invoke-p11tool.texi +++ b/doc/invoke-p11tool.texi @@ -3,10 +3,10 @@ @pindex p11tool @ignore # -*- buffer-read-only: t -*- vi: set ro: -# +# # DO NOT EDIT THIS FILE (invoke-p11tool.texi) -# -# It has been AutoGen-ed January 1, 2013 at 09:07:59 PM by AutoGen 5.16 +# +# It has been AutoGen-ed May 5, 2013 at 03:51:57 PM by AutoGen 5.17.3 # From the definitions ../src/p11tool-args.def # and the template file agtexi-cmd.tpl @end ignore @@ -25,11 +25,13 @@ This software is released under the GNU General Public License, version 3 or lat @anchor{p11tool usage} -@subsubheading p11tool help/usage (-h) +@subsubheading p11tool help/usage (@option{--help}) @cindex p11tool help This is the automatically generated usage text for p11tool. -The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!). @code{more-help} will print + +The text printed is the same whether selected with the @code{help} option +(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print the usage text by passing it through a pager program. @code{more-help} is disabled on platforms without a working @code{fork(2)} function. The @code{PAGER} environment variable is @@ -38,11 +40,11 @@ with a status code of 0. @exampleindent 0 @example -p11tool - GnuTLS PKCS #11 tool - Ver. @@VERSION@@ -USAGE: p11tool [ - [] | --[@{=| @}] ]... [url] +p11tool - GnuTLS PKCS #11 tool +Usage: p11tool [ - [] | --[@{=| @}] ]... [url] -d, --debug=num Enable debugging. - - It must be in the range: + - it must be in the range: 0 to 9999 --outfile=str Output file --list-tokens List all available tokens @@ -61,14 +63,14 @@ USAGE: p11tool [ - [] | --[@{=| @}] ]... [url] --generate-ecc Generate an RSA private-public key pair --label=str Sets a label for the write operation --trusted Marks the object to be written as trusted - - disabled as --no-trusted + - disabled as '--no-trusted' --private Marks the object to be written as private - - disabled as --no-private + - disabled as '--no-private' - enabled by default --login Force login to token - - disabled as --no-login + - disabled as '--no-login' --detailed-url Print detailed URLs - - disabled as --no-detailed-url + - disabled as '--no-detailed-url' --secret-key=str Provide a hex encoded secret key --load-privkey=file Private key file to use - file must pre-exist @@ -80,20 +82,18 @@ USAGE: p11tool [ - [] | --[@{=| @}] ]... [url] --bits=num Specify the number of bits for key generate --sec-param=str Specify the security level --inder Use DER/RAW format for input - - disabled as --no-inder - --inraw This is an alias for 'inder' + - disabled as '--no-inder' + --inraw an alias for the 'inder' option --provider=file Specify the PKCS #11 provider library - file must pre-exist - -v, --version[=arg] Output version information and exit - -h, --help Display extended usage information and exit - -!, --more-help Extended usage information passed thru pager + -v, --version[=arg] output version information and exit + -h, --help display extended usage information and exit + -!, --more-help extended usage information passed thru pager Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. Operands and options may be intermixed. They will be reordered. - - Program that allows handling data from PKCS #11 smart cards and security modules. @@ -101,7 +101,7 @@ To use PKCS #11 tokens with gnutls the configuration file /etc/gnutls/pkcs11.conf has to exist and contain a number of lines of the form 'load=/usr/lib/opensc-pkcs11.so'. -please send bug reports to: bug-gnutls@@gnu.org +Please send bug reports to: @end example @exampleindent 4 @@ -158,7 +158,7 @@ Use DER/RAW format for input certificates and private keys. @anchor{p11tool inraw} @subsubheading inraw option -This is an alias for the inder option, +This is an alias for the @code{inder} option, @pxref{p11tool inder, the inder option documentation}. @anchor{p11tool provider} @@ -180,7 +180,6 @@ The operation failed or the command syntax was not valid. @anchor{p11tool See Also} @subsubheading p11tool See Also certtool (1) - @anchor{p11tool Examples} @subsubheading p11tool Examples To view all tokens in your system use: @@ -216,5 +215,3 @@ request with certtool. certtool --generate-request --load-privkey "pkcs11:KEY-URL" \ --load-pubkey MyNewKey.pub --outfile request.pem @end example - - diff --git a/doc/invoke-psktool.texi b/doc/invoke-psktool.texi index 0f3c26819c..0ed966a1ac 100644 --- a/doc/invoke-psktool.texi +++ b/doc/invoke-psktool.texi @@ -3,10 +3,10 @@ @pindex psktool @ignore # -*- buffer-read-only: t -*- vi: set ro: -# +# # DO NOT EDIT THIS FILE (invoke-psktool.texi) -# -# It has been AutoGen-ed January 1, 2013 at 09:07:58 PM by AutoGen 5.16 +# +# It has been AutoGen-ed May 5, 2013 at 03:51:57 PM by AutoGen 5.17.3 # From the definitions ../src/psk-args.def # and the template file agtexi-cmd.tpl @end ignore @@ -21,11 +21,13 @@ This software is released under the GNU General Public License, version 3 or lat @anchor{psktool usage} -@subsubheading psktool help/usage (-h) +@subsubheading psktool help/usage (@option{--help}) @cindex psktool help This is the automatically generated usage text for psktool. -The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!). @code{more-help} will print + +The text printed is the same whether selected with the @code{help} option +(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print the usage text by passing it through a pager program. @code{more-help} is disabled on platforms without a working @code{fork(2)} function. The @code{PAGER} environment variable is @@ -34,30 +36,28 @@ with a status code of 0. @exampleindent 0 @example -psktool - GnuTLS PSK tool - Ver. @@VERSION@@ -USAGE: psktool [ - [] | --[@{=| @}] ]... +psktool - GnuTLS PSK tool +Usage: psktool [ - [] | --[@{=| @}] ]... -d, --debug=num Enable debugging. - - It must be in the range: + - it must be in the range: 0 to 9999 -s, --keysize=num specify the key size in bytes - - It must be in the range: + - it must be in the range: 0 to 512 -u, --username=str specify a username -p, --passwd=str specify a password file. - -v, --version[=arg] Output version information and exit - -h, --help Display extended usage information and exit - -!, --more-help Extended usage information passed thru pager + -v, --version[=arg] output version information and exit + -h, --help display extended usage information and exit + -!, --more-help extended usage information passed thru pager Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. - - Program that generates random keys for use with TLS-PSK. The keys are stored in hexadecimal format in a key file. -please send bug reports to: bug-gnutls@@gnu.org +Please send bug reports to: @end example @exampleindent 4 @@ -80,7 +80,6 @@ The operation failed or the command syntax was not valid. @anchor{psktool See Also} @subsubheading psktool See Also gnutls-cli-debug (1), gnutls-serv (1), srptool (1), certtool (1) - @anchor{psktool Examples} @subsubheading psktool Examples To add a user 'psk_identity' in @file{passwd.psk} for use with GnuTLS run: @@ -94,5 +93,4 @@ $ @end example This command will create @file{passwd.psk} if it does not exist -and will add user 'psk_identity' (you will also be prompted for a password). - +and will add user 'psk_identity' (you will also be prompted for a password). diff --git a/doc/invoke-srptool.texi b/doc/invoke-srptool.texi index dd4a8de914..4e2f5c60f5 100644 --- a/doc/invoke-srptool.texi +++ b/doc/invoke-srptool.texi @@ -3,10 +3,10 @@ @pindex srptool @ignore # -*- buffer-read-only: t -*- vi: set ro: -# +# # DO NOT EDIT THIS FILE (invoke-srptool.texi) -# -# It has been AutoGen-ed January 1, 2013 at 09:07:56 PM by AutoGen 5.16 +# +# It has been AutoGen-ed May 5, 2013 at 03:51:57 PM by AutoGen 5.17.3 # From the definitions ../src/srptool-args.def # and the template file agtexi-cmd.tpl @end ignore @@ -26,11 +26,13 @@ This software is released under the GNU General Public License, version 3 or lat @anchor{srptool usage} -@subsubheading srptool help/usage (-h) +@subsubheading srptool help/usage (@option{--help}) @cindex srptool help This is the automatically generated usage text for srptool. -The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!). @code{more-help} will print + +The text printed is the same whether selected with the @code{help} option +(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print the usage text by passing it through a pager program. @code{more-help} is disabled on platforms without a working @code{fork(2)} function. The @code{PAGER} environment variable is @@ -39,11 +41,11 @@ with a status code of 0. @exampleindent 0 @example -srptool - GnuTLS SRP tool - Ver. @@VERSION@@ -USAGE: srptool [ - [] | --[@{=| @}] ]... +srptool - GnuTLS SRP tool +Usage: srptool [ - [] | --[@{=| @}] ]... -d, --debug=num Enable debugging. - - It must be in the range: + - it must be in the range: 0 to 9999 -i, --index specify the index of the group parameters in tpasswd.conf to use. -u, --username=str specify a username @@ -52,15 +54,13 @@ USAGE: srptool [ - [] | --[@{=| @}] ]... --verify just verify the password. -v, --passwd-conf=str specify a password conf file. --create-conf=str Generate a password configuration file. - -v, --version[=arg] Output version information and exit - -h, --help Display extended usage information and exit - -!, --more-help Extended usage information passed thru pager + -v, --version[=arg] output version information and exit + -h, --help display extended usage information and exit + -!, --more-help extended usage information passed thru pager Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. - - Simple program that emulates the programs in the Stanford SRP (Secure Remote Password) libraries using GnuTLS. It is intended for use in places where you don't expect SRP authentication to be the used for system users. @@ -69,7 +69,7 @@ In brief, to use SRP you need to create two files. These are the password file that holds the users and the verifiers associated with them and the configuration file to hold the group parameters (called tpasswd.conf). -please send bug reports to: bug-gnutls@@gnu.org +Please send bug reports to: @end example @exampleindent 4 @@ -110,7 +110,6 @@ The operation failed or the command syntax was not valid. @anchor{srptool See Also} @subsubheading srptool See Also gnutls-cli-debug (1), gnutls-serv (1), srptool (1), psktool (1), certtool (1) - @anchor{srptool Examples} @subsubheading srptool Examples To create @file{tpasswd.conf} which holds the g and n values for SRP protocol @@ -132,4 +131,3 @@ the one in @file{/etc/tpasswd} you will get an ok. @example $ srptool --passwd /etc/tpasswd --passwd\-conf /etc/tpasswd.conf --verify -u test @end example - diff --git a/doc/invoke-tpmtool.texi b/doc/invoke-tpmtool.texi index d510346e55..d560807a64 100644 --- a/doc/invoke-tpmtool.texi +++ b/doc/invoke-tpmtool.texi @@ -3,10 +3,10 @@ @pindex tpmtool @ignore # -*- buffer-read-only: t -*- vi: set ro: -# +# # DO NOT EDIT THIS FILE (invoke-tpmtool.texi) -# -# It has been AutoGen-ed January 1, 2013 at 09:08:01 PM by AutoGen 5.16 +# +# It has been AutoGen-ed May 5, 2013 at 03:51:58 PM by AutoGen 5.17.3 # From the definitions ../src/tpmtool-args.def # and the template file agtexi-cmd.tpl @end ignore @@ -20,11 +20,13 @@ This software is released under the GNU General Public License, version 3 or lat @anchor{tpmtool usage} -@subsubheading tpmtool help/usage (-h) +@subsubheading tpmtool help/usage (@option{--help}) @cindex tpmtool help This is the automatically generated usage text for tpmtool. -The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!). @code{more-help} will print + +The text printed is the same whether selected with the @code{help} option +(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print the usage text by passing it through a pager program. @code{more-help} is disabled on platforms without a working @code{fork(2)} function. The @code{PAGER} environment variable is @@ -33,60 +35,7 @@ with a status code of 0. @exampleindent 0 @example -tpmtool - GnuTLS TPM tool - Ver. @@VERSION@@ -USAGE: tpmtool [ - [] | --[@{=| @}] ]... - - -d, --debug=num Enable debugging. - - It must be in the range: - 0 to 9999 - --infile=file Input file - - file must pre-exist - --outfile=str Output file - --generate-rsa Generate an RSA private-public key pair - --register Any generated key will be registered in the TPM - - requires these options: - generate-rsa - --signing Any generated key will be a signing key - - requires these options: - generate-rsa - -- and prohibits these options: - legacy - --legacy Any generated key will be a legacy key - - requires these options: - generate-rsa - -- and prohibits these options: - signing - --user Any registered key will be a user key - - requires these options: - register - -- and prohibits these options: - system - --system Any registred key will be a system key - - requires these options: - register - -- and prohibits these options: - user - --pubkey=str Prints the public key of the provided key - --list Lists all stored keys in the TPM - --delete=str Delete the key identified by the given URL (UUID). - --sec-param=str Specify the security level [low, legacy, normal, high, ultra]. - --bits=num Specify the number of bits for key generate - --inder Use the DER format for keys. - - disabled as --no-inder - --outder Use DER format for output keys - - disabled as --no-outder - -v, --version[=arg] Output version information and exit - -h, --help Display extended usage information and exit - -!, --more-help Extended usage information passed thru pager - -Options are specified by doubled hyphens and their name or by a single -hyphen and the flag character. - - - -Program that allows handling cryptographic data from the TPM chip. - -please send bug reports to: bug-gnutls@@gnu.org +tpmtool is unavailable - no --help @end example @exampleindent 4 @@ -169,7 +118,6 @@ The operation failed or the command syntax was not valid. @anchor{tpmtool See Also} @subsubheading tpmtool See Also p11tool (1), certtool (1) - @anchor{tpmtool Examples} @subsubheading tpmtool Examples To generate a key that is to be stored in filesystem use: @@ -197,4 +145,3 @@ To list all keys stored in TPM use: @example $ tpmtool --list @end example - diff --git a/doc/manpages/tpmtool.1 b/doc/manpages/tpmtool.1 index 7b1dff167c..c2a4441479 100644 --- a/doc/manpages/tpmtool.1 +++ b/doc/manpages/tpmtool.1 @@ -1,8 +1,8 @@ -.TH tpmtool 1 "01 Jan 2013" "@VERSION@" "User Commands" +.TH tpmtool 1 "05 May 2013" "@VERSION@" "User Commands" .\" .\" DO NOT EDIT THIS FILE (tpmtool-args.man) -.\" -.\" It has been AutoGen-ed January 1, 2013 at 09:07:45 PM by AutoGen 5.16 +.\" +.\" It has been AutoGen-ed May 5, 2013 at 03:45:59 PM by AutoGen 5.17.3 .\" From the definitions ../../src/tpmtool-args.def.tmp .\" and the template file agman-cmd.tpl .\" @@ -11,7 +11,7 @@ tpmtool \- GnuTLS TPM tool .SH SYNOPSIS .B tpmtool .\" Mixture of short (flag) options and long options -.RB [ \-\fIflag\fP " [\fIvalue\fP]]... [" \-\-\fIopt\-name\fP " [[=| ]\fIvalue\fP]]..." +.RB [ \-\fIflag\fP " [\fIvalue\fP]]... [" \-\-\fIopt\-name\fP "[[=| ]\fIvalue\fP]]..." .PP All arguments must be options. .PP @@ -183,6 +183,10 @@ Successful program execution. .TP .BR 1 " (EXIT_FAILURE)" The operation failed or the command syntax was not valid. +.TP +.BR 70 " (EX_SOFTWARE)" +libopts had an internal operational error. Please report +it to autogen-users@lists.sourceforge.net. Thank you. .SH "SEE ALSO" p11tool (1), certtool (1) .SH "AUTHORS"