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