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