]> git.ipfire.org Git - thirdparty/gnutls.git/commitdiff
doc update
authorNikos Mavrogiannopoulos <nmav@redhat.com>
Mon, 16 Dec 2013 12:42:47 +0000 (13:42 +0100)
committerNikos Mavrogiannopoulos <nmav@redhat.com>
Mon, 16 Dec 2013 12:42:47 +0000 (13:42 +0100)
doc/invoke-certtool.texi
doc/invoke-danetool.texi
doc/invoke-gnutls-cli-debug.texi
doc/invoke-gnutls-cli.texi
doc/invoke-gnutls-serv.texi
doc/invoke-ocsptool.texi
doc/invoke-p11tool.texi
doc/invoke-psktool.texi
doc/invoke-srptool.texi
doc/invoke-tpmtool.texi

index 936a873f9ebf1eeaa10c224aeb7dfddf3a0fb751..f6749458a6cd94461978077287fd607e8ed3de23 100644 (file)
@@ -6,7 +6,7 @@
 #
 # DO NOT EDIT THIS FILE   (invoke-certtool.texi)
 #
-# It has been AutoGen-ed  November 23, 2013 at 10:34:46 AM by AutoGen 5.18.2
+# It has been AutoGen-ed  December 16, 2013 at 01:40:32 PM by AutoGen 5.18
 # From the definitions    ../src/certtool-args.def
 # and the template file   agtexi-cmd.tpl
 @end ignore
@@ -129,7 +129,7 @@ Please send bug reports to:  <bugs@@gnutls.org>
 @subsubheading debug option (-d)
 
 This is the ``enable debugging.'' option.
-This option takes a number argument.
+This option takes an argument number.
 Specifies the debug level.
 @anchor{certtool generate-request}
 @subsubheading generate-request option (-q)
@@ -188,31 +188,31 @@ are more efficient since GnuTLS 3.0.9.
 @subsubheading load-privkey option
 
 This is the ``loads a private key file'' option.
-This option takes a string argument.
+This option takes an argument string.
 This can be either a file or a PKCS #11 URL
 @anchor{certtool load-pubkey}
 @subsubheading load-pubkey option
 
 This is the ``loads a public key file'' option.
-This option takes a string argument.
+This option takes an argument string.
 This can be either a file or a PKCS #11 URL
 @anchor{certtool load-certificate}
 @subsubheading load-certificate option
 
 This is the ``loads a certificate file'' option.
-This option takes a string argument.
+This option takes an argument string.
 This can be either a file or a PKCS #11 URL
 @anchor{certtool load-ca-privkey}
 @subsubheading load-ca-privkey option
 
 This is the ``loads the certificate authority's private key file'' option.
-This option takes a string argument.
+This option takes an argument string.
 This can be either a file or a PKCS #11 URL
 @anchor{certtool load-ca-certificate}
 @subsubheading load-ca-certificate option
 
 This is the ``loads the certificate authority's certificate file'' option.
-This option takes a string argument.
+This option takes an argument string.
 This can be either a file or a PKCS #11 URL
 @anchor{certtool cprint}
 @subsubheading cprint option
@@ -268,20 +268,12 @@ This is an alias for the @code{ecc} option,
 @subsubheading hash option
 
 This is the ``hash algorithm to use for signing.'' option.
-This option takes a string argument.
+This option takes an argument string.
 Available hash functions are SHA1, RMD160, SHA256, SHA384, SHA512.
 @anchor{certtool inder}
 @subsubheading inder option
 
 This is the ``use der format for input certificates and private keys.'' option.
-
-@noindent
-This option has some usage constraints.  It:
-@itemize @bullet
-@item
-can be disabled with --no-inder.
-@end itemize
-
 The input files will be assumed to be in DER or RAW format. 
 Unlike options that in PEM input would allow multiple input data (e.g. multiple 
 certificates), when reading in DER format a single data structure is read.
@@ -295,14 +287,6 @@ This is an alias for the @code{inder} option,
 @subsubheading outder option
 
 This is the ``use der format for output certificates and private keys'' option.
