doc/
[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 @end table
697
698 More types will be added in the future.  Please see the @var{alt-type}
699 field for information on how to cope with unknown types.
700
701 @item alt-type
702 This field is identical to @var{type}, except that only the types
703 @code{0} to @code{31} are allowed.  The GUI is expected to present the
704 user the option in the format specified by @var{type}.  But if the
705 argument type @var{type} is not supported by the GUI, it can still
706 display the option in the more generic basic type @var{alt-type}.  The
707 GUI must support all the defined basic types to be able to display all
708 options.  More basic types may be added in future versions.  If the
709 GUI encounters a basic type it doesn't support, it should report an
710 error and abort the operation.
711
712 @item argname
713 This field is only defined for options with an argument type
714 @var{type} that is not @code{0}.  In this case it may contain a
715 @emph{percent-escaped} and @emph{localised string} that gives a short
716 name for the argument.  The field may also be empty, though, in which
717 case a short name is not known.
718
719 @item default
720 This field is defined only for options for which the @code{default} or
721 @code{default desc} flag is set.  If the @code{default} flag is set,
722 its format is that of an @emph{option argument} (@xref{Format
723 conventions}, for details).  If the default value is empty, then no
724 default is known.  Otherwise, the value specifies the default value
725 for this option.  If the @code{default desc} flag is set, the field is
726 either empty or contains a description of the effect if the option is
727 not given.
728
729 @item argdef
730 This field is defined only for options for which the @code{optional
731 arg} flag is set.  If the @code{no arg desc} flag is not set, its
732 format is that of an @emph{option argument} (@xref{Format
733 conventions}, for details).  If the default value is empty, then no
734 default is known.  Otherwise, the value specifies the default argument
735 for this option.  If the @code{no arg desc} flag is set, the field is
736 either empty or contains a description of the effect of this option if
737 no argument is given.
738
739 @item value
740 This field is defined only for options.  Its format is that of an
741 @emph{option argument}.  If it is empty, then the option is not
742 explicitely set in the current configuration, and the default applies
743 (if any).  Otherwise, it contains the current value of the option.
744 Note that this field is also meaningful if the option itself does not
745 take a real argument (in this case, it contains the number of times
746 the option appears).
747 @end table
748
749
750 @node Changing options
751 @subsection Changing options
752
753 The command @w{@code{--change-options @var{component}}} will attempt
754 to change the options of the component @var{component} to the
755 specified values.  @var{component} must be the string in the field
756 @var{name} in the output of the @code{--list-components} command.  You
757 have to provide the options that shall be changed in the following
758 format on standard input:
759
760 @code{@var{name}:@var{flags}:@var{new-value}}
761
762 @table @var
763 @item name
764 This is the name of the option to change.  @var{name} must be the
765 string in the field @var{name} in the output of the
766 @code{--list-options} command.
767
768 @item flags
769 The flags field contains an @emph{unsigned number}.  Its value is the
770 OR-wise combination of the following flag values:
771
772 @table @code
773 @item default (16)
774 If this flag is set, the option is deleted and the default value is
775 used instead (if applicable).
776 @end table
777
778 @item new-value
779 The new value for the option.  This field is only defined if the
780 @code{default} flag is not set.  The format is that of an @emph{option
781 argument}.  If it is empty (or the field is omitted), the default
782 argument is used (only allowed if the argument is optional for this
783 option).  Otherwise, the option will be set to the specified value.
784 @end table
785
786 @noindent
787 The output of the command is the same as that of
788 @code{--check-options} for the modified configuration file.
789
790 Examples:
791
792 To set the force option, which is of basic type @code{none (0)}:
793
794 @example
795 $ echo 'force:0:1' | gpgconf --change-options dirmngr
796 @end example
797
798 To delete the force option:
799
800 @example
801 $ echo 'force:16:' | gpgconf --change-options dirmngr
802 @end example
803
804 The @code{--runtime} option can influence when the changes take
805 effect.
806
807
808 @node Listing global options
809 @subsection Listing global options
810
811 Sometimes it is useful for applications to look at the global options
812 file @file{gpgconf.conf}. 
813 The colon separated listing format is record oriented and uses the first
814 field to identify the record type:
815
816 @table @code
817 @item k
818 This describes a key record to start the definition of a new ruleset for
819 a user/group.  The format of a key record is:
820
821   @code{k:@var{user}:@var{group}:}
822
823 @table @var
824 @item user
825 This is the user field of the key.  It is percent escaped.  See the
826 definition of the gpgconf.conf format for details.
827
828 @item group
829 This is the group field of the key.  It is percent escaped.
830 @end table
831
832 @item r
833 This describes a rule record. All rule records up to the next key record
834 make up a rule set for that key.  The format of a rule record is:
835
836   @code{r:::@var{component}:@var{option}:@var{flags}:@var{value}:}
837
838 @table @var
839 @item component
840 This is the component part of a rule.  It is a plain string.
841
842 @item option
843 This is the option part of a rule.  It is a plain string.
844
845 @item flag
846 This is the flags part of a rule.  There may be only one flag per rule
847 but by using the same component and option, several flags may be
848 assigned to an option.  It is a plain string.
849
850 @item value
851 This is the optional value for the option.  It is a percent escaped
852 string with a single quotation mark to indicate a string.  The quotation
853 mark is only required to distinguish between no value specified and an
854 empty string.
855 @end table
856
857 @end table
858
859 @noindent
860 Unknown record typs should be ignored.  Note that there is intentionally
861 no feature to change the global option file through @command{gpgconf}.
862
863
864
865 @mansect files
866 @node Files used by gpgconf
867 @subsection Files used by gpgconf
868
869 @table @file
870
871 @item /etc/gnupg/gpgconf.conf
872 @cindex gpgconf.conf
873   If this file exists, it is processed as a global configuration file.
874   A commented example can be found in the @file{examples} directory of
875   the distribution.
876 @end table
877
878
879 @mansect see also
880 @ifset isman
881 @command{gpg}(1), 
882 @command{gpgsm}(1), 
883 @command{gpg-agent}(1), 
884 @command{scdaemon}(1),
885 @command{dirmngr}(1)
886 @end ifset
887 @include see-also-note.texi
888
889
890
891 @c
892 @c    APPLYGNUPGDEFAULTS
893 @c
894 @manpage applygnupgdefaults.8
895 @node applygnupgdefaults
896 @section Run gpgconf for all users.
897 @ifset manverb
898 .B applygnupgdefaults
899 \- Run gpgconf --apply-defaults for all users.
900 @end ifset
901
902 @mansect synopsis
903 @ifset manverb
904 .B  applygnupgdefaults
905 @end ifset
906
907 @mansect description
908 This script is a wrapper around @command{gpgconf} to run it with the
909 command @code{--apply-defaults} for all real users with an existing
910 GnuPG home directory.  Admins might want to use this script to update he
911 GnuPG configuration files for all users after
912 @file{/etc/gnupg/gpgconf.conf} has been changed.  This allows to enforce
913 certain policies for all users.  Note, that this is not a bulletproof of
914 forcing a user to use certain options.  A user may always directly edit
915 the configuration files and bypass gpgconf.
916
917 @noindent
918 @command{applygnupgdefaults} is invoked by root as:
919
920 @example
921 applygnupgdefaults
922 @end example
923
924
925 @c
926 @c    GPGSM-GENCERT.SH
927 @c
928 @node gpgsm-gencert.sh
929 @section Generate an X.509 certificate request
930 @manpage gpgsm-gencert.sh.1
931 @ifset manverb
932 .B gpgsm-gencert.sh
933 \- Generate an X.509 certificate request
934 @end ifset 
935
936 @mansect synopsis
937 @ifset manverb
938 .B  gpgsm-gencert.sh
939 @end ifset
940
941 @mansect description
942 This is a simple tool to interactivly generate a certificate request
943 which will be printed to stdout.
944
945 @manpause
946 @noindent
947 @command{gpgsm-gencert.sh} is invoked as:
948
949 @samp{gpgsm-cencert.sh}
950
951 @mansect see also
952 @ifset isman
953 @command{gpgsm}(1), 
954 @command{gpg-agent}(1), 
955 @command{scdaemon}(1)
956 @end ifset
957 @include see-also-note.texi
958
959
960
961 @c
962 @c   GPG-PRESET-PASSPHRASE
963 @c
964 @node gpg-preset-passphrase
965 @section Put a passphrase into the cache.
966 @manpage gpg-preset-passphrase.1
967 @ifset manverb
968 .B gpg-preset-passphrase
969 \- Put a passphrase into gpg-agent's cache
970 @end ifset
971
972 @mansect synopsis
973 @ifset manverb
974 .B  gpg-preset-passphrase
975 .RI [ options ]
976 .RI [ command ]
977 .I keygrip
978 @end ifset
979
980 @mansect description
981 The @command{gpg-preset-passphrase} is a utility to seed the internal
982 cache of a running @command{gpg-agent} with passphrases.  It is mainly
983 useful for unattended machines, where the usual @command{pinentry} tool
984 may not be used and the passphrases for the to be used keys are given at
985 machine startup.
986
987 Passphrases set with this utility don't expire unless the
988 @option{--forget} option is used to explicitly clear them from the cache
989 --- or @command{gpg-agent} is either restarted or reloaded (by sending a
990 SIGHUP to it).  It is necessary to allow this passphrase presetting by
991 starting @command{gpg-agent} with the
992 @option{--allow-preset-passphrase}.
993
994 @menu
995 * Invoking gpg-preset-passphrase::   List of all commands and options.
996 @end menu
997
998 @manpause
999 @node Invoking gpg-preset-passphrase
1000 @subsection List of all commands and options.
1001 @mancont
1002
1003 @noindent
1004 @command{gpg-preset-passphrase} is invoked this way:
1005
1006 @example
1007 gpg-preset-passphrase [options] [command] @var{keygrip}
1008 @end example
1009
1010 @var{keygrip} is a 40 character string of hexadecimal characters
1011 identifying the key for which the passphrase should be set or cleared.
1012 This keygrip is listed along with the key when running the command:
1013 @code{gpgsm --dump-secret-keys}. One of the following command options
1014 must be given:
1015
1016 @table @gnupgtabopt
1017 @item --preset
1018 @opindex preset
1019 Preset a passphrase. This is what you usually will
1020 use. @command{gpg-preset-passphrase} will then read the passphrase from
1021 @code{stdin}.
1022
1023 @item --forget
1024 @opindex forget
1025 Flush the passphrase for the given keygrip from the cache.
1026
1027 @end table
1028
1029 @noindent
1030 The following additional options may be used:
1031
1032 @table @gnupgtabopt
1033 @item -v
1034 @itemx --verbose
1035 @opindex verbose
1036 Output additional information while running.  
1037
1038 @item -P @var{string}
1039 @itemx --passphrase @var{string}
1040 @opindex passphrase
1041 Instead of reading the passphrase from @code{stdin}, use the supplied
1042 @var{string} as passphrase.  Note that this makes the passphrase visible
1043 for other users.
1044 @end table
1045
1046 @mansect see also
1047 @ifset isman
1048 @command{gpg}(1), 
1049 @command{gpgsm}(1), 
1050 @command{gpg-agent}(1), 
1051 @command{scdaemon}(1)
1052 @end ifset
1053 @include see-also-note.texi
1054
1055
1056
1057
1058 @c
1059 @c   GPG-CONNECT-AGENT
1060 @c
1061 @node gpg-connect-agent
1062 @section Communicate with a running agent.
1063 @manpage gpg-connect-agent.1
1064 @ifset manverb
1065 .B gpg-connect-agent
1066 \- Communicate with a running agent
1067 @end ifset
1068
1069 @mansect synopsis
1070 @ifset manverb
1071 .B  gpg-connect-agent
1072 .RI [ options ]
1073 @end ifset
1074
1075 @mansect description
1076 The @command{gpg-connect-agent} is a utility to communicate with a
1077 running @command{gpg-agent}.  It is useful to check out the commands
1078 gpg-agent provides using the Assuan interface.  It might also be useful
1079 for scripting simple applications.  Inputis expected at stdin and out
1080 put gets printed to stdout.
1081
1082 It is very similar to running @command{gpg-agent} in server mode; but
1083 here we connect to a running instance.
1084
1085 @menu
1086 * Invoking gpg-connect-agent::       List of all options.
1087 * Controlling gpg-connect-agent::    Control commands.
1088 @end menu
1089
1090 @manpause
1091 @node Invoking gpg-connect-agent
1092 @subsection List of all options.
1093
1094 @noindent
1095 @command{gpg-connect-agent} is invoked this way:
1096
1097 @example
1098 gpg-connect-agent [options]
1099 @end example
1100 @mancont
1101
1102 @noindent
1103 The following options may be used:
1104
1105 @table @gnupgtabopt
1106 @item -v
1107 @itemx --verbose
1108 @opindex verbose
1109 Output additional information while running.  
1110
1111 @item -q
1112 @item --quiet
1113 @opindex q
1114 @opindex quiet
1115 Try to be as quiet as possible.
1116
1117 @include opt-homedir.texi
1118
1119 @item -S
1120 @itemx --raw-socket @var{name}
1121 @opindex S        
1122 @opindex raw-socket
1123 Connect to socket @var{name} assuming this is an Assuan style server.
1124 Do not run any special initializations or environment checks.  This may
1125 be used to directly connect to any Assuan style socket server.
1126
1127 @item -E
1128 @itemx --exec
1129 @opindex exec
1130 Take the rest of the command line as a program and it's arguments and
1131 execute it as an assuan server. Here is how you would run @command{gpgsm}:
1132 @smallexample
1133  gpg-connect-agent --exec gpgsm --server
1134 @end smallexample
1135
1136
1137 @item --no-ext-connect
1138 @opindex no-ext-connect
1139 When using @option{-S} or @option{--exec}, @command{gpg-connect-agent}
1140 connects to the assuan server in extended mode to allow descriptor
1141 passing.  This option makes it use the old mode.
1142
1143 @item --run @var{file}
1144 @opindex run 
1145 Run the commands from @var{file} at startup and then continue with the
1146 regular input method.
1147
1148 @item -s
1149 @itemx --subst
1150 @opindex subst
1151 Run the command @code{/subst} at startup.
1152
1153 @item --hex
1154 @opindex hex
1155 Print data lines in a hex format and the ASCII representation of
1156 non-control characters.
1157
1158 @item --decode
1159 @opindex decode
1160 Decode data lines.  That is to remove percent escapes but make sure that
1161 a new line always starts with a D and a space.
1162
1163 @end table
1164
1165 @mansect control commands
1166 @node Controlling gpg-connect-agent
1167 @subsection Control commands.
1168
1169 While reading Assuan commands, gpg-agent also allows a few special
1170 commands to control its operation.  These control commands all start
1171 with a slash (@code{/}).
1172
1173 @table @code
1174
1175 @item /echo @var{args}
1176 Just print @var{args}.
1177
1178 @item /let @var{name} @var{value}
1179 Set the variable @var{name} to @var{value}.  Variables are only
1180 substituted on the input if the @command{/subst} has been used.
1181 Variables are referenced by prefixing the name with a dollr sign and
1182 optionally include the name in curly braces.  The rules for a valid name
1183 are idnetically to those of the standard bourne shell.  This is not yet
1184 enforced but may be in the future.  When used with curly braces no
1185 leading or trailing white space is allowed. 
1186
1187 If a variable is not found, it is searched in the environment and if
1188 found copied to the table of variables.
1189
1190 Variable functions are available: The name of the function must be
1191 followed by at least one space and the at least one argument.  The
1192 following functions are available:
1193
1194 @table @code
1195 @item get
1196 Return a value described by the argument.  Available arguments are:
1197
1198 @table @code    
1199 @item cwd
1200 The current working directory.
1201 @item homedir
1202 The gnupg homedir.
1203 @item sysconfdir
1204 GnuPG's system configuration directory.
1205 @item bindir
1206 GnuPG's binary directory.
1207 @item libdir
1208 GnuPG's library directory.
1209 @item libexecdir
1210 GnuPG's library directory for executable files.
1211 @item datadir
1212 GnuPG's data directory.
1213 @item serverpid
1214 The PID of the current server. Command @command{/serverpid} must
1215 have been given to return a useful value.
1216 @end table
1217
1218 @item unescape @var{args}
1219 Remove C-style escapes from @var{args}.  Note that @code{\0} and
1220 @code{\x00} terminate the returned string implicitly.  The string to be
1221 converted are the entire arguments right behind the delimiting space of
1222 the function name.
1223
1224 @item unpercent @var{args}
1225 @itemx unpercent+ @var{args}
1226 Remove percent style ecaping from @var{args}.  Note that @code{%00}
1227 terminates the string implicitly.  The string to be converted are the
1228 entire arguments right behind the delimiting space of the function
1229 name. @code{unpercent+} also maps plus signs to a spaces.
1230
1231 @item percent @var{args}
1232 @itemx percent+ @var{args}
1233 Escape the @var{args} using percent style ecaping.  Tabs, formfeeds,
1234 linefeeds, carriage returns and colons are escaped. @code{percent+} also
1235 maps spaces to plus signs.
1236
1237 @item errcode @var{arg}
1238 @itemx errsource @var{arg}
1239 @itemx errstring @var{arg}
1240 Assume @var{arg} is an integer and evaluate it using @code{strtol}.  Return
1241 the gpg-error error code, error source or a formatted string with the
1242 error code and error source.
1243
1244
1245 @item +
1246 @itemx -
1247 @itemx *
1248 @itemx /
1249 @itemx %
1250 Evaluate all arguments as long integers using @code{strtol} and apply
1251 this operator.  A division by zero yields an empty string.
1252
1253 @item !
1254 @itemx |
1255 @itemx &
1256 Evaluate all arguments as long integers using @code{strtol} and apply
1257 the logical oeprators NOT, OR or AND.  The NOT operator works on the
1258 last argument only.
1259
1260
1261 @end table
1262
1263
1264 @item /definq @var{name} @var{var}
1265 Use content of the variable @var{var} for inquiries with @var{name}.
1266 @var{name} may be an asterisk (@code{*}) to match any inquiry.
1267
1268
1269 @item /definqfile @var{name} @var{file}
1270 Use content of @var{file} for inquiries with @var{name}.
1271 @var{name} may be an asterisk (@code{*}) to match any inquiry.
1272
1273 @item /definqprog @var{name} @var{prog}
1274 Run @var{prog} for inquiries matching @var{name} and pass the
1275 entire line to it as command line arguments.
1276
1277 @item /showdef
1278 Print all definitions
1279
1280 @item /cleardef
1281 Delete all definitions
1282
1283 @item /sendfd @var{file} @var{mode}
1284 Open @var{file} in @var{mode} (which needs to be a valid @code{fopen}
1285 mode string) and send the file descriptor to the server.  This is
1286 usually followed by a command like @code{INPUT FD} to set the
1287 input source for other commands.
1288
1289 @item /recvfd
1290 Not yet implemented.
1291
1292 @item /open @var{var} @var{file} [@var{mode}]
1293 Open @var{file} and assign the file descriptor to @var{var}.  Warning:
1294 This command is experimental and might change in future versions.
1295
1296 @item /close @var{fd}
1297 Close the file descriptor @var{fd}.  Warning: This command is
1298 experimental and might change in future versions.
1299
1300 @item /showopen
1301 Show a listy of open files.
1302
1303 @item /serverpid
1304 Send the Assuan command @command{GETINFO pid} to the server and store
1305 the returned PID for internal purposes.
1306
1307 @item /sleep
1308 Sleep for a second.
1309
1310 @item /hex
1311 @itemx /nohex
1312 Same as the command line option @option{--hex}.
1313
1314 @item /decode
1315 @itemx /nodecode
1316 Same as the command line option @option{--decode}.
1317
1318 @item /subst
1319 @itemx /nosubst
1320 Enable and disable variable substitution.  It defaults to disabled
1321 unless the command line option @option{--subst} has been used.
1322 If /subst as been enabled once, leading whitespace is removed from
1323 input lines which makes scripts easier to read.
1324
1325 @item /while @var{condition}
1326 @itemx /end
1327 These commands provide a way for executing loops.  All lines between the
1328 @code{while} and the corresponding @code{end} are executed as long as
1329 the evaluation of @var{condition} yields a non-zero value.  The
1330 evaluation is done by passing @var{condition} to the @code{strtol}
1331 function.  Example:
1332
1333 @smallexample
1334   /subst
1335   /let i 3
1336   /while $i
1337     /echo loop couter is $i
1338     /let i $@{- $i 1@}
1339   /end
1340 @end smallexample
1341
1342
1343 @item /run @var{file}
1344 Run commands from @var{file}.
1345
1346 @item /bye
1347 Terminate the connection and the program
1348
1349 @item /help
1350 Print a list of available control commands.
1351
1352 @end table
1353
1354
1355 @ifset isman
1356 @mansect see also
1357 @command{gpg-agent}(1), 
1358 @command{scdaemon}(1)
1359 @include see-also-note.texi
1360 @end ifset
1361
1362
1363 @c
1364 @c   GPGPARSEMAIL
1365 @c
1366 @node gpgparsemail
1367 @section Parse a mail message into an annotated format
1368
1369 @manpage gpgparsemail.1
1370 @ifset manverb
1371 .B gpgparsemail
1372 \- Parse a mail message into an annotated format
1373 @end ifset
1374
1375 @mansect synopsis
1376 @ifset manverb
1377 .B  gpgparsemail
1378 .RI [ options ]
1379 .RI [ file ]
1380 @end ifset
1381
1382 @mansect description
1383 The @command{gpgparsemail} is a utility currently only useful for
1384 debugging.  Run it with @code{--help} for usage information.
1385
1386
1387
1388 @c
1389 @c   SYMCRYPTRUN
1390 @c
1391 @node symcryptrun
1392 @section Call a simple symmetric encryption tool.
1393 @manpage symcryptrun.1
1394 @ifset manverb
1395 .B symcryptrun
1396 \- Call a simple symmetric encryption tool
1397 @end ifset
1398
1399 @mansect synopsis
1400 @ifset manverb
1401 .B  symcryptrun
1402 .B \-\-class
1403 .I class
1404 .B \-\-program
1405 .I program
1406 .B \-\-keyfile
1407 .I keyfile
1408 .RB [ --decrypt | --encrypt ]
1409 .RI [ inputfile ]
1410 @end ifset
1411
1412 @mansect description
1413 Sometimes simple encryption tools are already in use for a long time and
1414 there might be a desire to integrate them into the GnuPG framework.  The
1415 protocols and encryption methods might be non-standard or not even
1416 properly documented, so that a full-fledged encryption tool with an
1417 interface like gpg is not doable.  @command{symcryptrun} provides a
1418 solution: It operates by calling the external encryption/decryption
1419 module and provides a passphrase for a key using the standard
1420 @command{pinentry} based mechanism through @command{gpg-agent}.
1421
1422 Note, that @command{symcryptrun} is only available if GnuPG has been
1423 configured with @samp{--enable-symcryptrun} at build time.
1424
1425 @menu
1426 * Invoking symcryptrun::   List of all commands and options.
1427 @end menu
1428
1429 @manpause
1430 @node Invoking symcryptrun
1431 @subsection List of all commands and options.
1432
1433 @noindent
1434 @command{symcryptrun} is invoked this way:
1435
1436 @example
1437 symcryptrun --class CLASS --program PROGRAM --keyfile KEYFILE 
1438    [--decrypt | --encrypt] [inputfile]
1439 @end example
1440 @mancont
1441
1442 For encryption, the plain text must be provided on STDIN or as the
1443 argument @var{inputfile}, and the ciphertext will be output to STDOUT.
1444 For decryption vice versa.
1445
1446 @var{CLASS} describes the calling conventions of the external tool.
1447 Currently it must be given as @samp{confucius}.  @var{PROGRAM} is the
1448 the full filename of that external tool.
1449  
1450 For the class @samp{confucius} the option @option{--keyfile} is
1451 required; @var{keyfile} is the name of a file containing the secret key,
1452 which may be protected by a passphrase.  For detailed calling
1453 conventions, see the source code.
1454  
1455 @noindent
1456 Note, that @command{gpg-agent} must be running before starting
1457 @command{symcryptrun}.
1458
1459 @noindent
1460 The following additional options may be used:
1461
1462 @table @gnupgtabopt
1463 @item -v
1464 @itemx --verbose
1465 @opindex verbose
1466 Output additional information while running.  
1467
1468 @item -q
1469 @item --quiet
1470 @opindex q
1471 @opindex quiet
1472 Try to be as quiet as possible.
1473
1474 @include opt-homedir.texi
1475
1476
1477 @item --log-file @var{file}
1478 @opindex log-file
1479 Append all logging output to @var{file}.  Default is to write logging
1480 informaton to STDERR.
1481
1482 @end table
1483
1484 @noindent
1485 The possible exit status codes of @command{symcryptrun} are:
1486
1487 @table @code
1488 @item 0 
1489         Success.
1490 @item 1 
1491         Some error occured.
1492 @item 2 
1493         No valid passphrase was provided.
1494 @item 3 
1495         The operation was canceled by the user.
1496
1497 @end table
1498
1499 @mansect see also
1500 @ifset isman
1501 @command{gpg}(1), 
1502 @command{gpgsm}(1), 
1503 @command{gpg-agent}(1), 
1504 @end ifset
1505 @include see-also-note.texi
1506
1507
1508 @c
1509 @c  GPG-ZIP
1510 @c
1511 @c The original manpage on which this section is based was written 
1512 @c by Colin Tuckley  <colin@tuckley.org> and Daniel Leidert 
1513 @c <daniel.leidert@wgdd.de> for the Debian distribution (but may be used by
1514 @c others).
1515 @manpage gpg-zip.1
1516 @node gpg-zip
1517 @section Encrypt or sign files into an archive
1518 @ifset manverb
1519 .B gpg-zip \- Encrypt or sign files into an archive
1520 @end ifset
1521
1522 @mansect synopsis
1523 @ifset manverb
1524 .B  gpg-zip
1525 .RI [ options ]
1526 .I filename1
1527 .I [ filename2, ... ]
1528 .I directory1
1529 .I [ directory2, ... ]
1530 @end ifset
1531
1532 @mansect description
1533 @command{gpg-zip} encrypts or signs files into an archive.  It is an
1534 gpg-ized tar using the same format as used by PGP's PGP Zip.
1535
1536 @manpause
1537 @noindent
1538 @command{gpg-zip} is invoked this way:
1539
1540 @example
1541 gpg-zip [options] @var{filename1} [@var{filename2}, ...] @var{directory} [@var{directory2}, ...]
1542 @end example
1543
1544 @mansect options
1545 @noindent
1546 @command{gpg-zip} understands these options:
1547
1548 @table @gnupgtabopt
1549
1550 @item --encrypt
1551 @itemx -e
1552 @opindex encrypt
1553 Encrypt data.  This option may be combined with @option{--symmetric} (for  output that may be decrypted via a secret key or a passphrase).
1554
1555 @item --decrypt
1556 @itemx -d
1557 @opindex decrypt
1558 Decrypt data.
1559
1560 @item --symmetric
1561 @itemx -c
1562 Encrypt with a symmetric cipher using a passphrase.  The default
1563 symmetric cipher used is CAST5, but may be chosen with the
1564 @option{--cipher-algo} option to @command{gpg}.
1565
1566 @item --sign
1567 @itemx -s
1568 Make a signature.  See @command{gpg}.
1569
1570 @item --recipient @var{user}
1571 @itemx -r @var{user}
1572 @opindex recipient
1573 Encrypt for user id @var{user}. See @command{gpg}.
1574
1575 @item --local-user @var{user}
1576 @itemx -u @var{user}
1577 @opindex local-user
1578 Use @var{user} as the key to sign with.  See @command{gpg}.
1579
1580 @item --list-archive
1581 @opindex list-archive
1582 List the contents of the specified archive.
1583
1584 @item --output @var{file}
1585 @itemx -o @var{file}
1586 @opindex output
1587 Write output to specified file @var{file}.
1588
1589 @item --gpg @var{gpgcmd}
1590 @opindex gpg
1591 Use the specified command @var{gpgcmd} instead of @command{gpg}.
1592
1593 @item --gpg-args @var{args}
1594 @opindex gpg-args
1595 Pass the specified options to @command{gpg}.
1596
1597 @item --tar @var{tarcmd}
1598 @opindex tar
1599 Use the specified command @var{tarcmd} instead of @command{tar}.
1600
1601 @item --tar-args @var{args}
1602 @opindex tar-args
1603 Pass the specified options to @command{tar}.
1604
1605 @item --version
1606 @opindex version
1607 Print version of the program and exit.
1608
1609 @item --help
1610 @opindex help
1611 Display a brief help page and exit.
1612
1613 @end table
1614
1615 @mansect diagnostics
1616 @noindent
1617 The program returns 0 if everything was fine, 1 otherwise.
1618
1619
1620 @mansect examples
1621 @ifclear isman
1622 @noindent
1623 Some examples:
1624
1625 @end ifclear
1626 @noindent
1627 Encrypt the contents of directory @file{mydocs} for user Bob to file
1628 @file{test1}:
1629
1630 @example
1631 gpg-zip --encrypt --output test1 --gpg-args  -r Bob mydocs
1632 @end example
1633
1634 @noindent
1635 List the contents of archive @file{test1}:
1636
1637 @example
1638 gpg-zip --list-archive test1
1639 @end example
1640
1641
1642 @mansect see also
1643 @ifset isman
1644 @command{gpg}(1), 
1645 @command{tar}(1), 
1646 @end ifset
1647 @include see-also-note.texi
1648