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