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