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