Revamped the W32 gettext implementation.
[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 @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 * gpgv::                  Verify OpenPGP signatures.
13 * addgnupghome::          Create .gnupg home directories.
14 * gpgconf::               Modify .gnupg home directories.
15 * applygnupgdefaults::    Run gpgconf for all users.
16 * gpgsm-gencert.sh::      Generate an X.509 certificate request.
17 * gpg-preset-passphrase:: Put a passphrase into the cache.
18 * gpg-connect-agent::     Communicate with a running agent.
19 * gpgparsemail::          Parse a mail message into an annotated format
20 * symcryptrun::           Call a simple symmetric encryption tool.
21 * gpg-zip::               Encrypt or sign files into an archive.
22 @end menu
23
24 @c
25 @c  WATCHGNUPG
26 @c
27 @manpage watchgnupg.1
28 @node watchgnupg
29 @section Read logs from a socket
30 @ifset manverb
31 .B watchgnupg
32 \- Read and print logs from a socket
33 @end ifset
34
35 @mansect synopsis
36 @ifset manverb
37 .B  watchgnupg
38 .RB [ \-\-force ]
39 .RB [ \-\-verbose ]
40 .I socketname
41 @end ifset
42
43 @mansect description
44 Most of the main utilities are able to write there log files to a
45 Unix Domain socket if configured that way.  @command{watchgnupg} is a simple
46 listener for such a socket.  It ameliorates the output with a time
47 stamp and makes sure that long lines are not interspersed with log
48 output from other utilities.
49
50 @noindent
51 @command{watchgnupg} is commonly invoked as
52
53 @example
54 watchgnupg --force ~/.gnupg/S.log
55 @end example
56 @manpause
57
58 @noindent
59 This starts it on the current terminal for listening on the socket
60 @file{~/.gnupg/S.log}.  
61
62 @mansect options
63 @noindent
64 @command{watchgnupg} understands these options:
65
66 @table @gnupgtabopt
67
68 @item --force 
69 @opindex force
70 Delete an already existing socket file.
71
72 @item --verbose
73 @opindex verbose
74 Enable extra informational output.
75
76 @item --version
77 @opindex version
78 Print version of the program and exit.
79
80 @item --help
81 @opindex help
82 Display a brief help page and exit.
83
84 @end table
85
86 @mansect see also
87 @ifset isman
88 @command{gpg}(1), 
89 @command{gpgsm}(1), 
90 @command{gpg-agent}(1), 
91 @command{scdaemon}(1)
92 @end ifset
93 @include see-also-note.texi
94
95
96 @c
97 @c  GPGV
98 @c
99 @include gpgv.texi
100
101
102 @c
103 @c    ADDGNUPGHOME
104 @c
105 @manpage addgnupghome.8
106 @node addgnupghome
107 @section Create .gnupg home directories.
108 @ifset manverb
109 .B addgnupghome 
110 \- Create .gnupg home directories
111 @end ifset
112
113 @mansect synopsis
114 @ifset manverb
115 .B  addgnupghome
116 .I account_1
117 .IR account_2 ... account_n
118 @end ifset
119
120 @mansect description
121 If GnuPG is installed on a system with existing user accounts, it is
122 sometimes required to populate the GnuPG home directory with existing
123 files.  Especially a @file{trustlist.txt} and a keybox with some
124 initial certificates are often desired.  This scripts help to do this
125 by copying all files from @file{/etc/skel/.gnupg} to the home
126 directories of the accounts given on the command line.  It takes care
127 not to overwrite existing GnuPG home directories.
128
129 @noindent
130 @command{addgnupghome} is invoked by root as:
131
132 @example
133 addgnupghome account1 account2 ... accountn
134 @end example
135
136
137 @c
138 @c   GPGCONF
139 @c
140 @manpage gpgconf.1
141 @node gpgconf
142 @section Modify .gnupg home directories.
143 @ifset manverb
144 .B gpgconf
145 \- Modify .gnupg home directories
146 @end ifset
147
148 @mansect synopsis
149 @ifset manverb
150 .B gpgconf
151 .RI [ options ]
152 .B \-\-list-components
153 .br
154 .B gpgconf
155 .RI [ options ]
156 .B \-\-list-options 
157 .I component
158 .br
159 .B gpgconf
160 .RI [ options ]
161 .B \-\-change-options
162 .I component
163 @end ifset
164
165
166 @mansect description
167 The @command{gpgconf} is a utility to automatically and reasonable
168 safely query and modify configuration files in the @file{.gnupg} home
169 directory.  It is designed not to be invoked manually by the user, but
170 automatically by graphical user interfaces (GUI).@footnote{Please note
171 that currently no locking is done, so concurrent access should be
172 avoided.  There are some precautions to avoid corruption with
173 concurrent usage, but results may be inconsistent and some changes may
174 get lost.  The stateless design makes it difficult to provide more
175 guarantees.}
176
177 @command{gpgconf} provides access to the configuration of one or more
178 components of the GnuPG system.  These components correspond more or
179 less to the programs that exist in the GnuPG framework, like GnuPG,
180 GPGSM, DirMngr, etc.  But this is not a strict one-to-one
181 relationship.  Not all configuration options are available through
182 @command{gpgconf}.  @command{gpgconf} provides a generic and abstract
183 method to access the most important configuration options that can
184 feasibly be controlled via such a mechanism.
185
186 @command{gpgconf} can be used to gather and change the options
187 available in each component, and can also provide their default
188 values.  @command{gpgconf} will give detailed type information that
189 can be used to restrict the user's input without making an attempt to
190 commit the changes.
191
192 @command{gpgconf} provides the backend of a configuration editor.  The
193 configuration editor would usually be a graphical user interface
194 program, that allows to display the current options, their default
195 values, and allows the user to make changes to the options.  These
196 changes can then be made active with @command{gpgconf} again.  Such a
197 program that uses @command{gpgconf} in this way will be called GUI
198 throughout this section.
199
200 @menu
201 * Invoking gpgconf::       List of all commands and options.
202 * Format conventions::     Formatting conventions relevant for all commands.
203 * Listing components::     List all gpgconf components.
204 * Checking programs::      Check all programs know to gpgconf.
205 * Listing options::        List all options of a component.
206 * Changing options::       Changing options of a component.
207 * Listing global options:: List all global options.
208 * Files used by gpgconf::  What files are used by gpgconf.
209 @end menu
210
211 @manpause
212 @node Invoking gpgconf
213 @subsection Invoking gpgconf
214
215 @mansect commands
216 One of the following commands must be given:
217
218 @table @gnupgtabopt
219
220 @item --list-components
221 List all components.  This is the default command used if none is
222 specified.
223
224 @item --check-programs
225 List all available backend programs and test whether they are runnable.
226
227 @item --list-options @var{component}
228 List all options of the component @var{component}.
229
230 @item --change-options @var{component}
231 Change the options of the component @var{component}.
232
233 @item --check-options @var{component}
234 Check the options for the component @var{component}.
235
236 @item --apply-defaults
237 Update all configuration files with values taken from the global
238 configuration file (usually @file{/etc/gnupg/gpgconf.conf}).
239
240 @item --list-dirs
241 Lists the directories used by @command{gpgconf}.  One directory is
242 listed per line, and each line consists of a colon-separated list
243 where the first field names the directory type (for example
244 @code{sysconfdir}) and the second field contains the percent-escaped
245 directory.
246
247 @item --list-config [@var{filename}]
248 List the global configuration file in a colon separated format.  If
249 @var{filename} is given, check that file instead.
250
251 @item --check-config [@var{filename}]
252 Run a syntax check on the global configuration file.  If @var{filename}
253 is given, check that file instead.
254
255 @end table
256
257
258 @mansect options
259
260 The following options may be used:
261
262 @table @gnupgtabopt
263 @c FIXME: Not yet supported.
264 @c @item -o @var{file}
265 @c @itemx --output @var{file}
266 @c Use @var{file} as output file.
267
268 @item -v
269 @itemx --verbose
270 Outputs additional information while running.  Specifically, this
271 extends numerical field values by human-readable descriptions.
272
273 @item -n
274 @itemx --dry-run
275 Do not actually change anything.  This is currently only implemented
276 for @code{--change-options} and can be used for testing purposes.
277
278 @item -r
279 @itemx --runtime
280 Only used together with @code{--change-options}.  If one of the
281 modified options can be changed in a running daemon process, signal
282 the running daemon to ask it to reparse its configuration file after
283 changing.
284
285 This means that the changes will take effect at run-time, as far as
286 this is possible.  Otherwise, they will take effect at the next start
287 of the respective backend programs.
288 @manpause
289 @end table
290
291
292 @node Format conventions
293 @subsection Format conventions
294
295 Some lines in the output of @command{gpgconf} contain a list of
296 colon-separated fields.  The following conventions apply:
297
298 @itemize @bullet
299 @item
300 The GUI program is required to strip off trailing newline and/or
301 carriage return characters from the output.
302
303 @item
304 @command{gpgconf} will never leave out fields.  If a certain version
305 provides a certain field, this field will always be present in all
306 @command{gpgconf} versions from that time on.
307
308 @item
309 Future versions of @command{gpgconf} might append fields to the list.
310 New fields will always be separated from the previously last field by
311 a colon separator.  The GUI should be prepared to parse the last field
312 it knows about up until a colon or end of line.
313
314 @item
315 Not all fields are defined under all conditions.  You are required to
316 ignore the content of undefined fields.
317 @end itemize
318
319 There are several standard types for the content of a field:
320
321 @table @asis
322 @item verbatim
323 Some fields contain strings that are not escaped in any way.  Such
324 fields are described to be used @emph{verbatim}.  These fields will
325 never contain a colon character (for obvious reasons).  No de-escaping
326 or other formatting is required to use the field content.  This is for
327 easy parsing of the output, when it is known that the content can
328 never contain any special characters.
329
330 @item percent-escaped
331 Some fields contain strings that are described to be
332 @emph{percent-escaped}.  Such strings need to be de-escaped before
333 their content can be presented to the user.  A percent-escaped string
334 is de-escaped by replacing all occurences of @code{%XY} by the byte
335 that has the hexadecimal value @code{XY}.  @code{X} and @code{Y} are
336 from the set @code{0-9a-f}.
337
338 @item localised
339 Some fields contain strings that are described to be @emph{localised}.
340 Such strings are translated to the active language and formatted in
341 the active character set.
342
343 @item @w{unsigned number}
344 Some fields contain an @emph{unsigned number}.  This number will
345 always fit into a 32-bit unsigned integer variable.  The number may be
346 followed by a space, followed by a human readable description of that
347 value (if the verbose option is used).  You should ignore everything
348 in the field that follows the number.
349
350 @item @w{signed number}
351 Some fields contain a @emph{signed number}.  This number will always
352 fit into a 32-bit signed integer variable.  The number may be followed
353 by a space, followed by a human readable description of that value (if
354 the verbose option is used).  You should ignore everything in the
355 field that follows the number.
356
357 @item @w{boolean value}
358 Some fields contain a @emph{boolean value}.  This is a number with
359 either the value 0 or 1.  The number may be followed by a space,
360 followed by a human readable description of that value (if the verbose
361 option is used).  You should ignore everything in the field that follows
362 the number; checking just the first character is sufficient in this
363 case.
364
365 @item option
366 Some fields contain an @emph{option} argument.  The format of an
367 option argument depends on the type of the option and on some flags:
368
369 @table @asis
370 @item no argument
371 The simplest case is that the option does not take an argument at all
372 (@var{type} @code{0}).  Then the option argument is an unsigned number
373 that specifies how often the option occurs.  If the @code{list} flag
374 is not set, then the only valid number is @code{1}.  Options that do
375 not take an argument never have the @code{default} or @code{optional
376 arg} flag set.
377
378 @item number
379 If the option takes a number argument (@var{alt-type} is @code{2} or
380 @code{3}), and it can only occur once (@code{list} flag is not set),
381 then the option argument is either empty (only allowed if the argument
382 is optional), or it is a number.  A number is a string that begins
383 with an optional minus character, followed by one or more digits.  The
384 number must fit into an integer variable (unsigned or signed,
385 depending on @var{alt-type}).
386
387 @item number list
388 If the option takes a number argument and it can occur more than once,
389 then the option argument is either empty, or it is a comma-separated
390 list of numbers as described above.
391
392 @item string
393 If the option takes a string argument (@var{alt-type} is 1), and it
394 can only occur once (@code{list} flag is not set) then the option
395 argument is either empty (only allowed if the argument is optional),
396 or it starts with a double quote character (@code{"}) followed by a
397 percent-escaped string that is the argument value.  Note that there is
398 only a leading double quote character, no trailing one.  The double
399 quote character is only needed to be able to differentiate between no
400 value and the empty string as value.
401
402 @item string list
403 If the option takes a number argument and it can occur more than once,
404 then the option argument is either empty, or it is a comma-separated
405 list of string arguments as described above.
406 @end table
407 @end table
408
409 The active language and character set are currently determined from
410 the locale environment of the @command{gpgconf} program.
411
412 @c FIXME: Document the active language and active character set.  Allow
413 @c to change it via the command line?
414
415
416 @mansect usage
417 @node Listing components
418 @subsection Listing components
419
420 The command @code{--list-components} will list all components that can
421 be configured with @command{gpgconf}.  Usually, one component will
422 correspond to one GnuPG-related program and contain the options of
423 that programs configuration file that can be modified using
424 @command{gpgconf}.  However, this is not necessarily the case.  A
425 component might also be a group of selected options from several
426 programs, or contain entirely virtual options that have a special
427 effect rather than changing exactly one option in one configuration
428 file.
429
430 A component is a set of configuration options that semantically belong
431 together.  Furthermore, several changes to a component can be made in
432 an atomic way with a single operation.  The GUI could for example
433 provide a menu with one entry for each component, or a window with one
434 tabulator sheet per component.
435
436 The command argument @code{--list-components} lists all available
437 components, one per line.  The format of each line is:
438
439 @code{@var{name}:@var{description}:@var{pgmname}:}
440
441 @table @var
442 @item name
443 This field contains a name tag of the component.  The name tag is used
444 to specify the component in all communication with @command{gpgconf}.
445 The name tag is to be used @emph{verbatim}.  It is thus not in any
446 escaped format.
447
448 @item description
449 The @emph{string} in this field contains a human-readable description
450 of the component.  It can be displayed to the user of the GUI for
451 informational purposes.  It is @emph{percent-escaped} and
452 @emph{localized}.
453
454 @item pgmname
455 The @emph{string} in this field contains the absolute name of the
456 program's file.  It can be used to unambiguously invoke that program.
457 It is @emph{percent-escaped}.
458 @end table
459
460 Example:
461 @example
462 $ gpgconf --list-components
463 gpg:GPG for OpenPGP:/usr/local/bin/gpg2:
464 gpg-agent:GPG Agent:/usr/local/bin/gpg-agent:
465 scdaemon:Smartcard Daemon:/usr/local/bin/scdaemon:
466 gpgsm:GPG for S/MIME:/usr/local/bin/gpgsm:
467 dirmngr:Directory Manager:/usr/local/bin/dirmngr:
468 @end example
469
470
471
472 @node Checking programs
473 @subsection Checking programs
474
475 The command @code{--check-programs} is similar to
476 @code{--list-components} but works on backend programs and not on
477 components.  It runs each program to test wether it is installed and
478 runnable.  This also includes a syntax check of all config file options
479 of the program.
480
481 The command argument @code{--check-programs} lists all available
482 programs, one per line.  The format of each line is:
483
484 @code{@var{name}:@var{description}:@var{pgmname}:@var{avail}:@var{okay}:@var{cfgfile}:@var{line}:@var{error}:}
485
486 @table @var
487 @item name
488 This field contains a name tag of the program which is identical to the
489 name of the component.  The name tag is to be used @emph{verbatim}.  It
490 is thus not in any escaped format.  This field may be empty to indicate
491 a continuation of error descriptions for the last name.  The description
492 and pgmname fields are then also empty.
493
494 @item description
495 The @emph{string} in this field contains a human-readable description
496 of the component.  It can be displayed to the user of the GUI for
497 informational purposes.  It is @emph{percent-escaped} and
498 @emph{localized}.
499
500 @item pgmname
501 The @emph{string} in this field contains the absolute name of the
502 program's file.  It can be used to unambiguously invoke that program.
503 It is @emph{percent-escaped}.
504
505 @item avail
506 The @emph{boolean value} in this field indicates whether the program is
507 installed and runnable.
508
509 @item okay
510 The @emph{boolean value} in this field indicates whether the program's
511 config file is syntactically okay.
512
513 @item cfgfile
514 If an error occured in the configuraion file (as indicated by a false
515 value in the field @code{okay}), this field has the name of the failing
516 configuration file.  It is @emph{percent-escaped}.
517
518 @item line
519 If an error occured in the configuration file, this field has the line
520 number of the failing statement in the configuration file.  
521 It is an @emph{unsigned number}.
522
523 @item error
524 If an error occured in the configuration file, this field has the error
525 text of the failing statement in the configuration file.  It is
526 @emph{percent-escaped} and @emph{localized}.
527
528 @end table
529
530 @noindent
531 In the following example the @command{dirmngr} is not runnable and the
532 configuration file of @command{scdaemon} is not okay.
533
534 @example
535 $ gpgconf --check-programs
536 gpg:GPG for OpenPGP:/usr/local/bin/gpg2:1:1:
537 gpg-agent:GPG Agent:/usr/local/bin/gpg-agent:1:1:
538 scdaemon:Smartcard Daemon:/usr/local/bin/scdaemon:1:0:
539 gpgsm:GPG for S/MIME:/usr/local/bin/gpgsm:1:1:
540 dirmngr:Directory Manager:/usr/local/bin/dirmngr:0:0:
541 @end example
542
543 @noindent
544 The command @w{@code{--check-options @var{component}}} will verify the
545 configuration file in the same manner as @code{--check-programs}, but
546 only for the component @var{component}.
547
548
549 @node Listing options
550 @subsection Listing options
551
552 Every component contains one or more options.  Options may be gathered
553 into option groups to allow the GUI to give visual hints to the user
554 about which options are related.
555
556 The command argument @code{@w{--list-options @var{component}}} lists
557 all options (and the groups they belong to) in the component
558 @var{component}, one per line.  @var{component} must be the string in
559 the field @var{name} in the output of the @code{--list-components}
560 command.
561
562 There is one line for each option and each group.  First come all
563 options that are not in any group.  Then comes a line describing a
564 group.  Then come all options that belong into each group.  Then comes
565 the next group and so on.  There does not need to be any group (and in
566 this case the output will stop after the last non-grouped option).
567
568 The format of each line is:
569
570 @code{@var{name}:@var{flags}:@var{level}:@var{description}:@var{type}:@var{alt-type}:@var{argname}:@var{default}:@var{argdef}:@var{value}}
571
572 @table @var
573 @item name
574 This field contains a name tag for the group or option.  The name tag
575 is used to specify the group or option in all communication with
576 @command{gpgconf}.  The name tag is to be used @emph{verbatim}.  It is
577 thus not in any escaped format.
578
579 @item flags
580 The flags field contains an @emph{unsigned number}.  Its value is the
581 OR-wise combination of the following flag values:
582
583 @table @code
584 @item group (1)
585 If this flag is set, this is a line describing a group and not an
586 option.
587 @end table
588
589 The following flag values are only defined for options (that is, if
590 the @code{group} flag is not used).
591
592 @table @code
593 @item optional arg (2)
594 If this flag is set, the argument is optional.  This is never set for
595 @var{type} @code{0} (none) options.
596
597 @item list (4)
598 If this flag is set, the option can be given multiple times.
599
600 @item runtime (8)
601 If this flag is set, the option can be changed at runtime.
602
603 @item default (16)
604 If this flag is set, a default value is available.
605
606 @item default desc (32)
607 If this flag is set, a (runtime) default is available.  This and the
608 @code{default} flag are mutually exclusive.
609
610 @item no arg desc (64)
611 If this flag is set, and the @code{optional arg} flag is set, then the
612 option has a special meaning if no argument is given.
613
614 @item no change (128)
615 If this flag is set, gpgconf ignores requests to change the value.  GUI
616 frontends should grey out this option.  Note, that manual changes of the
617 configuration files are still possible.
618 @end table
619
620 @item level
621 This field is defined for options and for groups.  It contains an
622 @emph{unsigned number} that specifies the expert level under which
623 this group or option should be displayed.  The following expert levels
624 are defined for options (they have analogous meaning for groups):
625
626 @table @code
627 @item basic (0)
628 This option should always be offered to the user.
629
630 @item advanced (1)
631 This option may be offered to advanced users.
632
633 @item expert (2)
634 This option should only be offered to expert users.
635
636 @item invisible (3)
637 This option should normally never be displayed, not even to expert
638 users.
639
640 @item internal (4)
641 This option is for internal use only.  Ignore it.
642 @end table
643
644 The level of a group will always be the lowest level of all options it
645 contains.
646
647 @item description
648 This field is defined for options and groups.  The @emph{string} in
649 this field contains a human-readable description of the option or
650 group.  It can be displayed to the user of the GUI for informational
651 purposes.  It is @emph{percent-escaped} and @emph{localized}.
652
653 @item type
654 This field is only defined for options.  It contains an @emph{unsigned
655 number} that specifies the type of the option's argument, if any.  The
656 following types are defined:
657
658 Basic types:
659
660 @table @code
661 @item none (0)
662 No argument allowed.
663
664 @item string (1)
665 An @emph{unformatted string}.
666
667 @item int32 (2)
668 A @emph{signed number}.
669
670 @item uint32 (3)
671 An @emph{unsigned number}.
672 @end table
673
674 Complex types:
675
676 @table @code
677 @item pathname (32)
678 A @emph{string} that describes the pathname of a file.  The file does
679 not necessarily need to exist.
680
681 @item ldap server (33)
682 A @emph{string} that describes an LDAP server in the format:
683
684 @code{@var{hostname}:@var{port}:@var{username}:@var{password}:@var{base_dn}}
685
686 @item key fingerprint (34)
687 A @emph{string} with a 40 digit fingerprint specifying a certificate.
688
689 @item pub key (35)
690 A @emph{string} that describes a certificate by user ID, key ID or
691 fingerprint.
692
693 @item sec key (36)
694 A @emph{string} that describes a certificate with a key by user ID,
695 key ID or fingerprint.
696
697 @item alias list (37)
698 A @emph{string} that describes an alias list, like the one used with
699 gpg's group option.  The list consists of a key, an equal sign and space
700 separated values.
701 @end table
702
703 More types will be added in the future.  Please see the @var{alt-type}
704 field for information on how to cope with unknown types.
705
706 @item alt-type
707 This field is identical to @var{type}, except that only the types
708 @code{0} to @code{31} are allowed.  The GUI is expected to present the
709 user the option in the format specified by @var{type}.  But if the
710 argument type @var{type} is not supported by the GUI, it can still
711 display the option in the more generic basic type @var{alt-type}.  The
712 GUI must support all the defined basic types to be able to display all
713 options.  More basic types may be added in future versions.  If the
714 GUI encounters a basic type it doesn't support, it should report an
715 error and abort the operation.
716
717 @item argname
718 This field is only defined for options with an argument type
719 @var{type} that is not @code{0}.  In this case it may contain a
720 @emph{percent-escaped} and @emph{localised string} that gives a short
721 name for the argument.  The field may also be empty, though, in which
722 case a short name is not known.
723
724 @item default
725 This field is defined only for options for which the @code{default} or
726 @code{default desc} flag is set.  If the @code{default} flag is set,
727 its format is that of an @emph{option argument} (@xref{Format
728 conventions}, for details).  If the default value is empty, then no
729 default is known.  Otherwise, the value specifies the default value
730 for this option.  If the @code{default desc} flag is set, the field is
731 either empty or contains a description of the effect if the option is
732 not given.
733
734 @item argdef
735 This field is defined only for options for which the @code{optional
736 arg} flag is set.  If the @code{no arg desc} flag is not set, its
737 format is that of an @emph{option argument} (@xref{Format
738 conventions}, for details).  If the default value is empty, then no
739 default is known.  Otherwise, the value specifies the default argument
740 for this option.  If the @code{no arg desc} flag is set, the field is
741 either empty or contains a description of the effect of this option if
742 no argument is given.
743
744 @item value
745 This field is defined only for options.  Its format is that of an
746 @emph{option argument}.  If it is empty, then the option is not
747 explicitely set in the current configuration, and the default applies
748 (if any).  Otherwise, it contains the current value of the option.
749 Note that this field is also meaningful if the option itself does not
750 take a real argument (in this case, it contains the number of times
751 the option appears).
752 @end table
753
754
755 @node Changing options
756 @subsection Changing options
757
758 The command @w{@code{--change-options @var{component}}} will attempt
759 to change the options of the component @var{component} to the
760 specified values.  @var{component} must be the string in the field
761 @var{name} in the output of the @code{--list-components} command.  You
762 have to provide the options that shall be changed in the following
763 format on standard input:
764
765 @code{@var{name}:@var{flags}:@var{new-value}}
766
767 @table @var
768 @item name
769 This is the name of the option to change.  @var{name} must be the
770 string in the field @var{name} in the output of the
771 @code{--list-options} command.
772
773 @item flags
774 The flags field contains an @emph{unsigned number}.  Its value is the
775 OR-wise combination of the following flag values:
776
777 @table @code
778 @item default (16)
779 If this flag is set, the option is deleted and the default value is
780 used instead (if applicable).
781 @end table
782
783 @item new-value
784 The new value for the option.  This field is only defined if the
785 @code{default} flag is not set.  The format is that of an @emph{option
786 argument}.  If it is empty (or the field is omitted), the default
787 argument is used (only allowed if the argument is optional for this
788 option).  Otherwise, the option will be set to the specified value.
789 @end table
790
791 @noindent
792 The output of the command is the same as that of
793 @code{--check-options} for the modified configuration file.
794
795 Examples:
796
797 To set the force option, which is of basic type @code{none (0)}:
798
799 @example
800 $ echo 'force:0:1' | gpgconf --change-options dirmngr
801 @end example
802
803 To delete the force option:
804
805 @example
806 $ echo 'force:16:' | gpgconf --change-options dirmngr
807 @end example
808
809 The @code{--runtime} option can influence when the changes take
810 effect.
811
812
813 @node Listing global options
814 @subsection Listing global options
815
816 Sometimes it is useful for applications to look at the global options
817 file @file{gpgconf.conf}. 
818 The colon separated listing format is record oriented and uses the first
819 field to identify the record type:
820
821 @table @code
822 @item k
823 This describes a key record to start the definition of a new ruleset for
824 a user/group.  The format of a key record is:
825
826   @code{k:@var{user}:@var{group}:}
827
828 @table @var
829 @item user
830 This is the user field of the key.  It is percent escaped.  See the
831 definition of the gpgconf.conf format for details.
832
833 @item group
834 This is the group field of the key.  It is percent escaped.
835 @end table
836
837 @item r
838 This describes a rule record. All rule records up to the next key record
839 make up a rule set for that key.  The format of a rule record is:
840
841   @code{r:::@var{component}:@var{option}:@var{flags}:@var{value}:}
842
843 @table @var
844 @item component
845 This is the component part of a rule.  It is a plain string.
846
847 @item option
848 This is the option part of a rule.  It is a plain string.
849
850 @item flag
851 This is the flags part of a rule.  There may be only one flag per rule
852 but by using the same component and option, several flags may be
853 assigned to an option.  It is a plain string.
854
855 @item value
856 This is the optional value for the option.  It is a percent escaped
857 string with a single quotation mark to indicate a string.  The quotation
858 mark is only required to distinguish between no value specified and an
859 empty string.
860 @end table
861
862 @end table
863
864 @noindent
865 Unknown record typs should be ignored.  Note that there is intentionally
866 no feature to change the global option file through @command{gpgconf}.
867
868
869
870 @mansect files
871 @node Files used by gpgconf
872 @subsection Files used by gpgconf
873
874 @table @file
875
876 @item /etc/gnupg/gpgconf.conf
877 @cindex gpgconf.conf
878   If this file exists, it is processed as a global configuration file.
879   A commented example can be found in the @file{examples} directory of
880   the distribution.
881 @end table
882
883
884 @mansect see also
885 @ifset isman
886 @command{gpg}(1), 
887 @command{gpgsm}(1), 
888 @command{gpg-agent}(1), 
889 @command{scdaemon}(1),
890 @command{dirmngr}(1)
891 @end ifset
892 @include see-also-note.texi
893
894
895
896 @c
897 @c    APPLYGNUPGDEFAULTS
898 @c
899 @manpage applygnupgdefaults.8
900 @node applygnupgdefaults
901 @section Run gpgconf for all users.
902 @ifset manverb
903 .B applygnupgdefaults
904 \- Run gpgconf --apply-defaults for all users.
905 @end ifset
906
907 @mansect synopsis
908 @ifset manverb
909 .B  applygnupgdefaults
910 @end ifset
911
912 @mansect description
913 This script is a wrapper around @command{gpgconf} to run it with the
914 command @code{--apply-defaults} for all real users with an existing
915 GnuPG home directory.  Admins might want to use this script to update he
916 GnuPG configuration files for all users after
917 @file{/etc/gnupg/gpgconf.conf} has been changed.  This allows to enforce
918 certain policies for all users.  Note, that this is not a bulletproof of
919 forcing a user to use certain options.  A user may always directly edit
920 the configuration files and bypass gpgconf.
921
922 @noindent
923 @command{applygnupgdefaults} is invoked by root as:
924
925 @example
926 applygnupgdefaults
927 @end example
928
929
930 @c
931 @c    GPGSM-GENCERT.SH
932 @c
933 @node gpgsm-gencert.sh
934 @section Generate an X.509 certificate request
935 @manpage gpgsm-gencert.sh.1
936 @ifset manverb
937 .B gpgsm-gencert.sh
938 \- Generate an X.509 certificate request
939 @end ifset 
940
941 @mansect synopsis
942 @ifset manverb
943 .B  gpgsm-gencert.sh
944 @end ifset
945
946 @mansect description
947 This is a simple tool to interactivly generate a certificate request
948 which will be printed to stdout.
949
950 @manpause
951 @noindent
952 @command{gpgsm-gencert.sh} is invoked as:
953
954 @samp{gpgsm-cencert.sh}
955
956 @mansect see also
957 @ifset isman
958 @command{gpgsm}(1), 
959 @command{gpg-agent}(1), 
960 @command{scdaemon}(1)
961 @end ifset
962 @include see-also-note.texi
963
964
965
966 @c
967 @c   GPG-PRESET-PASSPHRASE
968 @c
969 @node gpg-preset-passphrase
970 @section Put a passphrase into the cache.
971 @manpage gpg-preset-passphrase.1
972 @ifset manverb
973 .B gpg-preset-passphrase
974 \- Put a passphrase into gpg-agent's cache
975 @end ifset
976
977 @mansect synopsis
978 @ifset manverb
979 .B  gpg-preset-passphrase
980 .RI [ options ]
981 .RI [ command ]
982 .I keygrip
983 @end ifset
984
985 @mansect description
986 The @command{gpg-preset-passphrase} is a utility to seed the internal
987 cache of a running @command{gpg-agent} with passphrases.  It is mainly
988 useful for unattended machines, where the usual @command{pinentry} tool
989 may not be used and the passphrases for the to be used keys are given at
990 machine startup.
991
992 Passphrases set with this utility don't expire unless the
993 @option{--forget} option is used to explicitly clear them from the cache
994 --- or @command{gpg-agent} is either restarted or reloaded (by sending a
995 SIGHUP to it).  It is necessary to allow this passphrase presetting by
996 starting @command{gpg-agent} with the
997 @option{--allow-preset-passphrase}.
998
999 @menu
1000 * Invoking gpg-preset-passphrase::   List of all commands and options.
1001 @end menu
1002
1003 @manpause
1004 @node Invoking gpg-preset-passphrase
1005 @subsection List of all commands and options.
1006 @mancont
1007
1008 @noindent
1009 @command{gpg-preset-passphrase} is invoked this way:
1010
1011 @example
1012 gpg-preset-passphrase [options] [command] @var{keygrip}
1013 @end example
1014
1015 @var{keygrip} is a 40 character string of hexadecimal characters
1016 identifying the key for which the passphrase should be set or cleared.
1017 This keygrip is listed along with the key when running the command:
1018 @code{gpgsm --dump-secret-keys}. One of the following command options
1019 must be given:
1020
1021 @table @gnupgtabopt
1022 @item --preset
1023 @opindex preset
1024 Preset a passphrase. This is what you usually will
1025 use. @command{gpg-preset-passphrase} will then read the passphrase from
1026 @code{stdin}.
1027
1028 @item --forget
1029 @opindex forget
1030 Flush the passphrase for the given keygrip from the cache.
1031
1032 @end table
1033
1034 @noindent
1035 The following additional options may be used:
1036
1037 @table @gnupgtabopt
1038 @item -v
1039 @itemx --verbose
1040 @opindex verbose
1041 Output additional information while running.  
1042
1043 @item -P @var{string}
1044 @itemx --passphrase @var{string}
1045 @opindex passphrase
1046 Instead of reading the passphrase from @code{stdin}, use the supplied
1047 @var{string} as passphrase.  Note that this makes the passphrase visible
1048 for other users.
1049 @end table
1050
1051 @mansect see also
1052 @ifset isman
1053 @command{gpg}(1), 
1054 @command{gpgsm}(1), 
1055 @command{gpg-agent}(1), 
1056 @command{scdaemon}(1)
1057 @end ifset
1058 @include see-also-note.texi
1059
1060
1061
1062
1063 @c
1064 @c   GPG-CONNECT-AGENT
1065 @c
1066 @node gpg-connect-agent
1067 @section Communicate with a running agent.
1068 @manpage gpg-connect-agent.1
1069 @ifset manverb
1070 .B gpg-connect-agent
1071 \- Communicate with a running agent
1072 @end ifset
1073
1074 @mansect synopsis
1075 @ifset manverb
1076 .B  gpg-connect-agent
1077 .RI [ options ] [commands]
1078 @end ifset
1079
1080 @mansect description
1081 The @command{gpg-connect-agent} is a utility to communicate with a
1082 running @command{gpg-agent}.  It is useful to check out the commands
1083 gpg-agent provides using the Assuan interface.  It might also be useful
1084 for scripting simple applications.  Inputis expected at stdin and out
1085 put gets printed to stdout.
1086
1087 It is very similar to running @command{gpg-agent} in server mode; but
1088 here we connect to a running instance.
1089
1090 @menu
1091 * Invoking gpg-connect-agent::       List of all options.
1092 * Controlling gpg-connect-agent::    Control commands.
1093 @end menu
1094
1095 @manpause
1096 @node Invoking gpg-connect-agent
1097 @subsection List of all options.
1098
1099 @noindent
1100 @command{gpg-connect-agent} is invoked this way:
1101
1102 @example
1103 gpg-connect-agent [options] [commands]
1104 @end example
1105 @mancont
1106
1107 @noindent
1108 The following options may be used:
1109
1110 @table @gnupgtabopt
1111 @item -v
1112 @itemx --verbose
1113 @opindex verbose
1114 Output additional information while running.  
1115
1116 @item -q
1117 @item --quiet
1118 @opindex q
1119 @opindex quiet
1120 Try to be as quiet as possible.
1121
1122 @include opt-homedir.texi
1123
1124 @item -S
1125 @itemx --raw-socket @var{name}
1126 @opindex S        
1127 @opindex raw-socket
1128 Connect to socket @var{name} assuming this is an Assuan style server.
1129 Do not run any special initializations or environment checks.  This may
1130 be used to directly connect to any Assuan style socket server.
1131
1132 @item -E
1133 @itemx --exec
1134 @opindex exec
1135 Take the rest of the command line as a program and it's arguments and
1136 execute it as an assuan server. Here is how you would run @command{gpgsm}:
1137 @smallexample
1138  gpg-connect-agent --exec gpgsm --server
1139 @end smallexample
1140 Note that you may not use options on the command line in this case.
1141
1142 @item --no-ext-connect
1143 @opindex no-ext-connect
1144 When using @option{-S} or @option{--exec}, @command{gpg-connect-agent}
1145 connects to the assuan server in extended mode to allow descriptor
1146 passing.  This option makes it use the old mode.
1147
1148 @item --run @var{file}
1149 @opindex run 
1150 Run the commands from @var{file} at startup and then continue with the
1151 regular input method.  Note, that commands given on the command line are
1152 executed after this file.
1153
1154 @item -s
1155 @itemx --subst
1156 @opindex subst
1157 Run the command @code{/subst} at startup.
1158
1159 @item --hex
1160 @opindex hex
1161 Print data lines in a hex format and the ASCII representation of
1162 non-control characters.
1163
1164 @item --decode
1165 @opindex decode
1166 Decode data lines.  That is to remove percent escapes but make sure that
1167 a new line always starts with a D and a space.
1168
1169 @end table
1170
1171 @mansect control commands
1172 @node Controlling gpg-connect-agent
1173 @subsection Control commands.
1174
1175 While reading Assuan commands, gpg-agent also allows a few special
1176 commands to control its operation.  These control commands all start
1177 with a slash (@code{/}).
1178
1179 @table @code
1180
1181 @item /echo @var{args}
1182 Just print @var{args}.
1183
1184 @item /let @var{name} @var{value}
1185 Set the variable @var{name} to @var{value}.  Variables are only
1186 substituted on the input if the @command{/subst} has been used.
1187 Variables are referenced by prefixing the name with a dollr sign and
1188 optionally include the name in curly braces.  The rules for a valid name
1189 are identically to those of the standard bourne shell.  This is not yet
1190 enforced but may be in the future.  When used with curly braces no
1191 leading or trailing white space is allowed. 
1192
1193 If a variable is not found, it is searched in the environment and if
1194 found copied to the table of variables.
1195
1196 Variable functions are available: The name of the function must be
1197 followed by at least one space and the at least one argument.  The
1198 following functions are available:
1199
1200 @table @code
1201 @item get
1202 Return a value described by the argument.  Available arguments are:
1203
1204 @table @code    
1205 @item cwd
1206 The current working directory.
1207 @item homedir
1208 The gnupg homedir.
1209 @item sysconfdir
1210 GnuPG's system configuration directory.
1211 @item bindir
1212 GnuPG's binary directory.
1213 @item libdir
1214 GnuPG's library directory.
1215 @item libexecdir
1216 GnuPG's library directory for executable files.
1217 @item datadir
1218 GnuPG's data directory.
1219 @item serverpid
1220 The PID of the current server. Command @command{/serverpid} must
1221 have been given to return a useful value.
1222 @end table
1223
1224 @item unescape @var{args}
1225 Remove C-style escapes from @var{args}.  Note that @code{\0} and
1226 @code{\x00} terminate the returned string implicitly.  The string to be
1227 converted are the entire arguments right behind the delimiting space of
1228 the function name.
1229
1230 @item unpercent @var{args}
1231 @itemx unpercent+ @var{args}
1232 Remove percent style ecaping from @var{args}.  Note that @code{%00}
1233 terminates the string implicitly.  The string to be converted are the
1234 entire arguments right behind the delimiting space of the function
1235 name. @code{unpercent+} also maps plus signs to a spaces.
1236
1237 @item percent @var{args}
1238 @itemx percent+ @var{args}
1239 Escape the @var{args} using percent style ecaping.  Tabs, formfeeds,
1240 linefeeds, carriage returns and colons are escaped. @code{percent+} also
1241 maps spaces to plus signs.
1242
1243 @item errcode @var{arg}
1244 @itemx errsource @var{arg}
1245 @itemx errstring @var{arg}
1246 Assume @var{arg} is an integer and evaluate it using @code{strtol}.  Return
1247 the gpg-error error code, error source or a formatted string with the
1248 error code and error source.
1249
1250
1251 @item +
1252 @itemx -
1253 @itemx *
1254 @itemx /
1255 @itemx %
1256 Evaluate all arguments as long integers using @code{strtol} and apply
1257 this operator.  A division by zero yields an empty string.
1258
1259 @item !
1260 @itemx |
1261 @itemx &
1262 Evaluate all arguments as long integers using @code{strtol} and apply
1263 the logical oeprators NOT, OR or AND.  The NOT operator works on the
1264 last argument only.
1265
1266
1267 @end table
1268
1269
1270 @item /definq @var{name} @var{var}
1271 Use content of the variable @var{var} for inquiries with @var{name}.
1272 @var{name} may be an asterisk (@code{*}) to match any inquiry.
1273
1274
1275 @item /definqfile @var{name} @var{file}
1276 Use content of @var{file} for inquiries with @var{name}.
1277 @var{name} may be an asterisk (@code{*}) to match any inquiry.
1278
1279 @item /definqprog @var{name} @var{prog}
1280 Run @var{prog} for inquiries matching @var{name} and pass the
1281 entire line to it as command line arguments.
1282
1283 @item /datafile @var{name}
1284 Write all data lines from the server to the file @var{name}.  The file
1285 is opened for writing and created if it does not exists.  An existsing
1286 file is first truncated to 0.  The data written to the file fully
1287 decoded.  Using a singel dash for @var{name} writes to stdout.  The
1288 file is kept open until a new file is set using this command or this
1289 command is used without an argument.
1290
1291 @item /showdef
1292 Print all definitions
1293
1294 @item /cleardef
1295 Delete all definitions
1296
1297 @item /sendfd @var{file} @var{mode}
1298 Open @var{file} in @var{mode} (which needs to be a valid @code{fopen}
1299 mode string) and send the file descriptor to the server.  This is
1300 usually followed by a command like @code{INPUT FD} to set the
1301 input source for other commands.
1302
1303 @item /recvfd
1304 Not yet implemented.
1305
1306 @item /open @var{var} @var{file} [@var{mode}]
1307 Open @var{file} and assign the file descriptor to @var{var}.  Warning:
1308 This command is experimental and might change in future versions.
1309
1310 @item /close @var{fd}
1311 Close the file descriptor @var{fd}.  Warning: This command is
1312 experimental and might change in future versions.
1313
1314 @item /showopen
1315 Show a list of open files.
1316
1317 @item /serverpid
1318 Send the Assuan command @command{GETINFO pid} to the server and store
1319 the returned PID for internal purposes.
1320
1321 @item /sleep
1322 Sleep for a second.
1323
1324 @item /hex
1325 @itemx /nohex
1326 Same as the command line option @option{--hex}.
1327
1328 @item /decode
1329 @itemx /nodecode
1330 Same as the command line option @option{--decode}.
1331
1332 @item /subst
1333 @itemx /nosubst
1334 Enable and disable variable substitution.  It defaults to disabled
1335 unless the command line option @option{--subst} has been used.
1336 If /subst as been enabled once, leading whitespace is removed from
1337 input lines which makes scripts easier to read.
1338
1339 @item /while @var{condition}
1340 @itemx /end
1341 These commands provide a way for executing loops.  All lines between the
1342 @code{while} and the corresponding @code{end} are executed as long as
1343 the evaluation of @var{condition} yields a non-zero value.  The
1344 evaluation is done by passing @var{condition} to the @code{strtol}
1345 function.  Example:
1346
1347 @smallexample
1348   /subst
1349   /let i 3
1350   /while $i
1351     /echo loop couter is $i
1352     /let i $@{- $i 1@}
1353   /end
1354 @end smallexample
1355
1356
1357 @item /run @var{file}
1358 Run commands from @var{file}.
1359
1360 @item /bye
1361 Terminate the connection and the program
1362
1363 @item /help
1364 Print a list of available control commands.
1365
1366 @end table
1367
1368
1369 @ifset isman
1370 @mansect see also
1371 @command{gpg-agent}(1), 
1372 @command{scdaemon}(1)
1373 @include see-also-note.texi
1374 @end ifset
1375
1376
1377 @c
1378 @c   GPGPARSEMAIL
1379 @c
1380 @node gpgparsemail
1381 @section Parse a mail message into an annotated format
1382
1383 @manpage gpgparsemail.1
1384 @ifset manverb
1385 .B gpgparsemail
1386 \- Parse a mail message into an annotated format
1387 @end ifset
1388
1389 @mansect synopsis
1390 @ifset manverb
1391 .B  gpgparsemail
1392 .RI [ options ]
1393 .RI [ file ]
1394 @end ifset
1395
1396 @mansect description
1397 The @command{gpgparsemail} is a utility currently only useful for
1398 debugging.  Run it with @code{--help} for usage information.
1399
1400
1401
1402 @c
1403 @c   SYMCRYPTRUN
1404 @c
1405 @node symcryptrun
1406 @section Call a simple symmetric encryption tool.
1407 @manpage symcryptrun.1
1408 @ifset manverb
1409 .B symcryptrun
1410 \- Call a simple symmetric encryption tool
1411 @end ifset
1412
1413 @mansect synopsis
1414 @ifset manverb
1415 .B  symcryptrun
1416 .B \-\-class
1417 .I class
1418 .B \-\-program
1419 .I program
1420 .B \-\-keyfile
1421 .I keyfile
1422 .RB [ --decrypt | --encrypt ]
1423 .RI [ inputfile ]
1424 @end ifset
1425
1426 @mansect description
1427 Sometimes simple encryption tools are already in use for a long time and
1428 there might be a desire to integrate them into the GnuPG framework.  The
1429 protocols and encryption methods might be non-standard or not even
1430 properly documented, so that a full-fledged encryption tool with an
1431 interface like gpg is not doable.  @command{symcryptrun} provides a
1432 solution: It operates by calling the external encryption/decryption
1433 module and provides a passphrase for a key using the standard
1434 @command{pinentry} based mechanism through @command{gpg-agent}.
1435
1436 Note, that @command{symcryptrun} is only available if GnuPG has been
1437 configured with @samp{--enable-symcryptrun} at build time.
1438
1439 @menu
1440 * Invoking symcryptrun::   List of all commands and options.
1441 @end menu
1442
1443 @manpause
1444 @node Invoking symcryptrun
1445 @subsection List of all commands and options.
1446
1447 @noindent
1448 @command{symcryptrun} is invoked this way:
1449
1450 @example
1451 symcryptrun --class CLASS --program PROGRAM --keyfile KEYFILE 
1452    [--decrypt | --encrypt] [inputfile]
1453 @end example
1454 @mancont
1455
1456 For encryption, the plain text must be provided on STDIN or as the
1457 argument @var{inputfile}, and the ciphertext will be output to STDOUT.
1458 For decryption vice versa.
1459
1460 @var{CLASS} describes the calling conventions of the external tool.
1461 Currently it must be given as @samp{confucius}.  @var{PROGRAM} is the
1462 the full filename of that external tool.
1463  
1464 For the class @samp{confucius} the option @option{--keyfile} is
1465 required; @var{keyfile} is the name of a file containing the secret key,
1466 which may be protected by a passphrase.  For detailed calling
1467 conventions, see the source code.
1468  
1469 @noindent
1470 Note, that @command{gpg-agent} must be running before starting
1471 @command{symcryptrun}.
1472
1473 @noindent
1474 The following additional options may be used:
1475
1476 @table @gnupgtabopt
1477 @item -v
1478 @itemx --verbose
1479 @opindex verbose
1480 Output additional information while running.  
1481
1482 @item -q
1483 @item --quiet
1484 @opindex q
1485 @opindex quiet
1486 Try to be as quiet as possible.
1487
1488 @include opt-homedir.texi
1489
1490
1491 @item --log-file @var{file}
1492 @opindex log-file
1493 Append all logging output to @var{file}.  Default is to write logging
1494 informaton to STDERR.
1495
1496 @end table
1497
1498 @noindent
1499 The possible exit status codes of @command{symcryptrun} are:
1500
1501 @table @code
1502 @item 0 
1503         Success.
1504 @item 1 
1505         Some error occured.
1506 @item 2 
1507         No valid passphrase was provided.
1508 @item 3 
1509         The operation was canceled by the user.
1510
1511 @end table
1512
1513 @mansect see also
1514 @ifset isman
1515 @command{gpg}(1), 
1516 @command{gpgsm}(1), 
1517 @command{gpg-agent}(1), 
1518 @end ifset
1519 @include see-also-note.texi
1520
1521
1522 @c
1523 @c  GPG-ZIP
1524 @c
1525 @c The original manpage on which this section is based was written 
1526 @c by Colin Tuckley  <colin@tuckley.org> and Daniel Leidert 
1527 @c <daniel.leidert@wgdd.de> for the Debian distribution (but may be used by
1528 @c others).
1529 @manpage gpg-zip.1
1530 @node gpg-zip
1531 @section Encrypt or sign files into an archive
1532 @ifset manverb
1533 .B gpg-zip \- Encrypt or sign files into an archive
1534 @end ifset
1535
1536 @mansect synopsis
1537 @ifset manverb
1538 .B  gpg-zip
1539 .RI [ options ]
1540 .I filename1
1541 .I [ filename2, ... ]
1542 .I directory1
1543 .I [ directory2, ... ]
1544 @end ifset
1545
1546 @mansect description
1547 @command{gpg-zip} encrypts or signs files into an archive.  It is an
1548 gpg-ized tar using the same format as used by PGP's PGP Zip.
1549
1550 @manpause
1551 @noindent
1552 @command{gpg-zip} is invoked this way:
1553
1554 @example
1555 gpg-zip [options] @var{filename1} [@var{filename2}, ...] @var{directory} [@var{directory2}, ...]
1556 @end example
1557
1558 @mansect options
1559 @noindent
1560 @command{gpg-zip} understands these options:
1561
1562 @table @gnupgtabopt
1563
1564 @item --encrypt
1565 @itemx -e
1566 @opindex encrypt
1567 Encrypt data.  This option may be combined with @option{--symmetric} (for  output that may be decrypted via a secret key or a passphrase).
1568
1569 @item --decrypt
1570 @itemx -d
1571 @opindex decrypt
1572 Decrypt data.
1573
1574 @item --symmetric
1575 @itemx -c
1576 Encrypt with a symmetric cipher using a passphrase.  The default
1577 symmetric cipher used is CAST5, but may be chosen with the
1578 @option{--cipher-algo} option to @command{gpg}.
1579
1580 @item --sign
1581 @itemx -s
1582 Make a signature.  See @command{gpg}.
1583
1584 @item --recipient @var{user}
1585 @itemx -r @var{user}
1586 @opindex recipient
1587 Encrypt for user id @var{user}. See @command{gpg}.
1588
1589 @item --local-user @var{user}
1590 @itemx -u @var{user}
1591 @opindex local-user
1592 Use @var{user} as the key to sign with.  See @command{gpg}.
1593
1594 @item --list-archive
1595 @opindex list-archive
1596 List the contents of the specified archive.
1597
1598 @item --output @var{file}
1599 @itemx -o @var{file}
1600 @opindex output
1601 Write output to specified file @var{file}.
1602
1603 @item --gpg @var{gpgcmd}
1604 @opindex gpg
1605 Use the specified command @var{gpgcmd} instead of @command{gpg}.
1606
1607 @item --gpg-args @var{args}
1608 @opindex gpg-args
1609 Pass the specified options to @command{gpg}.
1610
1611 @item --tar @var{tarcmd}
1612 @opindex tar
1613 Use the specified command @var{tarcmd} instead of @command{tar}.
1614
1615 @item --tar-args @var{args}
1616 @opindex tar-args
1617 Pass the specified options to @command{tar}.
1618
1619 @item --version
1620 @opindex version
1621 Print version of the program and exit.
1622
1623 @item --help
1624 @opindex help
1625 Display a brief help page and exit.
1626
1627 @end table
1628
1629 @mansect diagnostics
1630 @noindent
1631 The program returns 0 if everything was fine, 1 otherwise.
1632
1633
1634 @mansect examples
1635 @ifclear isman
1636 @noindent
1637 Some examples:
1638
1639 @end ifclear
1640 @noindent
1641 Encrypt the contents of directory @file{mydocs} for user Bob to file
1642 @file{test1}:
1643
1644 @example
1645 gpg-zip --encrypt --output test1 --gpg-args  -r Bob mydocs
1646 @end example
1647
1648 @noindent
1649 List the contents of archive @file{test1}:
1650
1651 @example
1652 gpg-zip --list-archive test1
1653 @end example
1654
1655
1656 @mansect see also
1657 @ifset isman
1658 @command{gpg}(1), 
1659 @command{tar}(1), 
1660 @end ifset
1661 @include see-also-note.texi
1662