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