home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2007 March / PCpro_2007_03.ISO / files / mailcrypto / gnupg / gnupg-w32cli-1.4.6.exe / Doc / gpg.man < prev    next >
Encoding:
Text File  |  2006-12-06  |  118.7 KB  |  2,898 lines

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