1GPGTAR(1) GNU Privacy Guard 2.3 GPGTAR(1)
2
6 gpgtar - Encrypt or sign files into an archive
7
9 gpgtar [options] filename1 [ filename2, ... ] directory1 [ directory2,
10 ... ]
11
14 gpgtar encrypts or signs files into an archive. It is an gpg-ized tar
15 using the same format as used by PGP's PGP Zip.
16
19 gpgtar understands these options:
20 --create
24 Put given files and directories into a vanilla ``ustar'' ar‐
25 chive.
26 --extract
29 Extract all files from a vanilla ``ustar'' archive.
30 --encrypt
33 -e Encrypt given files and directories into an archive. This op‐
34 tion may be combined with option --symmetric for an archive that
35 may be decrypted via a secret key or a passphrase.
36 --decrypt
39 -d Extract all files from an encrypted archive.
40 --sign
43 -s Make a signed archive from the given files and directories.
44 This can be combined with option --encrypt to create a signed
45 and then encrypted archive.
46 --list-archive
49 -t List the contents of the specified archive.
50 --symmetric
53 -c Encrypt with a symmetric cipher using a passphrase. The default
54 symmetric cipher used is AES-128, but may be chosen with the
55 --cipher-algo option to gpg.
56 --recipient user
59 -r user
60 Encrypt for user id user. For details see gpg.
61 --local-user user
64 -u user
65 Use user as the key to sign with. For details see gpg.
66 --output file
69 -o file
70 Write the archive to the specified file file.
71 --verbose
74 -v Enable extra informational output.
75 --quiet
78 -q Try to be as quiet as possible.
79 --skip-crypto
82 Skip all crypto operations and create or extract vanilla ``us‐
83 tar'' archives.
84 --dry-run
87 Do not actually output the extracted files.
88 --directory dir
91 -C dir Extract the files into the directory dir. The default is to
92 take the directory name from the input filename. If no input
93 filename is known a directory named ‘GPGARCH’ is used. For tar‐
94 ball creation, switch to directory dir before performing any op‐
95 erations.
96 --files-from file
99 -T file
100 Take the file names to work from the file file; one file per
101 line.
102 --null Modify option --files-from to use a binary nul instead of a
105 linefeed to separate file names.
106 --utf8-strings
109 Assume that the file names read by --files-from are UTF-8 en‐
110 coded. This option has an effect only on Windows where the ac‐
111 tive code page is otherwise assumed.
112 --openpgp
115 This option has no effect because OpenPGP encryption and signing
116 is the default.
117 --cms This option is reserved and shall not be used. It will eventu‐
120 ally be used to encrypt or sign using the CMS protocol; but that
121 is not yet implemented.
122 --batch
125 Use batch mode. Never ask but use the default action. This op‐
126 tion is passed directly to gpg.
127 --yes Assume "yes" on most questions. Often used together with
130 --batch to overwrite existing files. This option is passed di‐
131 rectly to gpg.
132 --no Assume "no" on most questions. This option is passed directly
135 to gpg.
136 --require-compliance
139 This option is passed directly to gpg.
140 --status-fd n
143 Write special status strings to the file descriptor n. See the
144 file DETAILS in the documentation for a listing of them.
145 --with-log
148 When extracting an encrypted tarball also write a log file with
149 the gpg output to a file named after the extraction directory
150 with the suffix ".log".
151 --set-filename file
154 Use the last component of file as the output directory. The de‐
155 fault is to take the directory name from the input filename. If
156 no input filename is known a directory named ‘GPGARCH’ is used.
157 This option is deprecated in favor of option --directory.
158 --gpg gpgcmd
161 Use the specified command gpgcmd instead of gpg.
162 --gpg-args args
165 Pass the specified extra options to gpg.
166 --tar-args args
169 Assume args are standard options of the command tar and parse
170 them. The only supported tar options are "--directory",
171 "--files-from", and "--null" This is an obsolete options because
172 those supported tar options can also be given directly.
173 --tar command
176 This is a dummy option for backward compatibility.
177 --version
180 Print version of the program and exit.
181 --help Display a brief help page and exit.
184
187 Encrypt the contents of directory ‘mydocs’ for user Bob to file
188 ‘test1’:
189 gpgtar --encrypt --output test1 -r Bob mydocs
191 List the contents of archive ‘test1’:
194 gpgtar --list-archive test1
196
200 The program returns 0 if everything was fine, 1 otherwise.
201
205 gpg(1), tar(1),
206 The full documentation for this tool is maintained as a Texinfo manual.
208 If GnuPG and the info program are properly installed at your site, the
209 command
210 info gnupg
212 should give you access to the complete manual including a menu struc‐
214 ture and an index.
215GnuPG 2.3.8 2022-10-07 GPGTAR(1)