Skip to content

Commit b5f95c1

Browse files
committed
doc: Improve the rendering of the manual
1 parent f149e05 commit b5f95c1

7 files changed

+53
-30
lines changed

artwork/gnupg-logo-420x135tr.png

14.1 KB
Loading

doc/debugging.texi

+9-4
Original file line numberDiff line numberDiff line change
@@ -177,22 +177,27 @@ you created the signing request. By running the command
177177

178178
you get a listing of all private keys under control of @command{gpg-agent}.
179179
Pick the key which best matches the creation time and run the command
180-
180+
181+
@cartouche
181182
@smallexample
182-
/usr/local/libexec/gpg-protect-tool --p12-export ~/.gnupg/private-keys-v1.d/@var{foo} >@var{foo}.p12
183+
/usr/local/libexec/gpg-protect-tool --p12-export \
184+
~/.gnupg/private-keys-v1.d/@var{foo} >@var{foo}.p12
183185
@end smallexample
186+
@end cartouche
184187

185188
(Please adjust the path to @command{gpg-protect-tool} to the appropriate
186189
location). @var{foo} is the name of the key file you picked (it should
187190
have the suffix @file{.key}). A Pinentry box will pop up and ask you
188191
for the current passphrase of the key and a new passphrase to protect it
189192
in the pkcs#12 file.
190193

191-
To import the created file on the machine you use this command:
194+
To import the created file on the machine you use this command:
192195

196+
@cartouche
193197
@smallexample
194198
/usr/local/libexec/gpg-protect-tool --p12-import --store @var{foo}.p12
195199
@end smallexample
200+
@end cartouche
196201

197202
You will be asked for the pkcs#12 passphrase and a new passphrase to
198203
protect the imported private key at its new location.
@@ -230,7 +235,7 @@ gpg: fatal: WriteConsole failed: Access denied
230235
@end smallexample
231236

232237
@noindent
233-
The solution is to use the command @command{wineconsole}.
238+
The solution is to use the command @command{wineconsole}.
234239

