[svn] GnuPG - r4756 - in trunk: . doc

[svn author wk]

Author: wk
Date: 2008-05-06 13:05:52 +0200 (Tue, 06 May 2008)
New Revision: 4756

Modified:
   trunk/AUTHORS
   trunk/THANKS
   trunk/doc/ChangeLog
   trunk/doc/Makefile.am
   trunk/doc/tools.texi
Log:
add gpg-zip man page.


Modified: trunk/doc/ChangeLog
===================================================================
--- trunk/doc/ChangeLog	2008-05-02 22:54:30 UTC (rev 4755)
+++ trunk/doc/ChangeLog	2008-05-06 11:05:52 UTC (rev 4756)
@@ -1,3 +1,9 @@
+2008-05-06  Werner Koch  <wk at g10code.com>
+
+	* Makefile.am (myman_pages): Add gpg-zip.1.
+
+	* tools.texi (gpg-zip): Add new section.
+
 2008-04-08  Werner Koch  <wk at g10code.com>
 
 	* gpg.texi (GPG Configuration Options): Change subkeys.pgp.net to

Modified: trunk/AUTHORS
===================================================================
--- trunk/AUTHORS	2008-05-02 22:54:30 UTC (rev 4755)
+++ trunk/AUTHORS	2008-05-06 11:05:52 UTC (rev 4756)
@@ -133,7 +133,10 @@
 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 @@
 =========
 
  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

Modified: trunk/THANKS
===================================================================
--- trunk/THANKS	2008-05-02 22:54:30 UTC (rev 4755)
+++ trunk/THANKS	2008-05-06 11:05:52 UTC (rev 4756)
@@ -44,10 +44,12 @@
 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

Modified: trunk/doc/Makefile.am
===================================================================
--- trunk/doc/Makefile.am	2008-05-02 22:54:30 UTC (rev 4755)
+++ trunk/doc/Makefile.am	2008-05-06 11:05:52 UTC (rev 4756)
@@ -67,7 +67,7 @@
 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

Modified: trunk/doc/tools.texi
===================================================================
--- trunk/doc/tools.texi	2008-05-02 22:54:30 UTC (rev 4755)
+++ trunk/doc/tools.texi	2008-05-06 11:05:52 UTC (rev 4756)
@@ -18,6 +18,7 @@
 * 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 @@
 
 @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 @@
 @end ifset
 @include see-also-note.texi
 
+
+ at c
+ at c  GPG-ZIP
+ at c
+ at c The original manpage on which this section is based was written 
+ at c by Colin Tuckley  <colin at tuckley.org> and Daniel Leidert 
+ at c <daniel.leidert at wgdd.de> for the Debian distribution (but may be used by
+ at c others).
+ at manpage gpg-zip.1
+ at node gpg-zip
+ at section Encrypt or sign files into an archive
+ at ifset manverb
+.B gpg-zip \- Encrypt or sign files into an archive
+ at end ifset
+
+ at mansect synopsis
+ at ifset manverb
+.B  gpg-zip
+.RI [ options ]
+.I filename1
+.I [ filename2, ... ]
+.I directory1
+.I [ directory2, ... ]
+ at end ifset
+
+ at mansect description
+ at 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.
+
+ at manpause
+ at noindent
+ at command{gpg-zip} is invoked this way:
+
+ at example
+gpg-zip [options] @var{filename1} [@var{filename2}, ...] @var{directory} [@var{directory2}, ...]
+ at end example
+
+ at mansect options
+ at noindent
+ at command{gpg-zip} understands these options:
+
+ at table @gnupgtabopt
+
+ at item --encrypt
+ at itemx -e
+ at 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).
+
+ at item --decrypt
+ at itemx -d
+ at opindex decrypt
+Decrypt data.
+
+ at item --symmetric
+ at itemx -c
+Encrypt with a symmetric cipher using a passphrase.  The default
+symmetric cipher used is CAST5, but may be chosen with the
+ at option{--cipher-algo} option to @command{gpg}.
+
+ at item --sign
+ at itemx -s
+Make a signature.  See @command{gpg}.
+
+ at item --recipient @var{user}
+ at itemx -r @var{user}
+ at opindex recipient
+Encrypt for user id @var{user}. See @command{gpg}.
+
+ at item --local-user @var{user}
+ at itemx -u @var{user}
+ at opindex local-user
+Use @var{user} as the key to sign with.  See @command{gpg}.
+
+ at item --list-archive
+ at opindex list-archive
+List the contents of the specified archive.
+
+ at item --output @var{file}
+ at itemx -o @var{file}
+ at opindex output
+Write output to specified file @var{file}.
+
+ at item --gpg @var{gpgcmd}
+ at opindex gpg
+Use the specified command @var{gpgcmd} instead of @command{gpg}.
+
+ at item --gpg-args @var{args}
+ at opindex gpg-args
+Pass the specified options to @command{gpg}.
+
+ at item --tar @var{tarcmd}
+ at opindex tar
+Use the specified command @var{tarcmd} instead of @command{tar}.
+
+ at item --tar-args @var{args}
+ at opindex tar-args
+Pass the specified options to @command{tar}.
+
+ at item --version
+ at opindex version
+Print version of the program and exit.
+
+ at item --help
+ at opindex help
+Display a brief help page and exit.
+
+ at end table
+
+ at mansect diagnostics
+ at noindent
+The program returns 0 if everything was fine, 1 otherwise.
+
+
+ at mansect examples
+ at ifclear isman
+ at noindent
+Some examples:
+
+ at end ifclear
+ at noindent
+Encrypt the contents of directory @file{mydocs} for user Bob to file
+ at file{test1}:
+
+ at example
+gpg-zip --encrypt --output test1 --gpg-args  -r Bob mydocs
+ at end example
+
+ at noindent
+List the contents of archive @file{test1}:
+
+ at example
+gpg-zip --list-archive test1
+ at end example
+
+
+ at mansect see also
+ at ifset isman
+ at command{gpg}(1), 
+ at command{tar}(1), 
+ at end ifset
+ at include see-also-note.texi
+