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