Fixes for CVE-2006-6235
[gnupg.git] / doc / gpg.texi
1 @c Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
2 @c               2006 Free Software Foundation, Inc.
3 @c This is part of the GnuPG manual.
4 @c For copying conditions, see the file gnupg.texi.
5
6 @node Invoking GPG
7 @chapter Invoking GPG
8 @cindex GPG command options
9 @cindex command options
10 @cindex options, GPG command
11
12 @c Begin GnuPG 1.x specific stuff
13 @ifset gpgone
14 @macro gpgname
15 gpg
16 @end macro
17 @manpage gpg.1
18 @ifset manverb
19 .B gpg
20 \- OpenPGP encryption and signing tool
21 @end ifset
22
23 @mansect synopsis
24 @ifset manverb
25 .B  gpg
26 .RB [ \-\-homedir
27 .IR dir ]
28 .RB [ \-\-options
29 .IR file ]
30 .RI [ options ]  
31 .I command
32 .RI [ args ]
33 @end ifset
34 @end ifset
35 @c End GnuPG 1.x specific stuff
36
37 @c Begin GnuPG 2 specific stuff
38 @ifclear gpgone
39 @macro gpgname
40 gpg2
41 @end macro
42 @manpage gpg2.1
43 @ifset manverb
44 .B gpg2
45 \- OpenPGP encryption and signing tool
46 @end ifset
47
48 @mansect synopsis
49 @ifset manverb
50 .B  gpg2
51 .RB [ \-\-homedir
52 .IR dir ]
53 .RB [ \-\-options
54 .IR file ]
55 .RI [ options ]  
56 .I command
57 .RI [ args ]
58 @end ifset
59 @end ifclear
60 @c Begin GnuPG 2 specific stuff
61
62 @mansect description
63 @command{@gpgname} is the OpenPGP part of the GNU Privacy Guard (GnuPG). It
64 is a tool to provide digital encryption and signing services using the
65 OpenPGP standard. @command{@gpgname} features complete key management and
66 all bells and whistles you can expect from a decent OpenPGP
67 implementation.
68
69 @ifset gpgone
70 This is the standalone version of @command{gpg}.  For desktop use you
71 should consider using @command{gpg2}.
72 @end ifset
73
74 @ifclear gpgone
75 In contrast to the standalone version @command{gpg}, which is more
76 suited for server and embedded platforms, this version is installed
77 under the name @command{gpg2} and more targeted to the desktop as it
78 requires several other modules to be installed.  The standalone version
79 will be kept maintained and it is possible to install both versions on
80 the same system.  If you need to use different configuration files, you
81 should make use of something like @file{gpg.conf-2} instead of just
82 @file{gpg.conf}.
83 @end ifclear
84
85 @manpause
86 @ifclear gpgone
87 Documentation for the old standard @command{gpg} is available as a man
88 page and at @inforef{Top,GnuPG 1,gpg}.
89 @end ifclear
90
91 @xref{Option Index}, for an index to @command{@gpgname}'s commands and options.
92 @mancont
93
94 @menu
95 * GPG Commands::        List of all commands.
96 * GPG Options::         List of all options.
97 * GPG Configuration::   Configuration files.
98 * GPG Examples::        Some usage examples.
99
100 Developer information:
101 @c * Unattended Usage::      Using @command{gpg} from other programs.
102 @c * GPG Protocol::        The protocol the server mode uses.
103 @end menu
104
105
106
107 @c *******************************************
108 @c ***************            ****************
109 @c ***************  COMMANDS  ****************
110 @c ***************            ****************
111 @c *******************************************
112 @mansect commands
113 @node GPG Commands
114 @section Commands
115
116 Commands are not distinguished from options execpt for the fact that
117 only one command is allowed.
118
119 @command{@gpgname} may be run with no commands, in which case it will
120 perform a reasonable action depending on the type of file it is given
121 as input (an encrypted message is decrypted, a signature is verified,
122 a file containing keys is listed).
123
124 Please remember that option as well as command parsing stops as soon as
125 a non-option is encountered, you can explicitly stop parsing by
126 using the special option @option{--}.
127
128
129 @menu
130 * General GPG Commands::        Commands not specific to the functionality.
131 * Operational GPG Commands::    Commands to select the type of operation.
132 * OpenPGP Key Management::      How to manage your keys.
133 @end menu
134
135
136 @c *******************************************
137 @c **********  GENERAL COMMANDS  *************
138 @c *******************************************
139 @node General GPG Commands
140 @subsection Commands not specific to the function
141
142 @table @gnupgtabopt
143 @item --version
144 @opindex version
145 Print the program version and licensing information.  Note that you
146 cannot abbreviate this command.
147
148 @item --help
149 @itemx -h
150 @opindex help
151 Print a usage message summarizing the most useful command line options.
152 Not that you cannot abbreviate this command.
153
154 @item --warranty
155 @opindex warranty
156 Print warranty information.
157
158 @item --dump-options
159 @opindex dump-options
160 Print a list of all available options and commands.  Note that you cannot
161 abbreviate this command.
162 @end table
163
164
165 @c *******************************************
166 @c ********  OPERATIONAL COMMANDS  ***********
167 @c *******************************************
168 @node Operational GPG Commands
169 @subsection Commands to select the type of operation
170
171
172 @table @gnupgtabopt
173
174 @item --sign
175 @itemx -s
176 @opindex sign
177 Make a signature. This command may be combined with @option{--encrypt}
178 (for a signed and encrypted message), @option{--symmetric} (for a signed
179 and symmetrically encrypted message), or @option{--encrypt} and
180 @option{--symmetric} together (for a signed message that may be
181 decrypted via a secret key or a passphrase).
182
183 @item --clearsign
184 @opindex clearsign
185 Make a clear text signature. The content in a clear text signature is
186 readable without any special software. OpenPGP software is only
187 needed to verify the signature. Clear text signatures may modify
188 end-of-line whitespace for platform independence and are not intended
189 to be reversible.
190
191 @item --detach-sign
192 @itemx -b
193 @opindex detach-sign
194 Make a detached signature.
195
196 @item --encrypt
197 @itemx -e
198 @opindex encrypt
199 Encrypt data. This option may be combined with @option{--sign} (for a
200 signed and encrypted message), @option{--symmetric} (for a message that
201 may be decrypted via a secret key or a passphrase), or @option{--sign}
202 and @option{--symmetric} together (for a signed message that may be
203 decrypted via a secret key or a passphrase).
204
205 @item --symmetric
206 @itemx -c
207 @opindex symmetric
208 Encrypt with a symmetric cipher using a passphrase. The default
209 symmetric cipher used is CAST5, but may be chosen with the
210 @option{--cipher-algo} option. This option may be combined with
211 @option{--sign} (for a signed and symmetrically encrypted message),
212 @option{--encrypt} (for a message that may be decrypted via a secret key
213 or a passphrase), or @option{--sign} and @option{--encrypt} together
214 (for a signed message that may be decrypted via a secret key or a
215 passphrase).
216
217 @item --store
218 @opindex store
219 Store only (make a simple RFC1991 literal data packet).
220
221 @item --decrypt
222 @itemx -d
223 @opindex decrypt
224 Decrypt the file given on the command line (or @code{stdin} if no file
225 is specified) and write it to stdout (or the file specified with
226 @option{--output}). If the decrypted file is signed, the signature is also
227 verified. This command differs from the default operation, as it never
228 writes to the filename which is included in the file and it rejects
229 files which don't begin with an encrypted message.
230
231 @item --verify
232 @opindex verify
233 Assume that the first argument is a signed file or a detached signature
234 and verify it without generating any output. With no arguments, the
235 signature packet is read from stdin. If only a sigfile is given, it may
236 be a complete signature or a detached signature, in which case the
237 signed stuff is expected in a file without the ".sig" or ".asc"
238 extension.  With more than 1 argument, the first should be a detached
239 signature and the remaining files are the signed stuff. To read the
240 signed stuff from stdin, use @samp{-} as the second filename.  For
241 security reasons a detached signature cannot read the signed material
242 from stdin without denoting it in the above way.
243
244 @item --multifile
245 @opindex multifile
246 This modifies certain other commands to accept multiple files for
247 processing on the command line or read from stdin with each filename on
248 a separate line. This allows for many files to be processed at
249 once. @option{--multifile} may currently be used along with
250 @option{--verify}, @option{--encrypt}, and @option{--decrypt}. Note that
251 @option{--multifile --verify} may not be used with detached signatures.
252
253 @item --verify-files
254 @opindex verify-files
255 Identical to @option{--multifile --verify}.
256
257 @item --encrypt-files
258 @opindex encrypt-files
259 Identical to @option{--multifile --encrypt}.
260
261 @item --decrypt-files
262 @opindex decrypt-files
263 Identical to @option{--multifile --decrypt}.
264
265 @item --list-keys
266 @itemx -k
267 @itemx --list-public-keys
268 @opindex list-keys
269 List all keys from the public keyrings, or just the keys given on the
270 command line.
271 @ifset gpgone
272 @option{-k} is slightly different from @option{--list-keys} in that it
273 allows only for one argument and takes the second argument as the
274 keyring to search.  This is for command line compatibility with PGP 2
275 and has been removed in @command{gpg2}.
276 @end ifset
277
278 Avoid using the output of this command in scripts or other programs as
279 it is likely to change as GnuPG changes. See @option{--with-colons} for a
280 machine-parseable key listing command that is appropriate for use in
281 scripts and other programs.
282
283 @item --list-secret-keys
284 @itemx -K
285 @opindex list-secret-keys
286 List all keys from the secret keyrings, or just the ones given on the
287 command line. A @code{#} after the letters @code{sec} means that the
288 secret key is not usable (for example, if it was created via
289 @option{--export-secret-subkeys}).
290
291 @item --list-sigs
292 @opindex list-sigs
293 Same as @option{--list-keys}, but the signatures are listed too.
294
295 For each signature listed, there are several flags in between the "sig"
296 tag and keyid. These flags give additional information about each
297 signature. From left to right, they are the numbers 1-3 for certificate
298 check level (see @option{--ask-cert-level}), "L" for a local or
299 non-exportable signature (see @option{--lsign-key}), "R" for a
300 nonRevocable signature (see the @option{--edit-key} command "nrsign"),
301 "P" for a signature that contains a policy URL (see
302 @option{--cert-policy-url}), "N" for a signature that contains a
303 notation (see @option{--cert-notation}), "X" for an eXpired signature
304 (see @option{--ask-cert-expire}), and the numbers 1-9 or "T" for 10 and
305 above to indicate trust signature levels (see the @option{--edit-key}
306 command "tsign").
307
308 @item --check-sigs
309 @opindex check-sigs
310 Same as @option{--list-sigs}, but the signatures are verified.
311
312 @item --fingerprint
313 @opindex fingerprint
314 List all keys (or the specified ones) along with their
315 fingerprints. This is the same output as @option{--list-keys} but with
316 the additional output of a line with the fingerprint. May also be
317 combined with @option{--list-sigs} or @option{--check-sigs}.  If this
318 command is given twice, the fingerprints of all secondary keys are
319 listed too.
320
321 @item --list-packets
322 @opindex list-packets
323 List only the sequence of packets. This is mainly
324 useful for debugging.
325
326
327 @item --card-edit
328 @opindex card-edit
329 Present a menu to work with a smartcard. The subcommand "help" provides
330 an overview on available commands. For a detailed description, please
331 see the Card HOWTO at
332 http://www.gnupg.org/documentation/howtos.html#GnuPG-cardHOWTO .
333
334 @item --card-status
335 @opindex card-status
336 Show the content of the smart card.
337
338 @item --change-pin
339 @opindex change-pin
340 Present a menu to allow changing the PIN of a smartcard. This
341 functionality is also available as the subcommand "passwd" with the
342 @option{--card-edit} command.
343
344 @item --delete-key @code{name}
345 @opindex delete-key
346 Remove key from the public keyring. In batch mode either @option{--yes} is
347 required or the key must be specified by fingerprint. This is a
348 safeguard against accidental deletion of multiple keys.
349
350 @item --delete-secret-key @code{name}
351 @opindex delete-secret-key
352 Remove key from the secret and public keyring. In batch mode the key
353 must be specified by fingerprint.
354
355 @item --delete-secret-and-public-key @code{name}
356 @opindex delete-secret-and-public-key
357 Same as @option{--delete-key}, but if a secret key exists, it will be
358 removed first. In batch mode the key must be specified by fingerprint.
359
360 @item --export
361 @opindex export
362 Either export all keys from all keyrings (default keyrings and those
363 registered via option @option{--keyring}), or if at least one name is given,
364 those of the given name. The new keyring is written to stdout or to the
365 file given with option @option{--output}. Use together with
366 @option{--armor} to mail those keys.
367
368 @item --send-keys @code{key IDs}
369 @opindex send-keys
370 Similar to @option{--export} but sends the keys to a keyserver.
371 Fingerprints may be used instead of key IDs. Option @option{--keyserver}
372 must be used to give the name of this keyserver. Don't send your
373 complete keyring to a keyserver --- select only those keys which are new
374 or changed by you.
375
376 @item --export-secret-keys
377 @itemx --export-secret-subkeys
378 @opindex export-secret-keys
379 @opindex export-secret-subkeys
380 Same as @option{--export}, but exports the secret keys instead.  This is
381 normally not very useful and a security risk.  The second form of the
382 command has the special property to render the secret part of the
383 primary key useless; this is a GNU extension to OpenPGP and other
384 implementations can not be expected to successfully import such a key.
385 See the option @option{--simple-sk-checksum} if you want to import such
386 an exported key with an older OpenPGP implementation.
387
388 @item --import
389 @itemx --fast-import
390 @opindex import
391 Import/merge keys. This adds the given keys to the
392 keyring. The fast version is currently just a synonym.
393
394 There are a few other options which control how this command works.
395 Most notable here is the @option{--keyserver-options merge-only} option
396 which does not insert new keys but does only the merging of new
397 signatures, user-IDs and subkeys.
398
399 @item --recv-keys @code{key IDs}
400 @opindex recv-keys
401 Import the keys with the given key IDs from a keyserver. Option
402 @option{--keyserver} must be used to give the name of this keyserver.
403
404 @item --refresh-keys
405 @opindex refresh-keys
406 Request updates from a keyserver for keys that already exist on the
407 local keyring. This is useful for updating a key with the latest
408 signatures, user IDs, etc. Calling this with no arguments will refresh
409 the entire keyring. Option @option{--keyserver} must be used to give the
410 name of the keyserver for all keys that do not have preferred keyservers
411 set (see @option{--keyserver-options honor-keyserver-url}).
412
413 @item --search-keys @code{names}
414 @opindex search-keys
415 Search the keyserver for the given names. Multiple names given here will
416 be joined together to create the search string for the keyserver.
417 Option @option{--keyserver} must be used to give the name of this
418 keyserver.  Keyservers that support different search methods allow using
419 the syntax specified in "How to specify a user ID" below. Note that
420 different keyserver types support different search methods. Currently
421 only LDAP supports them all.
422
423 @item --fetch-keys @code{URIs}
424 @opindex fetch-keys
425 Retrieve keys located at the specified URIs. Note that different
426 installations of GnuPG may support different protocols (HTTP, FTP,
427 LDAP, etc.)
428
429 @item --update-trustdb
430 @opindex update-trustdb
431 Do trust database maintenance. This command iterates over all keys and
432 builds the Web of Trust. This is an interactive command because it may
433 have to ask for the "ownertrust" values for keys. The user has to give
434 an estimation of how far she trusts the owner of the displayed key to
435 correctly certify (sign) other keys. GnuPG only asks for the ownertrust
436 value if it has not yet been assigned to a key. Using the
437 @option{--edit-key} menu, the assigned value can be changed at any time.
438
439 @item --check-trustdb
440 @opindex check-trustdb
441 Do trust database maintenance without user interaction. From time to
442 time the trust database must be updated so that expired keys or
443 signatures and the resulting changes in the Web of Trust can be
444 tracked. Normally, GnuPG will calculate when this is required and do it
445 automatically unless @option{--no-auto-check-trustdb} is set. This
446 command can be used to force a trust database check at any time. The
447 processing is identical to that of @option{--update-trustdb} but it
448 skips keys with a not yet defined "ownertrust".
449
450 For use with cron jobs, this command can be used together with
451 @option{--batch} in which case the trust database check is done only if
452 a check is needed. To force a run even in batch mode add the option
453 @option{--yes}.
454
455 @item --export-ownertrust
456 @opindex export-ownertrust
457 Send the ownertrust values to stdout. This is useful for backup purposes
458 as these values are the only ones which can't be re-created from a
459 corrupted trust DB.
460
461 @item --import-ownertrust
462 @opindex import-ownertrust
463 Update the trustdb with the ownertrust values stored in @code{files} (or
464 stdin if not given); existing values will be overwritten.
465
466 @item --rebuild-keydb-caches
467 @opindex rebuild-keydb-caches
468 When updating from version 1.0.6 to 1.0.7 this command should be used
469 to create signature caches in the keyring. It might be handy in other
470 situations too.
471
472 @item --print-md @code{algo}
473 @itemx --print-mds
474 @opindex print-md
475 Print message digest of algorithm ALGO for all given files or stdin.
476 With the second form (or a deprecated "*" as algo) digests for all
477 available algorithms are printed.
478
479 @item --gen-random @code{0|1|2}
480 @opindex gen-random
481 Emit @var{count} random bytes of the given quality level. If count is
482 not given or zero, an endless sequence of random bytes will be emitted.
483 PLEASE, don't use this command unless you know what you are doing; it
484 may remove precious entropy from the system!
485
486 @item --gen-prime @code{mode}  @code{bits}
487 @opindex gen-prime
488 Use the source, Luke :-). The output format is still subject to change.
489
490
491 @item --enarmor
492 @item --dearmor
493 @opindex enarmor
494 @opindex --enarmor
495 Pack or unpack an arbitrary input into/from an OpenPGP ASCII armor.
496 This is a GnuPG extension to OpenPGP and in general not very useful.
497
498 @end table
499
500
501 @c *******************************************
502 @c *******  KEY MANGEMENT COMMANDS  **********
503 @c *******************************************
504 @node OpenPGP Key Management
505 @subsection How to manage your keys
506
507 This section explains the main commands for key management
508
509 @table @gnupgtabopt
510
511 @item --gen-key
512 @opindex gen-key
513 Generate a new key pair. This command is normally only used
514 interactively.
515
516 There is an experimental feature which allows you to create keys in
517 batch mode. See the file @file{doc/DETAILS} in the source distribution
518 on how to use this.
519
520 @item --gen-revoke @code{name}
521 @opindex gen-revoke
522 Generate a revocation certificate for the complete key. To revoke
523 a subkey or a signature, use the @option{--edit} command.
524
525 @item --desig-revoke @code{name}
526 @opindex desig-revoke
527 Generate a designated revocation certificate for a key. This allows a
528 user (with the permission of the keyholder) to revoke someone else's
529 key.
530
531
532 @item --edit-key
533 @opindex edit-key
534 Present a menu which enables you to do most of the key management
535 related tasks.  It expects the specification of a key on the command
536 line.
537
538 @c ******** Begin Edit-key Options **********
539 @table @asis
540
541 @item sign
542 @opindex keyedit:sign
543 Make a signature on key of user @code{name} If the key is not yet
544 signed by the default user (or the users given with -u), the program
545 displays the information of the key again, together with its
546 fingerprint and asks whether it should be signed. This question is
547 repeated for all users specified with
548 -u.
549
550 @item lsign
551 @opindex keyedit:lsign
552 Same as "sign" but the signature is marked as non-exportable and will
553 therefore never be used by others. This may be used to make keys
554 valid only in the local environment.
555
556 @item nrsign
557 @opindex keyedit:nrsign
558 Same as "sign" but the signature is marked as non-revocable and can
559 therefore never be revoked.
560
561 @item tsign
562 @opindex keyedit:tsign
563 Make a trust signature. This is a signature that combines the notions
564 of certification (like a regular signature), and trust (like the
565 "trust" command). It is generally only useful in distinct communities
566 or groups.
567 @end table
568
569 @c man:.RS
570 Note that "l" (for local / non-exportable), "nr" (for non-revocable,
571 and "t" (for trust) may be freely mixed and prefixed to "sign" to
572 create a signature of any type desired.
573 @c man:.RE
574
575 @table @asis
576
577 @item revsig
578 @opindex keyedit:revsig
579 Revoke a signature. For every signature which has been generated by
580 one of the secret keys, GnuPG asks whether a revocation certificate
581 should be generated.
582
583 @item trust
584 @opindex keyedit:trust
585 Change the owner trust value. This updates the
586 trust-db immediately and no save is required.
587
588 @item disable
589 @itemx enable
590 @opindex keyedit:disable
591 @opindex keyedit:enable
592 Disable or enable an entire key. A disabled key can not normally be
593 used for encryption.
594
595 @item adduid
596 @opindex keyedit:adduid
597 Create an alternate user id.
598
599 @item addphoto
600 @opindex keyedit:addphoto
601 Create a photographic user id. This will prompt for a JPEG file that
602 will be embedded into the user ID. Note that a very large JPEG will make
603 for a very large key. Also note that some programs will display your
604 JPEG unchanged (GnuPG), and some programs will scale it to fit in a
605 dialog box (PGP).
606
607 @item deluid
608 @opindex keyedit:deluid
609 Delete a user id.  Note that it is not possible to retract a user id,
610 once it has been send to the public (i.e. to a keyserver).  In that case
611 you better use @code{revuid}.
612
613 @item delsig
614 @opindex keyedit:delsig
615 Delete a signature. Note that it is not possible to retract a signature,
616 once it has been send to the public (i.e. to a keyserver).  In that case
617 you better use @code{revsig}.
618
619 @item revuid
620 @opindex keyedit:revuid
621 Revoke a user id.
622
623 @item addkey
624 @opindex keyedit:addkey
625 Add a subkey to this key.
626
627 @item addcardkey
628 @opindex keyedit:addcardkey
629 Generate a key on a card and add it to this key.
630
631 @item keytocard
632 @opindex keyedit:keytocard
633 Transfer the selected secret key (or the primary key if no key has been
634 selected) to a smartcard. The secret key in the keyring will be replaced
635 by a stub if the key could be stored successfully on the card and you
636 use the save command later. Only certain key types may be transferred to
637 the card. A sub menu allows you to select on what card to store the
638 key. Note that it is not possible to get that key back from the card -
639 if the card gets broken your secret key will be lost unless you have a
640 backup somewhere.
641
642 @item bkuptocard @code{file}
643 @opindex keyedit:bkuptocard
644 Restore the given file to a card. This command may be used to restore a
645 backup key (as generated during card initialization) to a new card. In
646 almost all cases this will be the encryption key. You should use this
647 command only with the corresponding public key and make sure that the
648 file given as argument is indeed the backup to restore. You should then
649 select 2 to restore as encryption key.  You will first be asked to enter
650 the passphrase of the backup key and then for the Admin PIN of the card.
651
652 @item delkey
653 @opindex keyedit:delkey
654 Remove a subkey (secondart key). Note that it is not possible to retract
655 a subkey, once it has been send to the public (i.e. to a keyserver).  In
656 that case you better use @code{revkey}.
657
658 @item addrevoker
659 @opindex keyedit:addrevoker
660 Add a designated revoker. This takes one optional argument:
661 "sensitive". If a designated revoker is marked as sensitive, it will not
662 be exported by default (see export-options).
663
664 @item revkey
665 @opindex keyedit:revkey
666 Revoke a subkey.
667
668 @item expire
669 @opindex keyedit:expire
670 Change the key expiration time. If a subkey is selected, the
671 expiration time of this subkey will be changed. With no selection,
672 the key expiration of the primary key is changed.
673
674 @item passwd
675 @opindex keyedit:passwd
676 Change the passphrase of the secret key.
677
678 @item primary
679 @opindex keyedit:primary
680 Flag the current user id as the primary one, removes the primary user
681 id flag from all other user ids and sets the timestamp of all affected
682 self-signatures one second ahead. Note that setting a photo user ID
683 as primary makes it primary over other photo user IDs, and setting a
684 regular user ID as primary makes it primary over other regular user
685 IDs.
686
687 @item uid @code{n}
688 @opindex keyedit:uid
689 Toggle selection of user id with index @code{n}.
690 Use 0 to deselect all.
691
692 @item key @code{n}
693 @opindex keyedit:key
694 Toggle selection of subkey with index @code{n}.
695 Use 0 to deselect all.
696
697 @item check
698 @opindex keyedit:check
699 Check all selected user ids.
700
701 @item showphoto
702 @opindex keyedit:showphoto
703 Display the selected photographic user
704 id.
705
706 @item pref
707 @opindex keyedit:pref
708 List preferences from the selected user ID. This shows the actual
709 preferences, without including any implied preferences.
710
711 @item showpref
712 @opindex keyedit:showpref
713 More verbose preferences listing for the selected user ID. This shows
714 the preferences in effect by including the implied preferences of 3DES
715 (cipher), SHA-1 (digest), and Uncompressed (compression) if they are
716 not already included in the preference list. In addition, the
717 preferred keyserver and signature notations (if any) are shown.
718
719 @item setpref @code{string}
720 @opindex keyedit:setpref
721 Set the list of user ID preferences to @code{string} for all (or just
722 the selected) user IDs. Calling setpref with no arguments sets the
723 preference list to the default (either built-in or set via
724 @option{--default-preference-list}), and calling setpref with "none" as
725 the argument sets an empty preference list. Use @command{@gpgname
726 --version} to get a list of available algorithms. Note that while you
727 can change the preferences on an attribute user ID (aka "photo ID"),
728 GnuPG does not select keys via attribute user IDs so these preferences
729 will not be used by GnuPG.
730
731 @item keyserver
732 @opindex keyedit:keyserver
733 Set a preferred keyserver for the specified user ID(s). This allows
734 other users to know where you prefer they get your key from. See
735 @option{--keyserver-options honor-keyserver-url} for more on how this
736 works.  Setting a value of "none" removes an existing preferred
737 keyserver.
738
739 @item notation
740 @opindex keyedit:notation
741 Set a name=value notation for the specified user ID(s). See
742 @option{--cert-notation} for more on how this works. Setting a value of
743 "none" removes all notations, setting a notation prefixed with a minus
744 sign (-) removes that notation, and setting a notation name (without the
745 =value) prefixed with a minus sign removes all notations with that name.
746
747 @item toggle
748 @opindex keyedit:toggle
749 Toggle between public and secret key listing.
750
751 @item clean
752 @opindex keyedit:clean
753 Compact (by removing all signatures except the selfsig) any user ID
754 that is no longer usable (e.g. revoked, or expired). Then, remove any
755 signatures that are not usable by the trust calculations.
756 Specifically, this removes any signature that does not validate, any
757 signature that is superseded by a later signature, revoked signatures,
758 and signatures issued by keys that are not present on the keyring.
759
760 @item minimize
761 @opindex keyedit:minimize
762 Make the key as small as possible. This removes all signatures from
763 each user ID except for the most recent self-signature.
764
765 @item cross-certify
766 @opindex keyedit:cross-certify
767 Add cross-certification signatures to signing subkeys that may not
768 currently have them. Cross-certification signatures protect against a
769 subtle attack against signing subkeys. See
770 @option{--require-cross-certification}.
771
772 @item save
773 @opindex keyedit:save
774 Save all changes to the key rings and quit.
775
776 @item quit
777 @opindex keyedit:quit
778 Quit the program without updating the
779 key rings.
780
781 @end table
782
783 @c man:.RS
784 The listing shows you the key with its secondary keys and all user
785 ids. Selected keys or user ids are indicated by an asterisk. The trust
786 value is displayed with the primary key: the first is the assigned owner
787 trust and the second is the calculated trust value. Letters are used for
788 the values:
789 @c man:.RE
790
791 @table @asis
792
793 @item -
794 No ownertrust assigned / not yet calculated.
795
796 @item e
797 Trust
798 calculation has failed; probably due to an expired key.
799
800 @item q
801 Not enough information for calculation.
802
803 @item n
804 Never trust this key.
805
806 @item m
807 Marginally trusted.
808
809 @item f
810 Fully trusted.
811
812 @item u
813 Ultimately trusted.
814 @end table
815 @c ******** End Edit-key Options **********
816
817 @item --sign-key @code{name}
818 @opindex sign-key
819 Signs a public key with your secret key. This is a shortcut version of
820 the subcommand "sign" from @option{--edit}.
821
822 @item --lsign-key @code{name}
823 @opindex lsign-key
824 Signs a public key with your secret key but marks it as
825 non-exportable. This is a shortcut version of the subcommand "lsign"
826 from @option{--edit-key}.
827
828
829 @end table
830
831
832 @c *******************************************
833 @c ***************            ****************
834 @c ***************  OPTIONS   ****************
835 @c ***************            ****************
836 @c *******************************************
837 @mansect options
838 @node GPG Options
839 @section Option Summary
840
841 @command{@gpgname} comes features a bunch of options to control the exact
842 behaviour and to change the default configuration.
843
844 @menu
845 * GPG Configuration Options::   How to change the configuration.
846 * GPG Key related Options::     Key related options.
847 * GPG Input and Output::        Input and Output.
848 * OpenPGP Options::             OpenPGP protocol specific options.
849 * GPG Esoteric Options::        Doing things one usually don't want to do.
850 @end menu
851
852 Long options can be put in an options file (default
853 "~/.gnupg/gpg.conf"). Short option names will not work - for example,
854 "armor" is a valid option for the options file, while "a" is not. Do not
855 write the 2 dashes, but simply the name of the option and any required
856 arguments. Lines with a hash ('#') as the first non-white-space
857 character are ignored. Commands may be put in this file too, but that is
858 not generally useful as the command will execute automatically with
859 every execution of gpg.
860
861 Please remember that option parsing stops as soon as a non-option is
862 encountered, you can explicitly stop parsing by using the special option
863 @option{--}.
864
865 @c *******************************************
866 @c ********  CONFIGURATION OPTIONS  **********
867 @c *******************************************
868 @node GPG Configuration Options
869 @subsection How to change the configuration
870
871 These options are used to change the configuraton and are usually found
872 in the option file.
873
874 @table @gnupgtabopt
875
876 @item --default-key @var{name}
877 @opindex default-key
878 Use @var{name} as the default key to sign with. If this option is not
879 used, the default key is the first key found in the secret keyring.
880 Note that @option{-u} or @option{--local-user} overrides this option.
881
882 @item --default-recipient @var{name}
883 @opindex default-recipient
884 Use @var{name} as default recipient if option @option{--recipient} is
885 not used and don't ask if this is a valid one. @var{name} must be
886 non-empty.
887
888 @item --default-recipient-self
889 @opindex default-recipient-self
890 Use the default key as default recipient if option @option{--recipient} is not
891 used and don't ask if this is a valid one. The default key is the first
892 one from the secret keyring or the one set with @option{--default-key}.
893
894 @item --no-default-recipient
895 @opindex no-default-recipient
896 Reset @option{--default-recipient} and @option{--default-recipient-self}.
897
898 @item -v, --verbose
899 @opindex verbose
900 Give more information during processing. If used
901 twice, the input data is listed in detail.
902
903 @item --no-verbose
904 @opindex no-verbose
905 Reset verbose level to 0.
906
907 @item -q, --quiet
908 @opindex quiet
909 Try to be as quiet as possible.
910
911 @item --list-options @code{parameters}
912 @opindex list-options
913 This is a space or comma delimited string that gives options used when
914 listing keys and signatures (that is, @option{--list-keys},
915 @option{--list-sigs}, @option{--list-public-keys},
916 @option{--list-secret-keys}, and the @option{--edit-key} functions).
917 Options can be prepended with a @option{no-} (after the two dashes) to
918 give the opposite meaning.  The options are:
919
920 @table @asis
921
922 @item show-photos
923 @opindex list-options:show-photos
924 Causes @option{--list-keys}, @option{--list-sigs},
925 @option{--list-public-keys}, and @option{--list-secret-keys} to display
926 any photo IDs attached to the key.  Defaults to no. See also
927 @option{--photo-viewer}.
928
929 @item show-policy-urls
930 @opindex list-options:show-policy-urls
931 Show policy URLs in the @option{--list-sigs} or @option{--check-sigs}
932 listings.  Defaults to no.
933
934 @item show-notations
935 @itemx show-std-notations
936 @itemx show-user-notations
937 @opindex list-options:show-notations
938 @opindex list-options:show-std-notations
939 @opindex list-options:show-user-notations
940 Show all, IETF standard, or user-defined signature notations in the
941 @option{--list-sigs} or @option{--check-sigs} listings. Defaults to no.
942
943 @item show-keyserver-urls
944
945 Show any preferred keyserver URL in the @option{--list-sigs} or
946 @option{--check-sigs} listings. Defaults to no.
947
948 @item show-uid-validity
949 Display the calculated validity of user IDs during key listings.
950 Defaults to no.
951
952 @item show-unusable-uids
953 Show revoked and expired user IDs in key listings. Defaults to no.
954
955 @item show-unusable-subkeys
956 Show revoked and expired subkeys in key listings. Defaults to no.
957
958 @item show-keyring
959 Display the keyring name at the head of key listings to show which
960 keyring a given key resides on. Defaults to no.
961
962 @item show-sig-expire
963 Show signature expiration dates (if any) during @option{--list-sigs} or
964 @option{--check-sigs} listings. Defaults to no.
965
966 @item show-sig-subpackets
967 Include signature subpackets in the key listing. This option can take an
968 optional argument list of the subpackets to list. If no argument is
969 passed, list all subpackets. Defaults to no. This option is only
970 meaningful when using @option{--with-colons} along with
971 @option{--list-sigs} or @option{--check-sigs}.
972 @end table
973
974 @item --verify-options @code{parameters}
975 This is a space or comma delimited string that gives options used when
976 verifying signatures. Options can be prepended with a `no-' to give
977 the opposite meaning. The options are:
978
979 @table @asis
980
981 @item show-photos
982 Display any photo IDs present on the key that issued the signature.
983 Defaults to no. See also @option{--photo-viewer}.
984
985 @item show-policy-urls
986 Show policy URLs in the signature being verified. Defaults to no.
987
988 @item show-notations
989 @itemx show-std-notations
990 @itemx show-user-notations
991 Show all, IETF standard, or user-defined signature notations in the
992 signature being verified. Defaults to IETF standard.
993
994 @item show-keyserver-urls
995 Show any preferred keyserver URL in the signature being verified.
996 Defaults to no.
997
998 @item show-uid-validity
999 Display the calculated validity of the user IDs on the key that issued
1000 the signature. Defaults to no.
1001
1002 @item show-unusable-uids
1003 Show revoked and expired user IDs during signature verification.
1004 Defaults to no.
1005
1006 @item pka-lookups
1007 Enable PKA lookups to verify sender addresses. Note that PKA is based
1008 on DNS, and so enabling this option may disclose information on when
1009 and what signatures are verified or to whom data is encrypted. This
1010 is similar to the "web bug" described for the auto-key-retrieve
1011 feature.
1012
1013 @item pka-trust-increase
1014 Raise the trust in a signature to full if the signature passes PKA
1015 validation. This option is only meaningful if pka-lookups is set.
1016 @end table
1017
1018 @item --enable-dsa2
1019 @itemx --disable-dsa2
1020 Enables new-style DSA keys which (unlike the old style) may be larger
1021 than 1024 bit and use hashes other than SHA-1 and RIPEMD/160. Note
1022 that very few programs currently support these keys and signatures
1023 from them.
1024
1025 @item --photo-viewer @code{string}
1026 This is the command line that should be run to view a photo ID. "%i"
1027 will be expanded to a filename containing the photo. "%I" does the
1028 same, except the file will not be deleted once the viewer exits.
1029 Other flags are "%k" for the key ID, "%K" for the long key ID, "%f"
1030 for the key fingerprint, "%t" for the extension of the image type
1031 (e.g. "jpg"), "%T" for the MIME type of the image (e.g. "image/jpeg"),
1032 and "%%" for an actual percent sign. If neither %i or %I are present,
1033 then the photo will be supplied to the viewer on standard input.
1034
1035 The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
1036 stdin". Note that if your image viewer program is not secure, then
1037 executing it from GnuPG does not make it secure.
1038
1039 @item --exec-path @code{string}
1040 Sets a list of directories to search for photo viewers and keyserver
1041 helpers. If not provided, keyserver helpers use the compiled-in
1042 default directory, and photo viewers use the $PATH environment
1043 variable.
1044 Note, that on W32 system this value is ignored when searching for
1045 keyserver helpers.
1046
1047 @item --keyring @code{file}
1048 Add @code{file} to the current list of keyrings. If @code{file} begins
1049 with a tilde and a slash, these are replaced by the $HOME directory. If
1050 the filename does not contain a slash, it is assumed to be in the GnuPG
1051 home directory ("~/.gnupg" if @option{--homedir} or $GNUPGHOME is not
1052 used).
1053
1054 Note that this adds a keyring to the current list. If the intent is to
1055 use the specified keyring alone, use @option{--keyring} along with
1056 @option{--no-default-keyring}.
1057
1058 @item --secret-keyring @code{file}
1059 Same as @option{--keyring} but for the secret keyrings.
1060
1061 @item --primary-keyring @code{file}
1062 Designate @code{file} as the primary public keyring. This means that
1063 newly imported keys (via @option{--import} or keyserver
1064 @option{--recv-from}) will go to this keyring.
1065
1066 @item --trustdb-name @code{file}
1067 Use @code{file} instead of the default trustdb. If @code{file} begins
1068 with a tilde and a slash, these are replaced by the $HOME directory. If
1069 the filename does not contain a slash, it is assumed to be in the GnuPG
1070 home directory (@file{~/.gnupg} if @option{--homedir} or $GNUPGHOME is
1071 not used).
1072
1073 @ifset gpgone
1074 @anchor{option --homedir}
1075 @end ifset
1076 @include opt-homedir.texi
1077
1078
1079 @item --pcsc-driver @code{file}
1080 Use @code{file} to access the smartcard reader. The current default is
1081 `libpcsclite.so.1' for GLIBC based systems,
1082 `/System/Library/Frameworks/PCSC.framework/PCSC' for MAC OS X,
1083 `winscard.dll' for Windows and `libpcsclite.so' for other systems.
1084
1085 @item --disable-ccid
1086 Disable the integrated support for CCID compliant readers. This
1087 allows to fall back to one of the other drivers even if the internal
1088 CCID driver can handle the reader. Note, that CCID support is only
1089 available if libusb was available at build time.
1090
1091 @item --reader-port @code{number_or_string}
1092 This option may be used to specify the port of the card terminal. A
1093 value of 0 refers to the first serial device; add 32768 to access USB
1094 devices. The default is 32768 (first USB device). PC/SC or CCID
1095 readers might need a string here; run the program in verbose mode to get
1096 a list of available readers. The default is then the first reader
1097 found.
1098
1099 @item --display-charset @code{name}
1100 Set the name of the native character set. This is used to convert
1101 some informational strings like user IDs to the proper UTF-8 encoding.
1102 Note that this has nothing to do with the character set of data to be
1103 encrypted or signed; GnuPG does not recode user supplied data. If
1104 this option is not used, the default character set is determined from
1105 the current locale. A verbosity level of 3 shows the chosen set.
1106 Valid values for @code{name} are:
1107
1108 @table @asis
1109
1110 @item iso-8859-1
1111 This is the Latin 1 set.
1112
1113 @item iso-8859-2
1114 The Latin 2 set.
1115
1116 @item iso-8859-15
1117 This is currently an alias for
1118 the Latin 1 set.
1119
1120 @item koi8-r
1121 The usual Russian set (rfc1489).
1122
1123 @item utf-8
1124 Bypass all translations and assume
1125 that the OS uses native UTF-8 encoding.
1126 @end table
1127
1128 @item --utf8-strings
1129 @itemx --no-utf8-strings
1130 Assume that command line arguments are given as UTF8 strings. The
1131 default (@option{--no-utf8-strings}) is to assume that arguments are
1132 encoded in the character set as specified by
1133 @option{--display-charset}. These options affect all following
1134 arguments. Both options may be used multiple times.
1135
1136 @ifset gpgone
1137 @anchor{option --options}
1138 @end ifset
1139 @item --options @code{file}
1140 Read options from @code{file} and do not try to read them from the
1141 default options file in the homedir (see @option{--homedir}). This
1142 option is ignored if used in an options file.
1143
1144 @item --no-options
1145 Shortcut for @option{--options /dev/null}. This option is detected
1146 before an attempt to open an option file.  Using this option will also
1147 prevent the creation of a @file{~/.gnupg} homedir.
1148
1149
1150
1151 @item -z @code{n}
1152 @itemx --compress-level @code{n}
1153 @itemx --bzip2-compress-level @code{n}
1154 Set compression level to @code{n} for the ZIP and ZLIB compression
1155 algorithms. The default is to use the default compression level of zlib
1156 (normally 6). @option{--bzip2-compress-level} sets the compression level
1157 for the BZIP2 compression algorithm (defaulting to 6 as well). This is a
1158 different option from @option{--compress-level} since BZIP2 uses a
1159 significant amount of memory for each additional compression level.
1160 @option{-z} sets both. A value of 0 for @code{n} disables compression.
1161
1162 @item --bzip2-decompress-lowmem
1163 Use a different decompression method for BZIP2 compressed files. This
1164 alternate method uses a bit more than half the memory, but also runs
1165 at half the speed. This is useful under extreme low memory
1166 circumstances when the file was originally compressed at a high
1167 @option{--bzip2-compress-level}.
1168
1169
1170 @item --mangle-dos-filenames
1171 @itemx --no-mangle-dos-filenames
1172 @opindex mangle-dos-filenames
1173 @opindex no-mangle-dos-filenames
1174 Older version of Windows cannot handle filenames with more than one
1175 dot. @option{--mangle-dos-filenames} causes GnuPG to replace (rather
1176 than add to) the extension of an output filename to avoid this
1177 problem. This option is off by default and has no effect on non-Windows
1178 platforms.
1179
1180 @item --ask-cert-level
1181 @itemx --no-ask-cert-level
1182 When making a key signature, prompt for a certification level. If this
1183 option is not specified, the certification level used is set via
1184 @option{--default-cert-level}. See @option{--default-cert-level} for
1185 information on the specific levels and how they are
1186 used. @option{--no-ask-cert-level} disables this option. This option
1187 defaults to no.
1188
1189 @item --default-cert-level @code{n}
1190 The default to use for the check level when signing a key.
1191
1192 0 means you make no particular claim as to how carefully you verified
1193 the key.
1194
1195 1 means you believe the key is owned by the person who claims to own
1196 it but you could not, or did not verify the key at all. This is
1197 useful for a "persona" verification, where you sign the key of a
1198 pseudonymous user.
1199
1200 2 means you did casual verification of the key. For example, this
1201 could mean that you verified that the key fingerprint and checked the
1202 user ID on the key against a photo ID.
1203
1204 3 means you did extensive verification of the key. For example, this
1205 could mean that you verified the key fingerprint with the owner of the
1206 key in person, and that you checked, by means of a hard to forge
1207 document with a photo ID (such as a passport) that the name of the key
1208 owner matches the name in the user ID on the key, and finally that you
1209 verified (by exchange of email) that the email address on the key
1210 belongs to the key owner.
1211
1212 Note that the examples given above for levels 2 and 3 are just that:
1213 examples. In the end, it is up to you to decide just what "casual"
1214 and "extensive" mean to you.
1215
1216 This option defaults to 0 (no particular claim).
1217
1218 @item --min-cert-level
1219 When building the trust database, treat any signatures with a
1220 certification level below this as invalid. Defaults to 2, which
1221 disregards level 1 signatures. Note that level 0 "no particular
1222 claim" signatures are always accepted.
1223
1224 @item --trusted-key @code{long key ID}
1225 Assume that the specified key (which must be given
1226 as a full 8 byte key ID) is as trustworthy as one of
1227 your own secret keys. This option is useful if you
1228 don't want to keep your secret keys (or one of them)
1229 online but still want to be able to check the validity of a given
1230 recipient's or signator's key.
1231
1232 @item --trust-model @code{pgp|classic|direct|always|auto}
1233 Set what trust model GnuPG should follow. The models are:
1234
1235 @table @asis
1236
1237 @item pgp
1238 This is the Web of Trust combined with trust signatures as used in PGP
1239 5.x and later. This is the default trust model when creating a new
1240 trust database.
1241
1242 @item classic
1243 This is the standard Web of Trust as used in PGP 2.x and earlier.
1244
1245 @item direct
1246 Key validity is set directly by the user and not calculated via the
1247 Web of Trust.
1248
1249 @item always
1250 Skip key validation and assume that used keys are always fully
1251 trusted. You generally won't use this unless you are using some
1252 external validation scheme. This option also suppresses the
1253 "[uncertain]" tag printed with signature checks when there is no
1254 evidence that the user ID is bound to the key.
1255
1256 @item auto
1257 Select the trust model depending on whatever the internal trust
1258 database says. This is the default model if such a database already
1259 exists.
1260 @end table
1261
1262 @item --auto-key-locate @code{parameters}
1263 @itemx --no-auto-key-locate
1264 GnuPG can automatically locate and retrieve keys as needed using this
1265 option. This happens when encrypting to an email address (in the
1266 "user@@example.com" form), and there are no user@@example.com keys on
1267 the local keyring. This option takes any number of the following
1268 arguments, in the order they are to be tried:
1269
1270 @table @asis
1271
1272 @item cert
1273 locate a key using DNS CERT, as specified in 2538bis (currently in
1274 draft): http://www.josefsson.org/rfc2538bis/
1275
1276 @item pka
1277 locate a key using DNS PKA.
1278
1279 @item ldap
1280 locate a key using the PGP Universal method of checking
1281 "ldap://keys.(thedomain)".
1282
1283 @item keyserver
1284 locate a key using whatever keyserver is defined using the
1285 @option{--keyserver} option.
1286
1287 @item (keyserver URL)
1288 In addition, a keyserver URL as used in the @option{--keyserver} option may be
1289 used here to query that particular keyserver.
1290 @end table
1291
1292 @item --keyid-format @code{short|0xshort|long|0xlong}
1293 Select how to display key IDs. "short" is the traditional 8-character
1294 key ID. "long" is the more accurate (but less convenient)
1295 16-character key ID. Add an "0x" to either to include an "0x" at the
1296 beginning of the key ID, as in 0x99242560.
1297
1298 @item --keyserver @code{name}
1299 Use @code{name} as your keyserver. This is the server that
1300 @option{--recv-keys}, @option{--send-keys}, and @option{--search-keys}
1301 will communicate with to receive keys from, send keys to, and search for
1302 keys on. The format of the @code{name} is a URI:
1303 `scheme:[//]keyservername[:port]' The scheme is the type of keyserver:
1304 "hkp" for the HTTP (or compatible) keyservers, "ldap" for the LDAP
1305 keyservers, or "mailto" for the Graff email keyserver. Note that your
1306 particular installation of GnuPG may have other keyserver types
1307 available as well. Keyserver schemes are case-insensitive. After the
1308 keyserver name, optional keyserver configuration options may be
1309 provided. These are the same as the global @option{--keyserver-options}
1310 from below, but apply only to this particular keyserver.
1311
1312 Most keyservers synchronize with each other, so there is generally no
1313 need to send keys to more than one server. The keyserver
1314 @code{hkp://subkeys.pgp.net} uses round robin DNS to give a different
1315 keyserver each time you use it.
1316
1317 @item --keyserver-options @code{name=value1 }
1318 This is a space or comma delimited string that gives options for the
1319 keyserver. Options can be prepended with a `no-' to give the opposite
1320 meaning. Valid import-options or export-options may be used here as well
1321 to apply to importing (@option{--recv-key}) or exporting
1322 (@option{--send-key}) a key from a keyserver. While not all options are
1323 available for all keyserver types, some common options are:
1324
1325 @table @asis
1326
1327 @item include-revoked
1328 When searching for a key with @option{--search-keys}, include keys that
1329 are marked on the keyserver as revoked. Note that not all keyservers
1330 differentiate between revoked and unrevoked keys, and for such
1331 keyservers this option is meaningless. Note also that most keyservers do
1332 not have cryptographic verification of key revocations, and so turning
1333 this option off may result in skipping keys that are incorrectly marked
1334 as revoked.
1335
1336 @item include-disabled
1337 When searching for a key with @option{--search-keys}, include keys that
1338 are marked on the keyserver as disabled. Note that this option is not
1339 used with HKP keyservers.
1340
1341 @item auto-key-retrieve
1342 This option enables the automatic retrieving of keys from a keyserver
1343 when verifying signatures made by keys that are not on the local
1344 keyring.
1345
1346 Note that this option makes a "web bug" like behavior possible.
1347 Keyserver operators can see which keys you request, so by sending you
1348 a message signed by a brand new key (which you naturally will not have
1349 on your local keyring), the operator can tell both your IP address and
1350 the time when you verified the signature.
1351
1352 @item honor-keyserver-url
1353 When using @option{--refresh-keys}, if the key in question has a preferred
1354 keyserver URL, then use that preferred keyserver to refresh the key
1355 from. In addition, if auto-key-retrieve is set, and the signature
1356 being verified has a preferred keyserver URL, then use that preferred
1357 keyserver to fetch the key from. Defaults to yes.
1358
1359 @item honor-pka-record
1360 If auto-key-retrieve is set, and the signature being verified has a
1361 PKA record, then use the PKA information to fetch the key. Defaults
1362 to yes.
1363
1364 @item include-subkeys
1365 When receiving a key, include subkeys as potential targets. Note that
1366 this option is not used with HKP keyservers, as they do not support
1367 retrieving keys by subkey id.
1368
1369 @item use-temp-files
1370 On most Unix-like platforms, GnuPG communicates with the keyserver
1371 helper program via pipes, which is the most efficient method. This
1372 option forces GnuPG to use temporary files to communicate. On some
1373 platforms (such as Win32 and RISC OS), this option is always enabled.
1374
1375 @item keep-temp-files
1376 If using `use-temp-files', do not delete the temp files after using
1377 them. This option is useful to learn the keyserver communication
1378 protocol by reading the temporary files.
1379
1380 @item verbose
1381 Tell the keyserver helper program to be more verbose. This option can
1382 be repeated multiple times to increase the verbosity level.
1383
1384 @item timeout
1385 Tell the keyserver helper program how long (in seconds) to try and
1386 perform a keyserver action before giving up. Note that performing
1387 multiple actions at the same time uses this timeout value per action.
1388 For example, when retrieving multiple keys via @option{--recv-keys}, the
1389 timeout applies separately to each key retrieval, and not to the
1390 @option{--recv-keys} command as a whole. Defaults to 30 seconds.
1391
1392 @item http-proxy
1393 For HTTP-like keyserver schemes that (such as HKP and HTTP itself),
1394 try to access the keyserver over a proxy. If a @code{value} is
1395 specified, use this as the HTTP proxy. If no @code{value} is
1396 specified, the value of the environment variable "http_proxy", if any,
1397 will be used.
1398
1399 @item max-cert-size
1400 When retrieving a key via DNS CERT, only accept keys up to this size.
1401 Defaults to 16384 bytes.
1402 @end table
1403
1404 @item --completes-needed @code{n}
1405 Number of completely trusted users to introduce a new
1406 key signer (defaults to 1).
1407
1408 @item --marginals-needed @code{n}
1409 Number of marginally trusted users to introduce a new
1410 key signer (defaults to 3)
1411
1412 @item --max-cert-depth @code{n}
1413 Maximum depth of a certification chain (default is 5).
1414
1415 @item --simple-sk-checksum
1416 Secret keys are integrity protected by using a SHA-1 checksum. This
1417 method is part of the upcoming enhanced OpenPGP specification but
1418 GnuPG already uses it as a countermeasure against certain attacks.
1419 Old applications don't understand this new format, so this option may
1420 be used to switch back to the old behaviour. Using this option bears
1421 a security risk. Note that using this option only takes effect when
1422 the secret key is encrypted - the simplest way to make this happen is
1423 to change the passphrase on the key (even changing it to the same
1424 value is acceptable).
1425
1426 @item --no-sig-cache
1427 Do not cache the verification status of key signatures.
1428 Caching gives a much better performance in key listings. However, if
1429 you suspect that your public keyring is not save against write
1430 modifications, you can use this option to disable the caching. It
1431 probably does not make sense to disable it because all kind of damage
1432 can be done if someone else has write access to your public keyring.
1433
1434 @item --no-sig-create-check
1435 GnuPG normally verifies each signature right after creation to protect
1436 against bugs and hardware malfunctions which could leak out bits from
1437 the secret key. This extra verification needs some time (about 115%
1438 for DSA keys), and so this option can be used to disable it.
1439 However, due to the fact that the signature creation needs manual
1440 interaction, this performance penalty does not matter in most settings.
1441
1442 @item --auto-check-trustdb
1443 @itemx --no-auto-check-trustdb
1444 If GnuPG feels that its information about the Web of Trust has to be
1445 updated, it automatically runs the @option{--check-trustdb} command
1446 internally.  This may be a time consuming
1447 process. @option{--no-auto-check-trustdb} disables this option.
1448
1449 @item --use-agent
1450 @itemx --no-use-agent
1451 @ifclear gpgone
1452 This is dummy option. @command{@gpgname} always requires the agent.
1453 @end ifclear
1454 @ifset gpgone
1455 Try to use the GnuPG-Agent.  With this option, GnuPG first tries to
1456 connect to the agent before it asks for a
1457 passphrase. @option{--no-use-agent} disables this option.
1458 @end ifset
1459
1460 @item --gpg-agent-info
1461 Override the value of the environment variable
1462 @samp{GPG_AGENT_INFO}. This is only used when @option{--use-agent} has
1463 been given
1464
1465 @item --lock-once
1466 Lock the databases the first time a lock is requested
1467 and do not release the lock until the process
1468 terminates.
1469
1470 @item --lock-multiple
1471 Release the locks every time a lock is no longer
1472 needed. Use this to override a previous @option{--lock-once}
1473 from a config file.
1474
1475 @item --lock-never
1476 Disable locking entirely. This option should be used only in very
1477 special environments, where it can be assured that only one process
1478 is accessing those files. A bootable floppy with a stand-alone
1479 encryption system will probably use this. Improper usage of this
1480 option may lead to data and key corruption.
1481
1482 @item --exit-on-status-write-error
1483 This option will cause write errors on the status FD to immediately
1484 terminate the process. That should in fact be the default but it never
1485 worked this way and thus we need an option to enable this, so that the
1486 change won't break applications which close their end of a status fd
1487 connected pipe too early. Using this option along with
1488 @option{--enable-progress-filter} may be used to cleanly cancel long
1489 running gpg operations.
1490
1491 @item --limit-card-insert-tries @code{n}
1492 With @code{n} greater than 0 the number of prompts asking to insert a
1493 smartcard gets limited to N-1. Thus with a value of 1 gpg won't at
1494 all ask to insert a card if none has been inserted at startup. This
1495 option is useful in the configuration file in case an application does
1496 not know about the smartcard support and waits ad infinitum for an
1497 inserted card.
1498
1499 @item --no-random-seed-file
1500 GnuPG uses a file to store its internal random pool over invocations.
1501 This makes random generation faster; however sometimes write operations
1502 are not desired. This option can be used to achieve that with the cost of
1503 slower random generation.
1504
1505 @item --no-greeting
1506 Suppress the initial copyright message.
1507
1508 @item --no-secmem-warning
1509 Suppress the warning about "using insecure memory".
1510
1511 @item --no-permission-warning
1512 Suppress the warning about unsafe file and home directory (@option{--homedir})
1513 permissions. Note that the permission checks that GnuPG performs are
1514 not intended to be authoritative, but rather they simply warn about
1515 certain common permission problems. Do not assume that the lack of a
1516 warning means that your system is secure.
1517
1518 Note that the warning for unsafe @option{--homedir} permissions cannot be
1519 suppressed in the gpg.conf file, as this would allow an attacker to
1520 place an unsafe gpg.conf file in place, and use this file to suppress
1521 warnings about itself. The @option{--homedir} permissions warning may only be
1522 suppressed on the command line.
1523
1524 @item --no-mdc-warning
1525 Suppress the warning about missing MDC integrity protection.
1526
1527 @item --require-secmem
1528 @itemx --no-require-secmem
1529 Refuse to run if GnuPG cannot get secure memory. Defaults to no
1530 (i.e. run, but give a warning).
1531
1532
1533 @item --require-cross-certification
1534 @itemx --no-require-cross-certification
1535 When verifying a signature made from a subkey, ensure that the cross
1536 certification "back signature" on the subkey is present and valid.  This
1537 protects against a subtle attack against subkeys that can sign.
1538 Defaults to @option{--require-cross-certification} for
1539 @command{@gpgname}.
1540
1541 @item --expert
1542 @itemx --no-expert
1543 Allow the user to do certain nonsensical or "silly" things like
1544 signing an expired or revoked key, or certain potentially incompatible
1545 things like generating unusual key types. This also disables certain
1546 warning messages about potentially incompatible actions. As the name
1547 implies, this option is for experts only. If you don't fully
1548 understand the implications of what it allows you to do, leave this
1549 off. @option{--no-expert} disables this option.
1550
1551
1552
1553
1554 @end table
1555
1556
1557 @c *******************************************
1558 @c ********  KEY RELATED OPTIONS  ************
1559 @c *******************************************
1560 @node GPG Key related Options
1561 @subsection Key related options
1562
1563 @table @gnupgtabopt
1564
1565 @item --recipient @var{name}
1566 @itemx -r
1567 @opindex recipient
1568 Encrypt for user id @var{name}. If this option or
1569 @option{--hidden-recipient} is not specified, GnuPG asks for the user-id
1570 unless @option{--default-recipient} is given.
1571
1572 @item --hidden-recipient @var{name}
1573 @itemx -R
1574 @opindex hidden-recipient
1575 Encrypt for user ID @var{name}, but hide the key ID of this user's
1576 key. This option helps to hide the receiver of the message and is a
1577 limited countermeasure against traffic analysis. If this option or
1578 @option{--recipient} is not specified, GnuPG asks for the user ID unless
1579 @option{--default-recipient} is given.
1580
1581 @item --encrypt-to @code{name}
1582 Same as @option{--recipient} but this one is intended for use in the
1583 options file and may be used with your own user-id as an
1584 "encrypt-to-self". These keys are only used when there are other
1585 recipients given either by use of @option{--recipient} or by the asked
1586 user id.  No trust checking is performed for these user ids and even
1587 disabled keys can be used.
1588
1589 @item --hidden-encrypt-to @code{name}
1590 Same as @option{--hidden-recipient} but this one is intended for use in the
1591 options file and may be used with your own user-id as a hidden
1592 "encrypt-to-self". These keys are only used when there are other
1593 recipients given either by use of @option{--recipient} or by the asked user id.
1594 No trust checking is performed for these user ids and even disabled
1595 keys can be used.
1596
1597 @item --no-encrypt-to
1598 Disable the use of all @option{--encrypt-to} and
1599 @option{--hidden-encrypt-to} keys.
1600
1601 @item --group @code{name=value1 }
1602 Sets up a named group, which is similar to aliases in email programs.
1603 Any time the group name is a recipient (@option{-r} or
1604 @option{--recipient}), it will be expanded to the values
1605 specified. Multiple groups with the same name are automatically merged
1606 into a single group.
1607
1608 The values are @code{key IDs} or fingerprints, but any key description
1609 is accepted. Note that a value with spaces in it will be treated as
1610 two different values. Note also there is only one level of expansion
1611 --- you cannot make an group that points to another group. When used
1612 from the command line, it may be necessary to quote the argument to
1613 this option to prevent the shell from treating it as multiple
1614 arguments.
1615
1616 @item --ungroup @code{name}
1617 Remove a given entry from the @option{--group} list.
1618
1619 @item --no-groups
1620 Remove all entries from the @option{--group} list.
1621
1622 @item --local-user @var{name}
1623 @itemx -u
1624 @opindex local-user
1625 Use @var{name} as the key to sign with. Note that this option overrides
1626 @option{--default-key}.
1627
1628 @item --try-all-secrets
1629 Don't look at the key ID as stored in the message but try all secret
1630 keys in turn to find the right decryption key. This option forces the
1631 behaviour as used by anonymous recipients (created by using
1632 @option{--throw-keyids}) and might come handy in case where an encrypted
1633 message contains a bogus key ID.
1634
1635
1636
1637
1638
1639 @end table
1640
1641 @c *******************************************
1642 @c ********  INPUT AND OUTPUT  ***************
1643 @c *******************************************
1644 @node GPG Input and Output
1645 @subsection Input and Output
1646
1647 @table @gnupgtabopt
1648
1649 @item --armor
1650 @itemx -a
1651 @opindex armor
1652 Create ASCII armored output.  The default is to create the binary
1653 OpenPGP format.
1654
1655 @item --no-armor
1656 Assume the input data is not in ASCII armored format.
1657
1658 @item --output @var{file}
1659 @itemx -o @var{file}
1660 @opindex output
1661 Write output to @var{file}.
1662
1663 @item --max-output @code{n}
1664 @opindex max-output
1665 This option sets a limit on the number of bytes that will be generated
1666 when processing a file. Since OpenPGP supports various levels of
1667 compression, it is possible that the plaintext of a given message may be
1668 significantly larger than the original OpenPGP message. While GnuPG
1669 works properly with such messages, there is often a desire to set a
1670 maximum file size that will be generated before processing is forced to
1671 stop by the OS limits. Defaults to 0, which means "no limit".
1672
1673 @item --import-options @code{parameters}
1674 This is a space or comma delimited string that gives options for
1675 importing keys. Options can be prepended with a `no-' to give the
1676 opposite meaning. The options are:
1677
1678 @table @asis
1679
1680 @item import-local-sigs
1681 Allow importing key signatures marked as "local". This is not
1682 generally useful unless a shared keyring scheme is being used.
1683 Defaults to no.
1684
1685 @item repair-pks-subkey-bug
1686 During import, attempt to repair the damage caused by the PKS keyserver
1687 bug (pre version 0.9.6) that mangles keys with multiple subkeys. Note
1688 that this cannot completely repair the damaged key as some crucial data
1689 is removed by the keyserver, but it does at least give you back one
1690 subkey. Defaults to no for regular @option{--import} and to yes for
1691 keyserver @option{--recv-keys}.
1692
1693 @item merge-only
1694 During import, allow key updates to existing keys, but do not allow
1695 any new keys to be imported. Defaults to no.
1696
1697 @item import-clean
1698 After import, compact (remove all signatures except the
1699 self-signature) any user IDs from the new key that are not usable.
1700 Then, remove any signatures from the new key that are not usable.
1701 This includes signatures that were issued by keys that are not present
1702 on the keyring. This option is the same as running the @option{--edit-key}
1703 command "clean" after import. Defaults to no.
1704
1705 @item import-minimal
1706 Import the smallest key possible. This removes all signatures except
1707 the most recent self-signature on each user ID. This option is the
1708 same as running the @option{--edit-key} command "minimize" after import.
1709 Defaults to no.
1710 @end table
1711
1712 @item --export-options @code{parameters}
1713 This is a space or comma delimited string that gives options for
1714 exporting keys. Options can be prepended with a `no-' to give the
1715 opposite meaning. The options are:
1716
1717 @table @asis
1718
1719 @item export-local-sigs
1720 Allow exporting key signatures marked as "local". This is not
1721 generally useful unless a shared keyring scheme is being used.
1722 Defaults to no.
1723
1724 @item export-attributes
1725 Include attribute user IDs (photo IDs) while exporting. This is
1726 useful to export keys if they are going to be used by an OpenPGP
1727 program that does not accept attribute user IDs. Defaults to yes.
1728
1729 @item export-sensitive-revkeys
1730 Include designated revoker information that was marked as
1731 "sensitive". Defaults to no.
1732
1733 @item export-reset-subkey-passwd
1734 When using the @option{--export-secret-subkeys} command, this option resets
1735 the passphrases for all exported subkeys to empty. This is useful
1736 when the exported subkey is to be used on an unattended machine where
1737 a passphrase doesn't necessarily make sense. Defaults to no.
1738
1739 @item export-clean
1740 Compact (remove all signatures from) user IDs on the key being
1741 exported if the user IDs are not usable. Also, do not export any
1742 signatures that are not usable. This includes signatures that were
1743 issued by keys that are not present on the keyring. This option is
1744 the same as running the @option{--edit-key} command "clean" before export
1745 except that the local copy of the key is not modified. Defaults to
1746 no.
1747
1748 @item export-minimal
1749 Export the smallest key possible. This removes all signatures except the
1750 most recent self-signature on each user ID. This option is the same as
1751 running the @option{--edit-key} command "minimize" before export except
1752 that the local copy of the key is not modified. Defaults to no.
1753 @end table
1754
1755 @item --with-colons
1756 @opindex with-colons
1757 Print key listings delimited by colons. Note that the output will be
1758 encoded in UTF-8 regardless of any @option{--display-charset} setting. This
1759 format is useful when GnuPG is called from scripts and other programs
1760 as it is easily machine parsed. The details of this format are
1761 documented in the file @file{doc/DETAILS}, which is included in the GnuPG
1762 source distribution.
1763
1764 @item --fixed-list-mode
1765 @opindex fixed-list-mode
1766 Do not merge primary user ID and primary key in @option{--with-colon}
1767 listing mode and print all timestamps as seconds since 1970-01-01.
1768
1769 @item --with-fingerprint
1770 @opindex with-fingerprint
1771 Same as the command @option{--fingerprint} but changes only the format
1772 of the output and may be used together with another command.
1773
1774
1775 @end table
1776
1777 @c *******************************************
1778 @c ********  OPENPGP OPTIONS  ****************
1779 @c *******************************************
1780 @node OpenPGP Options
1781 @subsection OpenPGP protocol specific options.
1782
1783 @table @gnupgtabopt
1784
1785 @item -t, --textmode
1786 @itemx --no-textmode
1787 Treat input files as text and store them in the OpenPGP canonical text
1788 form with standard "CRLF" line endings. This also sets the necessary
1789 flags to inform the recipient that the encrypted or signed data is text
1790 and may need its line endings converted back to whatever the local
1791 system uses. This option is useful when communicating between two
1792 platforms that have different line ending conventions (UNIX-like to Mac,
1793 Mac to Windows, etc). @option{--no-textmode} disables this option, and
1794 is the default.
1795
1796 @ifset gpgone
1797 If @option{-t} (but not @option{--textmode}) is used together with
1798 armoring and signing, this enables clearsigned messages. This kludge is
1799 needed for command-line compatibility with command-line versions of PGP;
1800 normally you would use @option{--sign} or @option{--clearsign} to select
1801 the type of the signature.
1802 @end ifset
1803
1804
1805
1806 @item --force-v3-sigs
1807 @itemx --no-force-v3-sigs
1808 OpenPGP states that an implementation should generate v4 signatures
1809 but PGP versions 5 through 7 only recognize v4 signatures on key
1810 material. This option forces v3 signatures for signatures on data.
1811 Note that this option overrides @option{--ask-sig-expire}, as v3 signatures
1812 cannot have expiration dates. @option{--no-force-v3-sigs} disables this
1813 option.
1814
1815 @item --force-v4-certs
1816 @itemx --no-force-v4-certs
1817 Always use v4 key signatures even on v3 keys. This option also
1818 changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1.
1819 @option{--no-force-v4-certs} disables this option.
1820
1821 @item --force-mdc
1822 Force the use of encryption with a modification detection code. This
1823 is always used with the newer ciphers (those with a blocksize greater
1824 than 64 bits), or if all of the recipient keys indicate MDC support in
1825 their feature flags.
1826
1827 @item --disable-mdc
1828 Disable the use of the modification detection code. Note that by
1829 using this option, the encrypted message becomes vulnerable to a
1830 message modification attack.
1831
1832 @item --personal-cipher-preferences @code{string}
1833 Set the list of personal cipher preferences to @code{string}, this list
1834 should be a string similar to the one printed by the command "pref" in
1835 the edit menu. This allows the user to factor in their own preferred
1836 algorithms when algorithms are chosen via recipient key preferences.
1837 The most highly ranked cipher in this list is also used for the
1838 @option{--symmetric} encryption command.
1839
1840 @item --personal-digest-preferences @code{string}
1841 Set the list of personal digest preferences to @code{string}, this list
1842 should be a string similar to the one printed by the command "pref" in
1843 the edit menu. This allows the user to factor in their own preferred
1844 algorithms when algorithms are chosen via recipient key preferences.
1845 The most highly ranked digest algorithm in this list is algo used when
1846 signing without encryption (e.g. @option{--clearsign} or
1847 @option{--sign}). The default value is SHA-1.
1848
1849 @item --personal-compress-preferences @code{string}
1850 Set the list of personal compression preferences to @code{string}, this
1851 list should be a string similar to the one printed by the command
1852 "pref" in the edit menu. This allows the user to factor in their own
1853 preferred algorithms when algorithms are chosen via recipient key
1854 preferences. The most highly ranked algorithm in this list is also
1855 used when there are no recipient keys to consider (e.g. @option{--symmetric}).
1856
1857
1858
1859 @item --s2k-cipher-algo @code{name}
1860 Use @code{name} as the cipher algorithm used to protect secret keys.
1861 The default cipher is CAST5. This cipher is also used for
1862 conventional encryption if @option{--personal-cipher-preferences} and
1863 @option{--cipher-algo} is not given.
1864
1865 @item --s2k-digest-algo @code{name}
1866 Use @code{name} as the digest algorithm used to mangle the passphrases.
1867 The default algorithm is SHA-1.
1868
1869 @item --s2k-mode @code{n}
1870 Selects how passphrases are mangled. If @code{n} is 0 a plain
1871 passphrase (which is not recommended) will be used, a 1 adds a salt to
1872 the passphrase and a 3 (the default) iterates the whole process a
1873 number of times (see --s2k-count).  Unless @option{--rfc1991} is used,
1874 this mode is also used for conventional encryption.
1875
1876 @item --s2k-count @code{n}
1877 Specify how many times the passphrase mangling is repeated.  This
1878 value may range between 1024 and 65011712 inclusive, and the default
1879 is 65536.  Note that not all values in the 1024-65011712 range are
1880 legal and if an illegal value is selected, GnuPG will round up to the
1881 nearest legal value.  This option is only meaningful if
1882 @option{--s2k-mode} is 3.
1883
1884
1885 @end table
1886
1887 @c ***************************
1888 @c ******* Compliance ********
1889 @c ***************************
1890 @subsection Compliance options
1891
1892 These options control what GnuPG is compliant to. Only one of these
1893 options may be active at a time. Note that the default setting of
1894 this is nearly always the correct one. See the INTEROPERABILITY WITH
1895 OTHER OPENPGP PROGRAMS section below before using one of these
1896 options.
1897
1898 @table @gnupgtabopt
1899
1900 @item --gnupg
1901 @opindex gnupg
1902 Use standard GnuPG behavior. This is essentially OpenPGP behavior
1903 (see @option{--openpgp}), but with some additional workarounds for common
1904 compatibility problems in different versions of PGP. This is the
1905 default option, so it is not generally needed, but it may be useful to
1906 override a different compliance option in the gpg.conf file.
1907
1908 @item --openpgp
1909 @opindex openpgp
1910 Reset all packet, cipher and digest options to strict OpenPGP
1911 behavior. Use this option to reset all previous options like
1912 @option{--rfc1991}, @option{--force-v3-sigs}, @option{--s2k-*},
1913 @option{--cipher-algo}, @option{--digest-algo} and
1914 @option{--compress-algo} to OpenPGP compliant values. All PGP
1915 workarounds are disabled.
1916
1917 @item --rfc2440
1918 @opindex rfc2440
1919 Reset all packet, cipher and digest options to strict RFC-2440
1920 behavior. Note that this is currently the same thing as @option{--openpgp}.
1921
1922 @item --rfc1991
1923 @opindex rfc1991
1924 Try to be more RFC-1991 (PGP 2.x) compliant.
1925
1926 @item --pgp2
1927 @opindex pgp2
1928 Set up all options to be as PGP 2.x compliant as possible, and warn if
1929 an action is taken (e.g. encrypting to a non-RSA key) that will create
1930 a message that PGP 2.x will not be able to handle. Note that `PGP
1931 2.x' here means `MIT PGP 2.6.2'. There are other versions of PGP 2.x
1932 available, but the MIT release is a good common baseline.
1933
1934 This option implies @option{--rfc1991 --disable-mdc --no-force-v4-certs
1935 --no-sk-comment --escape-from-lines --force-v3-sigs --no-ask-sig-expire
1936 --no-ask-cert-expire --cipher-algo IDEA --digest-algo MD5
1937 --compress-algo 1}. It also disables @option{--textmode} when
1938 encrypting.
1939
1940 @item --pgp6
1941 @opindex pgp6
1942 Set up all options to be as PGP 6 compliant as possible. This
1943 restricts you to the ciphers IDEA (if the IDEA plugin is installed),
1944 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the
1945 compression algorithms none and ZIP. This also disables
1946 --throw-keyids, and making signatures with signing subkeys as PGP 6
1947 does not understand signatures made by signing subkeys.
1948
1949 This option implies @option{--disable-mdc --no-sk-comment
1950 --escape-from-lines --force-v3-sigs --no-ask-sig-expire}.
1951
1952 @item --pgp7
1953 @opindex pgp7
1954 Set up all options to be as PGP 7 compliant as possible. This is
1955 identical to @option{--pgp6} except that MDCs are not disabled, and the
1956 list of allowable ciphers is expanded to add AES128, AES192, AES256, and
1957 TWOFISH.
1958
1959 @item --pgp8
1960 @opindex pgp8
1961 Set up all options to be as PGP 8 compliant as possible. PGP 8 is a lot
1962 closer to the OpenPGP standard than previous versions of PGP, so all
1963 this does is disable @option{--throw-keyids} and set
1964 @option{--escape-from-lines}.  All algorithms are allowed except for the
1965 SHA224, SHA384, and SHA512 digests.
1966
1967 @end table
1968
1969
1970 @c *******************************************
1971 @c ********  ESOTERIC OPTIONS  ***************
1972 @c *******************************************
1973 @node GPG Esoteric Options
1974 @subsection Doing things one usually don't want to do.
1975
1976 @table @gnupgtabopt
1977
1978 @item -n
1979 @itemx --dry-run
1980 @opindex dry-run
1981 Don't make any changes (this is not completely implemented).
1982
1983 @item --list-only
1984 Changes the behaviour of some commands. This is like @option{--dry-run} but
1985 different in some cases. The semantic of this command may be extended in
1986 the future. Currently it only skips the actual decryption pass and
1987 therefore enables a fast listing of the encryption keys.
1988
1989 @item -i
1990 @itemx --interactive
1991 @opindex interactive
1992 Prompt before overwriting any files.
1993
1994 @item --debug @var{flags}
1995 @opindex debug
1996 Set debugging flags. All flags are or-ed and @var{flags} may
1997 be given in C syntax (e.g. 0x0042).
1998
1999 @item --debug-all
2000 Set all useful debugging flags.
2001
2002 @ifset gpgone
2003 @item --debug-ccid-driver
2004 Enable debug output from the included CCID driver for smartcards.
2005 Note that this option is only available on some system.
2006 @end ifset
2007
2008 @item --enable-progress-filter
2009 Enable certain PROGRESS status outputs. This option allows frontends
2010 to display a progress indicator while gpg is processing larger files.
2011 There is a slight performance overhead using it.
2012
2013 @item --status-fd @code{n}
2014 Write special status strings to the file descriptor @code{n}.
2015 See the file DETAILS in the documentation for a listing of them.
2016
2017 @item --status-file @code{file}
2018 Same as @option{--status-fd}, except the status data is written to file
2019 @code{file}.
2020
2021 @item --logger-fd @code{n}
2022 Write log output to file descriptor @code{n} and not to stderr.
2023
2024 @item --logger-file @code{file}
2025 Same as @option{--logger-fd}, except the logger data is written to file
2026 @code{file}.
2027
2028 @item --attribute-fd @code{n}
2029 Write attribute subpackets to the file descriptor @code{n}. This is most
2030 useful for use with @option{--status-fd}, since the status messages are
2031 needed to separate out the various subpackets from the stream delivered
2032 to the file descriptor.
2033
2034 @item --attribute-file @code{file}
2035 Same as @option{--attribute-fd}, except the attribute data is written to
2036 file @code{file}.
2037
2038 @item --comment @code{string}
2039 @itemx --no-comments
2040 Use @code{string} as a comment string in clear text signatures and ASCII
2041 armored messages or keys (see @option{--armor}). The default behavior is
2042 not to use a comment string. @option{--comment} may be repeated multiple
2043 times to get multiple comment strings. @option{--no-comments} removes
2044 all comments.  It is a good idea to keep the length of a single comment
2045 below 60 characters to avoid problems with mail programs wrapping such
2046 lines.  Note that comment lines, like all other header lines, are not
2047 protected by the signature.
2048
2049 @item --emit-version
2050 @itemx --no-emit-version
2051 Force inclusion of the version string in ASCII armored output.
2052 @option{--no-emit-version} disables this option.
2053
2054 @item --sig-notation @code{name=value}
2055 @itemx --cert-notation @code{name=value}
2056 @itemx -N, --set-notation @code{name=value}
2057 Put the name value pair into the signature as notation data.
2058 @code{name} must consist only of printable characters or spaces, and
2059 must contain a '@@' character in the form keyname@@domain.example.com
2060 (substituting the appropriate keyname and domain name, of course).  This
2061 is to help prevent pollution of the IETF reserved notation
2062 namespace. The @option{--expert} flag overrides the '@@'
2063 check. @code{value} may be any printable string; it will be encoded in
2064 UTF8, so you should check that your @option{--display-charset} is set
2065 correctly. If you prefix @code{name} with an exclamation mark (!), the
2066 notation data will be flagged as critical
2067 (rfc2440:5.2.3.15). @option{--sig-notation} sets a notation for data
2068 signatures. @option{--cert-notation} sets a notation for key signatures
2069 (certifications). @option{--set-notation} sets both.
2070
2071 There are special codes that may be used in notation names. "%k" will
2072 be expanded into the key ID of the key being signed, "%K" into the
2073 long key ID of the key being signed, "%f" into the fingerprint of the
2074 key being signed, "%s" into the key ID of the key making the
2075 signature, "%S" into the long key ID of the key making the signature,
2076 "%g" into the fingerprint of the key making the signature (which might
2077 be a subkey), "%p" into the fingerprint of the primary key of the key
2078 making the signature, "%c" into the signature count from the OpenPGP
2079 smartcard, and "%%" results in a single "%". %k, %K, and %f are only
2080 meaningful when making a key signature (certification), and %c is only
2081 meaningful when using the OpenPGP smartcard.
2082
2083 @item --sig-policy-url @code{string}
2084 @itemx --cert-policy-url @code{string}
2085 @itemx --set-policy-url @code{string}
2086 Use @code{string} as a Policy URL for signatures (rfc2440:5.2.3.19).  If
2087 you prefix it with an exclamation mark (!), the policy URL packet will
2088 be flagged as critical. @option{--sig-policy-url} sets a policy url for
2089 data signatures. @option{--cert-policy-url} sets a policy url for key
2090 signatures (certifications). @option{--set-policy-url} sets both.
2091
2092 The same %-expandos used for notation data are available here as well.
2093
2094 @item --sig-keyserver-url @code{string}
2095 Use @code{string} as a preferred keyserver URL for data signatures. If
2096 you prefix it with an exclamation mark, the keyserver URL packet will
2097 be flagged as critical.
2098
2099 The same %-expandos used for notation data are available here as well.
2100
2101 @item --set-filename @code{string}
2102 Use @code{string} as the filename which is stored inside messages.
2103 This overrides the default, which is to use the actual filename of the
2104 file being encrypted.
2105
2106 @item --for-your-eyes-only
2107 @itemx --no-for-your-eyes-only
2108 Set the `for your eyes only' flag in the message. This causes GnuPG
2109 to refuse to save the file unless the @option{--output} option is given, and
2110 PGP to use the "secure viewer" with a Tempest-resistant font to
2111 display the message. This option overrides @option{--set-filename}.
2112 @option{--no-for-your-eyes-only} disables this option.
2113
2114 @item --use-embedded-filename
2115 @itemx --no-use-embedded-filename
2116 Try to create a file with a name as embedded in the data. This can be
2117 a dangerous option as it allows to overwrite files. Defaults to no.
2118
2119 @item --cipher-algo @code{name}
2120 Use @code{name} as cipher algorithm. Running the program with the
2121 command @option{--version} yields a list of supported algorithms. If
2122 this is not used the cipher algorithm is selected from the preferences
2123 stored with the key. In general, you do not want to use this option as
2124 it allows you to violate the OpenPGP standard.
2125 @option{--personal-cipher-preferences} is the safe way to accomplish the
2126 same thing.
2127
2128 @item --digest-algo @code{name}
2129 Use @code{name} as the message digest algorithm. Running the program
2130 with the command @option{--version} yields a list of supported algorithms. In
2131 general, you do not want to use this option as it allows you to
2132 violate the OpenPGP standard. @option{--personal-digest-preferences} is the
2133 safe way to accomplish the same thing.
2134
2135 @item --compress-algo @code{name}
2136 Use compression algorithm @code{name}. "zlib" is RFC-1950 ZLIB
2137 compression. "zip" is RFC-1951 ZIP compression which is used by PGP.
2138 "bzip2" is a more modern compression scheme that can compress some
2139 things better than zip or zlib, but at the cost of more memory used
2140 during compression and decompression. "uncompressed" or "none"
2141 disables compression. If this option is not used, the default
2142 behavior is to examine the recipient key preferences to see which
2143 algorithms the recipient supports. If all else fails, ZIP is used for
2144 maximum compatibility.
2145
2146 ZLIB may give better compression results than ZIP, as the compression
2147 window size is not limited to 8k. BZIP2 may give even better
2148 compression results than that, but will use a significantly larger
2149 amount of memory while compressing and decompressing. This may be
2150 significant in low memory situations. Note, however, that PGP (all
2151 versions) only supports ZIP compression. Using any algorithm other
2152 than ZIP or "none" will make the message unreadable with PGP. In
2153 general, you do not want to use this option as it allows you to
2154 violate the OpenPGP standard. @option{--personal-compress-preferences} is the
2155 safe way to accomplish the same thing.
2156
2157 @item --cert-digest-algo @code{name}
2158 Use @code{name} as the message digest algorithm used when signing a
2159 key. Running the program with the command @option{--version} yields a
2160 list of supported algorithms. Be aware that if you choose an algorithm
2161 that GnuPG supports but other OpenPGP implementations do not, then some
2162 users will not be able to use the key signatures you make, or quite
2163 possibly your entire key.
2164
2165 @item --disable-cipher-algo @code{name}
2166 Never allow the use of @code{name} as cipher algorithm.
2167 The given name will not be checked so that a later loaded algorithm
2168 will still get disabled.
2169
2170 @item --disable-pubkey-algo @code{name}
2171 Never allow the use of @code{name} as public key algorithm.
2172 The given name will not be checked so that a later loaded algorithm
2173 will still get disabled.
2174
2175 @item --throw-keyids
2176 @itemx --no-throw-keyids
2177 Do not put the recipient key IDs into encrypted messages. This helps
2178 to hide the receivers of the message and is a limited countermeasure
2179 against traffic analysis. On the receiving side, it may slow down the
2180 decryption process because all available secret keys must be tried.
2181 @option{--no-throw-keyids} disables this option. This option is essentially
2182 the same as using @option{--hidden-recipient} for all recipients.
2183
2184 @item --not-dash-escaped
2185 This option changes the behavior of cleartext signatures
2186 so that they can be used for patch files. You should not
2187 send such an armored file via email because all spaces
2188 and line endings are hashed too. You can not use this
2189 option for data which has 5 dashes at the beginning of a
2190 line, patch files don't have this. A special armor header
2191 line tells GnuPG about this cleartext signature option.
2192
2193 @item --escape-from-lines
2194 @itemx --no-escape-from-lines
2195 Because some mailers change lines starting with "From " to ">From " it
2196 is good to handle such lines in a special way when creating cleartext
2197 signatures to prevent the mail system from breaking the signature. Note
2198 that all other PGP versions do it this way too.  Enabled by
2199 default. @option{--no-escape-from-lines} disables this option.
2200
2201 @item --passphrase-repeat @code{n}
2202 Specify how many times @command{@gpgname} will request a new
2203 passphrase be repeated.  This is useful for helping memorize a
2204 passphrase.  Defaults to 1 repetition.
2205
2206 @item --passphrase-fd @code{n}
2207 Read the passphrase from file descriptor @code{n}. Only the first line
2208 will be read from file descriptor @code{n}. If you use 0 for @code{n},
2209 the passphrase will be read from stdin. This can only be used if only
2210 one passphrase is supplied.
2211 @ifclear gpgone
2212 Note that this passphrase is only used if the option @option{--batch}
2213 has also been given.  This is different from @command{gpg}.
2214 @end ifclear
2215
2216 @item --passphrase-file @code{file}
2217 Read the passphrase from file @code{file}. Only the first line will
2218 be read from file @code{file}. This can only be used if only one
2219 passphrase is supplied. Obviously, a passphrase stored in a file is
2220 of questionable security if other users can read this file. Don't use
2221 this option if you can avoid it.
2222 @ifclear gpgone
2223 Note that this passphrase is only used if the option @option{--batch}
2224 has also been given.  This is different from @command{gpg}.
2225 @end ifclear
2226
2227 @item --passphrase @code{string}
2228 Use @code{string} as the passphrase. This can only be used if only one
2229 passphrase is supplied. Obviously, this is of very questionable
2230 security on a multi-user system. Don't use this option if you can
2231 avoid it.
2232 @ifclear gpgone
2233 Note that this passphrase is only used if the option @option{--batch}
2234 has also been given.  This is different from @command{gpg}.
2235 @end ifclear
2236
2237 @item --command-fd @code{n}
2238 This is a replacement for the deprecated shared-memory IPC mode.
2239 If this option is enabled, user input on questions is not expected
2240 from the TTY but from the given file descriptor. It should be used
2241 together with @option{--status-fd}. See the file doc/DETAILS in the source
2242 distribution for details on how to use it.
2243
2244 @item --command-file @code{file}
2245 Same as @option{--command-fd}, except the commands are read out of file
2246 @code{file}
2247
2248 @item --allow-non-selfsigned-uid
2249 @itemx --no-allow-non-selfsigned-uid
2250 Allow the import and use of keys with user IDs which are not
2251 self-signed. This is not recommended, as a non self-signed user ID is
2252 trivial to forge. @option{--no-allow-non-selfsigned-uid} disables.
2253
2254 @item --allow-freeform-uid
2255 Disable all checks on the form of the user ID while generating a new
2256 one. This option should only be used in very special environments as
2257 it does not ensure the de-facto standard format of user IDs.
2258
2259 @item --ignore-time-conflict
2260 GnuPG normally checks that the timestamps associated with keys and
2261 signatures have plausible values. However, sometimes a signature
2262 seems to be older than the key due to clock problems. This option
2263 makes these checks just a warning. See also @option{--ignore-valid-from} for
2264 timestamp issues on subkeys.
2265
2266 @item --ignore-valid-from
2267 GnuPG normally does not select and use subkeys created in the future.
2268 This option allows the use of such keys and thus exhibits the
2269 pre-1.0.7 behaviour. You should not use this option unless you there
2270 is some clock problem. See also @option{--ignore-time-conflict} for timestamp
2271 issues with signatures.
2272
2273 @item --ignore-crc-error
2274 The ASCII armor used by OpenPGP is protected by a CRC checksum against
2275 transmission errors. Occasionally the CRC gets mangled somewhere on
2276 the transmission channel but the actual content (which is protected by
2277 the OpenPGP protocol anyway) is still okay. This option allows GnuPG
2278 to ignore CRC errors.
2279
2280 @item --ignore-mdc-error
2281 This option changes a MDC integrity protection failure into a warning.
2282 This can be useful if a message is partially corrupt, but it is
2283 necessary to get as much data as possible out of the corrupt message.
2284 However, be aware that a MDC protection failure may also mean that the
2285 message was tampered with intentionally by an attacker.
2286
2287 @item --no-default-keyring
2288 Do not add the default keyrings to the list of keyrings. Note that
2289 GnuPG will not operate without any keyrings, so if you use this option
2290 and do not provide alternate keyrings via @option{--keyring} or
2291 @option{--secret-keyring}, then GnuPG will still use the default public or
2292 secret keyrings.
2293
2294 @item --skip-verify
2295 Skip the signature verification step. This may be
2296 used to make the decryption faster if the signature
2297 verification is not needed.
2298
2299 @item --with-key-data
2300 Print key listings delimited by colons (like @option{--with-colons}) and
2301 print the public key data.
2302
2303 @item --fast-list-mode
2304 Changes the output of the list commands to work faster; this is achieved
2305 by leaving some parts empty. Some applications don't need the user ID
2306 and the trust information given in the listings. By using this options
2307 they can get a faster listing. The exact behaviour of this option may
2308 change in future versions.  If you are missing some information, don't
2309 use this option.
2310
2311 @item --no-literal
2312 This is not for normal use. Use the source to see for what it might be useful.
2313
2314 @item --set-filesize
2315 This is not for normal use. Use the source to see for what it might be useful.
2316
2317 @item --show-session-key
2318 Display the session key used for one message. See
2319 @option{--override-session-key} for the counterpart of this option.
2320
2321 We think that Key Escrow is a Bad Thing; however the user should have
2322 the freedom to decide whether to go to prison or to reveal the content
2323 of one specific message without compromising all messages ever
2324 encrypted for one secret key. DON'T USE IT UNLESS YOU ARE REALLY
2325 FORCED TO DO SO.
2326
2327 @item --override-session-key @code{string}
2328 Don't use the public key but the session key @code{string}. The format
2329 of this string is the same as the one printed by
2330 @option{--show-session-key}. This option is normally not used but comes
2331 handy in case someone forces you to reveal the content of an encrypted
2332 message; using this option you can do this without handing out the
2333 secret key.
2334
2335 @item --ask-sig-expire
2336 @itemx --no-ask-sig-expire
2337 When making a data signature, prompt for an expiration time. If this
2338 option is not specified, the expiration time set via
2339 @option{--default-sig-expire} is used. @option{--no-ask-sig-expire}
2340 disables this option. Note that by default, @option{--force-v3-sigs} is
2341 set which also disables this option. If you want signature expiration,
2342 you must set @option{--no-force-v3-sigs} as well as turning
2343 @option{--ask-sig-expire} on.
2344
2345 @item --default-sig-expire
2346 The default expiration time to use for signature expiration. Valid
2347 values are "0" for no expiration, a number followed by the letter d
2348 (for days), w (for weeks), m (for months), or y (for years) (for
2349 example "2m" for two months, or "5y" for five years), or an absolute
2350 date in the form YYYY-MM-DD. Defaults to "0".
2351
2352 @item --ask-cert-expire
2353 @itemx --no-ask-cert-expire
2354 When making a key signature, prompt for an expiration time. If this
2355 option is not specified, the expiration time set via
2356 @option{--default-cert-expire} is used. @option{--no-ask-cert-expire}
2357 disables this option.
2358
2359 @item --default-cert-expire
2360 The default expiration time to use for key signature expiration.
2361 Valid values are "0" for no expiration, a number followed by the
2362 letter d (for days), w (for weeks), m (for months), or y (for years)
2363 (for example "2m" for two months, or "5y" for five years), or an
2364 absolute date in the form YYYY-MM-DD. Defaults to "0".
2365
2366 @item --allow-secret-key-import
2367 This is an obsolete option and is not used anywhere.
2368
2369 @item --allow-multisig-verification
2370 Allow verification of concatenated signed messages. This will run a
2371 signature verification for each data+signature block. There are some
2372 security issues with this option and thus it is off by default. Note
2373 that versions of GPG prior to version 1.4.3 implicitly allowed this.
2374
2375 @item --enable-special-filenames
2376 This options enables a mode in which filenames of the form
2377 @file{-&n}, where n is a non-negative decimal number,
2378 refer to the file descriptor n and not to a file with that name.
2379
2380 @item --no-expensive-trust-checks
2381 Experimental use only.
2382
2383 @item --preserve-permissions
2384 Don't change the permissions of a secret keyring back to user
2385 read/write only. Use this option only if you really know what you are doing.
2386
2387 @item --default-preference-list @code{string}
2388 @opindex default-preference-list
2389 Set the list of default preferences to @code{string}. This preference
2390 list is used for new keys and becomes the default for "setpref" in the
2391 edit menu.
2392
2393 @item --default-keyserver-url @code{name}
2394 @opindex default-keyserver-url
2395 Set the default keyserver URL to @code{name}. This keyserver will be
2396 used as the keyserver URL when writing a new self-signature on a key,
2397 which includes key generation and changing preferences.
2398
2399 @item --list-config
2400 @opindex list-config
2401 Display various internal configuration parameters of GnuPG. This option
2402 is intended for external programs that call GnuPG to perform tasks, and
2403 is thus not generally useful. See the file @file{doc/DETAILS} in the
2404 source distribution for the details of which configuration items may be
2405 listed. @option{--list-config} is only usable with
2406 @option{--with-colons} set.
2407
2408 @item --gpgconf-list
2409 @opindex gpgconf-list
2410 This command is simliar to @option{--list-config} but in general only
2411 internally used by the @command{gpgconf} tool.
2412
2413 @item --gpgconf-test
2414 @opindex gpgconf-test
2415 This is more or less dummy action.  However it parses the configuration
2416 file and returns with failure if the configuraion file would prevent
2417 @command{gpg} from startup.  Thus it may be used to run a syntax check
2418 on the configuration file.
2419
2420 @end table
2421
2422 @c *******************************
2423 @c ******* Deprecated ************
2424 @c *******************************
2425 @subsection Deprecated options
2426
2427 @table @gnupgtabopt
2428
2429 @ifset gpgone
2430 @item --load-extension @code{name}
2431 Load an extension module. If @code{name} does not contain a slash it is
2432 searched for in the directory configured when GnuPG was built
2433 (generally "/usr/local/lib/gnupg"). Extensions are not generally
2434 useful anymore, and the use of this option is deprecated.
2435 @end ifset
2436
2437 @item --show-photos
2438 @itemx --no-show-photos
2439 Causes @option{--list-keys}, @option{--list-sigs},
2440 @option{--list-public-keys}, @option{--list-secret-keys}, and verifying
2441 a signature to also display the photo ID attached to the key, if
2442 any. See also @option{--photo-viewer}. These options are deprecated. Use
2443 @option{--list-options [no-]show-photos} and/or @option{--verify-options
2444 [no-]show-photos} instead.
2445
2446 @item --show-keyring
2447 Display the keyring name at the head of key listings to show which
2448 keyring a given key resides on. This option is deprecated: use
2449 @option{--list-options [no-]show-keyring} instead.
2450
2451 @item --ctapi-driver @code{file}
2452 Use @code{file} to access the smartcard reader. The current default
2453 is `libtowitoko.so'. Note that the use of this interface is
2454 deprecated; it may be removed in future releases.
2455
2456 @item --always-trust
2457 Identical to @option{--trust-model always}. This option is deprecated.
2458
2459 @item --show-notation
2460 @itemx --no-show-notation
2461 Show signature notations in the @option{--list-sigs} or @option{--check-sigs} listings
2462 as well as when verifying a signature with a notation in it. These
2463 options are deprecated. Use @option{--list-options [no-]show-notation}
2464 and/or @option{--verify-options [no-]show-notation} instead.
2465
2466 @item --show-policy-url
2467 @itemx --no-show-policy-url
2468 Show policy URLs in the @option{--list-sigs} or @option{--check-sigs}
2469 listings as well as when verifying a signature with a policy URL in
2470 it. These options are deprecated. Use @option{--list-options
2471 [no-]show-policy-url} and/or @option{--verify-options
2472 [no-]show-policy-url} instead.
2473
2474
2475 @end table
2476
2477
2478 @c *******************************************
2479 @c ***************            ****************
2480 @c ***************   FILES    ****************
2481 @c ***************            ****************
2482 @c *******************************************
2483 @mansect files
2484 @node GPG Configuration
2485 @section Configuration files
2486
2487 There are a few configuration files to control certain aspects of
2488 @command{@gpgname}'s operation. Unless noted, they are expected in the
2489 current home directory (@pxref{option --homedir}).
2490
2491 @table @file
2492
2493 @item gpg.conf
2494 @cindex gpgsm.conf
2495 This is the standard configuration file read by @command{@gpgname} on
2496 startup.  It may contain any valid long option; the leading two dashes
2497 may not be entered and the option may not be abbreviated.  This default
2498 name may be changed on the command line (@pxref{option
2499   --options}).
2500
2501 @end table
2502
2503 @c man:.RE
2504 Note that on larger installations, it is useful to put predefined files
2505 into the directory @file{/etc/skel/.gnupg/} so that newly created users
2506 start up with a working configuration.
2507 @ifclear gpgone
2508 For existing users the a small
2509 helper script is provided to create these files (@pxref{addgnupghome}).
2510 @end ifclear
2511
2512 For internal purposes @command{@gpgname} creates and maintaines a few other
2513 files; They all live in in the current home directory (@pxref{option
2514 --homedir}).  Only the @command{@gpgname} may modify these files.
2515
2516
2517 @table @file
2518 @item ~/.gnupg/secring.gpg
2519 The secret keyring.
2520
2521 @item ~/.gnupg/secring.gpg.lock
2522 and the lock file
2523
2524 @item ~/.gnupg/pubring.gpg
2525 The public keyring
2526
2527 @item ~/.gnupg/pubring.gpg.lock
2528 and the lock file
2529
2530 @item ~/.gnupg/trustdb.gpg
2531 The trust database
2532
2533 @item ~/.gnupg/trustdb.gpg.lock
2534 and the lock file
2535
2536 @item ~/.gnupg/random_seed
2537 used to preserve the internal random pool
2538
2539 @item /usr[/local]/share/gnupg/options.skel
2540 Skeleton options file
2541
2542 @item /usr[/local]/lib/gnupg/
2543 Default location for extensions
2544
2545 @end table
2546
2547 @c man:.RE
2548 Operation is further controlled by a few environment variables:
2549
2550 @table @asis
2551
2552 @item HOME
2553 Used to locate the default home directory.
2554
2555 @item GNUPGHOME
2556 If set directory used instead of "~/.gnupg".
2557
2558 @item GPG_AGENT_INFO
2559 Used to locate the gpg-agent.
2560 @ifset gpgone
2561 This is only honored when @option{--use-agent} is set.
2562 @end ifset
2563 The value consists of 3 colon delimited fields: The first is the path
2564 to the Unix Domain Socket, the second the PID of the gpg-agent and the
2565 protocol version which should be set to 1. When starting the gpg-agent
2566 as described in its documentation, this variable is set to the correct
2567 value. The option @option{--gpg-agent-info} can be used to override it.
2568
2569 @item COLUMNS
2570 @itemx LINES
2571 Used to size some displays to the full size of the screen.
2572
2573 @end table
2574
2575
2576 @c *******************************************
2577 @c ***************            ****************
2578 @c ***************  EXAMPLES  ****************
2579 @c ***************            ****************
2580 @c *******************************************
2581 @mansect examples
2582 @node GPG Examples
2583 @section Examples
2584
2585 @table @asis
2586
2587 @item gpg -se -r @code{Bob} @code{file}
2588 sign and encrypt for user Bob
2589
2590 @item gpg --clearsign @code{file}
2591 make a clear text signature
2592
2593 @item gpg -sb @code{file}
2594 make a detached signature
2595
2596 @item gpg --list-keys @code{user_ID}
2597 show keys
2598
2599 @item gpg --fingerprint @code{user_ID}
2600 show fingerprint
2601
2602 @item gpg --verify @code{pgpfile}
2603 @itemx gpg --verify @code{sigfile}
2604 Verify the signature of the file but do not output the data. The
2605 second form is used for detached signatures, where @code{sigfile}
2606 is the detached signature (either ASCII armored or binary) and
2607 are the signed data; if this is not given, the name of
2608 the file holding the signed data is constructed by cutting off the
2609 extension (".asc" or ".sig") of @code{sigfile} or by asking the
2610 user for the filename.
2611 @end table
2612
2613
2614 @c *******************************************
2615 @c ***************            ****************
2616 @c ***************  USER ID   ****************
2617 @c ***************            ****************
2618 @c *******************************************
2619 @mansect how to specify a user id
2620 @ifset isman
2621 @include specify-user-id.texi
2622 @end ifset
2623
2624 @mansect return vaue
2625 @chapheading RETURN VALUE
2626
2627 The program returns 0 if everything was fine, 1 if at least
2628 a signature was bad, and other error codes for fatal errors.
2629
2630 @mansect warnings
2631 @chapheading WARNINGS
2632
2633 Use a *good* password for your user account and a *good* passphrase
2634 to protect your secret key. This passphrase is the weakest part of the
2635 whole system. Programs to do dictionary attacks on your secret keyring
2636 are very easy to write and so you should protect your "~/.gnupg/"
2637 directory very well.
2638
2639 Keep in mind that, if this program is used over a network (telnet), it
2640 is *very* easy to spy out your passphrase!
2641
2642 If you are going to verify detached signatures, make sure that the
2643 program knows about it; either give both filenames on the command line
2644 or use @samp{-} to specify stdin.
2645
2646 @mansect interoperability
2647 @chapheading INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS
2648
2649 GnuPG tries to be a very flexible implementation of the OpenPGP
2650 standard. In particular, GnuPG implements many of the optional parts
2651 of the standard, such as the SHA-512 hash, and the ZLIB and BZIP2
2652 compression algorithms. It is important to be aware that not all
2653 OpenPGP programs implement these optional algorithms and that by
2654 forcing their use via the @option{--cipher-algo}, @option{--digest-algo},
2655 @option{--cert-digest-algo}, or @option{--compress-algo} options in GnuPG, it is
2656 possible to create a perfectly valid OpenPGP message, but one that
2657 cannot be read by the intended recipient.
2658
2659 There are dozens of variations of OpenPGP programs available, and each
2660 supports a slightly different subset of these optional algorithms.
2661 For example, until recently, no (unhacked) version of PGP supported
2662 the BLOWFISH cipher algorithm. A message using BLOWFISH simply could
2663 not be read by a PGP user. By default, GnuPG uses the standard
2664 OpenPGP preferences system that will always do the right thing and
2665 create messages that are usable by all recipients, regardless of which
2666 OpenPGP program they use. Only override this safe default if you
2667 really know what you are doing.
2668
2669 If you absolutely must override the safe default, or if the preferences
2670 on a given key are invalid for some reason, you are far better off using
2671 the @option{--pgp6}, @option{--pgp7}, or @option{--pgp8} options. These
2672 options are safe as they do not force any particular algorithms in
2673 violation of OpenPGP, but rather reduce the available algorithms to a
2674 "PGP-safe" list.
2675
2676 @mansect bugs
2677 @chapheading BUGS
2678
2679 On many systems this program should be installed as setuid(root). This
2680 is necessary to lock memory pages. Locking memory pages prevents the
2681 operating system from writing memory pages (which may contain
2682 passphrases or other sensitive material) to disk. If you get no
2683 warning message about insecure memory your operating system supports
2684 locking without being root. The program drops root privileges as soon
2685 as locked memory is allocated.
2686
2687 @mansect see also
2688 @ifset isman
2689 @command{gpgv}(1), 
2690 @ifclear gpgone
2691 @command{gpgsm}(1), 
2692 @command{gpg-agent}(1)
2693 @end ifclear
2694 @end ifset
2695 @include see-also-note.texi