-
-@noindent
-This option has some usage constraints.  It:
-@itemize @bullet
-@item
-can be disabled with --no-outder.
-@end itemize
-
 The output will be in DER or RAW format.
 @anchor{certtool outraw}
 @subsubheading outraw option
@@ -314,13 +298,13 @@ This is an alias for the @code{outder} option,
 @subsubheading sec-param option
 
 This is the ``specify the security level [low, legacy, normal, high, ultra].'' option.
-This option takes a string argument @file{Security parameter}.
+This option takes an argument string @file{Security parameter}.
 This is alternative to the bits option.
 @anchor{certtool pkcs-cipher}
 @subsubheading pkcs-cipher option
 
 This is the ``cipher to use for pkcs #8 and #12 operations'' option.
-This option takes a string argument @file{Cipher}.
+This option takes an argument string @file{Cipher}.
 Cipher may be one of 3des, 3des-pkcs12, aes-128, aes-192, aes-256, rc2-40, arcfour.
 @anchor{certtool exit status}
 @subsubheading certtool exit status
index ca4c6c81be0e8dc0ba734bbac7ab929a7f714aff..477e32938f7d02ef8c86fe4004565efc1fd2fbc2 100644 (file)
@@ -6,7 +6,7 @@
 #
 # DO NOT EDIT THIS FILE   (invoke-danetool.texi)
 #
-# It has been AutoGen-ed  November 23, 2013 at 10:34:53 AM by AutoGen 5.18.2
+# It has been AutoGen-ed  December 16, 2013 at 01:40:34 PM by AutoGen 5.18
 # From the definitions    ../src/danetool-args.def
 # and the template file   agtexi-cmd.tpl
 @end ignore
@@ -89,37 +89,37 @@ Please send bug reports to:  <bugs@@gnutls.org>
 @subsubheading debug option (-d)
 
 This is the ``enable debugging.'' option.
-This option takes a number argument.
+This option takes an argument number.
 Specifies the debug level.
 @anchor{danetool load-pubkey}
 @subsubheading load-pubkey option
 
 This is the ``loads a public key file'' option.
-This option takes a string argument.
+This option takes an argument string.
 This can be either a file or a PKCS #11 URL
 @anchor{danetool load-certificate}
 @subsubheading load-certificate option
 
 This is the ``loads a certificate file'' option.
-This option takes a string argument.
+This option takes an argument string.
 This can be either a file or a PKCS #11 URL
 @anchor{danetool dlv}
 @subsubheading dlv option
 
 This is the ``sets a dlv file'' option.
-This option takes a string argument.
+This option takes an argument string.
 This sets a DLV file to be used for DNSSEC verification.
 @anchor{danetool hash}
 @subsubheading hash option
 
 This is the ``hash algorithm to use for signing.'' option.
-This option takes a string argument.
+This option takes an argument string.
 Available hash functions are SHA1, RMD160, SHA256, SHA384, SHA512.
 @anchor{danetool check}
 @subsubheading check option
 
 This is the ``check a host's dane tlsa entry.'' option.
-This option takes a string argument.
+This option takes an argument string.
 Obtains the DANE TLSA entry from the given hostname and prints information. Note that the actual certificate of the host has to be provided using --load-certificate.
 @anchor{danetool check-ee}
 @subsubheading check-ee option
@@ -140,28 +140,12 @@ Ignores any DNSSEC signature verification results.
 @subsubheading local-dns option
 
 This is the ``use the local dns server for dnssec resolving.'' option.
-
-@noindent
-This option has some usage constraints.  It:
-@itemize @bullet
-@item
-can be disabled with --no-local-dns.
-@end itemize
-
 This option will use the local DNS server for DNSSEC.
 This is disabled by default due to many servers not allowing DNSSEC.
 @anchor{danetool inder}
 @subsubheading inder option
 
 This is the ``use der format for input certificates and private keys.'' option.
