diff options
| -rw-r--r-- | AUTHORS | 5 | ||||
| -rw-r--r-- | THANKS | 2 | ||||
| -rw-r--r-- | doc/ChangeLog | 6 | ||||
| -rw-r--r-- | doc/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/tools.texi | 147 |
5 files changed, 158 insertions, 4 deletions
@@ -133,6 +133,9 @@ several people. The function build_argv in agent/w32main.c is based on code from Alexandre Julliard. +The gpg-zip documentation is based on the manpage for gpg-zip, written +by Colin Tuckley and Daniel Leidert for the GNU/Debian distribution. + Copyright ========= @@ -160,7 +163,7 @@ name gpg2keys_*. ========= Copyright 1998, 1999, 2000, 2001, 2002, 2004, 2005, - 2006, 2007 Free Software Foundation, Inc. + 2006, 2007, 2008 Free Software Foundation, Inc. This file is free software; as a special exception the author gives unlimited permission to copy and/or distribute it, with or without @@ -44,10 +44,12 @@ Christian Kurz shorty at debian.org Christian von Roques roques at pond.sub.org Christopher Oliver oliver at fritz.traverse.net Christian Recktenwald chris at citecs.de +Colin Tuckley colin at tuckley.org Daiki Ueno ueno at unixuser.org Dan Winship danw at helixcode.com Daniel Eisenbud eisenbud at cs.swarthmore.edu Daniel Koening dan at chaosdorf.de +Daniel Leidert daniel leidert at wgdd.de Daniel Resare daniel at resare.com Dany Nativel dany at natzo.com Dave Dykstra dwd at bell-labs.com diff --git a/doc/ChangeLog b/doc/ChangeLog index f11a34907..d1b9120d2 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2008-05-06 Werner Koch <wk@g10code.com> + + * Makefile.am (myman_pages): Add gpg-zip.1. + + * tools.texi (gpg-zip): Add new section. + 2008-04-08 Werner Koch <wk@g10code.com> * gpg.texi (GPG Configuration Options): Change subkeys.pgp.net to diff --git a/doc/Makefile.am b/doc/Makefile.am index 8d623abfb..f7dee4056 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -67,7 +67,7 @@ myman_sources = gnupg7.texi gpg.texi gpgsm.texi gpg-agent.texi \ myman_pages = gpg2.1 gpgsm.1 gpg-agent.1 scdaemon.1 gpgv2.1 \ watchgnupg.1 gpgconf.1 addgnupghome.8 gpg-preset-passphrase.1 \ gpg-connect-agent.1 gpgparsemail.1 symcryptrun.1 \ - gpgsm-gencert.sh.1 applygnupgdefaults.8 + gpgsm-gencert.sh.1 applygnupgdefaults.8 gpg-zip.1 man_MANS = $(myman_pages) noinst_MANS = gnupg.7 diff --git a/doc/tools.texi b/doc/tools.texi index b86972cac..79a909d2f 100644 --- a/doc/tools.texi +++ b/doc/tools.texi @@ -18,6 +18,7 @@ GnuPG comes with a couple of smaller tools: * gpg-connect-agent:: Communicate with a running agent. * gpgparsemail:: Parse a mail message into an annotated format * symcryptrun:: Call a simple symmetric encryption tool. +* gpg-zip:: Encrypt or sign files into an archive. @end menu @c @@ -74,11 +75,11 @@ Enable extra informational output. @item --version @opindex version -print version of the program and exit +Print version of the program and exit. @item --help @opindex help -Display a brief help page and exit +Display a brief help page and exit. @end table @@ -1485,3 +1486,145 @@ The possible exit status codes of @command{symcryptrun} are: @end ifset @include see-also-note.texi + +@c +@c GPG-ZIP +@c +@c The original manpage on which this section is based was written +@c by Colin Tuckley <colin@tuckley.org> and Daniel Leidert +@c <daniel.leidert@wgdd.de> for the Debian distribution (but may be used by +@c others). +@manpage gpg-zip.1 +@node gpg-zip +@section Encrypt or sign files into an archive +@ifset manverb +.B gpg-zip \- Encrypt or sign files into an archive +@end ifset + +@mansect synopsis +@ifset manverb +.B gpg-zip +.RI [ options ] +.I filename1 +.I [ filename2, ... ] +.I directory1 +.I [ directory2, ... ] +@end ifset + +@mansect description +@command{gpg-zip} encrypts or signs files into an archive. It is an +gpg-ized tar using the same format as used by PGP's PGP Zip. + +@manpause +@noindent +@command{gpg-zip} is invoked this way: + +@example +gpg-zip [options] @var{filename1} [@var{filename2}, ...] @var{directory} [@var{directory2}, ...] +@end example + +@mansect options +@noindent +@command{gpg-zip} understands these options: + +@table @gnupgtabopt + +@item --encrypt +@itemx -e +@opindex encrypt +Encrypt data. This option may be combined with @option{--symmetric} (for output that may be decrypted via a secret key or a passphrase). + +@item --decrypt +@itemx -d +@opindex decrypt +Decrypt data. + +@item --symmetric +@itemx -c +Encrypt with a symmetric cipher using a passphrase. The default +symmetric cipher used is CAST5, but may be chosen with the +@option{--cipher-algo} option to @command{gpg}. + +@item --sign +@itemx -s +Make a signature. See @command{gpg}. + +@item --recipient @var{user} +@itemx -r @var{user} +@opindex recipient +Encrypt for user id @var{user}. See @command{gpg}. + +@item --local-user @var{user} +@itemx -u @var{user} +@opindex local-user +Use @var{user} as the key to sign with. See @command{gpg}. + +@item --list-archive +@opindex list-archive +List the contents of the specified archive. + +@item --output @var{file} +@itemx -o @var{file} +@opindex output +Write output to specified file @var{file}. + +@item --gpg @var{gpgcmd} +@opindex gpg +Use the specified command @var{gpgcmd} instead of @command{gpg}. + +@item --gpg-args @var{args} +@opindex gpg-args +Pass the specified options to @command{gpg}. + +@item --tar @var{tarcmd} +@opindex tar +Use the specified command @var{tarcmd} instead of @command{tar}. + +@item --tar-args @var{args} +@opindex tar-args +Pass the specified options to @command{tar}. + +@item --version +@opindex version +Print version of the program and exit. + +@item --help +@opindex help +Display a brief help page and exit. + +@end table + +@mansect diagnostics +@noindent +The program returns 0 if everything was fine, 1 otherwise. + + +@mansect examples +@ifclear isman +@noindent +Some examples: + +@end ifclear +@noindent +Encrypt the contents of directory @file{mydocs} for user Bob to file +@file{test1}: + +@example +gpg-zip --encrypt --output test1 --gpg-args -r Bob mydocs +@end example + +@noindent +List the contents of archive @file{test1}: + +@example +gpg-zip --list-archive test1 +@end example + + +@mansect see also +@ifset isman +@command{gpg}(1), +@command{tar}(1), +@end ifset +@include see-also-note.texi + |