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