-
-@noindent
-This option has some usage constraints.  It:
-@itemize @bullet
-@item
-can be disabled with --no-inder.
-@end itemize
-
 The input files will be assumed to be in DER or RAW format. 
 Unlike options that in PEM input would allow multiple input data (e.g. multiple 
 certificates), when reading in DER format a single data structure is read.
@@ -189,13 +173,13 @@ This command prints the DANE RR data needed to enable DANE on a DNS server.
 @subsubheading host option
 
 This is the ``specify the hostname to be used in the dane rr'' option.
-This option takes a string argument @file{Hostname}.
+This option takes an argument string @file{Hostname}.
 This command sets the hostname for the DANE RR.
 @anchor{danetool proto}
 @subsubheading proto option
 
 This is the ``the protocol set for dane data (tcp, udp etc.)'' option.
-This option takes a string argument @file{Protocol}.
+This option takes an argument string @file{Protocol}.
 This command specifies the protocol for the service set in the DANE data.
 @anchor{danetool ca}
 @subsubheading ca option
@@ -222,9 +206,7 @@ This is the ``the provided certificate or public key is issued by the local doma
 This option has some usage constraints.  It:
 @itemize @bullet
 @item
-can be disabled with --no-domain.
-@item
-It is enabled by default.
+is enabled by default.
 @end itemize
 
 DANE distinguishes certificates and public keys offered via the DNSSEC to trusted and local entities. This flag indicates that this is a domain-issued certificate, meaning that there could be no CA involved.
index 90548663bac264c675baf67b4de5a0049be5cf06..a4007d3aca37f23067626ca203c6c4ad5c96d099 100644 (file)
@@ -6,7 +6,7 @@
 #
 # DO NOT EDIT THIS FILE   (invoke-gnutls-cli-debug.texi)
 #
-# It has been AutoGen-ed  November 23, 2013 at 10:34:44 AM by AutoGen 5.18.2
+# It has been AutoGen-ed  December 16, 2013 at 01:40:29 PM by AutoGen 5.18
 # From the definitions    ../src/cli-debug-args.def
 # and the template file   agtexi-cmd.tpl
 @end ignore
@@ -74,7 +74,7 @@ Please send bug reports to:  <bugs@@gnutls.org>
 @subheading debug option (-d)
 
 This is the ``enable debugging.'' option.
-This option takes a number argument.
+This option takes an argument number.
 Specifies the debug level.
 @anchor{gnutls-cli-debug exit status}
 @subheading gnutls-cli-debug exit status
index 82047ad230ba9ecfef108c648b3093fe5fa1a3c3..1ce69543fbe78ead2e67fb6c8a2ebd77d29fdedf 100644 (file)
@@ -6,7 +6,7 @@
 #
 # DO NOT EDIT THIS FILE   (invoke-gnutls-cli.texi)
 #
-# It has been AutoGen-ed  November 23, 2013 at 10:34:43 AM by AutoGen 5.18.2
+# It has been AutoGen-ed  December 16, 2013 at 01:40:28 PM by AutoGen 5.18
 # From the definitions    ../src/cli-args.def
 # and the template file   agtexi-cmd.tpl
 @end ignore
@@ -120,33 +120,17 @@ Please send bug reports to:  <bugs@@gnutls.org>
 @subheading debug option (-d)
 
 This is the ``enable debugging.'' option.
-This option takes a number argument.
+This option takes an argument number.
 Specifies the debug level.
 @anchor{gnutls-cli tofu}
 @subheading tofu option
 
 This is the ``enable trust on first use authentication'' option.
-
-@noindent
-This option has some usage constraints.  It:
-@itemize @bullet
-@item
-can be disabled with --no-tofu.
-@end itemize
-
 This option will, in addition to certificate authentication, perform authentication based on previously seen public keys, a model similar to SSH authentication.
 @anchor{gnutls-cli dane}
 @subheading dane option
 
 This is the ``enable dane certificate verification (dnssec)'' option.
-
-@noindent
-This option has some usage constraints.  It:
-@itemize @bullet
-@item
-can be disabled with --no-dane.
-@end itemize
-
 This option will, in addition to certificate authentication using 
 the trusted CAs, verify the server certificates using on the DANE information
 available via DNSSEC.
