home *** CD-ROM | disk | FTP | other *** search
/ com!online 2002 May / comcd0502.iso / top100com / gnupg-w32-1.0.6 / gpg.man < prev    next >
Encoding:
Text File  |  2002-03-04  |  47.6 KB  |  1,189 lines

  1.  
  2.  
  3.  
  4. gpg(1)                                                     gpg(1)
  5.  
  6.  
  7. NAME
  8.        gpg -- encryption and signing tool
  9.  
  10. SYNOPSIS
  11.        gpg  [--homedir name]  [--options file]  [options]  command  [args]
  12.  
  13. DESCRIPTION
  14.        gpg is the main program for the GnuPG system.
  15.  
  16.  
  17.        This   man  page  only  lists  the  commands  and  options
  18.        available.  For a more verbose documentation get  the  GNU
  19.        Privacy    Handbook   (GPH),   which   is   available   at
  20.        http://www.gnupg.org/gph/ .  You will find a list of HOWTO
  21.        documents at http://www.gnupg.org/docs.html .
  22.  
  23. COMMANDS
  24.        gpg recognizes these commands:
  25.  
  26.        -s, --sign
  27.                  Make  a  signature. This command may be combined
  28.                  with --encrypt.
  29.  
  30.        --clearsign
  31.                  Make a clear text signature.
  32.  
  33.        -b, --detach-sign
  34.                  Make a detached signature.
  35.  
  36.        -e, --encrypt
  37.                  Encrypt data. This option may be  combined  with
  38.                  --sign.
  39.  
  40.        -c, --symmetric
  41.                  Encrypt   with   symmetric  cipher  only.   This
  42.                  command asks for a passphrase.
  43.  
  44.        --store   Store only (make a simple RFC1991 packet).
  45.  
  46.        --decrypt [file]
  47.                  Decrypt file (or stdin if no file is  specified)
  48.                  and  write  it  to stdout (or the file specified
  49.                  with --output). If the decrypted file is signed,
  50.                  the  signature  is  also  verified. This command
  51.                  differs from the default operation, as it  never
  52.                  writes  to the filename which is included in the
  53.                  file and it rejects files which don't begin with
  54.                  an encrypted message.
  55.  
  56.        --verify [[sigfile]  [signed-files]]
  57.                  Assume that sigfile is a signature and verify it
  58.                  without   generating   any   output.   With   no
  59.                  arguments,  the  signature  packet  is read from
  60.                  stdin.  If only a sigfile is given, it may be  a
  61.                  complete  signature  or a detached signature, in
  62.                  which case the signed stuff  is  expected  in  a
  63.                  file  without  the  ".sig"  or ".asc" extension.
  64.                  With more than 1 argument, the first should be a
  65.                  detached  signature  and the remaining files are
  66.                  the signed stuff.  To read the signed stuff from
  67.                  stdin,  use  -  as  the  second  filename.   For
  68.                  security reasons  a  detached  signature  cannot
  69.                  read  the  signed  material  from  stdin without
  70.                  denoting it in the above way.
  71.  
  72.        --verify-files [files]
  73.                  This  is  a  special  version  of  the  --verify
  74.                  command   which  does  not  work  with  detached
  75.                  signatures.  The command expects the files to be
  76.                  verified either on the command line or reads the
  77.                  filenames from stdin;   each  name  must  be  on
  78.                  separate line. The command is intended for quick
  79.                  checking of many files.
  80.  
  81.        --list-keys [names]
  82.  
  83.        --list-public-keys [names]
  84.                  List all keys from the public keyrings, or  just
  85.                  the ones given on the command line.
  86.  
  87.        --list-secret-keys [names]
  88.                  List  all keys from the secret keyrings, or just
  89.                  the ones given on the command line.
  90.  
  91.        --list-sigs [names]
  92.                  Same as  --list-keys,  but  the  signatures  are
  93.                  listed too.
  94.  
  95.        --check-sigs [names]
  96.                  Same  as  --list-sigs,  but  the  signatures are
  97.                  verified.
  98.  
  99.        --fingerprint [names]
  100.                  List all keys with their fingerprints.  This  is
  101.                  the  same  output  as  --list-keys  but with the
  102.                  additional   output   of   a   line   with   the
  103.                  fingerprint.  May  also be combined with --list-
  104.                  sigs or --check-sigs.  If this command is  given
  105.                  twice,  the  fingerprints  of all secondary keys
  106.                  are listed too.
  107.  
  108.        --list-packets
  109.                  List only  the  sequence  of  packets.  This  is
  110.                  mainly useful for debugging.
  111.  
  112.        --gen-key Generate   a  new  key  pair.  This  command  is
  113.                  normally only used interactively.
  114.  
  115.                  There is an experimental  feature  which  allows
  116.                  you  to  create keys in batch mode. See the file
  117.                  doc/DETAILS in the source distribution on how to
  118.                  use this.
  119.  
  120.        --edit-key name
  121.                  Present  a  menu which enables you to do all key
  122.                  related tasks:
  123.  
  124.                  sign      Make a signature on key of  user  name
  125.                            If  the  key  is not yet signed by the
  126.                            default user (or the users given  with
  127.                            -u),    the   program   displays   the
  128.                            information of the key again, together
  129.                            with  its fingerprint and asks whether
  130.                            it should be signed. This question  is
  131.                            repeated  for all users specified with
  132.                            -u.
  133.  
  134.                  lsign     Same as --sign but  the  signature  is
  135.                            marked   as  non-exportable  and  will
  136.                            therefore never  be  used  by  others.
  137.                            This  may  be  used to make keys valid
  138.                            only in the local environment.
  139.  
  140.                  revsig    Revoke a signature.   GnuPG  asks  for
  141.                            every signature which has been done by
  142.                            one of  the  secret  keys,  whether  a
  143.                            revocation   certificate   should   be
  144.                            generated.
  145.  
  146.                  trust     Change the  owner  trust  value.  This
  147.                            updates  the  trust-db immediately and
  148.                            no save is required.
  149.  
  150.                  disable
  151.  
  152.                  enable    Disable or enable  an  entire  key.  A
  153.                            disabled  key can normally not be used
  154.                            for encryption.
  155.  
  156.                  adduid    Create an alternate user id.
  157.  
  158.                  deluid    Delete a user id.
  159.  
  160.                  addkey    Add a subkey to this key.
  161.  
  162.                  delkey    Remove a subkey.
  163.  
  164.                  revkey    Revoke a subkey.
  165.  
  166.                  expire    Change the key expiration time.  If  a
  167.                            key  is selected, the time of this key
  168.                            will be changed.   With  no  selection
  169.                            the  key expiration of the primary key
  170.                            is changed.
  171.  
  172.                  passwd    Change the passphrase  of  the  secret
  173.                            key.
  174.  
  175.                  uid n     Toggle selection of user id with index
  176.                            n.  Use 0 to deselect all.
  177.  
  178.                  key n     Toggle selection of subkey with  index
  179.                            n.  Use 0 to deselect all.
  180.  
  181.                  check     Check all selected user ids.
  182.  
  183.                  pref      List preferences.
  184.  
  185.                  showpref  More verbose preferences listing.
  186.  
  187.                  toggle    Toggle  between  public and secret key
  188.                            listing.
  189.  
  190.                  save      Save all changes to the key rings  and
  191.                            quit.
  192.  
  193.                  quit      Quit  the program without updating the
  194.                            key rings.
  195.  
  196.                  The listing shows you the key with its secondary
  197.                  keys and all user ids. Selected keys or user ids
  198.                  are indicated by an asterisk. The trust value is
  199.                  displayed with the primary key: the first is the
  200.                  assigned owner  trust  and  the  second  is  the
  201.                  calculated  trust  value.   Letters are used for
  202.                  the values:
  203.  
  204.                  -         No  ownertrust  assigned  /  not   yet
  205.                            calculated.
  206.  
  207.                  e         Trust calculation has failed; probably
  208.                            due to an expired key.
  209.  
  210.                  q         Not     enough     information     for
  211.                            calculation.
  212.  
  213.                  n         Never trust this key.
  214.  
  215.                  m         Marginally trusted.
  216.  
  217.                  f         Fully trusted.
  218.  
  219.                  u         Ultimately trusted.
  220.  
  221.        --sign-key name
  222.                  Sign  a public key with your secret key. This is
  223.                  a shortcut version of the subcommand "sign" from
  224.                  --edit.
  225.  
  226.        --lsign-key name
  227.                  Sign  a public key with your secret key but mark
  228.                  it  as  non-exportable.   This  is  a   shortcut
  229.                  version of the subcommand "lsign" from --edit.
  230.  
  231.        --trusted-key long key ID
  232.                  Assume  that  the  specified  key (which must be
  233.                  given  as  a   full  8  byte  key  ID)   is   as
  234.                  trustworthy as one of your own secret keys. This
  235.                  option is useful if you don't want to keep  your
  236.                  secret  keys  (or  one of them) online but still
  237.                  want to be able to check the validity of a given
  238.                  recipient's or signator's key.
  239.  
  240.        --delete-key name
  241.                  Remove key from the public keyring
  242.  
  243.        --delete-secret-key  name
  244.                  Remove key from the secret and public keyring
  245.  
  246.        --delete-secret-and-public-key  name
  247.                  Same  as  --delete-key,  but  if  a  secret  key
  248.                  exists, it will be removed first.
  249.  
  250.        --gen-revoke
  251.                  Generate  a  revocation  certificate   for   the
  252.                  complete key. To revoke a subkey or a signature,
  253.                  use the --edit command.
  254.  
  255.        --export [names]
  256.                  Either  export  all  keys  from   all   keyrings
  257.                  (default   keyrings  and  those  registered  via
  258.                  option --keyring), or if at least  one  name  is
  259.                  given,  those of the given name. The new keyring
  260.                  is written to stdout or to the file  given  with
  261.                  option  "output".   Use together with --armor to
  262.                  mail those keys.
  263.  
  264.  
  265.        --send-keys [names]
  266.                  Same  as  --export  but  sends  the  keys  to  a
  267.                  keyserver.   Option  --keyserver must be used to
  268.                  give the name of this keyserver. Don't send your
  269.                  complete  keyring  to  a keyserver - select only
  270.                  those keys which are new or changed by you.
  271.  
  272.        --export-all [names]
  273.                  Same as --export, but also  exports  keys  which
  274.                  are not compatible with OpenPGP.
  275.  
  276.        --export-secret-keys [names]
  277.  
  278.        --export-secret-subkeys [names]
  279.                  Same  as  --export,  but exports the secret keys
  280.                  instead.  This is normally not very useful and a
  281.                  security  risk.   The second form of the command
  282.                  has the special property to  render  the  secret
  283.                  part  of  the primary key useless; this is a GNU
  284.                  extension to OpenPGP and  other  implementations
  285.                  can  not be expected to successfully import such
  286.                  a key.
  287.  
  288.        --import [files]
  289.  
  290.        --fast-import [files]
  291.                  Import/merge keys. This adds the given  keys  to
  292.                  the  keyring.   The  fast version does not build
  293.                  the trustdb; this can be done at any  time  with
  294.                  the command --update-trustdb.
  295.  
  296.                  There  are a few other options which control how
  297.                  this command works.  Most notable  here  is  the
  298.                  --merge-only  option  which  does not insert new
  299.                  keys  but  does  only   the   merging   of   new
  300.                  signatures,  user-IDs and subkeys.  See also the
  301.                  option --allow-secret-key-import.
  302.  
  303.        --recv-keys key IDs
  304.                  Import the keys with the given key  IDs  from  a
  305.                  HKP  keyserver.  Option --keyserver must be used
  306.                  to give the name of this keyserver.
  307.  
  308.        --export-ownertrust
  309.                  List the assigned  ownertrust  values  in  ASCII
  310.                  format for backup purposes.
  311.  
  312.        --import-ownertrust [files]
  313.                  Update  the  trustdb  with the ownertrust values
  314.                  stored  in  files  (or  stdin  if  not   given);
  315.                  existing values will be overwritten.
  316.  
  317.        --print-md algo [files]
  318.                  Print  message  digest of algorithm ALGO for all
  319.                  given files of stdin.  If "*" is  used  for  the
  320.                  algorithm,  digests for all available algorithms
  321.                  are printed.
  322.  
  323.        --gen-random 0|1|2                 [count]
  324.                  Emit COUNT random bytes  of  the  given  quality
  325.                  level. If count is not given or zero, an endless
  326.                  sequence  of  random  bytes  will  be   emitted.
  327.                  PLEASE,  don't  use this command unless you know
  328.                  what you  are  doing;  it  may  remove  precious
  329.                  entropy from the system!
  330.  
  331.        --gen-prime mode                  bits             [qbits]
  332.                  Use the source, Luke :-). The output  format  is
  333.                  still subject to change.
  334.  
  335.        --version Print  version  information along with a list of
  336.                  supported algorithms.
  337.  
  338.        --warranty
  339.                  Print warranty information.
  340.  
  341.        -h, --help
  342.                  Print usage information.  This is a really  long
  343.                  list even though it doesn't list all options.
  344.  
  345. OPTIONS
  346.        Long  options  can  be  put  in  an  options file (default
  347.        "~/.gnupg/options").  Do  not  write  the  2  dashes,  but
  348.        simply  the name of the option and any required arguments.
  349.        Lines with a hash as the first  non-white-space  character
  350.        are  ignored.  Commands  may  be put in this file too, but
  351.        that does not make sense.
  352.  
  353.        gpg recognizes these options:
  354.  
  355.        -a, --armor
  356.                  Create ASCII armored output.
  357.  
  358.        -o, --output file
  359.                  Write output to file.
  360.  
  361.        -u, --local-user name
  362.                  Use name as the user ID to sign.  This option is
  363.                  silently  ignored for the list commands, so that
  364.                  it can be used in an options file.
  365.  
  366.        --default-key name
  367.                  Use name as default user ID for signatures.   If
  368.                  this  is  not  used  the  default user ID is the
  369.                  first user ID found in the secret keyring.
  370.  
  371.        -r, --recipient name
  372.  
  373.                  Encrypt for user id name. If this option is  not
  374.                  specified,  GnuPG  asks  for  the user-id unless
  375.                  --default-recipient is given
  376.  
  377.        --default-recipient name
  378.                  Use  name  as  default   recipient   if   option
  379.                  --recipient is not used and don't ask if this is
  380.                  a valid one. name must be non-empty.
  381.  
  382.        --default-recipient-self
  383.                  Use the default  key  as  default  recipient  if
  384.                  option  --recipient is not used and don't ask if
  385.                  this is a valid one.  The  default  key  is  the
  386.                  first one from the secret keyring or the one set
  387.                  with --default-key.
  388.  
  389.        --no-default-recipient
  390.                  Reset   --default-recipient    and    --default-
  391.                  recipient-self.
  392.  
  393.        --encrypt-to name
  394.                  Same as --recipient but this one is intended for
  395.                  use in the options file and  may  be  used  with
  396.                  your own user-id as an "encrypt-to-self".  These
  397.                  keys  are  only  used  when  there   are   other
  398.                  recipients given either by use of --recipient or
  399.                  by the asked user  id.   No  trust  checking  is
  400.                  performed  for  these user ids and even disabled
  401.                  keys can be used.
  402.  
  403.        --no-encrypt-to
  404.                  Disable the use of all --encrypt-to keys.
  405.  
  406.        -v, --verbose
  407.                  Give more information during processing. If used
  408.                  twice, the input data is listed in detail.
  409.  
  410.        -q, --quiet
  411.                  Try to be as quiet as possible.
  412.  
  413.        -z n      Set  compression  level to n. A value of 0 for n
  414.                  disables compression.  Default  is  to  use  the
  415.                  default  compression level of zlib (normally 6).
  416.  
  417.        -t, --textmode
  418.                  Use  canonical  text  mode.   If  -t  (but   not
  419.                  --textmode)  is  used together with armoring and
  420.                  signing,  this  enables  clearsigned   messages.
  421.                  This  kludge  is  needed  for PGP compatibility;
  422.                  normally you would use --sign or --clearsign  to
  423.                  selected the type of the signature.
  424.  
  425.        -n, --dry-run
  426.                  Don't  make  any changes (this is not completely
  427.                  implemented).
  428.  
  429.        -i, --interactive
  430.                  Prompt before overwriting any files.
  431.  
  432.        --batch   Use  batch  mode.   Never  ask,  do  not   allow
  433.                  interactive commands.
  434.  
  435.        --no-tty  Make  sure that the TTY (terminal) is never used
  436.                  for any output.  This option is needed  in  some
  437.                  cases because GnuPG sometimes prints warnings to
  438.                  the TTY if --batch is used.
  439.  
  440.        --no-batch
  441.                  Disable batch mode.   This  may  be  of  use  if
  442.                  --batch is enabled from an options file.
  443.  
  444.        --yes     Assume "yes" on most questions.
  445.  
  446.        --no      Assume "no" on most questions.
  447.  
  448.        --always-trust
  449.                  Skip  key  validation  and assume that used keys
  450.                  are always fully trusted.  You  won't  use  this
  451.                  unless   you   have   installed   some  external
  452.                  validation scheme.
  453.  
  454.        --keyserver name
  455.                  Use name to lookup keys which  are  not  yet  in
  456.                  your keyring.  This is only done while verifying
  457.                  messages with signatures.  The  option  is  also
  458.                  required  for the command --send-keys to specify
  459.                  the keyserver to where the keys should be  send.
  460.                  All  keyservers synchronize with each other - so
  461.                  there is no need to send keys to more  than  one
  462.                  server.   Using  the  command "host -l pgp.net |
  463.                  grep wwwkeys" gives you a  list  of  keyservers.
  464.                  Because  there  is  load  balancing using round-
  465.                  robin DNS you may notice that you get  different
  466.                  key servers.
  467.  
  468.        --no-auto-key-retrieve
  469.                  This option disables the automatic retrieving of
  470.                  keys   from   a   keyserver   while    verifying
  471.                  signatures.  This  option  allows  you to keep a
  472.                  keyserver in the options file  for  the  --send-
  473.                  keys and --recv-keys commands.
  474.  
  475.        --honor-http-proxy
  476.                  Try  to  access the keyserver over the proxy set
  477.                  with the variable "http_proxy".
  478.  
  479.        --keyring file
  480.                  Add file to  the  list  of  keyrings.   If  file
  481.                  begins  with  a  tilde  and  a  slash, these are
  482.                  replaced by the HOME directory. If the  filename
  483.                  does not contain a slash, it is assumed to be in
  484.                  the home-directory ("~/.gnupg" if  --homedir  is
  485.                  not  used).  The filename may be prefixed with a
  486.                  scheme:
  487.  
  488.                  "gnupg-ring:" is the default one.
  489.  
  490.                  "gnupg-gdbm:" may be used for a GDBM ring.  Note
  491.                  that  GDBM  is  experimental  and  likely  to be
  492.                  removed in future versions.
  493.  
  494.                  It might make sense  to  use  it  together  with
  495.                  --no-default-keyring.
  496.  
  497.        --secret-keyring file
  498.                  Same as --keyring but for the secret keyrings.
  499.  
  500.        --homedir directory
  501.                  Set  the name of the home directory to directory
  502.                  If this  option  is  not  used  it  defaults  to
  503.                  "~/.gnupg".  It  does not make sense to use this
  504.                  in a  options  file.  This  also  overrides  the
  505.                  environment variable "GNUPGHOME".
  506.  
  507.        --charset name
  508.                  Set  the name of the native character set.  This
  509.                  is used to convert some strings to proper  UTF-8
  510.                  encoding.  Valid values for name are:
  511.  
  512.                  iso-8859-1
  513.                            This is the default Latin 1 set.
  514.  
  515.                  iso-8859-2
  516.                            The Latin 2 set.
  517.  
  518.                  koi8-r    The usual Russian set (rfc1489).
  519.  
  520.                  utf-8     Bypass  all  translations  and  assume
  521.                            that  the   OS   uses   native   UTF-8
  522.                            encoding.
  523.  
  524.        --utf8-strings
  525.  
  526.        --no-utf8-strings
  527.                  Assume  that  the arguments are already given as
  528.                  UTF8 strings.  The  default  (--no-utf8-strings)
  529.                  is  to  assume that arguments are encoded in the
  530.                  character set as specified by  --charset.  These
  531.                  options  affect  all  following arguments.  Both
  532.                  options may be used multiple times.
  533.  
  534.        --options file
  535.                  Read options from file and do not  try  to  read
  536.                  them  from  the  default  options  file  in  the
  537.                  homedir (see --homedir). This option is  ignored
  538.                  if used in an options file.
  539.  
  540.        --no-options
  541.                  Shortcut for "--options /dev/null".  This option
  542.                  is detected before an attempt to open an  option
  543.                  file.
  544.  
  545.        --load-extension name
  546.                  Load  an  extension  module.  If  name  does not
  547.                  contain   a   slash   it    is    searched    in
  548.                  "/usr/local/lib/gnupg"  See  the manual for more
  549.                  information about extensions.
  550.  
  551.        --debug flags
  552.                  Set debugging flags. All  flags  are  or-ed  and
  553.                  flags may be given in C syntax (e.g. 0x0042).
  554.  
  555.        --debug-all
  556.                  Set all useful debugging flags.
  557.  
  558.        --status-fd n
  559.                  Write   special   status  strings  to  the  file
  560.                  descriptor n.   See  the  file  DETAILS  in  the
  561.                  documentation for a listing of them.
  562.  
  563.        --logger-fd n
  564.                  Write log output to file descriptor n and not to
  565.                  stderr.
  566.  
  567.        --no-comment
  568.                  Do  not  write  comment  packets.   This  option
  569.                  affects    only   the   generation   of   secret
  570.                  keys.  Please note, that this has nothing to  do
  571.                  with the comments in clear text signatures.
  572.  
  573.        --comment string
  574.                  Use  string  as  comment  string  in  clear text
  575.                  signatures.  To suppress those  comment  strings
  576.                  entirely, use an empty string here.
  577.  
  578.        --default-comment
  579.                  Force  to  write  the standard comment string in
  580.                  clear text signatures.  Use this to overwrite  a
  581.                  --comment from a config file.
  582.  
  583.        --no-version
  584.                  Omit   the   version   string   in   clear  text
  585.                  signatures.
  586.  
  587.        --emit-version
  588.                  Force to write the version string in clear  text
  589.                  signatures.   Use  this  to overwrite a previous
  590.                  --no-version from a config file.
  591.  
  592.        -N, --notation-data name=value
  593.                  Put the name value pair into  the  signature  as
  594.                  notation   data.   name  must  consist  only  of
  595.                  alphanumeric   characters,   digits    or    the
  596.                  underscore;  the  first  character must not be a
  597.                  digit.  value may be any  printable  string;  it
  598.                  will  be  encoded  in  UTF8, so you should check
  599.                  that your --charset is set  correctly.   If  you
  600.                  prefix   name  with  an  exclamation  mark,  the
  601.                  notation  data  will  be  flagged  as   critical
  602.                  (rfc2440:5.2.3.15).
  603.  
  604.        --set-policy-url string
  605.                  Use   string   as   Policy  URL  for  signatures
  606.                  (rfc2440:5.2.3.19).  If you prefix  it  with  an
  607.                  exclamation  mark, the policy URL packet will be
  608.                  flagged as critical.
  609.  
  610.        --set-filename string
  611.                  Use string as the name of file which  is  stored
  612.                  in messages.
  613.  
  614.        --use-embedded-filename
  615.                  Try  to create a file with a name as embedded in
  616.                  the data.  This can be a dangerous option as  it
  617.                  allows to overwrite files.
  618.  
  619.        --completes-needed n
  620.                  Number  of completely trusted users to introduce
  621.                  a new key signer (defaults to 1).
  622.  
  623.        --marginals-needed n
  624.                  Number of marginally trusted users to  introduce
  625.                  a new key signer (defaults to 3)
  626.  
  627.        --max-cert-depth n
  628.                  Maximum  depth of a certification chain (default
  629.                  is 5).
  630.  
  631.        --cipher-algo name
  632.                  Use   name  as  cipher  algorithm.  Running  the
  633.                  program with the command --version yields a list
  634.                  of supported algorithms. If this is not used the
  635.                  cipher    algorithm   is   selected   from   the
  636.                  preferences stored with the key.
  637.  
  638.        --digest-algo name
  639.                  Use  name as message digest  algorithm.  Running
  640.                  the  program with the command --version yields a
  641.                  list of supported algorithms.  Please note  that
  642.                  using   this  option  may  violate  the  OpenPGP
  643.                  requirement, that a 160 bit hash is to  be  used
  644.                  for DSA.
  645.  
  646.        --s2k-cipher-algo name
  647.                  Use   name  as  the  cipher  algorithm  used  to
  648.                  protect secret  keys.   The  default  cipher  is
  649.                  BLOWFISH.  This   cipher   is   also   used  for
  650.                  conventional encryption if --cipher-algo is  not
  651.                  given.
  652.  
  653.        --s2k-digest-algo name
  654.                  Use  name as the digest algorithm used to mangle
  655.                  the passphrases.  The default algorithm is RIPE-
  656.                  MD-160.   This digest algorithm is also used for
  657.                  conventional encryption if --digest-algo is  not
  658.                  given.
  659.  
  660.  
  661.        --s2k-mode n
  662.                  Selects how passphrases are mangled. If n is 0 a
  663.                  plain passphrase (which is not recommended) will
  664.                  be  used,  a  1  (default)  adds  a  salt to the
  665.                  passphrase and a 3 iterates the whole process  a
  666.                  couple of times.  Unless --rfc1991 is used, this
  667.                  mode is also used for conventional encryption.
  668.  
  669.        --compress-algo n
  670.                  Use compress algorithm  n. Default is 2 which is
  671.                  RFC1950  compression.  You  may use 1 to use the
  672.                  old zlib version (RFC1951) which is used by PGP.
  673.                  The  default  algorithm  may give better results
  674.                  because the window size is not limited to 8K. If
  675.                  this  is  not used the OpenPGP behavior is used,
  676.                  i.e. the compression algorithm is selected  from
  677.                  the  preferences;  note, that this can't be done
  678.                  if you do not encrypt the data.
  679.  
  680.        --disable-cipher-algo name
  681.                  Never allow the use of name as cipher algorithm.
  682.                  The  given  name  will  not be checked so that a
  683.                  later loaded algorithm will still get  disabled.
  684.  
  685.        --disable-pubkey-algo name
  686.                  Never  allow  the  use  of  name  as  public key
  687.                  algorithm.  The given name will not  be  checked
  688.                  so  that a later loaded algorithm will still get
  689.                  disabled.
  690.  
  691.        --no-sig-cache
  692.                  Do not cache  the  verification  status  of  key
  693.                  signatures.    Caching   gives   a  much  better
  694.                  performance in key listings.   However,  if  you
  695.                  suspect  that  your  public  keyring is not save
  696.                  against write modifications, you  can  use  this
  697.                  option to disable the caching.  It probably does
  698.                  not make sense to disable it because all kind of
  699.                  damage  can  be  done  if someone else has write
  700.                  access to your public keyring.
  701.  
  702.        --no-sig-create-check
  703.                  GnuPG normally  verifies  each  signature  right
  704.                  after  creation  to  protect  against  bugs  and
  705.                  hardware malfunctions which could leak out  bits
  706.                  from  the  secret  key.  This extra verification
  707.                  needs some time (about 115% for DSA  keys),  and
  708.                  so  this  option  can  be  used  to  disable it.
  709.                  However, due to  the  fact  that  the  signature
  710.                  creation    needs   manual   interaction,   this
  711.                  performance penalty  does  not  matter  in  most
  712.                  settings.
  713.  
  714.        --throw-keyid
  715.                  Do  not  put  the  keyid into encrypted packets.
  716.                  This option hides the receiver  of  the  message
  717.                  and   is   a   countermeasure   against  traffic
  718.                  analysis.   It  may  slow  down  the  decryption
  719.                  process  because  all  available secret keys are
  720.                  tried.
  721.  
  722.        --not-dash-escaped
  723.                  This option changes the  behavior  of  cleartext
  724.                  signatures  so  that  they can be used for patch
  725.                  files. You should not send such an armored  file
  726.                  via  email  because  all spaces and line endings
  727.                  are hashed too.  You can not use this option for
  728.                  data  which  has  5 dashes at the beginning of a
  729.                  line, patch files don't  have  this.  A  special
  730.                  armor   header   line  tells  GnuPG  about  this
  731.                  cleartext signature option.
  732.  
  733.        --escape-from-lines
  734.                  Because some mailers change lines starting  with
  735.                  "From  "  to  "<From " it is good to handle such
  736.                  lines in a special way when  creating  cleartext
  737.                  signatures.  All  other  PGP versions do it this
  738.                  way too. This option is not enabled  by  default
  739.                  because it would violate rfc2440.
  740.  
  741.        --passphrase-fd n
  742.                  Read  the  passphrase from file descriptor n. If
  743.                  you use 0 for n, the  passphrase  will  be  read
  744.                  from  stdin.     This  can  only be used if only
  745.                  one passphrase  is  supplied.   Don't  use  this
  746.                  option if you can avoid it.
  747.  
  748.        --command-fd n
  749.                  This is a replacement for the deprecated shared-
  750.                  memory IPC mode.  If  this  option  is  enabled,
  751.                  user input on questions is not expected from the
  752.                  TTY but from  the  given  file  descriptor.   It
  753.                  should  be  used  together with --status-fd. See
  754.                  the file doc/DETAILS in the source  distribution
  755.                  for details on how to use it.
  756.  
  757.        --use-agent
  758.                  Try  to  use  the  GnuPG-Agent. Please note that
  759.                  this agent is  still  under  development.   With
  760.                  this option, GnuPG first tries to connect to the
  761.                  agent before it asks for a passphrase.
  762.  
  763.        --rfc1991 Try to be more RFC1991 (PGP 2.x) compliant.
  764.  
  765.        --openpgp Reset all packet, cipher and digest  options  to
  766.                  OpenPGP  behavior.  Use this option to reset all
  767.                  previous  options   like   --rfc1991,   --force-
  768.                  v3-sigs,  --s2k-*,  --cipher-algo, --digest-algo
  769.                  and --compress-algo to OpenPGP compliant values.
  770.                  All PGP workarounds are also disabled.
  771.  
  772.        --force-v3-sigs
  773.                  OpenPGP  states  that  an  implementation should
  774.                  generate v4 signatures but PGP 5.x recognizes v4
  775.                  signatures  only  on  key material.  This option
  776.                  forces v3 signatures for signatures on data.
  777.  
  778.        --force-mdc
  779.                  Force  the  use  of  encryption  with   appended
  780.                  manipulation code.  This is always used with the
  781.                  newer ciphers (those with  a  blocksize  greater
  782.                  than   64   bit).   This  option  might  not  be
  783.                  implemented yet.
  784.  
  785.        --allow-non-selfsigned-uid
  786.                  Allow the import of keys with user IDs which are
  787.                  not   self-signed,   but   have   at  least  one
  788.                  signature.  This only allows the  import  -  key
  789.                  validation  will  fail and you have to check the
  790.                  validity of the key my other means.   This  hack
  791.                  is  needed  for  some German keys generated with
  792.                  pgp 2.6.3in. You should really avoid  using  it,
  793.                  because  OpenPGP  has  better  mechanics  to  do
  794.                  separate signing and encryption keys.
  795.  
  796.        --allow-freeform-uid
  797.                  Disable all checks on the form of  the  user  ID
  798.                  while  generating a new one.  This option should
  799.                  only be used in very special environments as  it
  800.                  does  not ensure the de-facto standard format of
  801.                  user IDs.
  802.  
  803.        --ignore-time-conflict
  804.                  GnuPG  normally  checks  that   the   timestamps
  805.                  associated   with   keys   and  signatures  have
  806.                  plausible   values.    However,   sometimes    a
  807.                  signature  seems to be older than the key due to
  808.                  clock problems.  This option makes these  checks
  809.                  just a warning.
  810.  
  811.        --ignore-crc-error
  812.                  The ASCII armor used by OpenPG is protected by a
  813.                  CRC  checksum   against   transmission   errors.
  814.                  Sometimes  it  happens that the CRC gets mangled
  815.                  somewhere on the transmission  channel  but  the
  816.                  actual content (which is anyway protected by the
  817.                  OpenPGP protocol) is still  okay.   This  option
  818.                  will let gpg ignore CRC errors.
  819.  
  820.        --lock-once
  821.                  Lock  the  databases  the  first  time a lock is
  822.                  requested and do not release the lock until  the
  823.                  process terminates.
  824.  
  825.        --lock-multiple
  826.                  Release the locks every time a lock is no longer
  827.                  needed. Use this to override a previous  --lock-
  828.                  once from a config file.
  829.  
  830.        --lock-never
  831.                  Disable locking entirely.  This option should be
  832.                  used only in very special environments, where it
  833.                  can   be   assured  that  only  one  process  is
  834.                  accessing those files.  A bootable floppy with a
  835.                  stand-alone  encryption system will probably use
  836.                  this.  Improper usage of this option may lead to
  837.                  data and key corruption.
  838.  
  839.        --no-random-seed-file
  840.                  GnuPG  uses  a file to store its internal random
  841.                  pool  over  invocations.   This   makes   random
  842.                  generation   faster;   however  sometimes  write
  843.                  operations are not desired.  This option can  be
  844.                  used  to  achieve  that  with the cost of slower
  845.                  random generation.
  846.  
  847.        --no-verbose
  848.                  Reset verbose level to 0.
  849.  
  850.        --no-greeting
  851.                  Suppress the initial copyright  message  but  do
  852.                  not enter batch mode.
  853.  
  854.        --no-secmem-warning
  855.                  Suppress   the  warning  about  "using  insecure
  856.                  memory".
  857.  
  858.  
  859.        --no-armor
  860.                  Assume the input data is not  in  ASCII  armored
  861.                  format.
  862.  
  863.        --no-default-keyring
  864.                  Do  not  add the default keyrings to the list of
  865.                  keyrings.
  866.  
  867.        --skip-verify
  868.                  Skip the signature verification step.  This  may
  869.                  be  used  to  make  the decryption faster if the
  870.                  signature verification is not needed.
  871.  
  872.        --with-colons
  873.                  Print key listings delimited by colons.
  874.  
  875.        --with-key-data
  876.                  Print key listings delimited by colons and print
  877.                  the public key data.
  878.  
  879.        --with-fingerprint
  880.                  Same  as  the  command --fingerprint but changes
  881.                  only the format of the output and  may  be  used
  882.                  together with another command.
  883.  
  884.        --fast-list-mode
  885.                  Changes  the output of the list commands to work
  886.                  faster; this is achieved by leaving  some  parts
  887.                  empty.  Some applications don't need the user ID
  888.                  and the trust information given in the listings.
  889.                  By  using  this  options  they  can get a faster
  890.                  listing.  The exact behaviour of this option may
  891.                  change in future versions.
  892.  
  893.        --fixed-list-mode
  894.                  Do  not merge user ID and primary key in --with-
  895.                  colon listing mode and print all  timestamps  as
  896.                  seconds since 1970-01-01.
  897.  
  898.        --list-only
  899.                  Changes the behaviour of some commands.  This is
  900.                  like --dry-run but different in some cases.  The
  901.                  semantic  of this command may be extended in the
  902.                  future.  Currently  it  only  skips  the  actual
  903.                  decryption  pass  and  therefore  enables a fast
  904.                  listing of the encryption keys.
  905.  
  906.        --no-literal
  907.                  This is not for normal use.  Use the  source  to
  908.                  see for what it might be useful.
  909.  
  910.        --set-filesize
  911.                  This  is  not for normal use.  Use the source to
  912.                  see for what it might be useful.
  913.  
  914.        --emulate-md-encode-bug
  915.                  GnuPG versions prior to 1.0.2 had a bug  in  the
  916.                  way  a  signature  was  encoded.   This  options
  917.                  enables  a   workaround   by   checking   faulty
  918.                  signatures  again  with the encoding used in old
  919.                  versions.  This  may  only  happen  for  ElGamal
  920.                  signatures which are not widely used.
  921.  
  922.        --show-session-key
  923.                  Display  the  session  key used for one message.
  924.                  See --override-session-key for  the  counterpart
  925.                  of this option.
  926.  
  927.                  We think that Key-Escrow is a Bad Thing; however
  928.                  the user  should  have  the  freedom  to  decide
  929.                  whether to go to prison or to reveal the content
  930.                  of one specific message without compromising all
  931.                  messages  ever  encrypted  for  one  secret key.
  932.                  DON'T USE IT UNLESS YOU ARE REALLY FORCED TO  DO
  933.                  SO.
  934.  
  935.        --override-session-key string
  936.                  Don't  use  the  public  key but the session key
  937.                  string.  The format of this string is  the  same
  938.                  as  the one printed by --show-session-key.  This
  939.                  option is normally not used but comes  handy  in
  940.                  case someone forces you to reveal the content of
  941.                  an encrypted message; using this option you  can
  942.                  do this without handing out the secret key.
  943.  
  944.        --merge-only
  945.                  Don't  insert  new  keys into the keyrings while
  946.                  doing an import.
  947.  
  948.        --allow-secret-key-import
  949.                  Allow import of secret keys.  The import command
  950.                  normally  skips secret keys because a secret key
  951.                  can  otherwise  be  used  to  attack  the  trust
  952.                  calculation.
  953.  
  954.        --try-all-secrets
  955.                  Don't  look  at  the  key  ID  as  stored in the
  956.                  message but try all secret keys in turn to  find
  957.                  the  right  decryption  key.  This option forces
  958.                  the behaviour as used  by  anonymous  recipients
  959.                  (created  by using --throw-keyid) and might come
  960.                  handy  in  case  where  an   encrypted   message
  961.                  contains a bogus key ID.
  962.  
  963.        --enable-special-filenames
  964.                  This  options  enables a mode in which filenames
  965.                  of the form  -&n,  where  n  is  a  non-negative
  966.                  decimal  number,  refer to the file descriptor n
  967.                  and not to a file with that name.
  968.  
  969.        --no-expensive-trust-checks
  970.                  Experimental use only.
  971.  
  972. How to specify a user ID
  973.        There are different ways on how to specify a  user  ID  to
  974.        GnuPG; here are some examples:
  975.  
  976.  
  977.  
  978.  
  979.        234567C4
  980.  
  981.        0F34E556E
  982.  
  983.        01347A56A
  984.  
  985.        0xAB123456
  986.                  Here  the  key  ID  is  given in the usual short
  987.                  form.
  988.  
  989.        234AABBCC34567C4
  990.  
  991.        0F323456784E56EAB
  992.  
  993.        01AB3FED1347A5612
  994.  
  995.        0x234AABBCC34567C4
  996.                  Here the key ID is given in  the  long  form  as
  997.                  used by OpenPGP.
  998.  
  999.        1234343434343434C434343434343434
  1000.  
  1001.        123434343434343C3434343434343734349A3434
  1002.  
  1003.        0E12343434343434343434EAB3484343434343434
  1004.  
  1005.        0xE12343434343434343434EAB3484343434343434
  1006.                  The best way to specify a key ID is by using the
  1007.                  fingerprint  of  the  key.   This   avoids   any
  1008.                  ambiguities  in  case  that there are duplicated
  1009.                  key IDs (which are really rare for the long  key
  1010.                  IDs).
  1011.  
  1012.        =Heinrich Heine <heinrichh@uni-duesseldorf.de>
  1013.                  Using  an exact to match string.  The equal sign
  1014.                  indicates this.
  1015.  
  1016.        <heinrichh@uni-duesseldorf.de>
  1017.                  Using the email address part  which  must  match
  1018.                  exactly.  The  left angle bracket indicates this
  1019.                  email address mode.
  1020.  
  1021.        +Heinrich Heine duesseldorf
  1022.                  All  words  must   match   exactly   (not   case
  1023.                  sensitive)  but  can  appear in any order in the
  1024.                  user ID.  Words are any  sequences  of  letters,
  1025.                  digits,  the  underscore and all characters with
  1026.                  bit 7 set.
  1027.  
  1028.        #34       Using the Local ID.  This is a  very  low  level
  1029.                  method  and  should only be used by applications
  1030.                  which  really  need  it.   The  hash   character
  1031.                  indicates  this method.    An application should
  1032.                  not assume that this is only a number.
  1033.  
  1034.        Heine
  1035.  
  1036.        *Heine    By case insensitive substring matching.  This is
  1037.                  the  default  mode  but applications may want to
  1038.                  explicitly indicate this by putting the asterisk
  1039.                  in front.
  1040.  
  1041.        Note that you can append an exclamation mark to key IDs or
  1042.        fingerprints.  This flag which tells GnuPG to use  exactly
  1043.        that  primary or secondary key and don't try to figure out
  1044.        which secondary or primary key to use.
  1045.  
  1046.  
  1047. RETURN VALUE
  1048.        The program returns 0 if everything  was  fine,  1  if  at
  1049.        least a signature was bad, and other error codes for fatal
  1050.        errors.
  1051.  
  1052.  
  1053. EXAMPLES
  1054.        gpg -se -r Bob file
  1055.                  sign and encrypt for user Bob
  1056.  
  1057.        gpg --clearsign file
  1058.                  make a clear text signature
  1059.  
  1060.        gpg -sb  file
  1061.                  make a detached signature
  1062.  
  1063.        gpg --list-keys  user_ID
  1064.                  show keys
  1065.  
  1066.        gpg --fingerprint  user_ID
  1067.                  show fingerprint
  1068.  
  1069.        gpg --verify  pgpfile
  1070.  
  1071.        gpg --verify  sigfile [files]
  1072.                  Verify the signature of  the  file  but  do  not
  1073.                  output  the  data.  The  second form is used for
  1074.                  detached  signatures,  where  sigfile   is   the
  1075.                  detached  signature  (either  ASCII  armored  of
  1076.                  binary) and [files] are the signed data; if this
  1077.                  is  not  given  the name of the file holding the
  1078.                  signed data is constructed by  cutting  off  the
  1079.                  extension  (".asc"  or  ".sig") of sigfile or by
  1080.                  asking the user for the filename.
  1081.  
  1082. ENVIRONMENT
  1083.        HOME      Used to locate the default home directory.
  1084.  
  1085.        GNUPGHOME If set directory used instead of "~/.gnupg".
  1086.  
  1087.        http_proxy
  1088.                  Only honored when the option  --honor-http-proxy
  1089.                  is set.
  1090.  
  1091. FILES
  1092.        ~/.gnupg/secring.gpg
  1093.                  The secret keyring
  1094.  
  1095.        ~/.gnupg/secring.gpg.lock
  1096.                  and the lock file
  1097.  
  1098.        ~/.gnupg/pubring.gpg
  1099.                  The public keyring
  1100.  
  1101.        ~/.gnupg/pubring.gpg.lock
  1102.                  and the lock file
  1103.  
  1104.        ~/.gnupg/trustdb.gpg
  1105.                  The trust database
  1106.  
  1107.        ~/.gnupg/trustdb.gpg.lock
  1108.                  and the lock file
  1109.  
  1110.        ~/.gnupg/random_seed
  1111.                  used to preserve the internal random pool
  1112.  
  1113.        ~/.gnupg/options
  1114.                  May contain options
  1115.  
  1116.        /usr[/local]/share/gnupg/options.skel
  1117.                  Skeleton options file
  1118.  
  1119.        /usr[/local]/lib/gnupg/
  1120.                  Default location for extensions
  1121.  
  1122.  
  1123. WARNINGS
  1124.        Use  a  *good* password for your user account and a *good*
  1125.        passphrase to protect your secret key.  This passphrase is
  1126.        the  weakest  part  of  the  whole system.  Programs to do
  1127.        dictionary attacks on your secret keyring are very easy to
  1128.        write and so you should protect your "~/.gnupg/" directory
  1129.        very well.
  1130.  
  1131.        Keep in mind that, if this program is used over a  network
  1132.        (telnet), it is *very* easy to spy out your passphrase!
  1133.  
  1134.        If  you are going to verify detached signatures, make sure
  1135.        that the program nows about  it;  either  be  giving  both
  1136.        filenames  on the commandline or using - to specify stdin.
  1137.  
  1138. BUGS
  1139.        On many  systems  this  program  should  be  installed  as
  1140.        setuid(root).  This  is  necessary  to  lock memory pages.
  1141.        Locking memory pages prevents the  operating  system  from
  1142.        writing  memory  pages  to  disk.  If  you  get no warning
  1143.        message  about  insecure  memory  your  operating   system
  1144.        supports  locking  without  being  root. The program drops
  1145.        root privileges as soon as locked memory is allocated.
  1146.  
  1147.  
  1148.  
  1149.  
  1150.  
  1151.  
  1152.  
  1153.  
  1154.  
  1155.  
  1156.  
  1157.  
  1158.  
  1159.  
  1160.  
  1161.  
  1162.  
  1163.  
  1164.  
  1165.  
  1166.  
  1167.  
  1168.  
  1169.  
  1170.  
  1171.  
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185.  
  1186.  
  1187.  
  1188.  
  1189.