* options.skel: Some language tweaks, and remove the load-extension
[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 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 # By default GnuPG creates version 3 signatures for data files.  This
43 # is not strictly OpenPGP compliant but PGP 6 and most versions of PGP
44 # 7 require them.  To disable this behavior, you may use this option
45 # or --openpgp.
46
47 #no-force-v3-sigs
48
49 # Because some mailers change lines starting with "From " to ">From "
50 # it is good to handle such lines in a special way when creating
51 # cleartext signatures; all other PGP versions do it this way too.
52 # To enable full OpenPGP compliance you may want to use this option.
53
54 #no-escape-from-lines
55
56 # If you do not use the Latin-1 (ISO-8859-1) charset, you should tell
57 # GnuPG which is the native character set.  Please check the man page
58 # for supported character sets.  This character set is only used for
59 # Meta data and not for the actual message which does not undergo any
60 # translation.  Note that future version of GnuPG will change to UTF-8
61 # as default character set.
62 #charset utf-8
63
64 # Group names may be defined like this:
65 #   group mynames paige 0x12345678 joe patti
66 #
67 # Any time "mynames" is a recipient (-r or --recipient), it will be
68 # expanded to the names "paige", "joe", and "patti", and the key ID
69 # "0x12345678".  Note there is only one level of expansion - you
70 # cannot make an group that points to another group.  Note if there
71 # are spaces in the recipient name, this will appear as two
72 # recipients.  In these cases it is better to use the key ID.
73
74 # Lock the file only once for the lifetime of a process.  If you do
75 # not define this, the lock will be obtained and released every time
76 # it is needed - normally this is not needed.
77
78 lock-once
79
80 # GnuPG can send and receive keys to and from a keyserver.  These
81 # servers can be HKP, email, or LDAP (if GnuPG is built with LDAP
82 # support).
83 #
84 # Example HKP keyserver:
85 #      x-hkp://keyserver.cryptnet.net
86 #
87 # Example email keyserver:
88 #      mailto:pgp-public-keys@keys.nl.pgp.net
89 #
90 # Example LDAP keyserver:
91 #      ldap://pgp.surfnet.nl:11370
92 #
93 # Regular URL syntax applies, and you can set an alternate port
94 # through the usual method:
95 #      x-hkp://keyserver.example.net:22742
96 #
97 # If you have problems connecting to a HKP server through a buggy http
98 # proxy, you can use keyserver option broken-http-proxy (see below),
99 # but first you should make sure that you have read the man page
100 # regarding proxies (keyserver option honor-http-proxy)
101 #
102 # Most users just set the name and type of their preferred keyserver.
103 # Most servers do synchronize with each other and DNS round-robin may
104 # give you a quasi-random server each time.
105
106 #keyserver x-hkp://keyserver.cryptnet.net
107 #keyserver mailto:pgp-public-keys@keys.nl.pgp.net
108 #keyserver ldap://pgp.surfnet.nl:11370
109
110 # Options for keyserver functions
111 #
112 # include-disabled = when searching, include keys marked as "disabled"
113 #                    on the keyserver (not all keyservers support this).
114 #
115 # include-revoked = when searching, include keys marked as "revoked"
116 #                   on the keyserver.
117 #
118 # verbose = show more information as the keys are fetched.
119 #           Can be used more than once to increase the amount
120 #           of information shown.
121 #
122 # use-temp-files = use temporary files instead of a pipe to talk to the
123 #                  keyserver.  Some platforms (Win32 for one) always
124 #                  have this on.
125 #
126 # keep-temp-files = do not delete temporary files after using them
127 #                   (really only useful for debugging)
128 #
129 # honor-http-proxy = if the keyserver uses HTTP, honor the http_proxy
130 #                    environment variable
131 #
132 # broken-http-proxy = try to work around a buggy HTTP proxy
133 #
134 # auto-key-retrieve = automatically fetch keys as needed from the
135 #                     keyserver when verifying signatures or when importing
136 #                     keys that have been revoked by a revocation key that
137 #                     is not present on the keyring.
138
139 #keyserver-options auto-key-retrieve include-disabled include-revoked
140
141 # Uncomment this line to display photo user IDs in key listings and
142 # when a signature from a key with a photo is verified.
143
144 #show-photos
145
146 # Use this program to display photo user IDs
147 #
148 # %i is expanded to a temporary file that contains the photo.
149 # %I is the same as %i, but the file isn't deleted afterwards by GnuPG.
150 # %k is expanded to the key ID of the key.
151 # %K is expanded to the long OpenPGP key ID of the key.
152 # %t is expanded to the extension of the image (e.g. "jpg").
153 # %T is expanded to the MIME type of the image (e.g. "image/jpeg").
154 # %f is expanded to the fingerprint of the key.
155 # %% is %, of course.
156 #
157 # If %i or %I are not present, then the photo is supplied to the
158 # viewer on standard input.  If your platform supports it, standard
159 # input is the best way to do this as it avoids the time and effort in
160 # generating and then cleaning up a secure temp file.
161 #
162 # The default program is "xloadimage -fork -quiet -title 'KeyID 0x%k' stdin"
163 # On Mac OS X and Windows, the default is to use your regular image viewer.
164 #
165 # Some other viewers:
166 # photo-viewer "qiv %i"
167 # photo-viewer "ee %i"
168 # photo-viewer "display -title 'KeyID 0x%k'"
169 #
170 # This one saves a copy of the photo ID in your home directory:
171 # photo-viewer "cat > ~/photoid-for-key-%k.%t"
172 #
173 # Use your MIME handler to view photos:
174 # photo-viewer "metamail -q -d -b -c %T -s 'KeyID 0x%k' -f GnuPG"
175
176
177 # Passphrase agent
178 #
179 # We support the old experimental passphrase agent protocol as well
180 # as the new Assuan based one (currently available in the "newpg" package
181 # at ftp.gnupg.org/gcrypt/alpha/aegypten/).  To make use of the agent, you have
182 # to run an agent as daemon and use the option
183 #
184 # use-agent
185
186 # which tries to use the agent but will fallback to the regular mode
187 # if there is a problem connecting to the agent.  The normal way to
188 # locate the agent is by looking at the environment variable
189 # GPG_AGENT_INFO which should have been set during gpg-agent startup.
190 # In certain situations the use of this variable is not possible, thus
191 # the option
192
193 # --gpg-agent-info=<path>:<pid>:1
194 #
195 # may be used to override it.