[Pkg-gnupg-commit] [gnupg2] 33/292: doc: Improve markup.
Daniel Kahn Gillmor
dkg at fifthhorseman.net
Mon Nov 21 06:31:23 UTC 2016
This is an automated email from the git hooks/post-receive script.
dkg pushed a commit to branch master
in repository gnupg2.
commit 377624207e9b2895ce00dfc4d1163d72f349841f
Author: Ineiev <ineiev at gnu.org>
Date: Fri Mar 4 16:38:09 2016 +0000
doc: Improve markup.
* doc/gpg-agent.texi, doc/gpg.texi, doc/gpgsm.texi,
doc/howto-create-a-server-cert.texi, doc/scdaemon.texi,
doc/specify-user-id.texi, doc/tools.texi: Fix.
---
doc/gpg-agent.texi | 2 +-
doc/gpg.texi | 10 +++++-----
doc/gpgsm.texi | 28 ++++++++++++++--------------
doc/howto-create-a-server-cert.texi | 2 +-
doc/scdaemon.texi | 2 +-
doc/specify-user-id.texi | 6 +++---
doc/tools.texi | 35 ++++++++++++++++++-----------------
7 files changed, 43 insertions(+), 42 deletions(-)
diff --git a/doc/gpg-agent.texi b/doc/gpg-agent.texi
index 8176b37..c24d935 100644
--- a/doc/gpg-agent.texi
+++ b/doc/gpg-agent.texi
@@ -1341,7 +1341,7 @@ least one of the keygrips corresponds to an available secret key.
LEARN [--send]
@end example
-This command is used to register a smartcard. With the --send
+This command is used to register a smartcard. With the @option{--send}
option given the certificates are sent back.
diff --git a/doc/gpg.texi b/doc/gpg.texi
index 59ea4fc..c141ec6 100644
--- a/doc/gpg.texi
+++ b/doc/gpg.texi
@@ -723,12 +723,12 @@ line.
@item sign
@opindex keyedit:sign
- Make a signature on key of user @code{name} If the key is not yet
- signed by the default user (or the users given with -u), the program
+ Make a signature on key of user @code{name}. If the key is not yet
+ signed by the default user (or the users given with @option{-u}), the program
displays the information of the key again, together with its
fingerprint and asks whether it should be signed. This question is
repeated for all users specified with
- -u.
+ @option{-u}.
@item lsign
@opindex keyedit:lsign
@@ -2598,7 +2598,7 @@ Set up all options to be as PGP 6 compliant as possible. This
restricts you to the ciphers IDEA (if the IDEA plugin is installed),
3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the
compression algorithms none and ZIP. This also disables
---throw-keyids, and making signatures with signing subkeys as PGP 6
+ at option{--throw-keyids}, and making signatures with signing subkeys as PGP 6
does not understand signatures made by signing subkeys.
This option implies @option{--disable-mdc --escape-from-lines}.
@@ -2815,7 +2815,7 @@ The same %-expandos used for notation data are available here as well.
@opindex set-filename
Use @code{string} as the filename which is stored inside messages.
This overrides the default, which is to use the actual filename of the
-file being encrypted. Using the empty string for @var{string}
+file being encrypted. Using the empty string for @code{string}
effectively removes the filename from the output.
@item --for-your-eyes-only
diff --git a/doc/gpgsm.texi b/doc/gpgsm.texi
index f334c99..deb57a6 100644
--- a/doc/gpgsm.texi
+++ b/doc/gpgsm.texi
@@ -569,7 +569,7 @@ When doing a key listing, do a full validation check for each key and
print the result. This is usually a slow operation because it
requires a CRL lookup and other operations.
-When used along with --import, a validation of the certificate to
+When used along with @option{--import}, a validation of the certificate to
import is done and only imported if it succeeds the test. Note that
this does not affect an already available certificate in the DB.
This option is therefore useful to simply verify a certificate.
@@ -581,7 +581,7 @@ certificate.
@item --with-keygrip
Include the keygrip in standard key listings. Note that the keygrip is
-always listed in --with-colons mode.
+always listed in @option{--with-colons} mode.
@item --with-secret
@opindex with-secret
@@ -834,7 +834,7 @@ They are defined as certificates capable of creating legally binding
signatures in the same way as handwritten signatures are. Comments
start with a hash mark and empty lines are ignored. Lines do have a
length limit but this is not a serious limitation as the format of the
-entries is fixed and checked by gpgsm: A non-comment line starts with
+entries is fixed and checked by @command{gpgsm}: A non-comment line starts with
optional whitespace, followed by exactly 40 hex characters, white space
and a lowercased 2 letter country code. Additional data delimited with
by a white space is current ignored but might late be used for other
@@ -893,7 +893,7 @@ into the directory @file{/etc/skel/.gnupg/} so that newly created users
start up with a working configuration. For existing users a small
helper script is provided to create these files (@pxref{addgnupghome}).
-For internal purposes gpgsm creates and maintains a few other files;
+For internal purposes @command{gpgsm} creates and maintains a few other files;
they all live in in the current home directory (@pxref{option
--homedir}). Only @command{gpgsm} may modify these files.
@@ -1230,8 +1230,8 @@ message). Obviously the pipe must be open at that point, the server
establishes its own end. If the server returns an error the client
should consider this session failed.
-The option armor encodes the output in @acronym{PEM} format, the
- at code{--base64} option applies just a base 64 encoding. No option
+The option @option{--armor} encodes the output in @acronym{PEM} format, the
+ at option{--base64} option applies just a base-64 encoding. No option
creates binary output (@acronym{BER}).
The actual encryption is done using the command
@@ -1257,7 +1257,7 @@ closed.
@subsection Decrypting a message
Input and output FDs are set the same way as in encryption, but
- at code{INPUT} refers to the ciphertext and output to the plaintext. There
+ at code{INPUT} refers to the ciphertext and @code{OUTPUT} to the plaintext. There
is no need to set recipients. @command{GPGSM} automatically strips any
@acronym{S/MIME} headers from the input, so it is valid to pass an
entire MIME part to the INPUT pipe.
@@ -1297,8 +1297,8 @@ requested, only the signature is written.
SIGN [--detached]
@end example
-Sign the data set with the INPUT command and write it to the sink set by
-OUTPUT. With @code{--detached}, a detached signature is created
+Sign the data set with the @code{INPUT} command and write it to the sink set by
+ at code{OUTPUT}. With @code{--detached}, a detached signature is created
(surprise).
The key used for signing is the default one or the one specified in
@@ -1422,14 +1422,14 @@ required: Spaces are to be translated into "+" or into "%20"; in turn
this requires that the usual escape quoting rules are done.
If the @option{--data} option has not been given, the format of the
-output depends on what was set with the OUTPUT command. When using
+output depends on what was set with the @code{OUTPUT} command. When using
@acronym{PEM} encoding a few informational lines are prepended.
-If the @option{--data} has been given, a target set via OUTPUT is
+If the @option{--data} has been given, a target set via @code{OUTPUT} is
ignored and the data is returned inline using standard
@code{D}-lines. This avoids the need for an extra file descriptor. In
this case the options @option{--armor} and @option{--base64} may be used
-in the same way as with the OUTPUT command.
+in the same way as with the @code{OUTPUT} command.
@node GPGSM IMPORT
@@ -1479,7 +1479,7 @@ GETAUDITLOG [--data] [--html]
@end example
If @option{--data} is used, the audit log is send using D-lines
-instead of being sent to the file descriptor given by an OUTPUT
+instead of being sent to the file descriptor given by an @code{OUTPUT}
command. If @option{--html} is used, the output is formatted as an
XHTML block. This is designed to be incorporated into a HTML
document.
@@ -1570,7 +1570,7 @@ signers certicate and all other positive values include up to
@item list-to-output
If @var{value} is true the output of the list commands
(@pxref{gpgsm-cmd listkeys}) is written to the file descriptor set
-with the last OUTPUT command. If @var{value} is false the output is
+with the last @code{OUTPUT} command. If @var{value} is false the output is
written via data lines; this is the default.
@item with-validation
diff --git a/doc/howto-create-a-server-cert.texi b/doc/howto-create-a-server-cert.texi
index 37cb118..ea0ce71 100644
--- a/doc/howto-create-a-server-cert.texi
+++ b/doc/howto-create-a-server-cert.texi
@@ -206,7 +206,7 @@ followed by a Ctrl-D
@end example
@end cartouche
-gpgsm tells you that it has imported the certificate. It is now
+ at command{gpgsm} tells you that it has imported the certificate. It is now
associated with the key you used when creating the request. The root
certificate has not been found, so you may want to import it from the
CACert website.
diff --git a/doc/scdaemon.texi b/doc/scdaemon.texi
index 84c37f8..ddf18db 100644
--- a/doc/scdaemon.texi
+++ b/doc/scdaemon.texi
@@ -533,7 +533,7 @@ the @code{0x5A} tag in the GDO file (FIX=0x2F02).
@end example
Learn all useful information of the currently inserted card. When
-used without the force options, the command might do an INQUIRE
+used without the @option{--force} option, the command might do an INQUIRE
like this:
@example
diff --git a/doc/specify-user-id.texi b/doc/specify-user-id.texi
index cd32ab8..3a2b6a2 100644
--- a/doc/specify-user-id.texi
+++ b/doc/specify-user-id.texi
@@ -99,9 +99,9 @@ This uses a substring search but considers only the mail address
@item By exact match on the subject's DN.
This is indicated by a leading slash, directly followed by the RFC-2253
encoded DN of the subject. Note that you can't use the string printed
-by "gpgsm --list-keys" because that one has been reordered and modified
-for better readability; use --with-colons to print the raw (but standard
-escaped) RFC-2253 string
+by @code{gpgsm --list-keys} because that one has been reordered and modified
+for better readability; use @option{--with-colons} to print the raw
+(but standard escaped) RFC-2253 string
@cartouche
@example
diff --git a/doc/tools.texi b/doc/tools.texi
index b1c3a18..f213bfe 100644
--- a/doc/tools.texi
+++ b/doc/tools.texi
@@ -319,9 +319,9 @@ may use this command to ensure that they are started.
@item --kill [@var{component}]
@opindex kill
Kill the given component. Components which support killing are
-gpg-agent and scdaemon. Components which don't support reloading are
-ignored. Note that as of now reload and kill have the same effect for
-scdaemon.
+ at command{gpg-agent} and @command{scdaemon}. Components which don't
+support reloading are ignored. Note that as of now reload and kill
+have the same effect for @command{scdaemon}.
@item --create-socketdir
@opindex create-socketdir
@@ -699,9 +699,9 @@ If this flag is set, and the @code{optional arg} flag is set, then the
option has a special meaning if no argument is given.
@item no change (128)
-If this flag is set, gpgconf ignores requests to change the value. GUI
-frontends should grey out this option. Note, that manual changes of the
-configuration files are still possible.
+If this flag is set, @command{gpgconf} ignores requests to change the
+value. GUI frontends should grey out this option. Note, that manual
+changes of the configuration files are still possible.
@end table
@item level
@@ -1137,9 +1137,9 @@ for other users.
@mansect description
The @command{gpg-connect-agent} is a utility to communicate with a
running @command{gpg-agent}. It is useful to check out the commands
-gpg-agent provides using the Assuan interface. It might also be useful
-for scripting simple applications. Input is expected at stdin and out
-put gets printed to stdout.
+ at command{gpg-agent} provides using the Assuan interface. It might
+also be useful for scripting simple applications. Input is expected
+at stdin and out put gets printed to stdout.
It is very similar to running @command{gpg-agent} in server mode; but
here we connect to a running instance.
@@ -1673,14 +1673,15 @@ debugging. Run it with @code{--help} for usage information.
@end ifset
@mansect description
-Sometimes simple encryption tools are already in use for a long time and
-there might be a desire to integrate them into the GnuPG framework. The
-protocols and encryption methods might be non-standard or not even
-properly documented, so that a full-fledged encryption tool with an
-interface like gpg is not doable. @command{symcryptrun} provides a
-solution: It operates by calling the external encryption/decryption
-module and provides a passphrase for a key using the standard
- at command{pinentry} based mechanism through @command{gpg-agent}.
+Sometimes simple encryption tools are already in use for a long time
+and there might be a desire to integrate them into the GnuPG
+framework. The protocols and encryption methods might be non-standard
+or not even properly documented, so that a full-fledged encryption
+tool with an interface like @command{gpg} is not doable.
+ at command{symcryptrun} provides a solution: It operates by calling the
+external encryption/decryption module and provides a passphrase for a
+key using the standard @command{pinentry} based mechanism through
+ at command{gpg-agent}.
Note, that @command{symcryptrun} is only available if GnuPG has been
configured with @samp{--enable-symcryptrun} at build time.
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-gnupg/gnupg2.git
More information about the Pkg-gnupg-commit
mailing list