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