aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNIIBE Yutaka <[email protected]>2023-11-02 06:05:19 +0000
committerNIIBE Yutaka <[email protected]>2023-11-02 06:05:19 +0000
commitc2812a9bbc3539e40bde0c9ea804aee39147a87c (patch)
tree903b6f9655244be7c453529f0896ce44a9bada1a
parentg10: Fix uninitalized variable use in sign_file (diff)
downloadgnupg-c2812a9bbc3539e40bde0c9ea804aee39147a87c.tar.gz
gnupg-c2812a9bbc3539e40bde0c9ea804aee39147a87c.zip
doc: Fix to avoid using en-dash for command options.
-- GnuPG-bug-id: 6746 Signed-off-by: NIIBE Yutaka <[email protected]>
-rw-r--r--doc/dirmngr.texi2
-rw-r--r--doc/gpg-agent.texi2
-rw-r--r--doc/gpg.texi30
-rw-r--r--doc/gpgsm.texi4
-rw-r--r--doc/gpgv.texi2
-rw-r--r--doc/tools.texi11
6 files changed, 26 insertions, 25 deletions
diff --git a/doc/dirmngr.texi b/doc/dirmngr.texi
index 0d0cb018d..9fc58ea24 100644
--- a/doc/dirmngr.texi
+++ b/doc/dirmngr.texi
@@ -295,7 +295,7 @@ seconds.
@opindex connect-quick-timeout
Set the timeout for HTTP and generic TCP connection attempts to N
seconds. The value set with the quick variant is used when the
---quick option has been given to certain Assuan commands. The quick
+@option{--quick} option has been given to certain Assuan commands. The quick
value is capped at the value of the regular connect timeout. The
default values are 15 and 2 seconds. Note that the timeout values are
for each connection attempt; the connection code will attempt to
diff --git a/doc/gpg-agent.texi b/doc/gpg-agent.texi
index 6d6cf97ec..08dd7f49f 100644
--- a/doc/gpg-agent.texi
+++ b/doc/gpg-agent.texi
@@ -177,7 +177,7 @@ Windows.
If in @file{common.conf} the option @option{no-autostart} is set, any
start attempts will be ignored.
-In --supervised mode, different file descriptors can be provided for
+In @option{--supervised} mode, different file descriptors can be provided for
use as different socket types (e.g., ssh, extra) as long as they are
identified in the environment variable @code{LISTEN_FDNAMES} (see
sd_listen_fds(3) on some Linux distributions for more information on
diff --git a/doc/gpg.texi b/doc/gpg.texi
index b5a9ccc51..760582c8e 100644
--- a/doc/gpg.texi
+++ b/doc/gpg.texi
@@ -362,9 +362,9 @@ public keys are listed.
The variant @option{--locate-external-keys} does not consider a
locally existing key and can thus be used to force the refresh of a
key via the defined external methods. If a fingerprint is given and
-and the methods defined by --auto-key-locate define LDAP servers, the
-key is fetched from these resources; defined non-LDAP keyservers are
-skipped.
+and the methods defined by @option{--auto-key-locate} define LDAP
+servers, the key is fetched from these resources; defined non-LDAP
+keyservers are skipped.
@item --show-keys
@@ -1455,10 +1455,10 @@ give the opposite meaning. The options are:
@item sort-sigs
@opindex list-options:sort-sigs
- With --list-sigs and --check-sigs sort the signatures by keyID and
- creation time to make it easier to view the history of these
- signatures. The self-signature is also listed before other
- signatures. Defaults to yes.
+ With @option{--list-sigs} and @option{--check-sigs} sort the
+ signatures by keyID and creation time to make it easier to view the
+ history of these signatures. The self-signature is also listed
+ before other signatures. Defaults to yes.
@end table
@@ -1515,12 +1515,12 @@ the opposite meaning. The options are:
@itemx --disable-large-rsa
@opindex enable-large-rsa
@opindex disable-large-rsa
-With --generate-key and --batch, enable the creation of RSA secret keys as
-large as 8192 bit. Note: 8192 bit is more than is generally
-recommended. These large keys don't significantly improve security,
-but they are more expensive to use, and their signatures and
-certifications are larger. This option is only available if the
-binary was build with large-secmem support.
+With @option{--generate-key} and @option{--batch}, enable the creation
+of RSA secret keys as large as 8192 bit. Note: 8192 bit is more than
+is generally recommended. These large keys don't significantly
+improve security, but they are more expensive to use, and their
+signatures and certifications are larger. This option is only
+available if the binary was build with large-secmem support.
@item --enable-dsa2
@itemx --disable-dsa2
@@ -2624,12 +2624,12 @@ The available filter types are:
@item drop-subkey
This filter drops the selected subkeys.
- Currently only implemented for --export-filter.
+ Currently only implemented for @option{--export-filter}.
@item drop-sig
This filter drops the selected key signatures on user ids.
Self-signatures are not considered.
- Currently only implemented for --import-filter.
+ Currently only implemented for @option{--import-filter}.
@item select
This filter is only implemented by @option{--list-filter}. All
diff --git a/doc/gpgsm.texi b/doc/gpgsm.texi
index 41eb08d16..22738c492 100644
--- a/doc/gpgsm.texi
+++ b/doc/gpgsm.texi
@@ -642,8 +642,8 @@ By default gpgsm prints distinguished names (DNs) like the Issuer or
Subject in a more readable format (e.g., using a well defined order of
the parts). However, this format can't be used as input strings.
This option reverts printing to standard RFC-2253 format and thus
-avoids the need to use --dump-cert or --with-colons to get the
-``real'' name.
+avoids the need to use @option{--dump-cert} or @option{--with-colons}
+to get the ``real'' name.
@end table
diff --git a/doc/gpgv.texi b/doc/gpgv.texi
index 2dd9576b6..c8ba9fa5e 100644
--- a/doc/gpgv.texi
+++ b/doc/gpgv.texi
@@ -91,7 +91,7 @@ Add @var{file} to the list of keyrings.
If @var{file} begins with a tilde and a slash, these
are replaced by the HOME directory. If the filename
does not contain a slash, it is assumed to be in the
-home-directory ("~/.gnupg" if --homedir is not used).
+home-directory ("~/.gnupg" if @option{--homedir} is not used).
@item --output @var{file}
@itemx -o @var{file}
diff --git a/doc/tools.texi b/doc/tools.texi
index 9cac81e4c..a7c141cfc 100644
--- a/doc/tools.texi
+++ b/doc/tools.texi
@@ -133,8 +133,8 @@ for the configuration files is:
log-file socket://
@end example
-If the default socket as given above and returned by "echo $(gpgconf
---list-dirs socketdir)/S.log" is not desired an arbitrary socket name
+If the default socket as given above and returned by @code{"echo $(gpgconf
+--list-dirs socketdir)/S.log"} is not desired an arbitrary socket name
can be specified, for example @file{socket:///home/foo/bar/mysocket}.
For debugging purposes it is also possible to do remote logging. Take
care if you use this feature because the information is send in the
@@ -2066,9 +2066,10 @@ Pass the specified extra options to @command{gpg}.
@item --tar-args @var{args}
@opindex tar-args
Assume @var{args} are standard options of the command @command{tar}
-and parse them. The only supported tar options are "--directory",
-"--files-from", and "--null" This is an obsolete options because those
-supported tar options can also be given directly.
+and parse them. The only supported tar options are
+@option{--directory}, @option{--files-from}, and @option{--null}.
+This is an obsolete options because those supported tar options can
+also be given directly.
@item --tar @var{command}
@opindex tar