* gpg.texi: New.
[gnupg.git] / doc / tools.texi
1 @c Copyright (C) 2004 Free Software Foundation, Inc.
2 @c This is part of the GnuPG manual.
3 @c For copying conditions, see the file GnuPG.texi.
4
5 @node Helper Tools
6 @chapter Helper Tools
7
8 GnuPG comes with a couple of smaller tools:
9
10 @menu
11 * watchgnupg::            Read logs from a socket.
12 * addgnupghome::          Create .gnupg home directories.
13 * gpgconf::               Modify .gnupg home directories.
14 @end menu
15
16 @c
17 @c  WATHCGNUPG
18 @c
19 @node watchgnupg
20 @section Read logs from a socket
21
22 Most of the main utilities are able to write there log files to a
23 Unix Domain socket if configured that way.  @command{watchgnupg} is a simple
24 listener for such a socket.  It ameliorates the output with a time
25 stamp and makes sure that long lines are not interspersed with log
26 output from other utilities.
27
28 @noindent
29 @command{watchgnupg} is commonly invoked as
30
31 @samp{watchgnupg --force ~/.gnupg/S.log}
32
33 @noindent
34 This starts it on the current terminal for listening on the socket
35 @file{~/.gnupg/S.log}.  
36
37 @noindent
38 @command{watchgnupg} understands these options:
39
40 @table @gnupgtabopt
41
42 @item --force 
43 @opindex force
44 Delete an already existing socket file.
45
46 @item --verbose
47 @opindex verbose
48 Enable extra informational output.
49
50 @item --version
51 @opindex version
52 print version of the program and exit
53
54 @item --help
55 @opindex help
56 Display a brief help page and exit
57
58 @end table
59
60
61 @c
62 @c    ADDGNUPGHOME
63 @c
64 @node addgnupghome
65 @section Create .gnupg home directories.
66
67 If GnuPG is installed on a system with existing user accounts, it is
68 sometimes required to populate the GnuPG home directory with existing
69 files.  Especially a @file{trustlist.txt} and a keybox with some
70 initial certificates are often desired.  This scripts help to do this
71 by copying all files from @file{/etc/skel/.gnupg} to the home
72 directories of the accounts given on the command line.  It takes care
73 not to overwrite existing GnuPG home directories.
74
75 @noindent
76 @command{addgnupghome} is invoked by root as:
77
78 @samp{addgnupghome account1 account2 ... accountn}
79
80
81 @c
82 @c   GPGCONF
83 @c
84 @node gpgconf
85 @section Modify .gnupg home directories.
86
87 The @command{gpgconf} is a utility to automatically and reasonable
88 safely query and modify configuration files in the @file{.gnupg} home
89 directory.  It is designed not to be invoked manually by the user, but
90 automatically by graphical user interfaces (GUI).@footnote{Please note
91 that currently no locking is done, so concurrent access should be
92 avoided.  There are some precautions to avoid corruption with
93 concurrent usage, but results may be inconsistent and some changes may
94 get lost.  The stateless design makes it difficult to provide more
95 guarantees.}
96
97 @command{gpgconf} provides access to the configuration of one or more
98 components of the GnuPG system.  These components correspond more or
99 less to the programs that exist in the GnuPG framework, like GnuPG,
100 GPGSM, DirMngr, etc.  But this is not a strict one-to-one
101 relationship.  Not all configuration options are available through
102 @command{gpgconf}.  @command{gpgconf} provides a generic and abstract
103 method to access the most important configuration options that can
104 feasibly be controlled via such a mechanism.
105
106 @command{gpgconf} can be used to gather and change the options
107 available in each component, and can also provide their default
108 values.  @command{gpgconf} will give detailed type information that
109 can be used to restrict the user's input without making an attempt to
110 commit the changes.
111
112 @command{gpgconf} provides the backend of a configuration editor.  The
113 configuration editor would usually be a graphical user interface
114 program, that allows to display the current options, their default
115 values, and allows the user to make changes to the options.  These
116 changes can then be made active with @command{gpgconf} again.  Such a
117 program that uses @command{gpgconf} in this way will be called GUI
118 throughout this section.
119
120 @menu
121 * Invoking gpgconf::      List of all commands and options.
122 * Format conventions::    Formatting conventions relevant for all commands.
123 * Listing components::    List all gpgconf components.
124 * Listing options::       List all options of a component.
125 * Changing options::      Changing options of a component.
126 @end menu
127
128
129 @node Invoking gpgconf
130 @subsection Invoking gpgconf
131
132 One of the following commands must be given:
133
134 @table @gnupgtabopt
135 @item --list-components
136 List all components.  This is the default command used if none is
137 specified.
138
139 @item --list-options @var{component}
140 List all options of the component @var{component}.
141
142 @item --change-options @var{component}
143 Change the options of the component @var{component}.
144 @end table
145
146 The following options may be used:
147
148 @table @gnupgtabopt
149 @c FIXME: Not yet supported.
150 @c @item -o @var{file}
151 @c @itemx --output @var{file}
152 @c Use @var{file} as output file.
153
154 @item -v
155 @itemx --verbose
156 Outputs additional information while running.  Specifically, this
157 extends numerical field values by human-readable descriptions.
158
159 @c FIXME: Not yet supported.
160 @c @item -n
161 @c @itemx --dry-run
162 @c Do not actually change anything.  Useful together with
163 @c @code{--change-options} for testing purposes.
164
165 @item -r
166 @itemx --runtime
167 Only used together with @code{--change-options}.  If one of the
168 modified options can be changed in a running daemon process, signal
169 the running daemon to ask it to reparse its configuration file after
170 changing.
171
172 This means that the changes will take effect at run-time, as far as
173 this is possible.  Otherwise, they will take effect at the next start
174 of the respective backend programs.
175 @end table
176
177
178 @node Format conventions
179 @subsection Format conventions
180
181 Some lines in the output of @command{gpgconf} contain a list of
182 colon-separated fields.  The following conventions apply:
183
184 @itemize @bullet
185 @item
186 The GUI program is required to strip off trailing newline and/or
187 carriage return characters from the output.
188
189 @item
190 @command{gpgconf} will never leave out fields.  If a certain version
191 provides a certain field, this field will always be present in all
192 @command{gpgconf} versions from that time on.
193
194 @item
195 Future versions of @command{gpgconf} might append fields to the list.
196 New fields will always be separated from the previously last field by
197 a colon separator.  The GUI should be prepared to parse the last field
198 it knows about up until a colon or end of line.
199
200 @item
201 Not all fields are defined under all conditions.  You are required to
202 ignore the content of undefined fields.
203 @end itemize
204
205 There are several standard types for the content of a field:
206
207 @table @asis
208 @item verbatim
209 Some fields contain strings that are not escaped in any way.  Such
210 fields are described to be used @emph{verbatim}.  These fields will
211 never contain a colon character (for obvious reasons).  No de-escaping
212 or other formatting is required to use the field content.  This is for
213 easy parsing of the output, when it is known that the content can
214 never contain any special characters.
215
216 @item percent-escaped
217 Some fields contain strings that are described to be
218 @emph{percent-escaped}.  Such strings need to be de-escaped before
219 their content can be presented to the user.  A percent-escaped string
220 is de-escaped by replacing all occurences of @code{%XY} by the byte
221 that has the hexadecimal value @code{XY}.  @code{X} and @code{Y} are
222 from the set @code{0-9a-f}.
223
224 @item localised
225 Some fields contain strings that are described to be @emph{localised}.
226 Such strings are translated to the active language and formatted in
227 the active character set.
228
229 @item @w{unsigned number}
230 Some fields contain an @emph{unsigned number}.  This number will
231 always fit into a 32-bit unsigned integer variable.  The number may be
232 followed by a space, followed by a human readable description of that
233 value (if the verbose option is used).  You should ignore everything
234 in the field that follows the number.
235
236 @item @w{signed number}
237 Some fields contain a @emph{signed number}.  This number will always
238 fit into a 32-bit signed integer variable.  The number may be followed
239 by a space, followed by a human readable description of that value (if
240 the verbose option is used).  You should ignore everything in the
241 field that follows the number.
242
243 @item option
244 Some fields contain an @emph{option} argument.  The format of an
245 option argument depends on the type of the option and on some flags:
246
247 @table @asis
248 @item no argument
249 The simplest case is that the option does not take an argument at all
250 (@var{type} @code{0}).  Then the option argument is an unsigned number
251 that specifies how often the option occurs.  If the @code{list} flag
252 is not set, then the only valid number is @code{1}.  Options that do
253 not take an argument never have the @code{default} or @code{optional
254 arg} flag set.
255
256 @item number
257 If the option takes a number argument (@var{alt-type} is @code{2} or
258 @code{3}), and it can only occur once (@code{list} flag is not set),
259 then the option argument is either empty (only allowed if the argument
260 is optional), or it is a number.  A number is a string that begins
261 with an optional minus character, followed by one or more digits.  The
262 number must fit into an integer variable (unsigned or signed,
263 depending on @var{alt-type}).
264
265 @item number list
266 If the option takes a number argument and it can occur more than once,
267 then the option argument is either empty, or it is a comma-separated
268 list of numbers as described above.
269
270 @item string
271 If the option takes a string argument (@var{alt-type} is 1), and it
272 can only occur once (@code{list} flag is not set) then the option
273 argument is either empty (only allowed if the argument is optional),
274 or it starts with a double quote character (@code{"}) followed by a
275 percent-escaped string that is the argument value.  Note that there is
276 only a leading double quote character, no trailing one.  The double
277 quote character is only needed to be able to differentiate between no
278 value and the empty string as value.
279
280 @item string list
281 If the option takes a number argument and it can occur more than once,
282 then the option argument is either empty, or it is a comma-separated
283 list of string arguments as described above.
284 @end table
285 @end table
286
287 The active language and character set are currently determined from
288 the locale environment of the @command{gpgconf} program.
289
290 @c FIXME: Document the active language and active character set.  Allow
291 @c to change it via the command line?
292
293
294 @node Listing components
295 @subsection Listing components
296
297 The command @code{--list-components} will list all components that can
298 be configured with @command{gpgconf}.  Usually, one component will
299 correspond to one GnuPG-related program and contain the options of
300 that programs configuration file that can be modified using
301 @command{gpgconf}.  However, this is not necessarily the case.  A
302 component might also be a group of selected options from several
303 programs, or contain entirely virtual options that have a special
304 effect rather than changing exactly one option in one configuration
305 file.
306
307 A component is a set of configuration options that semantically belong
308 together.  Furthermore, several changes to a component can be made in
309 an atomic way with a single operation.  The GUI could for example
310 provide a menu with one entry for each component, or a window with one
311 tabulator sheet per component.
312
313 The command argument @code{--list-components} lists all available
314 components, one per line.  The format of each line is:
315
316 @code{@var{name}:@var{description}}
317
318 @table @var
319 @item name
320 This field contains a name tag of the component.  The name tag is used
321 to specify the component in all communication with @command{gpgconf}.
322 The name tag is to be used @emph{verbatim}.  It is thus not in any
323 escaped format.
324
325 @item description
326 The @emph{string} in this field contains a human-readable description
327 of the component.  It can be displayed to the user of the GUI for
328 informational purposes.  It is @emph{percent-escaped} and
329 @emph{localized}.
330 @end table
331
332 Example:
333 @example
334 $ gpgconf --list-components
335 gpg:GPG for OpenPGP
336 gpg-agent:GPG Agent
337 scdaemon:Smartcard Daemon
338 gpgsm:GPG for S/MIME
339 dirmngr:Directory Manager
340 @end example
341
342
343 @node Listing options
344 @subsection Listing options
345
346 Every component contains one or more options.  Options may be gathered
347 into option groups to allow the GUI to give visual hints to the user
348 about which options are related.
349
350 The command argument @code{@w{--list-options @var{component}}} lists
351 all options (and the groups they belong to) in the component
352 @var{component}, one per line.  @var{component} must be the string in
353 the field @var{name} in the output of the @code{--list-components}
354 command.
355
356 There is one line for each option and each group.  First come all
357 options that are not in any group.  Then comes a line describing a
358 group.  Then come all options that belong into each group.  Then comes
359 the next group and so on.  There does not need to be any group (and in
360 this case the output will stop after the last non-grouped option).
361
362 The format of each line is:
363
364 @code{@var{name}:@var{flags}:@var{level}:@var{description}:@var{type}:@var{alt-type}:@var{argname}:@var{default}:@var{argdef}:@var{value}}
365
366 @table @var
367 @item name
368 This field contains a name tag for the group or option.  The name tag
369 is used to specify the group or option in all communication with
370 @command{gpgconf}.  The name tag is to be used @emph{verbatim}.  It is
371 thus not in any escaped format.
372
373 @item flags
374 The flags field contains an @emph{unsigned number}.  Its value is the
375 OR-wise combination of the following flag values:
376
377 @table @code
378 @item group (1)
379 If this flag is set, this is a line describing a group and not an
380 option.
381 @end table
382
383 The following flag values are only defined for options (that is, if
384 the @code{group} flag is not used).
385
386 @table @code
387 @item optional arg (2)
388 If this flag is set, the argument is optional.  This is never set for
389 @var{type} @code{0} (none) options.
390
391 @item list (4)
392 If this flag is set, the option can be given multiple times.
393
394 @item runtime (8)
395 If this flag is set, the option can be changed at runtime.
396
397 @item default (16)
398 If this flag is set, a default value is available.
399
400 @item default desc (32)
401 If this flag is set, a (runtime) default is available.  This and the
402 @code{default} flag are mutually exclusive.
403
404 @item no arg desc (64)
405 If this flag is set, and the @code{optional arg} flag is set, then the
406 option has a special meaning if no argument is given.
407 @end table
408
409 @item level
410 This field is defined for options and for groups.  It contains an
411 @emph{unsigned number} that specifies the expert level under which
412 this group or option should be displayed.  The following expert levels
413 are defined for options (they have analogous meaning for groups):
414
415 @table @code
416 @item basic (0)
417 This option should always be offered to the user.
418
419 @item advanced (1)
420 This option may be offered to advanced users.
421
422 @item expert (2)
423 This option should only be offered to expert users.
424
425 @item invisible (3)
426 This option should normally never be displayed, not even to expert
427 users.
428
429 @item internal (4)
430 This option is for internal use only.  Ignore it.
431 @end table
432
433 The level of a group will always be the lowest level of all options it
434 contains.
435
436 @item description
437 This field is defined for options and groups.  The @emph{string} in
438 this field contains a human-readable description of the option or
439 group.  It can be displayed to the user of the GUI for informational
440 purposes.  It is @emph{percent-escaped} and @emph{localized}.
441
442 @item type
443 This field is only defined for options.  It contains an @emph{unsigned
444 number} that specifies the type of the option's argument, if any.  The
445 following types are defined:
446
447 Basic types:
448
449 @table @code
450 @item none (0)
451 No argument allowed.
452
453 @item string (1)
454 An @emph{unformatted string}.
455
456 @item int32 (2)
457 A @emph{signed number}.
458
459 @item uint32 (3)
460 An @emph{unsigned number}.
461 @end table
462
463 Complex types:
464
465 @table @code
466 @item pathname (32)
467 A @emph{string} that describes the pathname of a file.  The file does
468 not necessarily need to exist.
469
470 @item ldap server (33)
471 A @emph{string} that describes an LDAP server in the format:
472
473 @code{@var{hostname}:@var{port}:@var{username}:@var{password}:@var{base_dn}}
474 @end table
475
476 More types will be added in the future.  Please see the @var{alt-type}
477 field for information on how to cope with unknown types.
478
479 @item alt-type
480 This field is identical to @var{type}, except that only the types
481 @code{0} to @code{31} are allowed.  The GUI is expected to present the
482 user the option in the format specified by @var{type}.  But if the
483 argument type @var{type} is not supported by the GUI, it can still
484 display the option in the more generic basic type @var{alt-type}.  The
485 GUI must support all the defined basic types to be able to display all
486 options.  More basic types may be added in future versions.  If the
487 GUI encounters a basic type it doesn't support, it should report an
488 error and abort the operation.
489
490 @item argname
491 This field is only defined for options with an argument type
492 @var{type} that is not @code{0}.  In this case it may contain a
493 @emph{percent-escaped} and @emph{localised string} that gives a short
494 name for the argument.  The field may also be empty, though, in which
495 case a short name is not known.
496
497 @item default
498 This field is defined only for options.  Its format is that of an
499 @emph{option argument} (@xref{Format conventions}, for details).  If
500 the default value is empty, then no default is known.  Otherwise, the
501 value specifies the default value for this option.  Note that this
502 field is also meaningful if the option itself does not take a real
503 argument.
504
505 @item argdef
506 This field is defined only for options for which the @code{optional
507 arg} flag is set.  If the @code{no arg desc} flag is not set, its
508 format is that of an @emph{option argument} (@xref{Format
509 conventions}, for details).  If the default value is empty, then no
510 default is known.  Otherwise, the value specifies the default value
511 for this option.  If the @code{no arg desc} flag is set, the field is
512 either empty or contains a description of the effect of this option if
513 no argument is given.  Note that this field is also meaningful if the
514 option itself does not take a real argument.
515
516 @item value
517 This field is defined only for options.  Its format is that of an
518 @emph{option argument}.  If it is empty, then the option is not
519 explicitely set in the current configuration, and the default applies
520 (if any).  Otherwise, it contains the current value of the option.
521 Note that this field is also meaningful if the option itself does not
522 take a real argument.
523 @end table
524
525
526 @node Changing options
527 @subsection Changing options
528
529 The command @w{@code{--change-options @var{component}}} will attempt
530 to change the options of the component @var{component} to the
531 specified values.  @var{component} must be the string in the field
532 @var{name} in the output of the @code{--list-components} command.  You
533 have to provide the options that shall be changed in the following
534 format on standard input:
535
536 @code{@var{name}:@var{flags}:@var{new-value}}
537
538 @table @var
539 @item name
540 This is the name of the option to change.  @var{name} must be the
541 string in the field @var{name} in the output of the
542 @code{--list-options} command.
543
544 @item flags
545 The flags field contains an @emph{unsigned number}.  Its value is the
546 OR-wise combination of the following flag values:
547
548 @table @code
549 @item default (16)
550 If this flag is set, the option is deleted and the default value is
551 used instead (if applicable).
552 @end table
553
554 @item new-value
555 The new value for the option.  This field is only defined if the
556 @code{default} flag is not set.  The format is that of an @emph{option
557 argument}.  If it is empty (or the field is omitted), the default
558 argument is used (only allowed if the argument is optional for this
559 option).  Otherwise, the option will be set to the specified value.
560 @end table
561
562 Examples:
563
564 To set the force option, which is of basic type @code{none (0)}:
565
566 @example
567 $ echo 'force:0:1' | gpgconf --change-options dirmngr
568 @end example
569
570 To delete the force option:
571
572 @example
573 $ echo 'force:16:' | gpgconf --change-options dirmngr
574 @end example
575
576 The @code{--runtime} option can influence when the changes take
577 effect.