Updated.
[gnupg.git] / g10 / options.skel
index ed5a2a9..fa77daa 100644 (file)
@@ -1,8 +1,8 @@
-These first three lines are not copied to the gpg.conf file in
-the users home directory.
-$Id$
+These first three lines are not copied to the gpg.conf file in
+the users home directory.
+$Id$
 # Options for GnuPG
-# Copyright 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
+# Copyright 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
 # 
 # This file is free software; as a special exception the author gives
 # unlimited permission to copy and/or distribute it, with or without
@@ -39,6 +39,14 @@ $Id$
 #default-recipient some-user-id
 #default-recipient-self
 
+# Use --encrypt-to to add the specified key as a recipient to all
+# messages.  This is useful, for example, when sending mail through a
+# mail client that does not automatically encrypt mail to your key.
+# In the example, this option allows you to read your local copy of
+# encrypted mail that you've sent to others.
+
+#encrypt-to some-key-id
+
 # By default GnuPG creates version 3 signatures for data files.  This
 # is not strictly OpenPGP compliant but PGP 6 and most versions of PGP
 # 7 require them.  To disable this behavior, you may use this option
@@ -56,14 +64,15 @@ $Id$
 # If you do not use the Latin-1 (ISO-8859-1) charset, you should tell
 # GnuPG which is the native character set.  Please check the man page
 # for supported character sets.  This character set is only used for
-# Meta data and not for the actual message which does not undergo any
+# metadata and not for the actual message which does not undergo any
 # translation.  Note that future version of GnuPG will change to UTF-8
-# as default character set.
+# as default character set.  In most cases this option is not required 
+# GnuPG is able to figure out the correct charset and use that.
 
 #charset utf-8
 
 # Group names may be defined like this:
-#   group mynames paige 0x12345678 joe patti
+#   group mynames paige 0x12345678 joe patti
 #
 # Any time "mynames" is a recipient (-r or --recipient), it will be
 # expanded to the names "paige", "joe", and "patti", and the key ID
@@ -72,30 +81,30 @@ $Id$
 # if there are spaces in the recipient name, this will appear as two
 # recipients.  In these cases it is better to use the key ID.
 
-#group mynames paige 0x12345678 joe patti
+#group mynames paige 0x12345678 joe patti
 
 # Lock the file only once for the lifetime of a process.  If you do
 # not define this, the lock will be obtained and released every time
-# it is needed - normally this is not needed.
+# it is needed, which is usually preferable.
 
-lock-once
+#lock-once
 
 # GnuPG can send and receive keys to and from a keyserver.  These
 # servers can be HKP, email, or LDAP (if GnuPG is built with LDAP
 # support).
 #
 # Example HKP keyserver:
-#      x-hkp://keyserver.cryptnet.net
+#      hkp://subkeys.pgp.net
 #
 # Example email keyserver:
-#      mailto:pgp-public-keys@keys.nl.pgp.net
+#      mailto:pgp-public-keys@keys.pgp.net
 #
-# Example LDAP keyserver:
-#      ldap://pgp.surfnet.nl:11370
+# Example LDAP keyservers:
+#      ldap://keyserver.pgp.com
 #
 # Regular URL syntax applies, and you can set an alternate port
 # through the usual method:
-#      x-hkp://keyserver.example.net:22742
+#      hkp://keyserver.example.net:22742
 #
 # If you have problems connecting to a HKP server through a buggy http
 # proxy, you can use keyserver option broken-http-proxy (see below),
@@ -103,20 +112,24 @@ lock-once
 # regarding proxies (keyserver option honor-http-proxy)
 #
 # Most users just set the name and type of their preferred keyserver.
-# Most servers do synchronize with each other and DNS round-robin may
-# give you a quasi-random server each time.
-
-#keyserver x-hkp://pgp.mit.edu
+# Note that most servers (with the notable exception of
+# ldap://keyserver.pgp.com) synchronize changes with each other.  Note
+# also that a single server name may actually point to multiple
+# servers via DNS round-robin.  hkp://subkeys.pgp.net is an example of
+# such a "server", which spreads the load over a number of physical
+# servers.
+
+keyserver hkp://subkeys.pgp.net
 #keyserver mailto:pgp-public-keys@keys.nl.pgp.net