235240
Some operations like gen-key really want to talk to the console directly
236241
for increased security (for example to prevent the passphrase from

doc/gnupg-logo.pdf

-11.5 KB
Binary file not shown.

doc/gnupg-logo.png

5.35 KB
Loading

doc/gnupg.texi

+7-6
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,13 @@ This is the @cite{The GNU Privacy Guard Manual} (version
2929
@value{VERSION}, @value{UPDATED-MONTH}).
3030

3131
@iftex
32-
Published by the Free Software Foundation@*
33-
51 Franklin St, Fifth Floor@*
34-
Boston, MA 02110-1301 USA
32+
Published by The GnuPG Project@*
33+
@url{https://gnupg.org}@*
34+
(or @url{http://ic6au7wa3f6naxjq.onion})
3535
@end iftex
3636

37-
Copyright @copyright{} 2002, 2004, 2005, 2006, 2007, 2010 Free Software Foundation, Inc.
37+
@copyright{} 2002, 2004, 2005, 2006, 2007, 2010 Free Software Foundation, Inc.@*
38+
@copyright{} 2013, 2014 Werner Koch.
3839

3940
@quotation
4041
Permission is granted to copy, distribute and/or modify this document
@@ -92,11 +93,11 @@ section entitled ``Copying''.
9293

9394
@sp 3
9495

95-
@image{gnupg-logo,16cm,,The GnuPG Logo}
96+
@image{gnupg-logo,,,The GnuPG Logo}
9697

9798
@sp 3
9899

99-
@author Werner Koch (@email{wk@@gnupg.org})
100+
@author The GnuPG Project (@url{https://gnupg.org})
100101

101102
@page
102103
@vskip 0pt plus 1filll

doc/gpg-agent.texi

+28-15
Original file line numberDiff line numberDiff line change
@@ -597,7 +597,8 @@ agent. By default they may all be found in the current home directory
597597
Here is an example where two keys are marked as ultimately trusted
598598
and one as not trusted:
599599

600-
@example
600+
@cartouche
601+
@smallexample
601602
# CN=Wurzel ZS 3,O=Intevation GmbH,C=DE
602603
A6935DD34EF3087973C706FC311AA2CCF733765B S
603604
@@ -606,7 +607,8 @@ agent. By default they may all be found in the current home directory
606607
607608
# CN=Root-CA/O=Schlapphuete/L=Pullach/C=DE
608609
!14:56:98:D3:FE:9C:CA:5A:31:6E:BC:81:D3:11:4E:00:90:A3:44:C2 S
609-
@end example
610+
@end smallexample
611+
@end cartouche
610612

611613
Before entering a key into this file, you need to ensure its
612614
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
669671
through a OpenPGP smartcard in the active smartcard reader are
670672
implicitly added to this list; i.e. there is no need to list them.
671673

672-
@example
674+
@cartouche
675+
@smallexample
673676
# Key added on: 2011-07-20 20:38:46
674677
# Fingerprint: 5e:8d:c4:ad:e7:af:6e:27:8a:d6:13:e4:79:ad:0b:81
675678
34B62F25E277CF13D3C6BCEBFD3F85D08F0A864B 0 confirm
676-
@end example
679+
@end smallexample
680+
@end cartouche
677681

678682
@item private-keys-v1.d/
679683

@@ -892,8 +896,8 @@ If the decryption was successful the decrypted data is returned by
892896
means of "D" lines.
893897

894898
Here is an example session:
895-
896-
@example
899+
@cartouche
900+
@smallexample
897901
C: PKDECRYPT
898902
S: INQUIRE CIPHERTEXT
899903
C: D (enc-val elg (a 349324324)
@@ -903,7 +907,8 @@ Here is an example session:
903907
S: S PADDING 0
904908
S: D (value 1234567890ABCDEF0)
905909
S: OK descryption successful
906-
@end example
910+
@end smallexample
911+
@end cartouche
907912

908913
The “PADDING” status line is only send if gpg-agent can tell what kind
909914
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:
937942

938943
@table @code
939944
@item sha1
945+
The SHA-1 hash algorithm
940946
@item sha256
947+
The SHA-256 hash algorithm
941948
@item rmd160
949+
The RIPE-MD160 hash algorithm
942950
@item md5
951+
The old and broken MD5 hash algorithm
943952
@item tls-md5sha1
953+
A combined hash algorithm as used by the TLS protocol.
944954
@end table
945955

946956
@noindent
@@ -977,8 +987,8 @@ caching.
977987

978988

979989
Here is an example session:
980-
981-
@example
990+
@cartouche
991+
@smallexample
982992
C: SIGKEY <keyGrip>
983993
S: OK key available
984994
C: SIGKEY <keyGrip>
@@ -992,8 +1002,8 @@ Here is an example session:
9921002
S: # signature follows
9931003
S: D (sig-val rsa (s 45435453654612121212))
9941004
S: OK
995-
@end example
996-
1005+
@end smallexample
1006+
@end cartouche
9971007

9981008
@node Agent GENKEY
9991009
@subsection Generating a Key
@@ -1043,16 +1053,17 @@ like S-Expression like this:
10431053
@end example
10441054

10451055
Here is an example session:
1046-
1047-
@example
1056+
@cartouche
1057+
@smallexample
10481058
C: GENKEY
10491059
S: INQUIRE KEYPARM
10501060
C: D (genkey (rsa (nbits 1024)))
10511061
C: END
10521062
S: D (public-key
10531063
S: D (rsa (n 326487324683264) (e 10001)))
10541064
S OK key created
1055-
@end example
1065+
@end smallexample
1066+
@end cartouche
10561067

10571068
@ifset gpgtwoone
10581069
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
11701181
clients to use the agent with minimum effort.
11711182

11721183
@example
1173-
GET_PASSPHRASE [--data] [--check] [--no-ask] [--repeat[=N]] [--qualitybar] @var{cache_id} [@var{error_message} @var{prompt} @var{description}]
1184+
GET_PASSPHRASE [--data] [--check] [--no-ask] [--repeat[=N]] \
1185+
[--qualitybar] @var{cache_id} \
1186+
[@var{error_message} @var{prompt} @var{description}]
11741187
@end example
11751188

11761189
@var{cache_id} is expected to be a string used to identify a cached

doc/scdaemon.texi

+9-5
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,8 @@ show memory statistics.
178178
@item 9 (512)
179179
write hashed data to files named @code{dbgmd-000*}
180180
@item 10 (1024)
181-
trace Assuan protocol. See also option @option{--debug-assuan-log-cats}.
181+
trace Assuan protocol.
182+
See also option @option{--debug-assuan-log-cats}.
182183
@item 11 (2048)
183184
trace APDU I/O to the card. This may reveal sensitive data.
184185
@item 12 (4096)
@@ -268,10 +269,12 @@ a list of available readers. The default is then the first reader
268269
found.
269270

270271
To get a list of available CCID readers you may use this command:
272+
@cartouche
271273
@smallexample
272-
echo scd getinfo reader_list | gpg-connect-agent --decode | awk '/^D/ @{print $2@}'
274+
echo scd getinfo reader_list \
275+
| gpg-connect-agent --decode | awk '/^D/ @{print $2@}'
273276
@end smallexample
274-
277+
@end cartouche
275278

276279
@item --card-timeout @var{n}
277280
@opindex card-timeout
@@ -347,8 +350,9 @@ This application is currently only used by @command{gpg} but may in
347350
future also be useful with @command{gpgsm}. Version 1 and version 2 of
348351
the card is supported.
349352

350-
The specifications for these cards are available at
351-
@uref{http://g10code.com/docs/openpgp-card-1.0.pdf} and
353+
@noindent
354+
The specifications for these cards are available at@*
355+
@uref{http://g10code.com/docs/openpgp-card-1.0.pdf} and@*
352356
@uref{http://g10code.com/docs/openpgp-card-2.0.pdf}.
353357

354358
@node NKS Card

0 commit comments

Comments
 (0)