agent/
[gnupg.git] / doc / tools.texi
1 @c Copyright (C) 2004 Free Software Foundation, Inc.
2 @c This is part of the GnuPG manual.
3 @c For copying conditions, see the file GnuPG.texi.
4
5 @node Helper Tools
6 @chapter Helper Tools
7
8 GnuPG comes with a couple of smaller tools:
9
10 @menu
11 * watchgnupg::            Read logs from a socket.
12 * addgnupghome::          Create .gnupg home directories.
13 * gpgconf::               Modify .gnupg home directories.
14 * gpgsm-gencert.sh::      Generate an X.509 certificate request.
15 * gpg-preset-passphrase:: Put a passphrase into the cache.
16 * gpg-connect-agent::     Communicate with a running agent.
17 * symcryptrun::           Call a simple symmetric encryption tool.
18 @end menu
19
20 @c
21 @c  WATCHGNUPG
22 @c
23 @manpage watchgnupg.1
24 @node watchgnupg
25 @section Read logs from a socket
26 @ifset manverb
27  watchgnupg \-  Read and print logs from a socket
28 @end ifset
29
30 @mansect description
31 Most of the main utilities are able to write there log files to a
32 Unix Domain socket if configured that way.  @command{watchgnupg} is a simple
33 listener for such a socket.  It ameliorates the output with a time
34 stamp and makes sure that long lines are not interspersed with log
35 output from other utilities.
36
37 @manpause
38 @noindent
39 @command{watchgnupg} is commonly invoked as
40
41 @mansect synopsis
42 @example
43 watchgnupg --force ~/.gnupg/S.log
44 @end example
45 @manpause
46
47 @noindent
48 This starts it on the current terminal for listening on the socket
49 @file{~/.gnupg/S.log}.  
50
51 @noindent
52 @command{watchgnupg} understands these options:
53
54 @table @gnupgtabopt
55 @mansect options
56
57 @item --force 
58 @opindex force
59 Delete an already existing socket file.
60
61 @item --verbose
62 @opindex verbose
63 Enable extra informational output.
64
65 @item --version
66 @opindex version
67 print version of the program and exit
68
69 @item --help
70 @opindex help
71 Display a brief help page and exit
72
73 @manpause
74 @end table
75
76
77 @c
78 @c    ADDGNUPGHOME
79 @c
80 @manpage addgnupghome.8
81 @node addgnupghome
82 @section Create .gnupg home directories.
83 @ifset manverb
84  addgnupghome \-  Create .gnupg home directories
85 @end ifset
86
87 @mansect description
88 If GnuPG is installed on a system with existing user accounts, it is
89 sometimes required to populate the GnuPG home directory with existing
90 files.  Especially a @file{trustlist.txt} and a keybox with some
91 initial certificates are often desired.  This scripts help to do this
92 by copying all files from @file{/etc/skel/.gnupg} to the home
93 directories of the accounts given on the command line.  It takes care
94 not to overwrite existing GnuPG home directories.
95
96 @manpause
97 @noindent
98 @command{addgnupghome} is invoked by root as:
99
100 @mansect synopsis
101 @example
102 addgnupghome account1 account2 ... accountn
103 @end example
104
105
106 @c
107 @c   GPGCONF
108 @c
109 @manpage gpgconf.1
110 @node gpgconf
111 @section Modify .gnupg home directories.
112 @ifset manverb
113   gpgconf \- Modify .gnupg home directories
114 @end ifset
115
116 @mansect description
117 The @command{gpgconf} is a utility to automatically and reasonable
118 safely query and modify configuration files in the @file{.gnupg} home
119 directory.  It is designed not to be invoked manually by the user, but
120 automatically by graphical user interfaces (GUI).@footnote{Please note
121 that currently no locking is done, so concurrent access should be
122 avoided.  There are some precautions to avoid corruption with
123 concurrent usage, but results may be inconsistent and some changes may
124 get lost.  The stateless design makes it difficult to provide more
125 guarantees.}
126
127 @command{gpgconf} provides access to the configuration of one or more
128 components of the GnuPG system.  These components correspond more or
129 less to the programs that exist in the GnuPG framework, like GnuPG,
130 GPGSM, DirMngr, etc.  But this is not a strict one-to-one
131 relationship.  Not all configuration options are available through
132 @command{gpgconf}.  @command{gpgconf} provides a generic and abstract
133 method to access the most important configuration options that can
134 feasibly be controlled via such a mechanism.
135
136 @command{gpgconf} can be used to gather and change the options
137 available in each component, and can also provide their default
138 values.  @command{gpgconf} will give detailed type information that
139 can be used to restrict the user's input without making an attempt to
140 commit the changes.
141
142 @command{gpgconf} provides the backend of a configuration editor.  The
143 configuration editor would usually be a graphical user interface
144 program, that allows to display the current options, their default
145 values, and allows the user to make changes to the options.  These
146 changes can then be made active with @command{gpgconf} again.  Such a
147 program that uses @command{gpgconf} in this way will be called GUI
148 throughout this section.
149
150 @manpause
151 @menu
152 * Invoking gpgconf::      List of all commands and options.
153 * Format conventions::    Formatting conventions relevant for all commands.
154 * Listing components::    List all gpgconf components.
155 * Listing options::       List all options of a component.
156 * Changing options::      Changing options of a component.
157 @end menu
158
159
160 @node Invoking gpgconf
161 @subsection Invoking gpgconf
162
163 @mansect commands
164 One of the following commands must be given:
165
166 @manpause
167 @table @gnupgtabopt
168 @mancont
169
170 @item --list-components
171 List all components.  This is the default command used if none is
172 specified.
173
174 @item --list-options @var{component}
175 List all options of the component @var{component}.
176
177 @item --change-options @var{component}
178 Change the options of the component @var{component}.
179 @manpause
180 @end table
181
182 @mansect options
183
184 The following options may be used:
185
186 @manpause
187 @table @gnupgtabopt
188 @mancont
189 @c FIXME: Not yet supported.
190 @c @item -o @var{file}
191 @c @itemx --output @var{file}
192 @c Use @var{file} as output file.
193
194 @item -v
195 @itemx --verbose
196 Outputs additional information while running.  Specifically, this
197 extends numerical field values by human-readable descriptions.
198
199 @c FIXME: Not yet supported.
200 @c @item -n
201 @c @itemx --dry-run
202 @c Do not actually change anything.  Useful together with
203 @c @code{--change-options} for testing purposes.
204
205 @item -r
206 @itemx --runtime
207 Only used together with @code{--change-options}.  If one of the
208 modified options can be changed in a running daemon process, signal
209 the running daemon to ask it to reparse its configuration file after
210 changing.
211
212 This means that the changes will take effect at run-time, as far as
213 this is possible.  Otherwise, they will take effect at the next start
214 of the respective backend programs.
215 @manpause
216 @end table
217
218
219 @node Format conventions
220 @subsection Format conventions
221
222 Some lines in the output of @command{gpgconf} contain a list of
223 colon-separated fields.  The following conventions apply:
224
225 @itemize @bullet
226 @item
227 The GUI program is required to strip off trailing newline and/or
228 carriage return characters from the output.
229
230 @item
231 @command{gpgconf} will never leave out fields.  If a certain version
232 provides a certain field, this field will always be present in all
233 @command{gpgconf} versions from that time on.
234
235 @item
236 Future versions of @command{gpgconf} might append fields to the list.
237 New fields will always be separated from the previously last field by
238 a colon separator.  The GUI should be prepared to parse the last field
239 it knows about up until a colon or end of line.
240
241 @item
242 Not all fields are defined under all conditions.  You are required to
243 ignore the content of undefined fields.
244 @end itemize
245
246 There are several standard types for the content of a field:
247
248 @table @asis
249 @item verbatim
250 Some fields contain strings that are not escaped in any way.  Such
251 fields are described to be used @emph{verbatim}.  These fields will
252 never contain a colon character (for obvious reasons).  No de-escaping
253 or other formatting is required to use the field content.  This is for
254 easy parsing of the output, when it is known that the content can
255 never contain any special characters.
256
257 @item percent-escaped
258 Some fields contain strings that are described to be
259 @emph{percent-escaped}.  Such strings need to be de-escaped before
260 their content can be presented to the user.  A percent-escaped string
261 is de-escaped by replacing all occurences of @code{%XY} by the byte
262 that has the hexadecimal value @code{XY}.  @code{X} and @code{Y} are
263 from the set @code{0-9a-f}.
264
265 @item localised
266 Some fields contain strings that are described to be @emph{localised}.
267 Such strings are translated to the active language and formatted in
268 the active character set.
269
270 @item @w{unsigned number}
271 Some fields contain an @emph{unsigned number}.  This number will
272 always fit into a 32-bit unsigned integer variable.  The number may be
273 followed by a space, followed by a human readable description of that
274 value (if the verbose option is used).  You should ignore everything
275 in the field that follows the number.
276
277 @item @w{signed number}
278 Some fields contain a @emph{signed number}.  This number will always
279 fit into a 32-bit signed integer variable.  The number may be followed
280 by a space, followed by a human readable description of that value (if
281 the verbose option is used).  You should ignore everything in the
282 field that follows the number.
283
284 @item option
285 Some fields contain an @emph{option} argument.  The format of an
286 option argument depends on the type of the option and on some flags:
287
288 @table @asis
289 @item no argument
290 The simplest case is that the option does not take an argument at all
291 (@var{type} @code{0}).  Then the option argument is an unsigned number
292 that specifies how often the option occurs.  If the @code{list} flag
293 is not set, then the only valid number is @code{1}.  Options that do
294 not take an argument never have the @code{default} or @code{optional
295 arg} flag set.
296
297 @item number
298 If the option takes a number argument (@var{alt-type} is @code{2} or
299 @code{3}), and it can only occur once (@code{list} flag is not set),
300 then the option argument is either empty (only allowed if the argument
301 is optional), or it is a number.  A number is a string that begins
302 with an optional minus character, followed by one or more digits.  The
303 number must fit into an integer variable (unsigned or signed,
304 depending on @var{alt-type}).
305
306 @item number list
307 If the option takes a number argument and it can occur more than once,
308 then the option argument is either empty, or it is a comma-separated
309 list of numbers as described above.
310
311 @item string
312 If the option takes a string argument (@var{alt-type} is 1), and it
313 can only occur once (@code{list} flag is not set) then the option
314 argument is either empty (only allowed if the argument is optional),
315 or it starts with a double quote character (@code{"}) followed by a
316 percent-escaped string that is the argument value.  Note that there is
317 only a leading double quote character, no trailing one.  The double
318 quote character is only needed to be able to differentiate between no
319 value and the empty string as value.
320
321 @item string list
322 If the option takes a number argument and it can occur more than once,
323 then the option argument is either empty, or it is a comma-separated
324 list of string arguments as described above.
325 @end table
326 @end table
327
328 The active language and character set are currently determined from
329 the locale environment of the @command{gpgconf} program.
330
331 @c FIXME: Document the active language and active character set.  Allow
332 @c to change it via the command line?
333
334
335 @mansect usage
336 @node Listing components
337 @subsection Listing components
338
339 The command @code{--list-components} will list all components that can
340 be configured with @command{gpgconf}.  Usually, one component will
341 correspond to one GnuPG-related program and contain the options of
342 that programs configuration file that can be modified using
343 @command{gpgconf}.  However, this is not necessarily the case.  A
344 component might also be a group of selected options from several
345 programs, or contain entirely virtual options that have a special
346 effect rather than changing exactly one option in one configuration
347 file.
348
349 A component is a set of configuration options that semantically belong
350 together.  Furthermore, several changes to a component can be made in
351 an atomic way with a single operation.  The GUI could for example
352 provide a menu with one entry for each component, or a window with one
353 tabulator sheet per component.
354
355 The command argument @code{--list-components} lists all available
356 components, one per line.  The format of each line is:
357
358 @code{@var{name}:@var{description}}
359
360 @table @var
361 @item name
362 This field contains a name tag of the component.  The name tag is used
363 to specify the component in all communication with @command{gpgconf}.
364 The name tag is to be used @emph{verbatim}.  It is thus not in any
365 escaped format.
366
367 @item description
368 The @emph{string} in this field contains a human-readable description
369 of the component.  It can be displayed to the user of the GUI for
370 informational purposes.  It is @emph{percent-escaped} and
371 @emph{localized}.
372 @end table
373
374 Example:
375 @example
376 $ gpgconf --list-components
377 gpg:GPG for OpenPGP
378 gpg-agent:GPG Agent
379 scdaemon:Smartcard Daemon
380 gpgsm:GPG for S/MIME
381 dirmngr:Directory Manager
382 @end example
383
384
385 @node Listing options
386 @subsection Listing options
387
388 Every component contains one or more options.  Options may be gathered
389 into option groups to allow the GUI to give visual hints to the user
390 about which options are related.
391
392 The command argument @code{@w{--list-options @var{component}}} lists
393 all options (and the groups they belong to) in the component
394 @var{component}, one per line.  @var{component} must be the string in
395 the field @var{name} in the output of the @code{--list-components}
396 command.
397
398 There is one line for each option and each group.  First come all
399 options that are not in any group.  Then comes a line describing a
400 group.  Then come all options that belong into each group.  Then comes
401 the next group and so on.  There does not need to be any group (and in
402 this case the output will stop after the last non-grouped option).
403
404 The format of each line is:
405
406 @code{@var{name}:@var{flags}:@var{level}:@var{description}:@var{type}:@var{alt-type}:@var{argname}:@var{default}:@var{argdef}:@var{value}}
407
408 @table @var
409 @item name
410 This field contains a name tag for the group or option.  The name tag
411 is used to specify the group or option in all communication with
412 @command{gpgconf}.  The name tag is to be used @emph{verbatim}.  It is
413 thus not in any escaped format.
414
415 @item flags
416 The flags field contains an @emph{unsigned number}.  Its value is the
417 OR-wise combination of the following flag values:
418
419 @table @code
420 @item group (1)
421 If this flag is set, this is a line describing a group and not an
422 option.
423 @end table
424
425 The following flag values are only defined for options (that is, if
426 the @code{group} flag is not used).
427
428 @table @code
429 @item optional arg (2)
430 If this flag is set, the argument is optional.  This is never set for
431 @var{type} @code{0} (none) options.
432
433 @item list (4)
434 If this flag is set, the option can be given multiple times.
435
436 @item runtime (8)
437 If this flag is set, the option can be changed at runtime.
438
439 @item default (16)
440 If this flag is set, a default value is available.
441
442 @item default desc (32)
443 If this flag is set, a (runtime) default is available.  This and the
444 @code{default} flag are mutually exclusive.
445
446 @item no arg desc (64)
447 If this flag is set, and the @code{optional arg} flag is set, then the
448 option has a special meaning if no argument is given.
449 @end table
450
451 @item level
452 This field is defined for options and for groups.  It contains an
453 @emph{unsigned number} that specifies the expert level under which
454 this group or option should be displayed.  The following expert levels
455 are defined for options (they have analogous meaning for groups):
456
457 @table @code
458 @item basic (0)
459 This option should always be offered to the user.
460
461 @item advanced (1)
462 This option may be offered to advanced users.
463
464 @item expert (2)
465 This option should only be offered to expert users.
466
467 @item invisible (3)
468 This option should normally never be displayed, not even to expert
469 users.
470
471 @item internal (4)
472 This option is for internal use only.  Ignore it.
473 @end table
474
475 The level of a group will always be the lowest level of all options it
476 contains.
477
478 @item description
479 This field is defined for options and groups.  The @emph{string} in
480 this field contains a human-readable description of the option or
481 group.  It can be displayed to the user of the GUI for informational
482 purposes.  It is @emph{percent-escaped} and @emph{localized}.
483
484 @item type
485 This field is only defined for options.  It contains an @emph{unsigned
486 number} that specifies the type of the option's argument, if any.  The
487 following types are defined:
488
489 Basic types:
490
491 @table @code
492 @item none (0)
493 No argument allowed.
494
495 @item string (1)
496 An @emph{unformatted string}.
497
498 @item int32 (2)
499 A @emph{signed number}.
500
501 @item uint32 (3)
502 An @emph{unsigned number}.
503 @end table
504
505 Complex types:
506
507 @table @code
508 @item pathname (32)
509 A @emph{string} that describes the pathname of a file.  The file does
510 not necessarily need to exist.
511
512 @item ldap server (33)
513 A @emph{string} that describes an LDAP server in the format:
514
515 @code{@var{hostname}:@var{port}:@var{username}:@var{password}:@var{base_dn}}
516 @end table
517
518 More types will be added in the future.  Please see the @var{alt-type}
519 field for information on how to cope with unknown types.
520
521 @item alt-type
522 This field is identical to @var{type}, except that only the types
523 @code{0} to @code{31} are allowed.  The GUI is expected to present the
524 user the option in the format specified by @var{type}.  But if the
525 argument type @var{type} is not supported by the GUI, it can still
526 display the option in the more generic basic type @var{alt-type}.  The
527 GUI must support all the defined basic types to be able to display all
528 options.  More basic types may be added in future versions.  If the
529 GUI encounters a basic type it doesn't support, it should report an
530 error and abort the operation.
531
532 @item argname
533 This field is only defined for options with an argument type
534 @var{type} that is not @code{0}.  In this case it may contain a
535 @emph{percent-escaped} and @emph{localised string} that gives a short
536 name for the argument.  The field may also be empty, though, in which
537 case a short name is not known.
538
539 @item default
540 This field is defined only for options.  Its format is that of an
541 @emph{option argument} (@xref{Format conventions}, for details).  If
542 the default value is empty, then no default is known.  Otherwise, the
543 value specifies the default value for this option.  Note that this
544 field is also meaningful if the option itself does not take a real
545 argument.
546
547 @item argdef
548 This field is defined only for options for which the @code{optional
549 arg} flag is set.  If the @code{no arg desc} flag is not set, its
550 format is that of an @emph{option argument} (@xref{Format
551 conventions}, for details).  If the default value is empty, then no
552 default is known.  Otherwise, the value specifies the default value
553 for this option.  If the @code{no arg desc} flag is set, the field is
554 either empty or contains a description of the effect of this option if
555 no argument is given.  Note that this field is also meaningful if the
556 option itself does not take a real argument.
557
558 @item value
559 This field is defined only for options.  Its format is that of an
560 @emph{option argument}.  If it is empty, then the option is not
561 explicitely set in the current configuration, and the default applies
562 (if any).  Otherwise, it contains the current value of the option.
563 Note that this field is also meaningful if the option itself does not
564 take a real argument.
565 @end table
566
567
568 @node Changing options
569 @subsection Changing options
570
571 The command @w{@code{--change-options @var{component}}} will attempt
572 to change the options of the component @var{component} to the
573 specified values.  @var{component} must be the string in the field
574 @var{name} in the output of the @code{--list-components} command.  You
575 have to provide the options that shall be changed in the following
576 format on standard input:
577
578 @code{@var{name}:@var{flags}:@var{new-value}}
579
580 @table @var
581 @item name
582 This is the name of the option to change.  @var{name} must be the
583 string in the field @var{name} in the output of the
584 @code{--list-options} command.
585
586 @item flags
587 The flags field contains an @emph{unsigned number}.  Its value is the
588 OR-wise combination of the following flag values:
589
590 @table @code
591 @item default (16)
592 If this flag is set, the option is deleted and the default value is
593 used instead (if applicable).
594 @end table
595
596 @item new-value
597 The new value for the option.  This field is only defined if the
598 @code{default} flag is not set.  The format is that of an @emph{option
599 argument}.  If it is empty (or the field is omitted), the default
600 argument is used (only allowed if the argument is optional for this
601 option).  Otherwise, the option will be set to the specified value.
602 @end table
603
604 Examples:
605
606 To set the force option, which is of basic type @code{none (0)}:
607
608 @example
609 $ echo 'force:0:1' | gpgconf --change-options dirmngr
610 @end example
611
612 To delete the force option:
613
614 @example
615 $ echo 'force:16:' | gpgconf --change-options dirmngr
616 @end example
617
618 The @code{--runtime} option can influence when the changes take
619 effect.
620
621 @manpause
622 @c
623 @c    GPGSM-GENCERT.SH
624 @c
625 @node gpgsm-gencert.sh
626 @section Generate an X.509 certificate request
627
628 This is a simple tool to interactivly generate a certificate request
629 which will be printed to stdout.
630
631 @noindent
632 @command{gpgsm-gencert.sh} is invoked as:
633
634 @samp{gpgsm-cencert.sh}
635
636
637
638 @c
639 @c   GPG-PRESET-PASSPHRASE
640 @c
641 @node gpg-preset-passphrase
642 @section Put a passphrase into the cache.
643
644 The @command{gpg-preset-passphrase} is a utility to seed the internal
645 cache of a running @command{gpg-agent} with passphrases.  It is mainly
646 useful for unattended machines, where the usual @command{pinentry} tool
647 may not be used and the passphrases for the to be used keys are given at
648 machine startup.
649
650 Passphrases set with this utility don't expire unless the
651 @option{--forget} option is used to explicitly clear them from the cache
652 --- or @command{gpg-agent} is either restarted or reloaded (by sending a
653 SIGHUP to it).  It is necessary to allow this passphrase presetting by
654 starting @command{gpg-agent} with the
655 @option{--allow-preset-passphrase}.
656
657 @menu
658 * Invoking gpg-preset-passphrase::   List of all commands and options.
659 @end menu
660
661
662 @node Invoking gpg-preset-passphrase
663 @subsection List of all commands and options.
664
665 @noindent
666 @command{gpg-preset-passphrase} is invoked this way:
667
668 @example
669 gpg-preset-passphrase [options] [command] @var{keygrip}
670 @end example
671
672 @var{keygrip} is a 40 character string of hexadecimal characters
673 identifying the key for which the passphrase should be set or cleared.
674 This keygrip is listed along with the key when running the command:
675 @code{gpgsm --dump-secret-keys}. One of the following command options
676 must be given:
677
678 @table @gnupgtabopt
679 @item --preset
680 Preset a passphrase. This is what you usually will
681 use. @command{gpg-preset-passphrase} will then read the passphrase from
682 @code{stdin}.
683
684 @item --forget
685 Flush the passphrase for the given keygrip from the cache.
686
687 @end table
688
689 @noindent
690 The following additional options may be used:
691
692 @table @gnupgtabopt
693 @item -v
694 @itemx --verbose
695 @opindex verbose
696 Output additional information while running.  
697
698 @item -P @var{string}
699 @itemx --passphrase @var{string}
700 @opindex passphrase
701 Instead of reading the passphrase from @code{stdin}, use the supplied
702 @var{string} as passphrase.  Note that this makes the passphrase visible
703 for other users.
704 @end table
705
706
707
708
709
710 @c
711 @c   GPG-CONNECT-AGENT
712 @c
713 @node gpg-connect-agent
714 @section Communicate with a runnig agent.
715
716 The @command{gpg-connect-agent} is a utility to communicate with a
717 running @command{gpg-agent}.  It is useful to check out the commands
718 gpg-agent provides using the Assuan interface.  It might also be useful
719 for scripting simple applications.  Inputis expected at stdin and out
720 put gets printed to stdout.
721
722 It is very similar to running @command{gpg-agent} in server mode; but
723 here we connect to a running instance.
724
725 @menu
726 * Invoking gpg-connect-agent::   List of all commands and options.
727 @end menu
728
729
730 @node Invoking gpg-connect-agent
731 @subsection List of all commands and options.
732
733 @noindent
734 @command{gpg-connect-agent} is invoked this way:
735
736 @example
737 gpg-connect-agent [options]
738 @end example
739
740 @noindent
741 The following options may be used:
742
743 @table @gnupgtabopt
744 @item -v
745 @itemx --verbose
746 @opindex verbose
747 Output additional information while running.  
748
749 @item -q
750 @item --quiet
751 @opindex q
752 @opindex quiet
753 Try to be as quiet as possible.
754
755 @item --homedir @var{dir}
756 @opindex homedir
757 Set the name of the home directory to @var{dir}. If his option is not
758 used, the home directory defaults to @file{~/.gnupg}.  It is only
759 recognized when given on the command line.  It also overrides any home
760 directory stated through the environment variable @env{GNUPGHOME} or
761 (on W32 systems) by means on the Registry entry
762 @var{HKCU\Software\GNU\GnuPG:HomeDir}.
763
764
765 @item -S
766 @itemx --raw-socket @var{name}
767 @opindex S        
768 @opindex raw-socket
769 Connect to socket @var{name} assuming this is an Assuan style server.
770 Do not run any special initializations or environment checks.  This may
771 be used to directly connect to any Assuan style socket server.
772
773
774 @end table
775
776 @c
777 @c   SYMCRYPTRUN
778 @c
779 @node symcryptrun
780 @section Call a simple symmetric encryption tool.
781
782 Sometimes simple encryption tools are already in use for a long time and
783 there might be a desire to integrate them into the GnuPG framework.  The
784 protocols and encryption methods might be non-standard or not even
785 properly documented, so that a full-fledged encryption tool with an
786 interface like gpg is not doable.  @command{symcryptrun} provides a
787 solution: It operates by calling the external encryption/decryption
788 module and provides a passphrase for a key using the standard
789 @command{pinentry} based mechanism through @command{gpg-agent}.
790
791 Note, that @command{symcryptrun} is only available if GnuPG has been
792 configured with @samp{--enable-symcryptrun} at build time.
793
794 @menu
795 * Invoking symcryptrun::   List of all commands and options.
796 @end menu
797
798
799 @node Invoking symcryptrun
800 @subsection List of all commands and options.
801
802 @noindent
803 @command{symcryptrun} is invoked this way:
804
805 @example
806 symcryptrun --class CLASS --program PROGRAM --keyfile KEYFILE 
807    [--decrypt | --encrypt] [inputfile]
808 @end example
809
810 For encryption, the plain text must be provided on STDIN or as the
811 argument @var{inputfile}, and the ciphertext will be output to STDOUT.
812 For decryption vice versa.
813
814 @var{CLASS} describes the calling conventions of the external tool.
815 Currently it must be given as @samp{confucius}.  @var{PROGRAM} is the
816 the full filename of that external tool.
817  
818 For the class @samp{confucius} the option @option{--keyfile} is
819 required; @var{keyfile} is the name of a file containing the secret key,
820 which may be protected by a passphrase.  For detailed calling
821 conventions, see the source code.
822  
823 @noindent
824 Note, that @command{gpg-agent} must be running before starting
825 @command{symcryptrun}.
826
827 @noindent
828 The following additional options may be used:
829
830 @table @gnupgtabopt
831 @item -v
832 @itemx --verbose
833 @opindex verbose
834 Output additional information while running.  
835
836 @item -q
837 @item --quiet
838 @opindex q
839 @opindex quiet
840 Try to be as quiet as possible.
841
842 @item --homedir @var{dir}
843 @opindex homedir
844 Set the name of the home directory to @var{dir}. If his option is not
845 used, the home directory defaults to @file{~/.gnupg}.  It is only
846 recognized when given on the command line.  It also overrides any home
847 directory stated through the environment variable @env{GNUPGHOME} or
848 (on W32 systems) by means on the Registry entry
849 @var{HKCU\Software\GNU\GnuPG:HomeDir}.
850
851 @item --log-file @var{file}
852 @opindex log-file
853 Append all logging output to @var{file}.  Default is to write logging
854 informaton to STDERR.
855
856 @end table
857
858 @noindent
859 The possible exit status codes of @command{symcryptrun} are:
860
861 @table @code
862 @item 0 
863         Success.
864 @item 1 
865         Some error occured.
866 @item 2 
867         No valid passphrase was provided.
868 @item 3 
869         The operation was canceled by the user.
870
871 @end table
872