1GPGTAR(1) GNU Privacy Guard 2.4 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. If no file
30 name is given (or it is "-") the archive is taken from stdin.
31 --encrypt
34 -e Encrypt given files and directories into an archive. This op‐
35 tion may be combined with option --symmetric for an archive that
36 may be decrypted via a secret key or a passphrase.
37 --decrypt
40 -d Extract all files from an encrypted archive. If no file name
41 is given (or it is "-") the archive is taken from stdin.
42 --sign
45 -s Make a signed archive from the given files and directories.
46 This can be combined with option --encrypt to create a signed
47 and then encrypted archive.
48 --list-archive
51 -t List the contents of the specified archive. If no file name is
52 given (or it is "-") the archive is taken from stdin.
53 --symmetric
56 -c Encrypt with a symmetric cipher using a passphrase. The default
57 symmetric cipher used is AES-128, but may be chosen with the
58 --cipher-algo option to gpg.
59 --recipient user
62 -r user
63 Encrypt for user id user. For details see gpg.
64 --local-user user
67 -u user
68 Use user as the key to sign with. For details see gpg.
69 --output file
72 -o file
73 Write the archive to the specified file file.
74 --verbose
77 -v Enable extra informational output.
78 --quiet
81 -q Try to be as quiet as possible.
82 --skip-crypto
85 Skip all crypto operations and create or extract vanilla ``us‐
86 tar'' archives.
87 --dry-run
90 Do not actually output the extracted files.
91 --directory dir
94 -C dir Extract the files into the directory dir. The default is to
95 take the directory name from the input filename. If no input
96 filename is known a directory named ‘GPGARCH’ is used. For tar‐
97 ball creation, switch to directory dir before performing any op‐
98 erations.
99 --files-from file
102 -T file
103 Take the file names to work from the file file; one file per
104 line.
105 --null Modify option --files-from to use a binary nul instead of a
108 linefeed to separate file names.
109 --utf8-strings
112 Assume that the file names read by --files-from are UTF-8 en‐
113 coded. This option has an effect only on Windows where the ac‐
114 tive code page is otherwise assumed.
115 --openpgp
118 This option has no effect because OpenPGP encryption and signing
119 is the default.
120 --cms This option is reserved and shall not be used. It will eventu‐
123 ally be used to encrypt or sign using the CMS protocol; but that
124 is not yet implemented.
125 --batch
128 Use batch mode. Never ask but use the default action. This op‐
129 tion is passed directly to gpg.
130 --yes Assume "yes" on most questions. Often used together with
133 --batch to overwrite existing files. This option is passed di‐
134 rectly to gpg.
135 --no Assume "no" on most questions. This option is passed directly
138 to gpg.
139 --require-compliance
142 This option is passed directly to gpg.
143 --status-fd n
146 Write special status strings to the file descriptor n. See the
147 file DETAILS in the documentation for a listing of them.
148 --with-log
151 When extracting an encrypted tarball also write a log file with
152 the gpg output to a file named after the extraction directory
153 with the suffix ".log".
154 --set-filename file
157 Use the last component of file as the output directory. The de‐
158 fault is to take the directory name from the input filename. If
159 no input filename is known a directory named ‘GPGARCH’ is used.
160 This option is deprecated in favor of option --directory.
161 --no-compress
164 This option tells gpg to disable compression (i.e. using option
165 -z0). It is useful for archiving only large files which are are
166 already compressed (e.g. a set of videos).
167 --gpg gpgcmd
170 Use the specified command gpgcmd instead of gpg.
171 --gpg-args args
174 Pass the specified extra options to gpg.
175 --tar-args args
178 Assume args are standard options of the command tar and parse
179 them. The only supported tar options are "--directory",
180 "--files-from", and "--null" This is an obsolete options because
181 those supported tar options can also be given directly.
182 --tar command
185 This is a dummy option for backward compatibility.
186 --version
189 Print version of the program and exit.
190 --help Display a brief help page and exit.
193
196 Encrypt the contents of directory ‘mydocs’ for user Bob to file
197 ‘test1’:
198 gpgtar --encrypt --output test1 -r Bob mydocs
200 List the contents of archive ‘test1’:
203 gpgtar --list-archive test1
205
209 The program returns 0 if everything was fine, 1 otherwise.
210
214 gpg(1), tar(1),
215 The full documentation for this tool is maintained as a Texinfo manual.
217 If GnuPG and the info program are properly installed at your site, the
218 command
219 info gnupg
221 should give you access to the complete manual including a menu struc‐
223 ture and an index.
224GnuPG 2.4.3 2023-06-21 GPGTAR(1)