* options.skel: Document auto-key-locate and give a pointer to Simon
[gnupg.git] / g10 / options.skel
1 # These first three lines are not copied to the gpg.conf file in
2 # the users home directory.
3 # $Id$
4 # Options for GnuPG
5 # Copyright 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
6
7 # This file is free software; as a special exception the author gives
8 # unlimited permission to copy and/or distribute it, with or without
9 # modifications, as long as this notice is preserved.
10
11 # This file is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
13 # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14 #
15 # Unless you specify which option file to use (with the command line
16 # option "--options filename"), GnuPG uses the file ~/.gnupg/gpg.conf
17 # by default.
18 #
19 # An options file can contain any long options which are available in
20 # GnuPG. If the first non white space character of a line is a '#',
21 # this line is ignored.  Empty lines are also ignored.
22 #
23 # See the man page for a list of options.
24
25 # Uncomment the following option to get rid of the copyright notice
26
27 #no-greeting
28
29 # If you have more than 1 secret key in your keyring, you may want to
30 # uncomment the following option and set your preferred keyid.
31
32 #default-key 621CC013
33
34 # If you do not pass a recipient to gpg, it will ask for one.  Using
35 # this option you can encrypt to a default key.  Key validation will
36 # not be done in this case.  The second form uses the default key as
37 # default recipient.
38
39 #default-recipient some-user-id
40 #default-recipient-self
41
42 # Use --encrypt-to to add the specified key as a recipient to all
43 # messages.  This is useful, for example, when sending mail through a
44 # mail client that does not automatically encrypt mail to your key.
45 # In the example, this option allows you to read your local copy of
46 # encrypted mail that you've sent to others.
47
48 #encrypt-to some-key-id
49
50 # By default GnuPG creates version 3 signatures for data files.  This
51 # is not strictly OpenPGP compliant but PGP 6 and most versions of PGP
52 # 7 require them.  To disable this behavior, you may use this option
53 # or --openpgp.
54
55 #no-force-v3-sigs
56
57 # Because some mailers change lines starting with "From " to ">From "
58 # it is good to handle such lines in a special way when creating
59 # cleartext signatures; all other PGP versions do it this way too.
60 # To enable full OpenPGP compliance you may want to use this option.
61
62 #no-escape-from-lines
63
64 # If you do not use the Latin-1 (ISO-8859-1) charset, you should tell
65 # GnuPG which is the native character set.  Please check the man page
66 # for supported character sets.  This character set is only used for
67 # metadata and not for the actual message which does not undergo any
68 # translation.  Note that future version of GnuPG will change to UTF-8
69 # as default character set.  In most cases this option is not required 
70 # GnuPG is able to figure out the correct charset and use that.
71
72 #charset utf-8
73
74 # Group names may be defined like this:
75 #   group mynames = paige 0x12345678 joe patti
76 #
77 # Any time "mynames" is a recipient (-r or --recipient), it will be
78 # expanded to the names "paige", "joe", and "patti", and the key ID
79 # "0x12345678".  Note there is only one level of expansion - you
80 # cannot make an group that points to another group.  Note also that
81 # if there are spaces in the recipient name, this will appear as two
82 # recipients.  In these cases it is better to use the key ID.
83
84 #group mynames = paige 0x12345678 joe patti
85
86 # Lock the file only once for the lifetime of a process.  If you do
87 # not define this, the lock will be obtained and released every time
88 # it is needed, which is usually preferable.
89
90 #lock-once
91
92 # GnuPG can send and receive keys to and from a keyserver.  These
93 # servers can be HKP, email, or LDAP (if GnuPG is built with LDAP
94 # support).
95 #
96 # Example HKP keyserver:
97 #      hkp://subkeys.pgp.net
98 #
99 # Example email keyserver:
100 #      mailto:pgp-public-keys@keys.pgp.net
101 #
102 # Example LDAP keyservers:
103 #      ldap://keyserver.pgp.com
104 #
105 # Regular URL syntax applies, and you can set an alternate port
106 # through the usual method:
107 #      hkp://keyserver.example.net:22742
108 #
109 # If you have problems connecting to a HKP server through a buggy http
110 # proxy, you can use keyserver option broken-http-proxy (see below),
111 # but first you should make sure that you have read the man page
112 # regarding proxies (keyserver option honor-http-proxy)
113 #
114 # Most users just set the name and type of their preferred keyserver.
115 # Note that most servers (with the notable exception of
116 # ldap://keyserver.pgp.com) synchronize changes with each other.  Note
117 # also that a single server name may actually point to multiple
118 # servers via DNS round-robin.  hkp://subkeys.pgp.net is an example of
119 # such a "server", which spreads the load over a number of physical
120 # servers.
121
122 keyserver hkp://subkeys.pgp.net
123 #keyserver mailto:pgp-public-keys@keys.nl.pgp.net
124 #keyserver ldap://keyserver.pgp.com
125
126 # Common options for keyserver functions:
127 #
128 # include-disabled = when searching, include keys marked as "disabled"
129 #                    on the keyserver (not all keyservers support this).
130 #
131 # no-include-revoked = when searching, do not include keys marked as
132 #                      "revoked" on the keyserver.
133 #
134 # verbose = show more information as the keys are fetched.
135 #           Can be used more than once to increase the amount
136 #           of information shown.
137 #
138 # use-temp-files = use temporary files instead of a pipe to talk to the
139 #                  keyserver.  Some platforms (Win32 for one) always
140 #                  have this on.
141 #
142 # keep-temp-files = do not delete temporary files after using them
143 #                   (really only useful for debugging)
144 #
145 # honor-http-proxy = if the keyserver uses HTTP, honor the http_proxy
146 #                    environment variable
147 #
148 # broken-http-proxy = try to work around a buggy HTTP proxy
149 #
150 # auto-key-retrieve = automatically fetch keys as needed from the keyserver
151 #                     when verifying signatures or when importing keys that
152 #                     have been revoked by a revocation key that is not
153 #                     present on the keyring.
154 #
155 # no-include-attributes = do not include attribute IDs (aka "photo IDs")
156 #                         when sending keys to the keyserver.
157
158 #keyserver-options auto-key-retrieve
159
160 # Display photo user IDs in key listings
161
162 # list-options show-photos
163
164 # Display photo user IDs when a signature from a key with a photo is
165 # verified
166
167 # verify-options show-photos
168
169 # Use this program to display photo user IDs
170 #
171 # %i is expanded to a temporary file that contains the photo.
172 # %I is the same as %i, but the file isn't deleted afterwards by GnuPG.
173 # %k is expanded to the key ID of the key.
174 # %K is expanded to the long OpenPGP key ID of the key.
175 # %t is expanded to the extension of the image (e.g. "jpg").
176 # %T is expanded to the MIME type of the image (e.g. "image/jpeg").
177 # %f is expanded to the fingerprint of the key.
178 # %% is %, of course.
179 #
180 # If %i or %I are not present, then the photo is supplied to the
181 # viewer on standard input.  If your platform supports it, standard
182 # input is the best way to do this as it avoids the time and effort in
183 # generating and then cleaning up a secure temp file.
184 #
185 # The default program is "xloadimage -fork -quiet -title 'KeyID 0x%k' stdin"
186 # On Mac OS X and Windows, the default is to use your regular JPEG image
187 # viewer.
188 #
189 # Some other viewers:
190 # photo-viewer "qiv %i"
191 # photo-viewer "ee %i"
192 # photo-viewer "display -title 'KeyID 0x%k'"
193 #
194 # This one saves a copy of the photo ID in your home directory:
195 # photo-viewer "cat > ~/photoid-for-key-%k.%t"
196 #
197 # Use your MIME handler to view photos:
198 # photo-viewer "metamail -q -d -b -c %T -s 'KeyID 0x%k' -f GnuPG"
199
200 # Passphrase agent
201 #
202 # We support the old experimental passphrase agent protocol as well as
203 # the new Assuan based one (currently available in the "newpg" package
204 # at ftp.gnupg.org/gcrypt/alpha/aegypten/).  To make use of the agent,
205 # you have to run an agent as daemon and use the option
206 #
207 # use-agent
208
209 # which tries to use the agent but will fallback to the regular mode
210 # if there is a problem connecting to the agent.  The normal way to
211 # locate the agent is by looking at the environment variable
212 # GPG_AGENT_INFO which should have been set during gpg-agent startup.
213 # In certain situations the use of this variable is not possible, thus
214 # the option
215
216 # --gpg-agent-info=<path>:<pid>:1
217 #
218 # may be used to override it.
219
220 # Automatic key location
221 #
222 # GnuPG can automatically locate and retrieve keys as needed using the
223 # auto-key-locate option.  This happens when encrypting to an email
224 # address (in the "user@example.com" form), and there are no
225 # user@example.com keys on the local keyring.  This option takes the
226 # following arguments, in the order they are to be tried:
227
228 # cert = locate a key using DNS CERT, as specified in 2538bis
229 # (currently in draft): http://www.josefsson.org/rfc2538bis/
230 #
231 # pka = locate a key using DNS PKA.
232 #
233 # ldap = locate a key using the PGP Universal method of checking
234 # "ldap://keys.(thedomain)".
235 #
236 # keyserver = locate a key using whatever keyserver is defined using
237 # the keyserver option.
238 #
239 # You may also list arbitrary keyservers here by URL.
240 #
241 # Try CERT, then PKA, then LDAP, then hkp://subkeys.net:
242 #auto-key-locate cert pka ldap hkp://subkeys.pgp.net