1
0
mirror of git://git.gnupg.org/gnupg.git synced 2024-05-28 21:50:02 +02:00

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.
This commit is contained in:
Ineiev 2016-03-04 16:38:09 +00:00 committed by NIIBE Yutaka
parent 9d2b7bff12
commit 377624207e
7 changed files with 43 additions and 42 deletions

View File

@ -1341,7 +1341,7 @@ least one of the keygrips corresponds to an available secret key.
LEARN [--send] LEARN [--send]
@end example @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. option given the certificates are sent back.

View File

@ -723,12 +723,12 @@ line.
@item sign @item sign
@opindex keyedit:sign @opindex keyedit:sign
Make a signature on key of user @code{name} If the key is not yet 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 signed by the default user (or the users given with @option{-u}), the program
displays the information of the key again, together with its displays the information of the key again, together with its
fingerprint and asks whether it should be signed. This question is fingerprint and asks whether it should be signed. This question is
repeated for all users specified with repeated for all users specified with
-u. @option{-u}.
@item lsign @item lsign
@opindex keyedit: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), restricts you to the ciphers IDEA (if the IDEA plugin is installed),
3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the
compression algorithms none and ZIP. This also disables compression algorithms none and ZIP. This also disables
--throw-keyids, and making signatures with signing subkeys as PGP 6 @option{--throw-keyids}, and making signatures with signing subkeys as PGP 6
does not understand signatures made by signing subkeys. does not understand signatures made by signing subkeys.
This option implies @option{--disable-mdc --escape-from-lines}. 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 @opindex set-filename
Use @code{string} as the filename which is stored inside messages. Use @code{string} as the filename which is stored inside messages.
This overrides the default, which is to use the actual filename of the 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. effectively removes the filename from the output.
@item --for-your-eyes-only @item --for-your-eyes-only

View File

