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