-#keyserver ldap://pgp.surfnet.nl:11370
+#keyserver ldap://keyserver.pgp.com
 
 # Common options for keyserver functions:
 #
 # include-disabled = when searching, include keys marked as "disabled"
 #                    on the keyserver (not all keyservers support this).
 #
-# include-revoked = when searching, include keys marked as "revoked"
-#                   on the keyserver.
+# no-include-revoked = when searching, do not include keys marked as
+#                      "revoked" on the keyserver.
 #
 # verbose = show more information as the keys are fetched.
 #           Can be used more than once to increase the amount
@@ -142,12 +155,16 @@ lock-once
 # no-include-attributes = do not include attribute IDs (aka "photo IDs")
 #                         when sending keys to the keyserver.
 
-#keyserver-options auto-key-retrieve include-disabled include-revoked
+#keyserver-options auto-key-retrieve
+
+# Display photo user IDs in key listings
 
-# Uncomment this line to display photo user IDs in key listings and
-# when a signature from a key with a photo is verified.
+# list-options show-photos
 
-#show-photos
+# Display photo user IDs when a signature from a key with a photo is
+# verified
+
+# verify-options show-photos
 
 # Use this program to display photo user IDs
 #
@@ -165,13 +182,13 @@ lock-once
 # input is the best way to do this as it avoids the time and effort in
 # generating and then cleaning up a secure temp file.
 #
-# The default program is "xloadimage -fork -quiet -title 'KeyID 0x%k' stdin"
-# On Mac OS X and Windows, the default is to use your regular image viewer.
+# If no photo-viewer is provided, GnuPG will look for xloadimage, eog,
+# or display (ImageMagick).  On Mac OS X and Windows, the default is
+# to use your regular JPEG image viewer.
 #
 # Some other viewers:
 # photo-viewer "qiv %i"
 # photo-viewer "ee %i"
-# photo-viewer "display -title 'KeyID 0x%k'"
 #
 # This one saves a copy of the photo ID in your home directory:
 # photo-viewer "cat > ~/photoid-for-key-%k.%t"
@@ -179,13 +196,12 @@ lock-once
 # Use your MIME handler to view photos:
 # photo-viewer "metamail -q -d -b -c %T -s 'KeyID 0x%k' -f GnuPG"
 
-
 # Passphrase agent
 #
-# We support the old experimental passphrase agent protocol as well
-# as the new Assuan based one (currently available in the "newpg" package
-# at ftp.gnupg.org/gcrypt/alpha/aegypten/).  To make use of the agent, you have
-# to run an agent as daemon and use the option
+# We support the old experimental passphrase agent protocol as well as
+# the new Assuan based one (currently available in the "newpg" package
+# at ftp.gnupg.org/gcrypt/alpha/aegypten/).  To make use of the agent,
+# you have to run an agent as daemon and use the option
 #
 # use-agent
 # 
@@ -199,3 +215,27 @@ lock-once
 # --gpg-agent-info=<path>:<pid>:1
 #
 # may be used to override it.
+
+# Automatic key location
+#
+# GnuPG can automatically locate and retrieve keys as needed using the
+# auto-key-locate option.  This happens when encrypting to an email
+# address (in the "user@example.com" form), and there are no
+# user@example.com keys on the local keyring.  This option takes the
+# following arguments, in the order they are to be tried:
+# 
+# cert = locate a key using DNS CERT, as specified in 2538bis
+# (currently in draft): http://www.josefsson.org/rfc2538bis/
+#
+# pka = locate a key using DNS PKA.
+#
+# ldap = locate a key using the PGP Universal method of checking
+# "ldap://keys.(thedomain)".
+#
+# keyserver = locate a key using whatever keyserver is defined using
+# the keyserver option.
+#
+# You may also list arbitrary keyservers here by URL.
+#
+# Try CERT, then PKA, then LDAP, then hkp://subkeys.net:
+#auto-key-locate cert pka ldap hkp://subkeys.pgp.net