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