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