@ -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 print the result. This is usually a slow operation because it
requires a CRL lookup and other operations. 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 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 does not affect an already available certificate in the DB.
This option is therefore useful to simply verify a certificate. This option is therefore useful to simply verify a certificate.
@ -581,7 +581,7 @@ certificate.
@item --with-keygrip @item --with-keygrip
Include the keygrip in standard key listings. Note that the keygrip is 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 @item --with-secret
@opindex 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 signatures in the same way as handwritten signatures are. Comments
start with a hash mark and empty lines are ignored. Lines do have a 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 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 optional whitespace, followed by exactly 40 hex characters, white space
and a lowercased 2 letter country code. Additional data delimited with 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 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 start up with a working configuration. For existing users a small
helper script is provided to create these files (@pxref{addgnupghome}). 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 they all live in in the current home directory (@pxref{option
--homedir}). Only @command{gpgsm} may modify these files. --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 establishes its own end. If the server returns an error the client
should consider this session failed. should consider this session failed.
The option armor encodes the output in @acronym{PEM} format, the The option @option{--armor} encodes the output in @acronym{PEM} format, the
@code{--base64} option applies just a base 64 encoding. No option @option{--base64} option applies just a base-64 encoding. No option
creates binary output (@acronym{BER}). creates binary output (@acronym{BER}).
The actual encryption is done using the command The actual encryption is done using the command
@ -1257,7 +1257,7 @@ closed.
@subsection Decrypting a message @subsection Decrypting a message
Input and output FDs are set the same way as in encryption, but Input and output FDs are set the same way as in encryption, but
@code{INPUT} refers to the ciphertext and output to the plaintext. There @code{INPUT} refers to the ciphertext and @code{OUTPUT} to the plaintext. There
is no need to set recipients. @command{GPGSM} automatically strips any 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 @acronym{S/MIME} headers from the input, so it is valid to pass an
entire MIME part to the INPUT pipe. entire MIME part to the INPUT pipe.
@ -1297,8 +1297,8 @@ requested, only the signature is written.
SIGN [--detached] SIGN [--detached]
@end example @end example
Sign the data set with the INPUT command and write it to the sink set by Sign the data set with the @code{INPUT} command and write it to the sink set by
OUTPUT. With @code{--detached}, a detached signature is created @code{OUTPUT}. With @code{--detached}, a detached signature is created
(surprise). (surprise).
The key used for signing is the default one or the one specified in 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. this requires that the usual escape quoting rules are done.
If the @option{--data} option has not been given, the format of the 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. @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 ignored and the data is returned inline using standard
@code{D}-lines. This avoids the need for an extra file descriptor. In @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 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 @node GPGSM IMPORT
@ -1479,7 +1479,7 @@ GETAUDITLOG [--data] [--html]
@end example @end example
If @option{--data} is used, the audit log is send using D-lines 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 command. If @option{--html} is used, the output is formatted as an
XHTML block. This is designed to be incorporated into a HTML XHTML block. This is designed to be incorporated into a HTML
document. document.
@ -1570,7 +1570,7 @@ signers certicate and all other positive values include up to
@item list-to-output @item list-to-output
If @var{value} is true the output of the list commands If @var{value} is true the output of the list commands
(@pxref{gpgsm-cmd listkeys}) is written to the file descriptor set (@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. written via data lines; this is the default.
@item with-validation @item with-validation

View File

@ -206,7 +206,7 @@ followed by a Ctrl-D
@end example @end example
@end cartouche @end cartouche
gpgsm tells you that it has imported the certificate. It is now @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 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 certificate has not been found, so you may want to import it from the
CACert website. CACert website.

View File

@ -533,7 +533,7 @@ the @code{0x5A} tag in the GDO file (FIX=0x2F02).
@end example @end example
Learn all useful information of the currently inserted card. When 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: like this:
@example @example

View File

@ -99,9 +99,9 @@ This uses a substring search but considers only the mail address
@item By exact match on the subject's DN. @item By exact match on the subject's DN.
This is indicated by a leading slash, directly followed by the RFC-2253 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 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 by @code{gpgsm --list-keys} because that one has been reordered and modified
for better readability; use --with-colons to print the raw (but standard for better readability; use @option{--with-colons} to print the raw
escaped) RFC-2253 string (but standard escaped) RFC-2253 string
@cartouche @cartouche
@example @example

View File

@ -319,9 +319,9 @@ may use this command to ensure that they are started.
@item --kill [@var{component}] @item --kill [@var{component}]
@opindex kill @opindex kill
Kill the given component. Components which support killing are Kill the given component. Components which support killing are
gpg-agent and scdaemon. Components which don't support reloading are @command{gpg-agent} and @command{scdaemon}. Components which don't
ignored. Note that as of now reload and kill have the same effect for support reloading are ignored. Note that as of now reload and kill
scdaemon. have the same effect for @command{scdaemon}.
@item --create-socketdir @item --create-socketdir
@opindex 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. option has a special meaning if no argument is given.
@item no change (128) @item no change (128)
If this flag is set, gpgconf ignores requests to change the value. GUI If this flag is set, @command{gpgconf} ignores requests to change the
frontends should grey out this option. Note, that manual changes of the value. GUI frontends should grey out this option. Note, that manual
configuration files are still possible. changes of the configuration files are still possible.
@end table @end table
@item level @item level
@ -1137,9 +1137,9 @@ for other users.
@mansect description @mansect description
The @command{gpg-connect-agent} is a utility to communicate with a The @command{gpg-connect-agent} is a utility to communicate with a
running @command{gpg-agent}. It is useful to check out the commands running @command{gpg-agent}. It is useful to check out the commands
gpg-agent provides using the Assuan interface. It might also be useful @command{gpg-agent} provides using the Assuan interface. It might
for scripting simple applications. Input is expected at stdin and out also be useful for scripting simple applications. Input is expected
put gets printed to stdout. at stdin and out put gets printed to stdout.
It is very similar to running @command{gpg-agent} in server mode; but It is very similar to running @command{gpg-agent} in server mode; but
here we connect to a running instance. here we connect to a running instance.
@ -1673,14 +1673,15 @@ debugging. Run it with @code{--help} for usage information.
@end ifset @end ifset
@mansect description @mansect description
Sometimes simple encryption tools are already in use for a long time and Sometimes simple encryption tools are already in use for a long time
there might be a desire to integrate them into the GnuPG framework. The and there might be a desire to integrate them into the GnuPG
protocols and encryption methods might be non-standard or not even framework. The protocols and encryption methods might be non-standard
properly documented, so that a full-fledged encryption tool with an or not even properly documented, so that a full-fledged encryption
interface like gpg is not doable. @command{symcryptrun} provides a tool with an interface like @command{gpg} is not doable.
solution: It operates by calling the external encryption/decryption @command{symcryptrun} provides a solution: It operates by calling the
module and provides a passphrase for a key using the standard external encryption/decryption module and provides a passphrase for a
@command{pinentry} based mechanism through @command{gpg-agent}. key using the standard @command{pinentry} based mechanism through
@command{gpg-agent}.
Note, that @command{symcryptrun} is only available if GnuPG has been Note, that @command{symcryptrun} is only available if GnuPG has been
configured with @samp{--enable-symcryptrun} at build time. configured with @samp{--enable-symcryptrun} at build time.