NT version compiles
[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 fingerprint
46 # show the fingerprints,
47
48 gen-key
49 # generate a new key pair, this is an interactive command.
50
51 gen-prime
52 # Generate a prime.
53 # With one argument:  take it as the bitsize and make a simple prime of
54 #                     this size
55 # With two arguments: Generate a prime, usable for DL algorithms.
56 # With three arguments: same as above, but a third argument indicates
57 #                       that a generator should also be calculated.
58
59 list-packets
60 # List only the sequence of packets"},
61
62
63 print-mds
64 # print all message digests of all give filenames
65
66 sign
67 # (Can be combined with a "encrypt")
68 # make a signature
69
70 sign-key
71 # make a signature on a key in the keyring
72 # Argument is the userid of the key to sign.
73 # This looks for the key, displays the key and checks all
74 # existing signatures of this key. If the key is not yet signed
75 # by the default user (or the users given with "-l"), the programm
76 # displays the information of the key again, together with
77 # it's fingerprint and asked wehter it should be signed. This question
78 # is repeated for all users specified with "-l".  The key is then signed
79 # and the keyring which contains the key is updated.
80
81 store
82 # simply packs the input data into a rfc1991 packet format
83
84 symmetric
85 # encrypt the input only with the symmetric (conventional) cipher.
86 # This asks for a passphrase.
87
88
89 test
90 # Used for testing some parts of the program
91
92 #----------------------------------------------
93 #------  Options without a long form ----------
94 #----------------------------------------------
95
96 -k
97 # List keyrings.
98 # Without arguments, all default public keyrings are listed
99 # With one argument, this keyring is listed.
100 #
101 # -kv    is the same as -k
102 # -kvv   list the signatures with every key
103 # -kvvv  additional checks all signatures
104 # -kvc   list fingerprints
105 # -kvvc  list fingerprints and signatures
106 # Note that this is a kludge, to emulate the strange pgp syntax;
107 # combining it with other options may give other outputs.
108
109
110
111 -z n
112 # Set compress level to n.
113 # n = 0 disables compresson. Default compress level depends on
114 # the local zlib (6).
115
116
117 #-----------------------------------------------
118 #------------------- Options -------------------
119 #-----------------------------------------------
120
121
122 armor
123 # create ascii armored output
124
125
126 batch
127 # batch mode: never ask
128
129 cache-all
130 # hold everything in memory
131
132
133 check-key
134 # check signatures on a key in the keyring
135
136 debug  value|hexvalue
137 #  set debugging flags,
138
139 debug-all
140 # enable full debugging
141
142
143 detach-sign
144 # make a detached signature,
145
146 dry-run
147 # don't make any changes
148
149
150 keyring  filename
151 # add this filename to the list of keyrings
152
153 local-user user-string
154 #  use this user-string to sign or decrypt
155
156 no
157 # assume no on most questions
158
159 no-armor
160 # Assume the input data is not in ascii armored format.
161
162 no-default-keyring
163 # Do not add the default keyrings to the list of keyrings
164
165 no-greeting
166 # suppress the initial copyright etc. messages but do not enter batch mode.
167
168 options filename
169 #  Ignored in option files.
170
171 output filename
172 # use filename for output
173
174 passphrase-fd n
175 # Read the passphrase from file with the descriptor n.  If you use
176 # 0 for n, the passphrase will be read from stdin.  This can only be used
177 # if only one passphrase is supplied.
178
179
180 remote-user
181 # use this user-id for encryption"
182
183 secret-keyring filename
184 # add filename to the list of secret keyrings
185
186 verbose
187 # Give more informations suring processing. If used 2 times, the input data
188 # is listed in detail.
189
190 yes
191 # assume yes on most questions
192