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