ce7d2b3bef3a3ac3a061af838af47100efa91e8b
[gnupg.git] / doc / tools.texi
1 @c Copyright (C) 2004, 2008 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 * gpgv::                  Verify OpenPGP signatures.
13 * addgnupghome::          Create .gnupg home directories.
14 * gpgconf::               Modify .gnupg home directories.
15 * applygnupgdefaults::    Run gpgconf for all users.
16 * gpgsm-gencert.sh::      Generate an X.509 certificate request.
17 * gpg-preset-passphrase:: Put a passphrase into the cache.
18 * gpg-connect-agent::     Communicate with a running agent.
19 * dirmngr-client::        How to use the Dirmngr client tool.
20 * gpgparsemail::          Parse a mail message into an annotated format
21 * symcryptrun::           Call a simple symmetric encryption tool.
22 * gpg-zip::               Encrypt or sign files into an archive.
23 @end menu
24
25 @c
26 @c  WATCHGNUPG
27 @c
28 @manpage watchgnupg.1
29 @node watchgnupg
30 @section Read logs from a socket
31 @ifset manverb
32 .B watchgnupg
33 \- Read and print logs from a socket
34 @end ifset
35
36 @mansect synopsis
37 @ifset manverb
38 .B  watchgnupg
39 .RB [ \-\-force ]
40 .RB [ \-\-verbose ]
41 .I socketname
42 @end ifset
43
44 @mansect description
45 Most of the main utilities are able to write their log files to a Unix
46 Domain socket if configured that way.  @command{watchgnupg} is a simple
47 listener for such a socket.  It ameliorates the output with a time stamp
48 and makes sure that long lines are not interspersed with log output from
49 other utilities.  This tool is not available for Windows.
50
51
52 @noindent
53 @command{watchgnupg} is commonly invoked as
54
55 @example
56 watchgnupg --force ~/.gnupg/S.log
57 @end example
58 @manpause
59
60 @noindent
61 This starts it on the current terminal for listening on the socket
62 @file{~/.gnupg/S.log}.  
63
64 @mansect options
65 @noindent
66 @command{watchgnupg} understands these options:
67
68 @table @gnupgtabopt
69
70 @item --force 
71 @opindex force
72 Delete an already existing socket file.
73
74 @item --tcp @var{n}
75 Instead of reading from a local socket, listen for connects on TCP port
76 @var{n}.
77
78 @item --verbose
79 @opindex verbose
80 Enable extra informational output.
81
82 @item --version
83 @opindex version
84 Print version of the program and exit.
85
86 @item --help
87 @opindex help
88 Display a brief help page and exit.
89
90 @end table
91
92 @noindent
93 @mansect examples
94 @chapheading Examples
95
96 @example
97 $ watchgnupg --force /home/foo/.gnupg/S.log
98 @end example
99
100 This waits for connections on the local socket
101 @file{/home/foo/.gnupg/S.log} and shows all log entries.  To make this
102 work the option @option{log-file} needs to be used with all modules
103 which logs are to be shown.  The value for that option must be given
104 with a special prefix (e.g. in the conf file):
105
106 @example
107 log-file socket:///home/foo/.gnupg/S.log
108 @end example
109
110 For debugging purposes it is also possible to do remote logging.  Take
111 care if you use this feature because the information is send in the
112 clear over the network.  Use this syntax in the conf files:
113
114 @example
115 log-file tcp://192.168.1.1:4711
116 @end example
117
118 You may use any port and not just 4711 as shown above; only IP addresses
119 are supported (v4 and v6) and no host names.  You need to start
120 @command{watchgnupg} with the @option{tcp} option.  Note that under
121 Windows the registry entry @var{HKCU\Software\GNU\GnuPG:DefaultLogFile}
122 can be used to change the default log output from @code{stderr} to
123 whatever is given by that entry.  However the only useful entry is a TCP
124 name for remote debugging.
125
126
127 @mansect see also
128 @ifset isman
129 @command{gpg}(1), 
130 @command{gpgsm}(1), 
131 @command{gpg-agent}(1), 
132 @command{scdaemon}(1)
133 @end ifset
134 @include see-also-note.texi
135
136
137 @c
138 @c  GPGV
139 @c
140 @include gpgv.texi
141
142
143 @c
144 @c    ADDGNUPGHOME
145 @c
146 @manpage addgnupghome.8
147 @node addgnupghome
148 @section Create .gnupg home directories.
149 @ifset manverb
150 .B addgnupghome 
151 \- Create .gnupg home directories
152 @end ifset
153
154 @mansect synopsis
155 @ifset manverb
156 .B  addgnupghome
157 .I account_1
158 .IR account_2 ... account_n
159 @end ifset
160
161 @mansect description
162 If GnuPG is installed on a system with existing user accounts, it is
163 sometimes required to populate the GnuPG home directory with existing
164 files.  Especially a @file{trustlist.txt} and a keybox with some
165 initial certificates are often desired.  This scripts help to do this
166 by copying all files from @file{/etc/skel/.gnupg} to the home
167 directories of the accounts given on the command line.  It takes care
168 not to overwrite existing GnuPG home directories.
169
170 @noindent
171 @command{addgnupghome} is invoked by root as:
172
173 @example
174 addgnupghome account1 account2 ... accountn
175 @end example
176
177
178 @c
179 @c   GPGCONF
180 @c
181 @manpage gpgconf.1
182 @node gpgconf
183 @section Modify .gnupg home directories.
184 @ifset manverb
185 .B gpgconf
186 \- Modify .gnupg home directories
187 @end ifset
188
189 @mansect synopsis
190 @ifset manverb
191 .B gpgconf
192 .RI [ options ]
193 .B \-\-list-components
194 .br
195 .B gpgconf
196 .RI [ options ]
197 .B \-\-list-options 
198 .I component
199 .br
200 .B gpgconf
201 .RI [ options ]
202 .B \-\-change-options
203 .I component
204 @end ifset
205
206
207 @mansect description
208 The @command{gpgconf} is a utility to automatically and reasonable
209 safely query and modify configuration files in the @file{.gnupg} home
210 directory.  It is designed not to be invoked manually by the user, but
211 automatically by graphical user interfaces (GUI).@footnote{Please note
212 that currently no locking is done, so concurrent access should be
213 avoided.  There are some precautions to avoid corruption with
214 concurrent usage, but results may be inconsistent and some changes may
215 get lost.  The stateless design makes it difficult to provide more
216 guarantees.}
217
218 @command{gpgconf} provides access to the configuration of one or more
219 components of the GnuPG system.  These components correspond more or
220 less to the programs that exist in the GnuPG framework, like GnuPG,
221 GPGSM, DirMngr, etc.  But this is not a strict one-to-one
222 relationship.  Not all configuration options are available through
223 @command{gpgconf}.  @command{gpgconf} provides a generic and abstract
224 method to access the most important configuration options that can
225 feasibly be controlled via such a mechanism.
226
227 @command{gpgconf} can be used to gather and change the options
228 available in each component, and can also provide their default
229 values.  @command{gpgconf} will give detailed type information that
230 can be used to restrict the user's input without making an attempt to
231 commit the changes.
232
233 @command{gpgconf} provides the backend of a configuration editor.  The
234 configuration editor would usually be a graphical user interface
235 program, that allows to display the current options, their default
236 values, and allows the user to make changes to the options.  These
237 changes can then be made active with @command{gpgconf} again.  Such a
238 program that uses @command{gpgconf} in this way will be called GUI
239 throughout this section.
240
241 @menu
242 * Invoking gpgconf::       List of all commands and options.
243 * Format conventions::     Formatting conventions relevant for all commands.
244 * Listing components::     List all gpgconf components.
245 * Checking programs::      Check all programs know to gpgconf.
246 * Listing options::        List all options of a component.
247 * Changing options::       Changing options of a component.
248 * Listing global options:: List all global options.
249 * Files used by gpgconf::  What files are used by gpgconf.
250 @end menu
251
252 @manpause
253 @node Invoking gpgconf
254 @subsection Invoking gpgconf
255
256 @mansect commands
257 One of the following commands must be given:
258
259 @table @gnupgtabopt
260
261 @item --list-components
262 List all components.  This is the default command used if none is
263 specified.
264
265 @item --check-programs
266 List all available backend programs and test whether they are runnable.
267
268 @item --list-options @var{component}
269 List all options of the component @var{component}.
270
271 @item --change-options @var{component}
272 Change the options of the component @var{component}.
273
274 @item --check-options @var{component}
275 Check the options for the component @var{component}.
276
277 @item --apply-defaults
278 Update all configuration files with values taken from the global
279 configuration file (usually @file{/etc/gnupg/gpgconf.conf}).
280
281 @item --list-dirs
282 Lists the directories used by @command{gpgconf}.  One directory is
283 listed per line, and each line consists of a colon-separated list where
284 the first field names the directory type (for example @code{sysconfdir})
285 and the second field contains the percent-escaped directory.  Although
286 they are not directories, the socket file names used by
287 @command{gpg-agent} and @command{dirmngr} are printed as well.  Note
288 that the socket file names and the @code{homedir} lines are the default
289 names and they may be overridden by command line switches.
290
291 @item --list-config [@var{filename}]
292 List the global configuration file in a colon separated format.  If
293 @var{filename} is given, check that file instead.
294
295 @item --check-config [@var{filename}]
296 Run a syntax check on the global configuration file.  If @var{filename}
297 is given, check that file instead.
298
299 @item --reload [@var{component}]
300 @opindex reload
301 Reload all or the given component. This is basically the sam as sending
302 a SIGHUP to the component.  Components which don't support reloading are
303 ignored.
304
305 @end table
306
307
308 @mansect options
309
310 The following options may be used:
311
312 @table @gnupgtabopt
313 @c FIXME: Not yet supported.
314 @c @item -o @var{file}
315 @c @itemx --output @var{file}
316 @c Use @var{file} as output file.
317
318 @item -v
319 @itemx --verbose
320 Outputs additional information while running.  Specifically, this
321 extends numerical field values by human-readable descriptions.
322
323 @item -n
324 @itemx --dry-run
325 Do not actually change anything.  This is currently only implemented
326 for @code{--change-options} and can be used for testing purposes.
327
328 @item -r
329 @itemx --runtime
330 Only used together with @code{--change-options}.  If one of the
331 modified options can be changed in a running daemon process, signal
332 the running daemon to ask it to reparse its configuration file after
333 changing.
334
335 This means that the changes will take effect at run-time, as far as
336 this is possible.  Otherwise, they will take effect at the next start
337 of the respective backend programs.
338 @manpause
339 @end table
340
341
342 @node Format conventions
343 @subsection Format conventions
344
345 Some lines in the output of @command{gpgconf} contain a list of
346 colon-separated fields.  The following conventions apply:
347
348 @itemize @bullet
349 @item
350 The GUI program is required to strip off trailing newline and/or
351 carriage return characters from the output.
352
353 @item
354 @command{gpgconf} will never leave out fields.  If a certain version
355 provides a certain field, this field will always be present in all
356 @command{gpgconf} versions from that time on.
357
358 @item
359 Future versions of @command{gpgconf} might append fields to the list.
360 New fields will always be separated from the previously last field by
361 a colon separator.  The GUI should be prepared to parse the last field
362 it knows about up until a colon or end of line.
363
364 @item
365 Not all fields are defined under all conditions.  You are required to
366 ignore the content of undefined fields.
367 @end itemize
368
369 There are several standard types for the content of a field:
370
371 @table @asis
372 @item verbatim
373 Some fields contain strings that are not escaped in any way.  Such
374 fields are described to be used @emph{verbatim}.  These fields will
375 never contain a colon character (for obvious reasons).  No de-escaping
376 or other formatting is required to use the field content.  This is for
377 easy parsing of the output, when it is known that the content can
378 never contain any special characters.
379
380 @item percent-escaped
381 Some fields contain strings that are described to be
382 @emph{percent-escaped}.  Such strings need to be de-escaped before
383 their content can be presented to the user.  A percent-escaped string
384 is de-escaped by replacing all occurrences of @code{%XY} by the byte
385 that has the hexadecimal value @code{XY}.  @code{X} and @code{Y} are
386 from the set @code{0-9a-f}.
387
388 @item localised
389 Some fields contain strings that are described to be @emph{localised}.
390 Such strings are translated to the active language and formatted in
391 the active character set.
392
393 @item @w{unsigned number}
394 Some fields contain an @emph{unsigned number}.  This number will
395 always fit into a 32-bit unsigned integer variable.  The number may be
396 followed by a space, followed by a human readable description of that
397 value (if the verbose option is used).  You should ignore everything
398 in the field that follows the number.
399
400 @item @w{signed number}
401 Some fields contain a @emph{signed number}.  This number will always
402 fit into a 32-bit signed integer variable.  The number may be followed
403 by a space, followed by a human readable description of that value (if
404 the verbose option is used).  You should ignore everything in the
405 field that follows the number.
406
407 @item @w{boolean value}
408 Some fields contain a @emph{boolean value}.  This is a number with
409 either the value 0 or 1.  The number may be followed by a space,
410 followed by a human readable description of that value (if the verbose
411 option is used).  You should ignore everything in the field that follows
412 the number; checking just the first character is sufficient in this
413 case.
414
415 @item option
416 Some fields contain an @emph{option} argument.  The format of an
417 option argument depends on the type of the option and on some flags:
418
419 @table @asis
420 @item no argument
421 The simplest case is that the option does not take an argument at all
422 (@var{type} @code{0}).  Then the option argument is an unsigned number
423 that specifies how often the option occurs.  If the @code{list} flag
424 is not set, then the only valid number is @code{1}.  Options that do
425 not take an argument never have the @code{default} or @code{optional
426 arg} flag set.
427
428 @item number
429 If the option takes a number argument (@var{alt-type} is @code{2} or
430 @code{3}), and it can only occur once (@code{list} flag is not set),
431 then the option argument is either empty (only allowed if the argument
432 is optional), or it is a number.  A number is a string that begins
433 with an optional minus character, followed by one or more digits.  The
434 number must fit into an integer variable (unsigned or signed,
435 depending on @var{alt-type}).
436
437 @item number list
438 If the option takes a number argument and it can occur more than once,
439 then the option argument is either empty, or it is a comma-separated
440 list of numbers as described above.
441
442 @item string
443 If the option takes a string argument (@var{alt-type} is 1), and it
444 can only occur once (@code{list} flag is not set) then the option
445 argument is either empty (only allowed if the argument is optional),
446 or it starts with a double quote character (@code{"}) followed by a
447 percent-escaped string that is the argument value.  Note that there is
448 only a leading double quote character, no trailing one.  The double
449 quote character is only needed to be able to differentiate between no
450 value and the empty string as value.
451
452 @item string list
453 If the option takes a number argument and it can occur more than once,
454 then the option argument is either empty, or it is a comma-separated
455 list of string arguments as described above.
456 @end table
457 @end table
458
459 The active language and character set are currently determined from
460 the locale environment of the @command{gpgconf} program.
461
462 @c FIXME: Document the active language and active character set.  Allow
463 @c to change it via the command line?
464
465
466 @mansect usage
467 @node Listing components
468 @subsection Listing components
469
470 The command @code{--list-components} will list all components that can
471 be configured with @command{gpgconf}.  Usually, one component will
472 correspond to one GnuPG-related program and contain the options of
473 that programs configuration file that can be modified using
474 @command{gpgconf}.  However, this is not necessarily the case.  A
475 component might also be a group of selected options from several
476 programs, or contain entirely virtual options that have a special
477 effect rather than changing exactly one option in one configuration
478 file.
479
480 A component is a set of configuration options that semantically belong
481 together.  Furthermore, several changes to a component can be made in
482 an atomic way with a single operation.  The GUI could for example
483 provide a menu with one entry for each component, or a window with one
484 tabulator sheet per component.
485
486 The command argument @code{--list-components} lists all available
487 components, one per line.  The format of each line is:
488
489 @code{@var{name}:@var{description}:@var{pgmname}:}
490
491 @table @var
492 @item name
493 This field contains a name tag of the component.  The name tag is used
494 to specify the component in all communication with @command{gpgconf}.
495 The name tag is to be used @emph{verbatim}.  It is thus not in any
496 escaped format.
497
498 @item description
499 The @emph{string} in this field contains a human-readable description
500 of the component.  It can be displayed to the user of the GUI for
501 informational purposes.  It is @emph{percent-escaped} and
502 @emph{localized}.
503
504 @item pgmname
505 The @emph{string} in this field contains the absolute name of the
506 program's file.  It can be used to unambiguously invoke that program.
507 It is @emph{percent-escaped}.
508 @end table
509
510 Example:
511 @example
512 $ gpgconf --list-components
513 gpg:GPG for OpenPGP:/usr/local/bin/gpg2:
514 gpg-agent:GPG Agent:/usr/local/bin/gpg-agent:
515 scdaemon:Smartcard Daemon:/usr/local/bin/scdaemon:
516 gpgsm:GPG for S/MIME:/usr/local/bin/gpgsm:
517 dirmngr:Directory Manager:/usr/local/bin/dirmngr:
518 @end example
519
520
521
522 @node Checking programs
523 @subsection Checking programs
524
525 The command @code{--check-programs} is similar to
526 @code{--list-components} but works on backend programs and not on
527 components.  It runs each program to test whether it is installed and
528 runnable.  This also includes a syntax check of all config file options
529 of the program.
530
531 The command argument @code{--check-programs} lists all available
532 programs, one per line.  The format of each line is:
533
534 @code{@var{name}:@var{description}:@var{pgmname}:@var{avail}:@var{okay}:@var{cfgfile}:@var{line}:@var{error}:}
535
536 @table @var
537 @item name
538 This field contains a name tag of the program which is identical to the
539 name of the component.  The name tag is to be used @emph{verbatim}.  It
540 is thus not in any escaped format.  This field may be empty to indicate
541 a continuation of error descriptions for the last name.  The description
542 and pgmname fields are then also empty.
543
544 @item description
545 The @emph{string} in this field contains a human-readable description
546 of the component.  It can be displayed to the user of the GUI for
547 informational purposes.  It is @emph{percent-escaped} and
548 @emph{localized}.
549
550 @item pgmname
551 The @emph{string} in this field contains the absolute name of the
552 program's file.  It can be used to unambiguously invoke that program.
553 It is @emph{percent-escaped}.
554
555 @item avail
556 The @emph{boolean value} in this field indicates whether the program is
557 installed and runnable.
558
559 @item okay
560 The @emph{boolean value} in this field indicates whether the program's
561 config file is syntactically okay.
562
563 @item cfgfile
564 If an error occurred in the configuration file (as indicated by a false
565 value in the field @code{okay}), this field has the name of the failing
566 configuration file.  It is @emph{percent-escaped}.
567
568 @item line
569 If an error occurred in the configuration file, this field has the line
570 number of the failing statement in the configuration file.  
571 It is an @emph{unsigned number}.
572
573 @item error
574 If an error occurred in the configuration file, this field has the error
575 text of the failing statement in the configuration file.  It is
576 @emph{percent-escaped} and @emph{localized}.
577
578 @end table
579
580 @noindent
581 In the following example the @command{dirmngr} is not runnable and the
582 configuration file of @command{scdaemon} is not okay.
583
584 @example
585 $ gpgconf --check-programs
586 gpg:GPG for OpenPGP:/usr/local/bin/gpg2:1:1:
587 gpg-agent:GPG Agent:/usr/local/bin/gpg-agent:1:1:
588 scdaemon:Smartcard Daemon:/usr/local/bin/scdaemon:1:0:
589 gpgsm:GPG for S/MIME:/usr/local/bin/gpgsm:1:1:
590 dirmngr:Directory Manager:/usr/local/bin/dirmngr:0:0:
591 @end example
592
593 @noindent
594 The command @w{@code{--check-options @var{component}}} will verify the
595 configuration file in the same manner as @code{--check-programs}, but
596 only for the component @var{component}.
597
598
599 @node Listing options
600 @subsection Listing options
601
602 Every component contains one or more options.  Options may be gathered
603 into option groups to allow the GUI to give visual hints to the user
604 about which options are related.
605
606 The command argument @code{@w{--list-options @var{component}}} lists
607 all options (and the groups they belong to) in the component
608 @var{component}, one per line.  @var{component} must be the string in
609 the field @var{name} in the output of the @code{--list-components}
610 command.
611
612 There is one line for each option and each group.  First come all
613 options that are not in any group.  Then comes a line describing a
614 group.  Then come all options that belong into each group.  Then comes
615 the next group and so on.  There does not need to be any group (and in
616 this case the output will stop after the last non-grouped option).
617
618 The format of each line is:
619
620 @code{@var{name}:@var{flags}:@var{level}:@var{description}:@var{type}:@var{alt-type}:@var{argname}:@var{default}:@var{argdef}:@var{value}}
621
622 @table @var
623 @item name
624 This field contains a name tag for the group or option.  The name tag
625 is used to specify the group or option in all communication with
626 @command{gpgconf}.  The name tag is to be used @emph{verbatim}.  It is
627 thus not in any escaped format.
628
629 @item flags
630 The flags field contains an @emph{unsigned number}.  Its value is the
631 OR-wise combination of the following flag values:
632
633 @table @code
634 @item group (1)
635 If this flag is set, this is a line describing a group and not an
636 option.
637 @end table
638
639 The following flag values are only defined for options (that is, if
640 the @code{group} flag is not used).
641
642 @table @code
643 @item optional arg (2)
644 If this flag is set, the argument is optional.  This is never set for
645 @var{type} @code{0} (none) options.
646
647 @item list (4)
648 If this flag is set, the option can be given multiple times.
649
650 @item runtime (8)
651 If this flag is set, the option can be changed at runtime.
652
653 @item default (16)
654 If this flag is set, a default value is available.
655
656 @item default desc (32)
657 If this flag is set, a (runtime) default is available.  This and the
658 @code{default} flag are mutually exclusive.
659
660 @item no arg desc (64)
661 If this flag is set, and the @code{optional arg} flag is set, then the
662 option has a special meaning if no argument is given.
663
664 @item no change (128)
665 If this flag is set, gpgconf ignores requests to change the value.  GUI
666 frontends should grey out this option.  Note, that manual changes of the
667 configuration files are still possible.
668 @end table
669
670 @item level
671 This field is defined for options and for groups.  It contains an
672 @emph{unsigned number} that specifies the expert level under which
673 this group or option should be displayed.  The following expert levels
674 are defined for options (they have analogous meaning for groups):
675
676 @table @code
677 @item basic (0)
678 This option should always be offered to the user.
679
680 @item advanced (1)
681 This option may be offered to advanced users.
682
683 @item expert (2)
684 This option should only be offered to expert users.
685
686 @item invisible (3)
687 This option should normally never be displayed, not even to expert
688 users.
689
690 @item internal (4)
691 This option is for internal use only.  Ignore it.
692 @end table
693
694 The level of a group will always be the lowest level of all options it
695 contains.
696
697 @item description
698 This field is defined for options and groups.  The @emph{string} in
699 this field contains a human-readable description of the option or
700 group.  It can be displayed to the user of the GUI for informational
701 purposes.  It is @emph{percent-escaped} and @emph{localized}.
702
703 @item type
704 This field is only defined for options.  It contains an @emph{unsigned
705 number} that specifies the type of the option's argument, if any.  The
706 following types are defined:
707
708 Basic types:
709
710 @table @code
711 @item none (0)
712 No argument allowed.
713
714 @item string (1)
715 An @emph{unformatted string}.
716
717 @item int32 (2)
718 A @emph{signed number}.
719
720 @item uint32 (3)
721 An @emph{unsigned number}.
722 @end table
723
724 Complex types:
725
726 @table @code
727 @item pathname (32)
728 A @emph{string} that describes the pathname of a file.  The file does
729 not necessarily need to exist.
730
731 @item ldap server (33)
732 A @emph{string} that describes an LDAP server in the format:
733
734 @code{@var{hostname}:@var{port}:@var{username}:@var{password}:@var{base_dn}}
735
736 @item key fingerprint (34)
737 A @emph{string} with a 40 digit fingerprint specifying a certificate.
738
739 @item pub key (35)
740 A @emph{string} that describes a certificate by user ID, key ID or
741 fingerprint.
742
743 @item sec key (36)
744 A @emph{string} that describes a certificate with a key by user ID,
745 key ID or fingerprint.
746
747 @item alias list (37)
748 A @emph{string} that describes an alias list, like the one used with
749 gpg's group option.  The list consists of a key, an equal sign and space
750 separated values.
751 @end table
752
753 More types will be added in the future.  Please see the @var{alt-type}
754 field for information on how to cope with unknown types.
755
756 @item alt-type
757 This field is identical to @var{type}, except that only the types
758 @code{0} to @code{31} are allowed.  The GUI is expected to present the
759 user the option in the format specified by @var{type}.  But if the
760 argument type @var{type} is not supported by the GUI, it can still
761 display the option in the more generic basic type @var{alt-type}.  The
762 GUI must support all the defined basic types to be able to display all
763 options.  More basic types may be added in future versions.  If the
764 GUI encounters a basic type it doesn't support, it should report an
765 error and abort the operation.
766
767 @item argname
768 This field is only defined for options with an argument type
769 @var{type} that is not @code{0}.  In this case it may contain a
770 @emph{percent-escaped} and @emph{localised string} that gives a short
771 name for the argument.  The field may also be empty, though, in which
772 case a short name is not known.
773
774 @item default
775 This field is defined only for options for which the @code{default} or
776 @code{default desc} flag is set.  If the @code{default} flag is set,
777 its format is that of an @emph{option argument} (@xref{Format
778 conventions}, for details).  If the default value is empty, then no
779 default is known.  Otherwise, the value specifies the default value
780 for this option.  If the @code{default desc} flag is set, the field is
781 either empty or contains a description of the effect if the option is
782 not given.
783
784 @item argdef
785 This field is defined only for options for which the @code{optional
786 arg} flag is set.  If the @code{no arg desc} flag is not set, its
787 format is that of an @emph{option argument} (@xref{Format
788 conventions}, for details).  If the default value is empty, then no
789 default is known.  Otherwise, the value specifies the default argument
790 for this option.  If the @code{no arg desc} flag is set, the field is
791 either empty or contains a description of the effect of this option if
792 no argument is given.
793
794 @item value
795 This field is defined only for options.  Its format is that of an
796 @emph{option argument}.  If it is empty, then the option is not
797 explicitly set in the current configuration, and the default applies
798 (if any).  Otherwise, it contains the current value of the option.
799 Note that this field is also meaningful if the option itself does not
800 take a real argument (in this case, it contains the number of times
801 the option appears).
802 @end table
803
804
805 @node Changing options
806 @subsection Changing options
807
808 The command @w{@code{--change-options @var{component}}} will attempt
809 to change the options of the component @var{component} to the
810 specified values.  @var{component} must be the string in the field
811 @var{name} in the output of the @code{--list-components} command.  You
812 have to provide the options that shall be changed in the following
813 format on standard input:
814
815 @code{@var{name}:@var{flags}:@var{new-value}}
816
817 @table @var
818 @item name
819 This is the name of the option to change.  @var{name} must be the
820 string in the field @var{name} in the output of the
821 @code{--list-options} command.
822
823 @item flags
824 The flags field contains an @emph{unsigned number}.  Its value is the
825 OR-wise combination of the following flag values:
826
827 @table @code
828 @item default (16)
829 If this flag is set, the option is deleted and the default value is
830 used instead (if applicable).
831 @end table
832
833 @item new-value
834 The new value for the option.  This field is only defined if the
835 @code{default} flag is not set.  The format is that of an @emph{option
836 argument}.  If it is empty (or the field is omitted), the default
837 argument is used (only allowed if the argument is optional for this
838 option).  Otherwise, the option will be set to the specified value.
839 @end table
840
841 @noindent
842 The output of the command is the same as that of
843 @code{--check-options} for the modified configuration file.
844
845 Examples:
846
847 To set the force option, which is of basic type @code{none (0)}:
848
849 @example
850 $ echo 'force:0:1' | gpgconf --change-options dirmngr
851 @end example
852
853 To delete the force option:
854
855 @example
856 $ echo 'force:16:' | gpgconf --change-options dirmngr
857 @end example
858
859 The @code{--runtime} option can influence when the changes take
860 effect.
861
862
863 @node Listing global options
864 @subsection Listing global options
865
866 Sometimes it is useful for applications to look at the global options
867 file @file{gpgconf.conf}. 
868 The colon separated listing format is record oriented and uses the first
869 field to identify the record type:
870
871 @table @code
872 @item k
873 This describes a key record to start the definition of a new ruleset for
874 a user/group.  The format of a key record is:
875
876   @code{k:@var{user}:@var{group}:}
877
878 @table @var
879 @item user
880 This is the user field of the key.  It is percent escaped.  See the
881 definition of the gpgconf.conf format for details.
882
883 @item group
884 This is the group field of the key.  It is percent escaped.
885 @end table
886
887 @item r
888 This describes a rule record. All rule records up to the next key record
889 make up a rule set for that key.  The format of a rule record is:
890
891   @code{r:::@var{component}:@var{option}:@var{flags}:@var{value}:}
892
893 @table @var
894 @item component
895 This is the component part of a rule.  It is a plain string.
896
897 @item option
898 This is the option part of a rule.  It is a plain string.
899
900 @item flag
901 This is the flags part of a rule.  There may be only one flag per rule
902 but by using the same component and option, several flags may be
903 assigned to an option.  It is a plain string.
904
905 @item value
906 This is the optional value for the option.  It is a percent escaped
907 string with a single quotation mark to indicate a string.  The quotation
908 mark is only required to distinguish between no value specified and an
909 empty string.
910 @end table
911
912 @end table
913
914 @noindent
915 Unknown record types should be ignored.  Note that there is intentionally
916 no feature to change the global option file through @command{gpgconf}.
917
918
919
920 @mansect files
921 @node Files used by gpgconf
922 @subsection Files used by gpgconf
923
924 @table @file
925
926 @item /etc/gnupg/gpgconf.conf
927 @cindex gpgconf.conf
928   If this file exists, it is processed as a global configuration file.
929   A commented example can be found in the @file{examples} directory of
930   the distribution.
931 @end table
932
933
934 @mansect see also
935 @ifset isman
936 @command{gpg}(1), 
937 @command{gpgsm}(1), 
938 @command{gpg-agent}(1), 
939 @command{scdaemon}(1),
940 @command{dirmngr}(1)
941 @end ifset
942 @include see-also-note.texi
943
944
945
946 @c
947 @c    APPLYGNUPGDEFAULTS
948 @c
949 @manpage applygnupgdefaults.8
950 @node applygnupgdefaults
951 @section Run gpgconf for all users.
952 @ifset manverb
953 .B applygnupgdefaults
954 \- Run gpgconf --apply-defaults for all users.
955 @end ifset
956
957 @mansect synopsis
958 @ifset manverb
959 .B  applygnupgdefaults
960 @end ifset
961
962 @mansect description
963 This script is a wrapper around @command{gpgconf} to run it with the
964 command @code{--apply-defaults} for all real users with an existing
965 GnuPG home directory.  Admins might want to use this script to update he
966 GnuPG configuration files for all users after
967 @file{/etc/gnupg/gpgconf.conf} has been changed.  This allows to enforce
968 certain policies for all users.  Note, that this is not a bulletproof of
969 forcing a user to use certain options.  A user may always directly edit
970 the configuration files and bypass gpgconf.
971
972 @noindent
973 @command{applygnupgdefaults} is invoked by root as:
974
975 @example
976 applygnupgdefaults
977 @end example
978
979
980 @c
981 @c    GPGSM-GENCERT.SH
982 @c
983 @node gpgsm-gencert.sh
984 @section Generate an X.509 certificate request
985 @manpage gpgsm-gencert.sh.1
986 @ifset manverb
987 .B gpgsm-gencert.sh
988 \- Generate an X.509 certificate request
989 @end ifset 
990
991 @mansect synopsis
992 @ifset manverb
993 .B  gpgsm-gencert.sh
994 @end ifset
995
996 @mansect description
997 This is a simple tool to interactively generate a certificate request
998 which will be printed to stdout.
999
1000 @manpause
1001 @noindent
1002 @command{gpgsm-gencert.sh} is invoked as:
1003
1004 @samp{gpgsm-cencert.sh}
1005
1006 @mansect see also
1007 @ifset isman
1008 @command{gpgsm}(1), 
1009 @command{gpg-agent}(1), 
1010 @command{scdaemon}(1)
1011 @end ifset
1012 @include see-also-note.texi
1013
1014
1015
1016 @c
1017 @c   GPG-PRESET-PASSPHRASE
1018 @c
1019 @node gpg-preset-passphrase
1020 @section Put a passphrase into the cache.
1021 @manpage gpg-preset-passphrase.1
1022 @ifset manverb
1023 .B gpg-preset-passphrase
1024 \- Put a passphrase into gpg-agent's cache
1025 @end ifset
1026
1027 @mansect synopsis
1028 @ifset manverb
1029 .B  gpg-preset-passphrase
1030 .RI [ options ]
1031 .RI [ command ]
1032 .I cache-id
1033 @end ifset
1034
1035 @mansect description
1036 The @command{gpg-preset-passphrase} is a utility to seed the internal
1037 cache of a running @command{gpg-agent} with passphrases.  It is mainly
1038 useful for unattended machines, where the usual @command{pinentry} tool
1039 may not be used and the passphrases for the to be used keys are given at
1040 machine startup.
1041
1042 Passphrases set with this utility don't expire unless the
1043 @option{--forget} option is used to explicitly clear them from the cache
1044 --- or @command{gpg-agent} is either restarted or reloaded (by sending a
1045 SIGHUP to it).  It is necessary to allow this passphrase presetting by
1046 starting @command{gpg-agent} with the
1047 @option{--allow-preset-passphrase}.
1048
1049 @menu
1050 * Invoking gpg-preset-passphrase::   List of all commands and options.
1051 @end menu
1052
1053 @manpause
1054 @node Invoking gpg-preset-passphrase
1055 @subsection List of all commands and options.
1056 @mancont
1057
1058 @noindent
1059 @command{gpg-preset-passphrase} is invoked this way:
1060
1061 @example
1062 gpg-preset-passphrase [options] [command] @var{cacheid}
1063 @end example
1064
1065 @var{cacheid} is either a 40 character keygrip of hexadecimal
1066 characters identifying the key for which the passphrase should be set
1067 or cleared.  The keygrip is listed along with the key when running the
1068 command: @code{gpgsm --dump-secret-keys}.  Alternatively an arbitrary
1069 string may be used to identify a passphrase; it is suggested that such
1070 a string is prefixed with the name of the application (e.g
1071 @code{foo:12346}).
1072
1073 @noindent
1074 One of the following command options must be given:
1075
1076 @table @gnupgtabopt
1077 @item --preset
1078 @opindex preset
1079 Preset a passphrase. This is what you usually will
1080 use. @command{gpg-preset-passphrase} will then read the passphrase from
1081 @code{stdin}.
1082
1083 @item --forget
1084 @opindex forget
1085 Flush the passphrase for the given cache ID from the cache.
1086
1087 @end table
1088
1089 @noindent
1090 The following additional options may be used:
1091
1092 @table @gnupgtabopt
1093 @item -v
1094 @itemx --verbose
1095 @opindex verbose
1096 Output additional information while running.  
1097
1098 @item -P @var{string}
1099 @itemx --passphrase @var{string}
1100 @opindex passphrase
1101 Instead of reading the passphrase from @code{stdin}, use the supplied
1102 @var{string} as passphrase.  Note that this makes the passphrase visible
1103 for other users.
1104 @end table
1105
1106 @mansect see also
1107 @ifset isman
1108 @command{gpg}(1), 
1109 @command{gpgsm}(1), 
1110 @command{gpg-agent}(1), 
1111 @command{scdaemon}(1)
1112 @end ifset
1113 @include see-also-note.texi
1114
1115
1116
1117
1118 @c
1119 @c   GPG-CONNECT-AGENT
1120 @c
1121 @node gpg-connect-agent
1122 @section Communicate with a running agent.
1123 @manpage gpg-connect-agent.1
1124 @ifset manverb
1125 .B gpg-connect-agent
1126 \- Communicate with a running agent
1127 @end ifset
1128
1129 @mansect synopsis
1130 @ifset manverb
1131 .B  gpg-connect-agent
1132 .RI [ options ] [commands]
1133 @end ifset
1134
1135 @mansect description
1136 The @command{gpg-connect-agent} is a utility to communicate with a
1137 running @command{gpg-agent}.  It is useful to check out the commands
1138 gpg-agent provides using the Assuan interface.  It might also be useful
1139 for scripting simple applications.  Input is expected at stdin and out
1140 put gets printed to stdout.
1141
1142 It is very similar to running @command{gpg-agent} in server mode; but
1143 here we connect to a running instance.
1144
1145 @menu
1146 * Invoking gpg-connect-agent::       List of all options.
1147 * Controlling gpg-connect-agent::    Control commands.
1148 @end menu
1149
1150 @manpause
1151 @node Invoking gpg-connect-agent
1152 @subsection List of all options.
1153
1154 @noindent
1155 @command{gpg-connect-agent} is invoked this way:
1156
1157 @example
1158 gpg-connect-agent [options] [commands]
1159 @end example
1160 @mancont
1161
1162 @noindent
1163 The following options may be used:
1164
1165 @table @gnupgtabopt
1166 @item -v
1167 @itemx --verbose
1168 @opindex verbose
1169 Output additional information while running.  
1170
1171 @item -q
1172 @item --quiet
1173 @opindex q
1174 @opindex quiet
1175 Try to be as quiet as possible.
1176
1177 @include opt-homedir.texi
1178
1179 @item --agent-program @var{file}
1180 @opindex agent-program
1181 Specify the agent program to be started if none is running.
1182
1183
1184 @item -S
1185 @itemx --raw-socket @var{name}
1186 @opindex S        
1187 @opindex raw-socket
1188 Connect to socket @var{name} assuming this is an Assuan style server.
1189 Do not run any special initializations or environment checks.  This may
1190 be used to directly connect to any Assuan style socket server.
1191
1192 @item -E
1193 @itemx --exec
1194 @opindex exec
1195 Take the rest of the command line as a program and it's arguments and
1196 execute it as an assuan server. Here is how you would run @command{gpgsm}:
1197 @smallexample
1198  gpg-connect-agent --exec gpgsm --server
1199 @end smallexample
1200 Note that you may not use options on the command line in this case.
1201
1202 @item --no-ext-connect
1203 @opindex no-ext-connect
1204 When using @option{-S} or @option{--exec}, @command{gpg-connect-agent}
1205 connects to the assuan server in extended mode to allow descriptor
1206 passing.  This option makes it use the old mode.
1207
1208 @item --run @var{file}
1209 @opindex run 
1210 Run the commands from @var{file} at startup and then continue with the
1211 regular input method.  Note, that commands given on the command line are
1212 executed after this file.
1213
1214 @item -s
1215 @itemx --subst
1216 @opindex subst
1217 Run the command @code{/subst} at startup.
1218
1219 @item --hex
1220 @opindex hex
1221 Print data lines in a hex format and the ASCII representation of
1222 non-control characters.
1223
1224 @item --decode
1225 @opindex decode
1226 Decode data lines.  That is to remove percent escapes but make sure that
1227 a new line always starts with a D and a space.
1228
1229 @end table
1230
1231 @mansect control commands
1232 @node Controlling gpg-connect-agent
1233 @subsection Control commands.
1234
1235 While reading Assuan commands, gpg-agent also allows a few special
1236 commands to control its operation.  These control commands all start
1237 with a slash (@code{/}).
1238
1239 @table @code
1240
1241 @item /echo @var{args}
1242 Just print @var{args}.
1243
1244 @item /let @var{name} @var{value}
1245 Set the variable @var{name} to @var{value}.  Variables are only
1246 substituted on the input if the @command{/subst} has been used.
1247 Variables are referenced by prefixing the name with a dollar sign and
1248 optionally include the name in curly braces.  The rules for a valid name
1249 are identically to those of the standard bourne shell.  This is not yet
1250 enforced but may be in the future.  When used with curly braces no
1251 leading or trailing white space is allowed. 
1252
1253 If a variable is not found, it is searched in the environment and if
1254 found copied to the table of variables.
1255
1256 Variable functions are available: The name of the function must be
1257 followed by at least one space and the at least one argument.  The
1258 following functions are available:
1259
1260 @table @code
1261 @item get
1262 Return a value described by the argument.  Available arguments are:
1263
1264 @table @code    
1265 @item cwd
1266 The current working directory.
1267 @item homedir
1268 The gnupg homedir.
1269 @item sysconfdir
1270 GnuPG's system configuration directory.
1271 @item bindir
1272 GnuPG's binary directory.
1273 @item libdir
1274 GnuPG's library directory.
1275 @item libexecdir
1276 GnuPG's library directory for executable files.
1277 @item datadir
1278 GnuPG's data directory.
1279 @item serverpid
1280 The PID of the current server. Command @command{/serverpid} must
1281 have been given to return a useful value.
1282 @end table
1283
1284 @item unescape @var{args}
1285 Remove C-style escapes from @var{args}.  Note that @code{\0} and
1286 @code{\x00} terminate the returned string implicitly.  The string to be
1287 converted are the entire arguments right behind the delimiting space of
1288 the function name.
1289
1290 @item unpercent @var{args}
1291 @itemx unpercent+ @var{args}
1292 Remove percent style escaping from @var{args}.  Note that @code{%00}
1293 terminates the string implicitly.  The string to be converted are the
1294 entire arguments right behind the delimiting space of the function
1295 name. @code{unpercent+} also maps plus signs to a spaces.
1296
1297 @item percent @var{args}
1298 @itemx percent+ @var{args}
1299 Escape the @var{args} using percent style escaping.  Tabs, formfeeds,
1300 linefeeds, carriage returns and colons are escaped. @code{percent+} also
1301 maps spaces to plus signs.
1302
1303 @item errcode @var{arg}
1304 @itemx errsource @var{arg}
1305 @itemx errstring @var{arg}
1306 Assume @var{arg} is an integer and evaluate it using @code{strtol}.  Return
1307 the gpg-error error code, error source or a formatted string with the
1308 error code and error source.
1309
1310
1311 @item +
1312 @itemx -
1313 @itemx *
1314 @itemx /
1315 @itemx %
1316 Evaluate all arguments as long integers using @code{strtol} and apply
1317 this operator.  A division by zero yields an empty string.
1318
1319 @item !
1320 @itemx |
1321 @itemx &
1322 Evaluate all arguments as long integers using @code{strtol} and apply
1323 the logical oeprators NOT, OR or AND.  The NOT operator works on the
1324 last argument only.
1325
1326
1327 @end table
1328
1329
1330 @item /definq @var{name} @var{var}
1331 Use content of the variable @var{var} for inquiries with @var{name}.
1332 @var{name} may be an asterisk (@code{*}) to match any inquiry.
1333
1334
1335 @item /definqfile @var{name} @var{file}
1336 Use content of @var{file} for inquiries with @var{name}.
1337 @var{name} may be an asterisk (@code{*}) to match any inquiry.
1338
1339 @item /definqprog @var{name} @var{prog}
1340 Run @var{prog} for inquiries matching @var{name} and pass the
1341 entire line to it as command line arguments.
1342
1343 @item /datafile @var{name}
1344 Write all data lines from the server to the file @var{name}.  The file
1345 is opened for writing and created if it does not exists.  An existing
1346 file is first truncated to 0.  The data written to the file fully
1347 decoded.  Using a single dash for @var{name} writes to stdout.  The
1348 file is kept open until a new file is set using this command or this
1349 command is used without an argument.
1350
1351 @item /showdef
1352 Print all definitions
1353
1354 @item /cleardef
1355 Delete all definitions
1356
1357 @item /sendfd @var{file} @var{mode}
1358 Open @var{file} in @var{mode} (which needs to be a valid @code{fopen}
1359 mode string) and send the file descriptor to the server.  This is
1360 usually followed by a command like @code{INPUT FD} to set the
1361 input source for other commands.
1362
1363 @item /recvfd
1364 Not yet implemented.
1365
1366 @item /open @var{var} @var{file} [@var{mode}]
1367 Open @var{file} and assign the file descriptor to @var{var}.  Warning:
1368 This command is experimental and might change in future versions.
1369
1370 @item /close @var{fd}
1371 Close the file descriptor @var{fd}.  Warning: This command is
1372 experimental and might change in future versions.
1373
1374 @item /showopen
1375 Show a list of open files.
1376
1377 @item /serverpid
1378 Send the Assuan command @command{GETINFO pid} to the server and store
1379 the returned PID for internal purposes.
1380
1381 @item /sleep
1382 Sleep for a second.
1383
1384 @item /hex
1385 @itemx /nohex
1386 Same as the command line option @option{--hex}.
1387
1388 @item /decode
1389 @itemx /nodecode
1390 Same as the command line option @option{--decode}.
1391
1392 @item /subst
1393 @itemx /nosubst
1394 Enable and disable variable substitution.  It defaults to disabled
1395 unless the command line option @option{--subst} has been used.
1396 If /subst as been enabled once, leading whitespace is removed from
1397 input lines which makes scripts easier to read.
1398
1399 @item /while @var{condition}
1400 @itemx /end
1401 These commands provide a way for executing loops.  All lines between the
1402 @code{while} and the corresponding @code{end} are executed as long as
1403 the evaluation of @var{condition} yields a non-zero value.  The
1404 evaluation is done by passing @var{condition} to the @code{strtol}
1405 function.  Example:
1406
1407 @smallexample
1408   /subst
1409   /let i 3
1410   /while $i
1411     /echo loop couter is $i
1412     /let i $@{- $i 1@}
1413   /end
1414 @end smallexample
1415
1416
1417 @item /run @var{file}
1418 Run commands from @var{file}.
1419
1420 @item /bye
1421 Terminate the connection and the program
1422
1423 @item /help
1424 Print a list of available control commands.
1425
1426 @end table
1427
1428
1429 @ifset isman
1430 @mansect see also
1431 @command{gpg-agent}(1), 
1432 @command{scdaemon}(1)
1433 @include see-also-note.texi
1434 @end ifset
1435
1436 @c
1437 @c   DIRMNGR-CLIENT
1438 @c
1439 @node dirmngr-client
1440 @section The Dirmngr Client Tool
1441
1442 @manpage dirmngr-client.1
1443 @ifset manverb
1444 .B dirmngr-client
1445 \- Tool to access the Dirmngr services
1446 @end ifset
1447
1448 @mansect synopsis
1449 @ifset manverb
1450 .B  dirmngr-client
1451 .RI [ options ]  
1452 .RI [ certfile | pattern ]  
1453 @end ifset
1454
1455 @mansect description
1456 The @command{dirmngr-client} is a simple tool to contact a running
1457 dirmngr and test whether a certificate has been revoked --- either by
1458 being listed in the corresponding CRL or by running the OCSP protocol.
1459 If no dirmngr is running, a new instances will be started but this is
1460 in general not a good idea due to the huge performance overhead.
1461
1462 @noindent
1463 The usual way to run this tool is either:
1464
1465 @example
1466 dirmngr-client @var{acert}
1467 @end example
1468
1469 @noindent
1470 or
1471
1472 @example
1473 dirmngr-client <@var{acert}
1474 @end example
1475
1476 Where @var{acert} is one DER encoded (binary) X.509 certificates to be
1477 tested. 
1478 @ifclear isman
1479 The return value of this command is
1480 @end ifclear
1481
1482 @mansect return value
1483 @ifset isman
1484 @command{dirmngr-client} returns these values:
1485 @end ifset
1486 @table @code
1487
1488 @item 0 
1489 The certificate under question is valid; i.e. there is a valid CRL
1490 available and it is not listed tehre or teh OCSP request returned that
1491 that certificate is valid.
1492
1493 @item 1
1494 The certificate has been revoked
1495
1496 @item 2 (and other values)
1497 There was a problem checking the revocation state of the certificate.
1498 A message to stderr has given more detailed information.  Most likely
1499 this is due to a missing or expired CRL or due to a network problem.
1500
1501 @end table
1502
1503 @mansect options
1504 @noindent
1505 @command{dirmngr-client} may be called with the following options:
1506
1507
1508 @table @gnupgtabopt
1509 @item --version
1510 @opindex version
1511 Print the program version and licensing information.  Note that you cannot
1512 abbreviate this command.
1513
1514 @item --help, -h
1515 @opindex help
1516 Print a usage message summarizing the most useful command-line options.
1517 Note that you cannot abbreviate this command.
1518
1519 @item --quiet, -q
1520 @opindex quiet
1521 Make the output extra brief by suppressing any informational messages.
1522
1523 @item -v
1524 @item --verbose
1525 @opindex v
1526 @opindex verbose
1527 Outputs additional information while running.
1528 You can increase the verbosity by giving several
1529 verbose commands to @sc{dirmngr}, such as @samp{-vv}.
1530
1531 @item --pem
1532 @opindex pem
1533 Assume that the given certificate is in PEM (armored) format.
1534
1535 @item --ocsp
1536 @opindex ocsp
1537 Do the check using the OCSP protocol and ignore any CRLs.
1538
1539 @item --force-default-responder
1540 @opindex force-default-responder
1541 When checking using the OCSP protocl, force the use of the default OCSP
1542 responder.  That is not to use the Reponder as given by the certificate.
1543
1544 @item --ping
1545 @opindex ping
1546 Check whether the dirmngr daemon is up and running.
1547
1548 @item --cache-cert
1549 @opindex cache-cert
1550 Put the given certificate into the cache of a running dirmngr.  This is
1551 mainly useful for debugging.
1552
1553 @item --validate
1554 @opindex validate
1555 Validate the given certificate using dirmngr's internal validation code.
1556 This is mainly useful for debugging.
1557
1558 @item --load-crl
1559 @opindex load-crl
1560 This command expects a list of filenames with DER encoded CRL files.
1561 With the option @option{--url} URLs are expected in place of filenames
1562 and they are loaded directly from the given location.  All CRLs will be
1563 validated and then loaded into dirmngr's cache.
1564
1565 @item --lookup
1566 @opindex lookup
1567 Take the remaining arguments and run a lookup command on each of them.
1568 The results are Base-64 encoded outputs (without header lines).  This
1569 may be used to retrieve certificates from a server. However the output
1570 format is not very well suited if more than one certificate is returned.
1571
1572 @item --url
1573 @itemx -u
1574 @opindex url
1575 Modify the @command{lookup} and @command{load-crl} commands to take an URL.
1576
1577 @item --local
1578 @itemx -l
1579 @opindex url
1580 Let the @command{lookup} command only search the local cache.
1581
1582 @item --squid-mode
1583 @opindex squid-mode
1584 Run @sc{dirmngr-client} in a mode suitable as a helper program for
1585 Squid's @option{external_acl_type} option.
1586
1587
1588 @end table
1589
1590 @ifset isman
1591 @mansect see also
1592 @command{dirmngr}(8),
1593 @command{gpgsm}(1)
1594 @include see-also-note.texi
1595 @end ifset
1596
1597
1598 @c
1599 @c   GPGPARSEMAIL
1600 @c
1601 @node gpgparsemail
1602 @section Parse a mail message into an annotated format
1603
1604 @manpage gpgparsemail.1
1605 @ifset manverb
1606 .B gpgparsemail
1607 \- Parse a mail message into an annotated format
1608 @end ifset
1609
1610 @mansect synopsis
1611 @ifset manverb
1612 .B  gpgparsemail
1613 .RI [ options ]
1614 .RI [ file ]
1615 @end ifset
1616
1617 @mansect description
1618 The @command{gpgparsemail} is a utility currently only useful for
1619 debugging.  Run it with @code{--help} for usage information.
1620
1621
1622
1623 @c
1624 @c   SYMCRYPTRUN
1625 @c
1626 @node symcryptrun
1627 @section Call a simple symmetric encryption tool.
1628 @manpage symcryptrun.1
1629 @ifset manverb
1630 .B symcryptrun
1631 \- Call a simple symmetric encryption tool
1632 @end ifset
1633
1634 @mansect synopsis
1635 @ifset manverb
1636 .B  symcryptrun
1637 .B \-\-class
1638 .I class
1639 .B \-\-program
1640 .I program
1641 .B \-\-keyfile
1642 .I keyfile
1643 .RB [ --decrypt | --encrypt ]
1644 .RI [ inputfile ]
1645 @end ifset
1646
1647 @mansect description
1648 Sometimes simple encryption tools are already in use for a long time and
1649 there might be a desire to integrate them into the GnuPG framework.  The
1650 protocols and encryption methods might be non-standard or not even
1651 properly documented, so that a full-fledged encryption tool with an
1652 interface like gpg is not doable.  @command{symcryptrun} provides a
1653 solution: It operates by calling the external encryption/decryption
1654 module and provides a passphrase for a key using the standard
1655 @command{pinentry} based mechanism through @command{gpg-agent}.
1656
1657 Note, that @command{symcryptrun} is only available if GnuPG has been
1658 configured with @samp{--enable-symcryptrun} at build time.
1659
1660 @menu
1661 * Invoking symcryptrun::   List of all commands and options.
1662 @end menu
1663
1664 @manpause
1665 @node Invoking symcryptrun
1666 @subsection List of all commands and options.
1667
1668 @noindent
1669 @command{symcryptrun} is invoked this way:
1670
1671 @example
1672 symcryptrun --class CLASS --program PROGRAM --keyfile KEYFILE 
1673    [--decrypt | --encrypt] [inputfile]
1674 @end example
1675 @mancont
1676
1677 For encryption, the plain text must be provided on STDIN or as the
1678 argument @var{inputfile}, and the ciphertext will be output to STDOUT.
1679 For decryption vice versa.
1680
1681 @var{CLASS} describes the calling conventions of the external tool.
1682 Currently it must be given as @samp{confucius}.  @var{PROGRAM} is
1683 the full filename of that external tool.
1684  
1685 For the class @samp{confucius} the option @option{--keyfile} is
1686 required; @var{keyfile} is the name of a file containing the secret key,
1687 which may be protected by a passphrase.  For detailed calling
1688 conventions, see the source code.
1689  
1690 @noindent
1691 Note, that @command{gpg-agent} must be running before starting
1692 @command{symcryptrun}.
1693
1694 @noindent
1695 The following additional options may be used:
1696
1697 @table @gnupgtabopt
1698 @item -v
1699 @itemx --verbose
1700 @opindex verbose
1701 Output additional information while running.  
1702
1703 @item -q
1704 @item --quiet
1705 @opindex q
1706 @opindex quiet
1707 Try to be as quiet as possible.
1708
1709 @include opt-homedir.texi
1710
1711
1712 @item --log-file @var{file}
1713 @opindex log-file
1714 Append all logging output to @var{file}.  Default is to write logging
1715 information to STDERR.
1716
1717 @end table
1718
1719 @noindent
1720 The possible exit status codes of @command{symcryptrun} are:
1721
1722 @table @code
1723 @item 0 
1724         Success.
1725 @item 1 
1726         Some error occured.
1727 @item 2 
1728         No valid passphrase was provided.
1729 @item 3 
1730         The operation was canceled by the user.
1731
1732 @end table
1733
1734 @mansect see also
1735 @ifset isman
1736 @command{gpg}(1), 
1737 @command{gpgsm}(1), 
1738 @command{gpg-agent}(1), 
1739 @end ifset
1740 @include see-also-note.texi
1741
1742
1743 @c
1744 @c  GPG-ZIP
1745 @c
1746 @c The original manpage on which this section is based was written 
1747 @c by Colin Tuckley  <colin@tuckley.org> and Daniel Leidert 
1748 @c <daniel.leidert@wgdd.de> for the Debian distribution (but may be used by
1749 @c others).
1750 @manpage gpg-zip.1
1751 @node gpg-zip
1752 @section Encrypt or sign files into an archive
1753 @ifset manverb
1754 .B gpg-zip \- Encrypt or sign files into an archive
1755 @end ifset
1756
1757 @mansect synopsis
1758 @ifset manverb
1759 .B  gpg-zip
1760 .RI [ options ]
1761 .I filename1
1762 .I [ filename2, ... ]
1763 .I directory1
1764 .I [ directory2, ... ]
1765 @end ifset
1766
1767 @mansect description
1768 @command{gpg-zip} encrypts or signs files into an archive.  It is an
1769 gpg-ized tar using the same format as used by PGP's PGP Zip.
1770
1771 @manpause
1772 @noindent
1773 @command{gpg-zip} is invoked this way:
1774
1775 @example
1776 gpg-zip [options] @var{filename1} [@var{filename2}, ...] @var{directory} [@var{directory2}, ...]
1777 @end example
1778
1779 @mansect options
1780 @noindent
1781 @command{gpg-zip} understands these options:
1782
1783 @table @gnupgtabopt
1784
1785 @item --encrypt
1786 @itemx -e
1787 @opindex encrypt
1788 Encrypt data.  This option may be combined with @option{--symmetric} (for  output that may be decrypted via a secret key or a passphrase).
1789
1790 @item --decrypt
1791 @itemx -d
1792 @opindex decrypt
1793 Decrypt data.
1794
1795 @item --symmetric
1796 @itemx -c
1797 Encrypt with a symmetric cipher using a passphrase.  The default
1798 symmetric cipher used is CAST5, but may be chosen with the
1799 @option{--cipher-algo} option to @command{gpg}.
1800
1801 @item --sign
1802 @itemx -s
1803 Make a signature.  See @command{gpg}.
1804
1805 @item --recipient @var{user}
1806 @itemx -r @var{user}
1807 @opindex recipient
1808 Encrypt for user id @var{user}. See @command{gpg}.
1809
1810 @item --local-user @var{user}
1811 @itemx -u @var{user}
1812 @opindex local-user
1813 Use @var{user} as the key to sign with.  See @command{gpg}.
1814
1815 @item --list-archive
1816 @opindex list-archive
1817 List the contents of the specified archive.
1818
1819 @item --output @var{file}
1820 @itemx -o @var{file}
1821 @opindex output
1822 Write output to specified file @var{file}.
1823
1824 @item --gpg @var{gpgcmd}
1825 @opindex gpg
1826 Use the specified command @var{gpgcmd} instead of @command{gpg}.
1827
1828 @item --gpg-args @var{args}
1829 @opindex gpg-args
1830 Pass the specified options to @command{gpg}.
1831
1832 @item --tar @var{tarcmd}
1833 @opindex tar
1834 Use the specified command @var{tarcmd} instead of @command{tar}.
1835
1836 @item --tar-args @var{args}
1837 @opindex tar-args
1838 Pass the specified options to @command{tar}.
1839
1840 @item --version
1841 @opindex version
1842 Print version of the program and exit.
1843
1844 @item --help
1845 @opindex help
1846 Display a brief help page and exit.
1847
1848 @end table
1849
1850 @mansect diagnostics
1851 @noindent
1852 The program returns 0 if everything was fine, 1 otherwise.
1853
1854
1855 @mansect examples
1856 @ifclear isman
1857 @noindent
1858 Some examples:
1859
1860 @end ifclear
1861 @noindent
1862 Encrypt the contents of directory @file{mydocs} for user Bob to file
1863 @file{test1}:
1864
1865 @example
1866 gpg-zip --encrypt --output test1 --gpg-args  -r Bob mydocs
1867 @end example
1868
1869 @noindent
1870 List the contents of archive @file{test1}:
1871
1872 @example
1873 gpg-zip --list-archive test1
1874 @end example
1875
1876
1877 @mansect see also
1878 @ifset isman
1879 @command{gpg}(1), 
1880 @command{tar}(1), 
1881 @end ifset
1882 @include see-also-note.texi
1883