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