import works
[gnupg.git] / g10 / OPTIONS
1 # This is a sample option file
2 #
3 # Unless you you specify which option file to use with the
4 # commandline option "--options filename", g10 uses per
5 # default the file ~/.g10/options.
6 #
7 # An option file can contain all long options which are
8 # available in G10. If the first non white space character of
9 # a line is a '#', this line is ignored.  Empty lines are also
10 # ignored.
11 #
12 # Here is a list of all possible options. Not of all them make
13 # sense in an option file; consider this as a complete option
14 # reference. Before the options you find a list of commands.
15
16
17 #-----------------------------------------------
18 #------------------- Commands ------------------
19 #-----------------------------------------------
20 # With some expections, those cannot be combined
21
22 add-key
23 # add key to the public keyring
24
25 change-passphrase
26 # change the passphrase of your secret keyring
27
28 check
29 # check a signature
30
31 decrypt
32 # decrypt data (default)
33
34 delete-key
35 # remove key from public keyring,
36
37 edit-sig
38 # edit a key signature. Currently you have only the option to delete
39 # some signatures.
40
41 encrypt
42 # (Can be combined with a "sign")
43 # encrypt data
44
45 export <names>
46 # Either export all keys from all keyrings (default keyrings and
47 # those registered via option "keyring"), or if at least one name is
48 # given, those of the givename. The new keyring is written to stdout
49 # or to the file given with option "output"
50
51 fingerprint
52 # show the fingerprints,
53
54 gen-key
55 # generate a new key pair, this is an interactive command.
56
57 gen-prime
58 # Generate a prime.
59 # With one argument:  take it as the bitsize and make a simple prime of
60 #                     this size
61 # With two arguments: Generate a prime, usable for DL algorithms.
62 # With three arguments: same as above, but a third argument indicates
63 #                       that a generator should also be calculated.
64
65 list-packets
66 # List only the sequence of packets"},
67
68
69 print-mds
70 # print all message digests of all give filenames
71
72 sign
73 # (Can be combined with a "encrypt")
74 # make a signature
75
76 sign-key
77 # make a signature on a key in the keyring
78 # Argument is the userid of the key to sign.
79 # This looks for the key, displays the key and checks all
80 # existing signatures of this key. If the key is not yet signed
81 # by the default user (or the users given with "-l"), the programm
82 # displays the information of the key again, together with
83 # it's fingerprint and asked wehter it should be signed. This question
84 # is repeated for all users specified with "-l".  The key is then signed
85 # and the keyring which contains the key is updated.
86
87 store
88 # simply packs the input data into a rfc1991 packet format
89
90 symmetric
91 # encrypt the input only with the symmetric (conventional) cipher.
92 # This asks for a passphrase.
93
94
95 test
96 # Used for testing some parts of the program
97
98 #----------------------------------------------
99 #------  Options without a long form ----------
100 #----------------------------------------------
101
102 -k
103 # List keyrings.
104 # Without arguments, all default public keyrings are listed
105 # With one argument, this keyring is listed.
106 #
107 # -kv    is the same as -k
108 # -kvv   list the signatures with every key
109 # -kvvv  additional checks all signatures
110 # -kvc   list fingerprints
111 # -kvvc  list fingerprints and signatures
112 # Note that this is a kludge, to emulate the strange pgp syntax;
113 # combining it with other options may give other outputs.
114
115
116
117 -z n
118 # Set compress level to n.
119 # n = 0 disables compresson. Default compress level depends on
120 # the local zlib (6).
121
122
123 #-----------------------------------------------
124 #------------------- Options -------------------
125 #-----------------------------------------------
126
127
128 armor
129 # create ascii armored output
130
131
132 batch
133 # batch mode: never ask
134
135 no-batch
136 # disables batch
137
138 cache-all
139 # hold everything in memory
140
141
142 check-key
143 # check signatures on a key in the keyring
144
145 debug  value|hexvalue
146 #  set debugging flags,
147
148 debug-all
149 # enable full debugging
150
151
152 detach-sign
153 # make a detached signature,
154
155 dry-run
156 # don't make any changes
157
158 homedir dirname
159 # Set the name of the home directory which defaults to "~/.g10".
160
161 keyring  filename
162 # add this filename to the list of keyrings.
163 # If the filename begins with a tilde and a slash, these are replaced
164 # by the HOME directory. If the filename does not contain a slash, it
165 # is assumed to be in "~/.g10"
166
167 local-user user-string
168 #  use this user-string to sign or decrypt
169
170 no
171 # assume no on most questions
172
173 no-armor
174 # Assume the input data is not in ascii armored format.
175
176 no-default-keyring
177 # Do not add the default keyrings to the list of keyrings
178
179 no-greeting
180 # suppress the initial copyright etc. messages but do not enter batch mode.
181
182 no-verbose
183 # set verbose level to 0
184
185 options filename
186 #  Ignored in option files.
187
188 no-options
189 # same as --options /dev/null.  This option is detected
190 # before an attempt to open an option file
191
192 output filename
193 # use filename for output
194
195 passphrase-fd n
196 # Read the passphrase from file with the descriptor n.  If you use
197 # 0 for n, the passphrase will be read from stdin.  This can only be used
198 # if only one passphrase is supplied.
199
200
201 remote-user
202 # use this user-id for encryption"
203
204 secret-keyring filename
205 # add filename to the list of secret keyrings
206 # see "keyring" for further informations
207
208 status-fd n
209 # Write status informations to this file descriptor. If this option
210 # is not used, no status information is writte.  This option is for the
211 # sake of a calling programm (e.g. a MUA) to ease up parsing of output
212 # and providing a defined set of status messages.
213 # FIXME: use a format ala "100 Blabla"?
214
215 verbose
216 # Give more informations suring processing. If used 2 times, the input data
217 # is listed in detail.
218
219 yes
220 # assume yes on most questions
221