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