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