1
0
mirror of git://git.gnupg.org/gnupg.git synced 2024-12-22 10:19:57 +01:00

doc: Improve the rendering of the manual

This commit is contained in:
Werner Koch 2014-06-25 11:15:45 +02:00
parent f149e05427
commit b5f95c1b56
7 changed files with 53 additions and 30 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

View File

@ -177,10 +177,13 @@ you created the signing request. By running the command
you get a listing of all private keys under control of @command{gpg-agent}. you get a listing of all private keys under control of @command{gpg-agent}.
Pick the key which best matches the creation time and run the command Pick the key which best matches the creation time and run the command
@cartouche
@smallexample @smallexample
/usr/local/libexec/gpg-protect-tool --p12-export ~/.gnupg/private-keys-v1.d/@var{foo} >@var{foo}.p12 /usr/local/libexec/gpg-protect-tool --p12-export \
~/.gnupg/private-keys-v1.d/@var{foo} >@var{foo}.p12
@end smallexample @end smallexample
@end cartouche
(Please adjust the path to @command{gpg-protect-tool} to the appropriate (Please adjust the path to @command{gpg-protect-tool} to the appropriate
location). @var{foo} is the name of the key file you picked (it should location). @var{foo} is the name of the key file you picked (it should
@ -188,11 +191,13 @@ have the suffix @file{.key}). A Pinentry box will pop up and ask you
for the current passphrase of the key and a new passphrase to protect it for the current passphrase of the key and a new passphrase to protect it
in the pkcs#12 file. in the pkcs#12 file.
To import the created file on the machine you use this command: To import the created file on the machine you use this command:
@cartouche
@smallexample @smallexample
/usr/local/libexec/gpg-protect-tool --p12-import --store @var{foo}.p12 /usr/local/libexec/gpg-protect-tool --p12-import --store @var{foo}.p12
@end smallexample @end smallexample
@end cartouche
You will be asked for the pkcs#12 passphrase and a new passphrase to You will be asked for the pkcs#12 passphrase and a new passphrase to
protect the imported private key at its new location. protect the imported private key at its new location.
@ -230,7 +235,7 @@ gpg: fatal: WriteConsole failed: Access denied
@end smallexample @end smallexample
@noindent @noindent
The solution is to use the command @command{wineconsole}. The solution is to use the command @command{wineconsole}.
Some operations like gen-key really want to talk to the console directly Some operations like gen-key really want to talk to the console directly
for increased security (for example to prevent the passphrase from for increased security (for example to prevent the passphrase from

Binary file not shown.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.8 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

@ -29,12 +29,13 @@ This is the @cite{The GNU Privacy Guard Manual} (version
@value{VERSION}, @value{UPDATED-MONTH}). @value{VERSION}, @value{UPDATED-MONTH}).
@iftex @iftex
Published by the Free Software Foundation@* Published by The GnuPG Project@*
51 Franklin St, Fifth Floor@* @url{https://gnupg.org}@*
Boston, MA 02110-1301 USA (or @url{http://ic6au7wa3f6naxjq.onion})
@end iftex @end iftex
Copyright @copyright{} 2002, 2004, 2005, 2006, 2007, 2010 Free Software Foundation, Inc. @copyright{} 2002, 2004, 2005, 2006, 2007, 2010 Free Software Foundation, Inc.@*
@copyright{} 2013, 2014 Werner Koch.
@quotation @quotation
Permission is granted to copy, distribute and/or modify this document Permission is granted to copy, distribute and/or modify this document
@ -92,11 +93,11 @@ section entitled ``Copying''.
@sp 3 @sp 3
@image{gnupg-logo,16cm,,The GnuPG Logo} @image{gnupg-logo,,,The GnuPG Logo}
@sp 3 @sp 3
@author Werner Koch (@email{wk@@gnupg.org}) @author The GnuPG Project (@url{https://gnupg.org})
@page @page
@vskip 0pt plus 1filll @vskip 0pt plus 1filll

View File

@ -597,7 +597,8 @@ agent. By default they may all be found in the current home directory
Here is an example where two keys are marked as ultimately trusted Here is an example where two keys are marked as ultimately trusted
and one as not trusted: and one as not trusted:
@example @cartouche
@smallexample
# CN=Wurzel ZS 3,O=Intevation GmbH,C=DE # CN=Wurzel ZS 3,O=Intevation GmbH,C=DE
A6935DD34EF3087973C706FC311AA2CCF733765B S A6935DD34EF3087973C706FC311AA2CCF733765B S
@ -606,7 +607,8 @@ agent. By default they may all be found in the current home directory
# CN=Root-CA/O=Schlapphuete/L=Pullach/C=DE # CN=Root-CA/O=Schlapphuete/L=Pullach/C=DE
!14:56:98:D3:FE:9C:CA:5A:31:6E:BC:81:D3:11:4E:00:90:A3:44:C2 S !14:56:98:D3:FE:9C:CA:5A:31:6E:BC:81:D3:11:4E:00:90:A3:44:C2 S
@end example @end smallexample
@end cartouche
Before entering a key into this file, you need to ensure its Before entering a key into this file, you need to ensure its
authenticity. How to do this depends on your organisation; your authenticity. How to do this depends on your organisation; your
@ -669,11 +671,13 @@ The following example lists exactly one key. Note that keys available
through a OpenPGP smartcard in the active smartcard reader are through a OpenPGP smartcard in the active smartcard reader are
implicitly added to this list; i.e. there is no need to list them. implicitly added to this list; i.e. there is no need to list them.
@example @cartouche
@smallexample
# Key added on: 2011-07-20 20:38:46 # Key added on: 2011-07-20 20:38:46
# Fingerprint: 5e:8d:c4:ad:e7:af:6e:27:8a:d6:13:e4:79:ad:0b:81 # Fingerprint: 5e:8d:c4:ad:e7:af:6e:27:8a:d6:13:e4:79:ad:0b:81
34B62F25E277CF13D3C6BCEBFD3F85D08F0A864B 0 confirm 34B62F25E277CF13D3C6BCEBFD3F85D08F0A864B 0 confirm
@end example @end smallexample
@end cartouche
@item private-keys-v1.d/ @item private-keys-v1.d/
@ -892,8 +896,8 @@ If the decryption was successful the decrypted data is returned by
means of "D" lines. means of "D" lines.
Here is an example session: Here is an example session:
@cartouche
@example @smallexample
C: PKDECRYPT C: PKDECRYPT
S: INQUIRE CIPHERTEXT S: INQUIRE CIPHERTEXT
C: D (enc-val elg (a 349324324) C: D (enc-val elg (a 349324324)
@ -903,7 +907,8 @@ Here is an example session:
S: S PADDING 0 S: S PADDING 0
S: D (value 1234567890ABCDEF0) S: D (value 1234567890ABCDEF0)
S: OK descryption successful S: OK descryption successful
@end example @end smallexample
@end cartouche
The “PADDING” status line is only send if gpg-agent can tell what kind The “PADDING” status line is only send if gpg-agent can tell what kind
of padding is used. As of now only the value 0 is used to indicate of padding is used. As of now only the value 0 is used to indicate
@ -937,10 +942,15 @@ must be given. Valid names for <name> are:
@table @code @table @code
@item sha1 @item sha1
The SHA-1 hash algorithm
@item sha256 @item sha256
The SHA-256 hash algorithm
@item rmd160 @item rmd160
The RIPE-MD160 hash algorithm
@item md5 @item md5
The old and broken MD5 hash algorithm
@item tls-md5sha1 @item tls-md5sha1
A combined hash algorithm as used by the TLS protocol.
@end table @end table
@noindent @noindent
@ -977,8 +987,8 @@ caching.
Here is an example session: Here is an example session:
@cartouche
@example @smallexample
C: SIGKEY <keyGrip> C: SIGKEY <keyGrip>
S: OK key available S: OK key available
C: SIGKEY <keyGrip> C: SIGKEY <keyGrip>
@ -992,8 +1002,8 @@ Here is an example session:
S: # signature follows S: # signature follows
S: D (sig-val rsa (s 45435453654612121212)) S: D (sig-val rsa (s 45435453654612121212))
S: OK S: OK
@end example @end smallexample
@end cartouche
@node Agent GENKEY @node Agent GENKEY
@subsection Generating a Key @subsection Generating a Key
@ -1043,8 +1053,8 @@ like S-Expression like this:
@end example @end example
Here is an example session: Here is an example session:
@cartouche
@example @smallexample
C: GENKEY C: GENKEY
S: INQUIRE KEYPARM S: INQUIRE KEYPARM
C: D (genkey (rsa (nbits 1024))) C: D (genkey (rsa (nbits 1024)))
@ -1052,7 +1062,8 @@ Here is an example session:
S: D (public-key S: D (public-key
S: D (rsa (n 326487324683264) (e 10001))) S: D (rsa (n 326487324683264) (e 10001)))
S OK key created S OK key created
@end example @end smallexample
@end cartouche
@ifset gpgtwoone @ifset gpgtwoone
The @option{--no-protection} option may be used to prevent prompting for a The @option{--no-protection} option may be used to prevent prompting for a
@ -1170,7 +1181,9 @@ special handling of passphrases. This command uses a syntax which helps
clients to use the agent with minimum effort. clients to use the agent with minimum effort.
@example @example
GET_PASSPHRASE [--data] [--check] [--no-ask] [--repeat[=N]] [--qualitybar] @var{cache_id} [@var{error_message} @var{prompt} @var{description}] GET_PASSPHRASE [--data] [--check] [--no-ask] [--repeat[=N]] \
[--qualitybar] @var{cache_id} \
[@var{error_message} @var{prompt} @var{description}]
@end example @end example
@var{cache_id} is expected to be a string used to identify a cached @var{cache_id} is expected to be a string used to identify a cached

View File

@ -178,7 +178,8 @@ show memory statistics.
@item 9 (512) @item 9 (512)
write hashed data to files named @code{dbgmd-000*} write hashed data to files named @code{dbgmd-000*}
@item 10 (1024) @item 10 (1024)
trace Assuan protocol. See also option @option{--debug-assuan-log-cats}. trace Assuan protocol.
See also option @option{--debug-assuan-log-cats}.
@item 11 (2048) @item 11 (2048)
trace APDU I/O to the card. This may reveal sensitive data. trace APDU I/O to the card. This may reveal sensitive data.
@item 12 (4096) @item 12 (4096)
@ -268,10 +269,12 @@ a list of available readers. The default is then the first reader
found. found.
To get a list of available CCID readers you may use this command: To get a list of available CCID readers you may use this command:
@cartouche
@smallexample @smallexample
echo scd getinfo reader_list | gpg-connect-agent --decode | awk '/^D/ @{print $2@}' echo scd getinfo reader_list \
| gpg-connect-agent --decode | awk '/^D/ @{print $2@}'
@end smallexample @end smallexample
@end cartouche
@item --card-timeout @var{n} @item --card-timeout @var{n}
@opindex card-timeout @opindex card-timeout
@ -347,8 +350,9 @@ This application is currently only used by @command{gpg} but may in
future also be useful with @command{gpgsm}. Version 1 and version 2 of future also be useful with @command{gpgsm}. Version 1 and version 2 of
the card is supported. the card is supported.
The specifications for these cards are available at @noindent
@uref{http://g10code.com/docs/openpgp-card-1.0.pdf} and The specifications for these cards are available at@*
@uref{http://g10code.com/docs/openpgp-card-1.0.pdf} and@*
@uref{http://g10code.com/docs/openpgp-card-2.0.pdf}. @uref{http://g10code.com/docs/openpgp-card-2.0.pdf}.
@node NKS Card @node NKS Card