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