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