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