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