gpg: Reflow long texts.
[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-2003, 2010 Free Software Foundation, Inc.
6 # Copyright 1998-2003, 2010 Werner Koch
7 #
8 # This file is free software; as a special exception the author gives
9 # unlimited permission to copy and/or distribute it, with or without
10 # modifications, as long as this notice is preserved.
11 #
12 # This file is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
14 # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15 #
16 # Unless you specify which option file to use (with the command line
17 # option "--options filename"), GnuPG uses the file ~/.gnupg/gpg.conf
18 # by default.
19 #
20 # An options file can contain any long options which are available in
21 # GnuPG. If the first non white space character of a line is a '#',
22 # this line is ignored.  Empty lines are also ignored.
23 #
24 # See the man page for a list of options.
25
26 # Uncomment the following option to get rid of the copyright notice
27
28 #no-greeting
29
30 # If you have more than 1 secret key in your keyring, you may want to
31 # uncomment the following option and set your preferred keyid.
32
33 #default-key 621CC013
34
35 # If you do not pass a recipient to gpg, it will ask for one.  Using
36 # this option you can encrypt to a default key.  Key validation will
37 # not be done in this case.  The second form uses the default key as
38 # default recipient.
39
40 #default-recipient some-user-id
41 #default-recipient-self
42
43 # By default GnuPG creates version 4 signatures for data files as
44 # specified by OpenPGP.  Some earlier (PGP 6, PGP 7) versions of PGP
45 # require the older version 3 signatures.  Setting this option forces
46 # GnuPG to create version 3 signatures.
47
48 #force-v3-sigs
49
50 # Because some mailers change lines starting with "From " to ">From "
51 # it is good to handle such lines in a special way when creating
52 # cleartext signatures; all other PGP versions do it this way too.
53 # To enable full OpenPGP compliance you may want to use this option.
54
55 #no-escape-from-lines
56
57 # When verifying a signature made from a subkey, ensure that the cross
58 # certification "back signature" on the subkey is present and valid.
59 # This protects against a subtle attack against subkeys that can sign.
60 # Defaults to --no-require-cross-certification.  However for new
61 # installations it should be enabled.
62
63 require-cross-certification
64
65
66 # If you do not use the Latin-1 (ISO-8859-1) charset, you should tell
67 # GnuPG which is the native character set.  Please check the man page
68 # for supported character sets.  This character set is only used for
69 # metadata and not for the actual message which does not undergo any
70 # translation.  Note that future version of GnuPG will change to UTF-8
71 # as default character set.
72
73 #charset utf-8
74
75 # Group names may be defined like this:
76 #   group mynames = paige 0x12345678 joe patti
77 #
78 # Any time "mynames" is a recipient (-r or --recipient), it will be
79 # expanded to the names "paige", "joe", and "patti", and the key ID
80 # "0x12345678".  Note there is only one level of expansion - you
81 # cannot make an group that points to another group.  Note also that
82 # if there are spaces in the recipient name, this will appear as two
83 # recipients.  In these cases it is better to use the key ID.
84
85 #group mynames = paige 0x12345678 joe patti
86
87 # Some old Windows platforms require 8.3 filenames.  If your system
88 # can handle long filenames, uncomment this.
89
90 #no-mangle-dos-filenames
91
92 # Lock the file only once for the lifetime of a process.  If you do
93 # not define this, the lock will be obtained and released every time
94 # it is needed - normally this is not needed.
95
96 #lock-once
97
98
99 # Common options for keyserver functions:
100 # (Note that the --keyserver option has been moved to dirmngr.conf)
101 #
102 # include-disabled = when searching, include keys marked as "disabled"
103 #                    on the keyserver (not all keyservers support this).
104 #
105 # no-include-revoked = when searching, do not include keys marked as
106 #                      "revoked" on the keyserver.
107 #
108 # verbose = show more information as the keys are fetched.
109 #           Can be used more than once to increase the amount
110 #           of information shown.
111 #
112 # use-temp-files = use temporary files instead of a pipe to talk to the
113 #                  keyserver.  Some platforms (Win32 for one) always
114 #                  have this on.
115 #
116 # keep-temp-files = do not delete temporary files after using them
117 #                   (really only useful for debugging)
118 #
119 # honor-http-proxy = if the keyserver uses HTTP, honor the http_proxy
120 #                    environment variable
121 #
122 # broken-http-proxy = try to work around a buggy HTTP proxy
123 #
124 # auto-key-retrieve = automatically fetch keys as needed from the keyserver
125 #                     when verifying signatures or when importing keys that
126 #                     have been revoked by a revocation key that is not
127 #                     present on the keyring.
128 #
129 # no-include-attributes = do not include attribute IDs (aka "photo IDs")
130 #                         when sending keys to the keyserver.
131
132 #keyserver-options auto-key-retrieve
133
134 # Uncomment this line to display photo user IDs in key listings and
135 # when a signature from a key with a photo is verified.
136
137 #show-photos
138
139 # Use this program to display photo user IDs
140 #
141 # %i is expanded to a temporary file that contains the photo.
142 # %I is the same as %i, but the file isn't deleted afterwards by GnuPG.
143 # %k is expanded to the key ID of the key.
144 # %K is expanded to the long OpenPGP key ID of the key.
145 # %t is expanded to the extension of the image (e.g. "jpg").
146 # %T is expanded to the MIME type of the image (e.g. "image/jpeg").
147 # %f is expanded to the fingerprint of the key.
148 # %% is %, of course.
149 #
150 # If %i or %I are not present, then the photo is supplied to the
151 # viewer on standard input.  If your platform supports it, standard
152 # input is the best way to do this as it avoids the time and effort in
153 # generating and then cleaning up a secure temp file.
154 #
155 # The default program is "xloadimage -fork -quiet -title 'KeyID 0x%k' stdin"
156 # On Mac OS X and Windows, the default is to use your regular JPEG image
157 # viewer.
158 #
159 # Some other viewers:
160 # photo-viewer "qiv %i"
161 # photo-viewer "ee %i"
162 # photo-viewer "display -title 'KeyID 0x%k'"
163 #
164 # This one saves a copy of the photo ID in your home directory:
165 # photo-viewer "cat > ~/photoid-for-key-%k.%t"
166 #
167 # Use your MIME handler to view photos:
168 # photo-viewer "metamail -q -d -b -c %T -s 'KeyID 0x%k' -f GnuPG"