diff --git a/doc/ChangeLog b/doc/ChangeLog index 6c6c3b7cb..9993fef40 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2008-04-30 David Shaw + + * gpg-zip.1: Add man page thanks to Colin Tuckley and Daniel + Leidert. + 2008-04-02 Werner Koch * opt-homedir.texi: Remove special case for Registry key. diff --git a/doc/Makefile.am b/doc/Makefile.am index 333f19f85..2d95e7126 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -20,14 +20,14 @@ EXTRA_DIST = DETAILS faq.raw FAQ faq.html \ HACKING OpenPGP README.W32 samplekeys.asc gnupg.7 \ TRANSLATE gpg.ru.sgml gpg.ru.1 highlights-1.4.txt \ gpg.texi gpgv.texi specify-user-id.texi see-also-note.texi \ - opt-homedir.texi texi.css yat2m.c gpl.texi + opt-homedir.texi texi.css yat2m.c gpl.texi gpg-zip.1 myman_sources = gpg.texi gpgv.texi myman_pages = gpg.1 gpgv.1 info_TEXINFOS = gnupg1.texi -man_MANS = $(myman_pages) gnupg.7 gpg.ru.1 +man_MANS = $(myman_pages) gnupg.7 gpg.ru.1 gpg-zip.1 gnupg1_TEXINFOS = gnupg1.texi diff --git a/doc/gpg-zip.1 b/doc/gpg-zip.1 new file mode 100644 index 000000000..b10d70c93 --- /dev/null +++ b/doc/gpg-zip.1 @@ -0,0 +1,102 @@ +.TH "gpg-zip" 1 "November 2006" + +.SH NAME +gpg\-zip \- encrypt or sign files into an archive + +.SH SYNOPSIS +.B gpg\-zip +.RB [ OPTIONS ] +.IR filename1 " [" "filename2, ..." ] +.IR directory1 " [" "directory2, ..." ] + +.SH DESCRIPTION +This manual page documents briefly the +.B gpg\-zip +command. +.PP +.B gpg\-zip +encrypts or signs files into an archive. It is an gpg-ized tar using the +same format as PGP's PGP Zip. + +.SH OPTIONS +.TP +.BR \-e ", " \-\-encrypt +Encrypt data. This option may be combined with +.B \-\-symmetric +(for output that may be decrypted via a secret key or a passphrase). +.TP +.BR \-d ", " \-\-decrypt +Decrypt data. +.TP +.BR \-c ", " \-\-symmetric +Encrypt with a symmetric cipher using a passphrase. The default +symmetric cipher used is CAST5, but may be chosen with the +.B \-\-cipher\-algo +option to +.BR gpg (1). +.TP +.BR \-s ", " \-\-sign +Make a signature. See +.BR gpg (1). +.TP +.BR \-r ", " \-\-recipient " \fIUSER\fR" +Encrypt for user id \fIUSER\fR. See +.BR gpg (1). +.TP +.BR \-u ", " \-\-local\-user " \fIUSER\fR" +Use \fIUSER\fR as the key to sign with. See +.BR gpg (1). +.TP +.B \-\-list\-archive +List the contents of the specified archive. +.TP +.BR \-o ", " \-\-output " " \fIFILE\fR +Write output to specified file +.IR FILE . +.TP +.BI \-\-gpg " GPG" +Use the specified command instead of +.BR gpg . +.TP +.BI \-\-gpg\-args " ARGS" +Pass the specified options to +.BR gpg (1). +.TP +.BI \-\-tar " TAR" +Use the specified command instead of +.BR tar . +.TP +.BI \-\-tar\-args " ARGS" +Pass the specified options to +.BR tar (1). +.TP +.BR \-h ", " \-\-help +Output a short usage information. +.TP +.B \-\-version +Output the program version. + +.SH DIAGNOSTICS +The program returns \fB0\fR if everything was fine, \fB1\fR otherwise. + +.SH EXAMPLES +Encrypt the contents of directory \fImydocs\fR for user Bob to file \fItest1\fR: +.IP +.B gpg\-zip \-\-encrypt \-\-output test1 \-\-gpg-args ""\-r Bob"" mydocs +.PP +List the contents of archive \fItest1\fR: +.IP +.B gpg\-zip \-\-list\-archive test1 + +.SH SEE ALSO +.BR gpg (1), +.BR tar (1) + +.SH AUTHOR +Copyright (C) 2005 Free Software Foundation, Inc. Please report bugs to +<\&bug-gnupg@gnu.org\&>. + +This manpage was written by \fBColin Tuckley\fR <\&colin@tuckley.org\&> +and \fBDaniel Leidert\fR <\&daniel.leidert@wgdd.de\&> for the Debian +distribution (but may be used by others). +