@@ -154,14 +138,6 @@ available via DNSSEC.
 @subheading local-dns option
 
 This is the ``use the local dns server for dnssec resolving.'' option.
-
-@noindent
-This option has some usage constraints.  It:
-@itemize @bullet
-@item
-can be disabled with --no-local-dns.
-@end itemize
-
 This option will use the local DNS server for DNSSEC.
 This is disabled by default due to many servers not allowing DNSSEC.
 @anchor{gnutls-cli ca-verification}
@@ -173,9 +149,7 @@ This is the ``disable ca certificate verification'' option.
 This option has some usage constraints.  It:
 @itemize @bullet
 @item
-can be disabled with --no-ca-verification.
-@item
-It is enabled by default.
+is enabled by default.
 @end itemize
 
 This option will disable CA certificate verification. It is to be used with the --dane or --tofu options.
@@ -183,14 +157,6 @@ This option will disable CA certificate verification. It is to be used with the
 @subheading ocsp option
 
 This is the ``enable ocsp certificate verification'' option.
-
-@noindent
-This option has some usage constraints.  It:
-@itemize @bullet
-@item
-can be disabled with --no-ocsp.
-@end itemize
-
 This option will enable verification of the peer's certificate using ocsp
 @anchor{gnutls-cli resume}
 @subheading resume option (-r)
@@ -216,13 +182,13 @@ This option disables all TLS extensions. Deprecated option. Use the priority str
 @subheading dh-bits option
 
 This is the ``the minimum number of bits allowed for dh'' option.
-This option takes a number argument.
+This option takes an argument number.
 This option sets the minimum number of bits allowed for a Diffie-Hellman key exchange. You may want to lower the default value if the peer sends a weak prime and you get an connection error with unacceptable prime.
 @anchor{gnutls-cli priority}
 @subheading priority option
 
 This is the ``priorities string'' option.
-This option takes a string argument.
+This option takes an argument string.
 TLS algorithms and protocols to enable. You can
 use predefined sets of ciphersuites such as PERFORMANCE,
 NORMAL, SECURE128, SECURE256.
index 96f21c0d70a5ec27fbcfdd3dae48f7fbefa46fd0..0191f400191ddb9d7bd95df7de19166e51bf2144 100644 (file)
@@ -6,7 +6,7 @@
 #
 # DO NOT EDIT THIS FILE   (invoke-gnutls-serv.texi)
 #
-# It has been AutoGen-ed  November 23, 2013 at 10:34:45 AM by AutoGen 5.18.2
+# It has been AutoGen-ed  December 16, 2013 at 01:40:30 PM by AutoGen 5.18
 # From the definitions    ../src/serv-args.def
 # and the template file   agtexi-cmd.tpl
 @end ignore
@@ -103,7 +103,7 @@ Please send bug reports to:  <bugs@@gnutls.org>
 @subheading debug option (-d)
 
 This is the ``enable debugging.'' option.
-This option takes a number argument.
+This option takes an argument number.
 Specifies the debug level.
 @anchor{gnutls-serv heartbeat}
 @subheading heartbeat option (-b)
@@ -114,7 +114,7 @@ Regularly ping client via heartbeat extension messages
 @subheading priority option
 
 This is the ``priorities string'' option.
-This option takes a string argument.
+This option takes an argument string.
 TLS algorithms and protocols to enable. You can
 use predefined sets of ciphersuites such as PERFORMANCE,
 NORMAL, SECURE128, SECURE256.
@@ -125,7 +125,7 @@ information on allowed keywords
 @subheading ocsp-response option
 
 This is the ``the ocsp response to send to client'' option.
-This option takes a file argument.
+This option takes an argument file.
 If the client requested an OCSP response, return data from this file to the client.
 @anchor{gnutls-serv list}
 @subheading list option (-l)
index 9c408ca1a38f410fc4b588d3d5306c748edee4e8..f169225c051743a1586bfbe723aa71f1086138a8 100644 (file)
@@ -6,7 +6,7 @@
 #
 # DO NOT EDIT THIS FILE   (invoke-ocsptool.texi)
 #
