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