chiark / gitweb /
gpg agent threading bugs: Add some `xxx' comments.
[gnupg2.git] / debian / gpg-zip.1
1 .TH "GPG\-ZIP" 1 "November 2006"
2
3 .SH NAME
4 gpg\-zip \- encrypt or sign files into an archive
5
6 .SH SYNOPSIS
7 .B gpg\-zip
8 .RB [ OPTIONS ]
9 .IR filename1 " [" "filename2, ..." ]
10 .IR directory1 " [" "directory2, ..." ]
11
12 .SH DESCRIPTION
13 This manual page documents briefly the 
14 .B gpg\-zip
15 command.
16 .PP
17 .B gpg\-zip
18 encrypts or signs files into an archive. It is an gpg-ized tar using the
19 same format as PGP's PGP Zip.
20
21 .SH OPTIONS
22 .TP
23 .BR \-e ", " \-\-encrypt
24 Encrypt data. This option may be combined with 
25 .B \-\-symmetric
26 (for output that may be decrypted via a secret key or a passphrase).
27 .TP
28 .BR \-d ", " \-\-decrypt
29 Decrypt data.
30 .TP
31 .BR \-c ", " \-\-symmetric
32 Encrypt with a symmetric cipher using a passphrase.  The default
33 symmetric cipher used is CAST5, but may be chosen with the
34 .B \-\-cipher\-algo
35 option to
36 .BR gpg (1).
37 .TP
38 .BR \-s ", " \-\-sign
39 Make a signature. See
40 .BR gpg (1).
41 .TP
42 .BR \-r ", " \-\-recipient " \fIUSER\fR"
43 Encrypt for user id \fIUSER\fR. See
44 .BR gpg (1).
45 .TP
46 .BR \-u ", " \-\-local\-user " \fIUSER\fR"
47 Use \fIUSER\fR as the key to sign with. See
48 .BR gpg (1).
49 .TP
50 .B \-\-list\-archive
51 List the contents of the specified archive.
52 .TP
53 .BR \-o ", " \-\-output " " \fIFILE\fR"
54 Write output to specified file
55 .IR FILE .
56 .TP
57 .BI \-\-gpg " GPG"
58 Use the specified command instead of
59 .BR gpg .
60 .TP
61 .BI \-\-gpg\-args " ARGS"
62 Pass the specified options to
63 .BR gpg (1).
64 .TP
65 .BI \-\-tar " TAR"
66 Use the specified command instead of
67 .BR tar .
68 .TP
69 .BI \-\-tar\-args " ARGS"
70 Pass the specified options to 
71 .BR tar (1).
72 .TP
73 .BR \-h ", " \-\-help
74 Output a short usage information.
75 .TP
76 .B \-\-version
77 Output the program version.
78
79 .SH DIAGNOSTICS
80 The program returns \fB0\fR if everything was fine, \fB1\fR otherwise.
81
82 .SH EXAMPLES
83 Encrypt the contents of directory \fImydocs\fR for user Bob to file \fItest1\fR:
84 .IP
85 .B gpg\-zip \-\-encrypt \-\-output test1 \-\-gpg-args ""\-r Bob"" mydocs
86 .PP
87 List the contents of archive \fItest1\fR:
88 .IP
89 .B gpg\-zip \-\-list\-archive test1
90
91 .SH SEE ALSO
92 .BR gpg (1),
93 .BR tar (1)
94
95 .SH AUTHOR
96 Copyright (C) 2005 Free Software Foundation, Inc. Please report bugs to
97 <\&bug-gnupg@gnu.org\&>.
98
99 This manpage was written by \fBColin Tuckley\fR <\&colin@tuckley.org\&>
100 and \fBDaniel Leidert\fR <\&daniel.leidert@wgdd.de\&> for the Debian
101 distribution (but may be used by others).
102