-# It has been AutoGen-ed  November 23, 2013 at 10:34:48 AM by AutoGen 5.18.2
+# It has been AutoGen-ed  December 16, 2013 at 01:40:33 PM by AutoGen 5.18
 # From the definitions    ../src/ocsptool-args.def
 # and the template file   agtexi-cmd.tpl
 @end ignore
@@ -92,13 +92,13 @@ Please send bug reports to:  <bugs@@gnutls.org>
 @subsubheading debug option (-d)
 
 This is the ``enable debugging.'' option.
-This option takes a number argument.
+This option takes an argument number.
 Specifies the debug level.
 @anchor{ocsptool ask}
 @subsubheading ask option
 
 This is the ``ask an ocsp/http server on a certificate validity'' option.
-This option takes an optional string argument @file{server name|url}.
+This option takes an optional argument string @file{server name|url}.
 
 @noindent
 This option has some usage constraints.  It:
index 549df710cf72741c76480f82a2fc2d6b3d0a2da7..128df72896e85ab3907ddd5ce9ed61cdc7ee9b49 100644 (file)
@@ -6,7 +6,7 @@
 #
 # DO NOT EDIT THIS FILE   (invoke-p11tool.texi)
 #
-# It has been AutoGen-ed  November 23, 2013 at 10:34:50 AM by AutoGen 5.18.2
+# It has been AutoGen-ed  December 16, 2013 at 01:40:37 PM by AutoGen 5.18
 # From the definitions    ../src/p11tool-args.def
 # and the template file   agtexi-cmd.tpl
 @end ignore
@@ -117,7 +117,7 @@ Please send bug reports to:  <bugs@@gnutls.org>
 @subsubheading debug option (-d)
 
 This is the ``enable debugging.'' option.
-This option takes a number argument.
+This option takes an argument number.
 Specifies the debug level.
 @anchor{p11tool write}
 @subsubheading write option
@@ -148,9 +148,7 @@ This is the ``marks the object to be written as private'' option.
 This option has some usage constraints.  It:
 @itemize @bullet
 @item
-can be disabled with --no-private.
-@item
-It is enabled by default.
+is enabled by default.
 @end itemize
 
 The written object will require a PIN to be used.
@@ -158,20 +156,12 @@ The written object will require a PIN to be used.
 @subsubheading sec-param option
 
 This is the ``specify the security level'' option.
-This option takes a string argument @file{Security parameter}.
+This option takes an argument string @file{Security parameter}.
 This is alternative to the bits option. Available options are [low, legacy, normal, high, ultra].
 @anchor{p11tool inder}
 @subsubheading inder option
 
 This is the ``use der/raw format for input'' option.
-
-@noindent
-This option has some usage constraints.  It:
-@itemize @bullet
-@item
-can be disabled with --no-inder.
-@end itemize
-
 Use DER/RAW format for input certificates and private keys.
 @anchor{p11tool inraw}
 @subsubheading inraw option
@@ -183,7 +173,7 @@ This is an alias for the @code{inder} option,
 @subsubheading provider option
 
 This is the ``specify the pkcs #11 provider library'' option.
-This option takes a file argument.
+This option takes an argument file.
 This will override the default options in /etc/gnutls/pkcs11.conf
 @anchor{p11tool exit status}
 @subsubheading p11tool exit status
index 51c1c7f5f21a28e4592e45005ccffc90260256e0..685015ae4726811611f6688c3e478cd6dd441bb9 100644 (file)
@@ -6,7 +6,7 @@
 #
 # DO NOT EDIT THIS FILE   (invoke-psktool.texi)
 #
-# It has been AutoGen-ed  November 23, 2013 at 10:34:49 AM by AutoGen 5.18.2
+# It has been AutoGen-ed  December 16, 2013 at 01:40:36 PM by AutoGen 5.18
 # From the definitions    ../src/psk-args.def
 # and the template file   agtexi-cmd.tpl
 @end ignore
