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