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