@@ -65,7 +65,7 @@ Please send bug reports to:  <bugs@@gnutls.org>
 @subsubheading debug option (-d)
 
 This is the ``enable debugging.'' option.
-This option takes a number argument.
+This option takes an argument number.
 Specifies the debug level.
 @anchor{psktool exit status}
 @subsubheading psktool exit status
index b38bac50a3547498839af882600ce4a27faeaec4..9d272580704b0a9f1aeac43a636e3a8d0d4d7428 100644 (file)
@@ -6,7 +6,7 @@
 #
 # DO NOT EDIT THIS FILE   (invoke-srptool.texi)
 #
-# It has been AutoGen-ed  November 23, 2013 at 10:34:47 AM by AutoGen 5.18.2
+# It has been AutoGen-ed  December 16, 2013 at 01:40:35 PM by AutoGen 5.18
 # From the definitions    ../src/srptool-args.def
 # and the template file   agtexi-cmd.tpl
 @end ignore
@@ -77,7 +77,7 @@ Please send bug reports to:  <bugs@@gnutls.org>
 @subsubheading debug option (-d)
 
 This is the ``enable debugging.'' option.
-This option takes a number argument.
+This option takes an argument number.
 Specifies the debug level.
 @anchor{srptool verify}
 @subsubheading verify option
@@ -88,13 +88,13 @@ Verifies the password provided against the password file.
 @subsubheading passwd-conf option (-v)
 
 This is the ``specify a password conf file.'' option.
-This option takes a string argument.
+This option takes an argument string.
 Specify a filename or a PKCS #11 URL to read the CAs from.
 @anchor{srptool create-conf}
 @subsubheading create-conf option
 
 This is the ``generate a password configuration file.'' option.
-This option takes a string argument.
+This option takes an argument string.
 This generates a password configuration file (tpasswd.conf)
 containing the required for TLS parameters.
 @anchor{srptool exit status}
index 073ebc8c122c8580ac73d0abcc869701f4b0c0f8..37dacae3dd2190e895f5c73cb0b581ff679895ec 100644 (file)
@@ -6,7 +6,7 @@
 #
 # DO NOT EDIT THIS FILE   (invoke-tpmtool.texi)
 #
-# It has been AutoGen-ed  November 23, 2013 at 10:34:52 AM by AutoGen 5.18.2
+# It has been AutoGen-ed  December 16, 2013 at 01:40:38 PM by AutoGen 5.18
 # From the definitions    ../src/tpmtool-args.def
 # and the template file   agtexi-cmd.tpl
 @end ignore
@@ -85,7 +85,7 @@ Please send bug reports to:  <bugs@@gnutls.org>
 @subsubheading debug option (-d)
 
 This is the ``enable debugging.'' option.
-This option takes a number argument.
+This option takes an argument number.
 Specifies the debug level.
 @anchor{tpmtool generate-rsa}
 @subsubheading generate-rsa option
@@ -132,21 +132,13 @@ The generated key will be stored in system persistent storage.
 @subsubheading sec-param option
 
 This is the ``specify the security level [low, legacy, normal, high, ultra].'' option.
-This option takes a string argument @file{Security parameter}.
+This option takes an argument string @file{Security parameter}.
 This is alternative to the bits option. Note however that the
 values allowed by the TPM chip are quantized and given values may be rounded up.
 @anchor{tpmtool inder}
 @subsubheading inder option
 
 This is the ``use the der format for keys.'' option.
-
-@noindent
-This option has some usage constraints.  It:
-@itemize @bullet
-@item
-can be disabled with --no-inder.
-@end itemize
-
 The input files will be assumed to be in the portable
 DER format of TPM. The default format is a custom format used by various
 TPM tools
@@ -154,14 +146,6 @@ TPM tools
 @subsubheading outder option
 
 This is the ``use der format for output keys'' option.
-
-@noindent
-This option has some usage constraints.  It:
-@itemize @bullet
-@item
-can be disabled with --no-outder.
-@end itemize
-
 The output will be in the TPM portable DER format.
 @anchor{tpmtool exit status}
 @subsubheading tpmtool exit status