man-pages/man1/gpgtar.1.html
2021-03-31 01:06:50 +01:00

307 lines
6.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of GPGTAR</TITLE>
</HEAD><BODY>
<H1>GPGTAR</H1>
Section: GNU Privacy Guard 2.2 (1)<BR>Updated: 2019-11-23<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
<B>gpgtar</B>
- Encrypt or sign files into an archive
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>gpgtar</B>
[<I>options</I>]
<I>filename1</I>
<I>[ filename2, ... ]</I>
<I>directory1</I>
<I>[ directory2, ... ]</I>
<P>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>gpgtar</B> encrypts or signs files into an archive. It is an
gpg-ized tar using the same format as used by PGP's PGP Zip.
<P>
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
<B>gpgtar</B> understands these options:
<P>
<P>
<DL COMPACT>
<DT id="1"><B>--create</B>
<DD>
Put given files and directories into a vanilla ``ustar'' archive.
<P>
<DT id="2"><B>--extract</B>
<DD>
Extract all files from a vanilla ``ustar'' archive.
<P>
<DT id="3"><B>--encrypt</B>
<DD>
<B>-e</B>
Encrypt given files and directories into an archive. This option may
be combined with option <B>--symmetric</B> for an archive that may
be decrypted via a secret key or a passphrase.
<P>
<DT id="4"><B>--decrypt</B>
<DD>
<B>-d</B>
Extract all files from an encrypted archive.
<P>
<DT id="5"><B>--sign</B>
<DD>
<B>-s</B>
Make a signed archive from the given files and directories. This can
be combined with option <B>--encrypt</B> to create a signed and then
encrypted archive.
<P>
<DT id="6"><B>--list-archive</B>
<DD>
<B>-t</B>
List the contents of the specified archive.
<P>
<DT id="7"><B>--symmetric</B>
<DD>
<B>-c</B>
Encrypt with a symmetric cipher using a passphrase. The default
symmetric cipher used is AES-128, but may be chosen with the
<B>--cipher-algo</B> option to <B>gpg</B>.
<P>
<DT id="8"><B>--recipient </B><I>user</I>
<DD>
<B>-r </B><I>user</I>
Encrypt for user id <I>user</I>. For details see <B>gpg</B>.
<P>
<DT id="9"><B>--local-user </B><I>user</I>
<DD>
<B>-u </B><I>user</I>
Use <I>user</I> as the key to sign with. For details see <B>gpg</B>.
<P>
<DT id="10"><B>--output </B><I>file</I>
<DD>
<B>-o </B><I>file</I>
Write the archive to the specified file <I>file</I>.
<P>
<DT id="11"><B>--verbose</B>
<DD>
<B>-v</B>
Enable extra informational output.
<P>
<DT id="12"><B>--quiet</B>
<DD>
<B>-q</B>
Try to be as quiet as possible.
<P>
<DT id="13"><B>--skip-crypto</B>
<DD>
Skip all crypto operations and create or extract vanilla ``ustar''
archives.
<P>
<DT id="14"><B>--dry-run</B>
<DD>
Do not actually output the extracted files.
<P>
<DT id="15"><B>--directory </B><I>dir</I>
<DD>
<B>-C </B><I>dir</I>
Extract the files into the directory <I>dir</I>. The default is to
take the directory name from the input filename. If no input filename
is known a directory named '<I>GPGARCH</I>' is used. For tarball
creation, switch to directory <I>dir</I> before performing any
operations.
<P>
<DT id="16"><B>--files-from </B><I>file</I>
<DD>
<B>-T </B><I>file</I>
Take the file names to work from the file <I>file</I>; one file per
line.
<P>
<DT id="17"><B>--null</B>
<DD>
Modify option <B>--files-from</B> to use a binary nul instead of a
linefeed to separate file names.
<P>
<DT id="18"><B>--openpgp</B>
<DD>
This option has no effect because OpenPGP encryption and signing is
the default.
<P>
<DT id="19"><B>--cms</B>
<DD>
This option is reserved and shall not be used. It will eventually be
used to encrypt or sign using the CMS protocol; but that is not yet
implemented.
<P>
<P>
<DT id="20"><B>--set-filename </B><I>file</I>
<DD>
Use the last component of <I>file</I> as the output directory. The
default is to take the directory name from the input filename. If no
input filename is known a directory named '<I>GPGARCH</I>' is used.
This option is deprecated in favor of option <B>--directory</B>.
<P>
<DT id="21"><B>--gpg </B><I>gpgcmd</I>
<DD>
Use the specified command <I>gpgcmd</I> instead of <B>gpg</B>.
<P>
<DT id="22"><B>--gpg-args </B><I>args</I>
<DD>
Pass the specified extra options to <B>gpg</B>.
<P>
<DT id="23"><B>--tar-args </B><I>args</I>
<DD>
Assume <I>args</I> are standard options of the command <B>tar</B>
and parse them. The only supported tar options are &quot;--directory&quot;,
&quot;--files-from&quot;, and &quot;--null&quot; This is an obsolete options because those
supported tar options can also be given directly.
<P>
<DT id="24"><B>--version</B>
<DD>
Print version of the program and exit.
<P>
<DT id="25"><B>--help</B>
<DD>
Display a brief help page and exit.
<P>
</DL>
<P>
<P>
<A NAME="lbAF">&nbsp;</A>
<H2>EXAMPLES</H2>
<P>
Encrypt the contents of directory '<I>mydocs</I>' for user Bob to file
'<I>test1</I>':
<P>
<DL COMPACT><DT id="26"><DD>
<PRE>
gpgtar --encrypt --output test1 -r Bob mydocs
</PRE>
</DL>
<P>
<P>
List the contents of archive '<I>test1</I>':
<P>
<DL COMPACT><DT id="27"><DD>
<PRE>
gpgtar --list-archive test1
</PRE>
</DL>
<P>
<P>
<A NAME="lbAG">&nbsp;</A>
<H2>DIAGNOSTICS</H2>
<P>
The program returns 0 if everything was fine, 1 otherwise.
<P>
<P>
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?1+gpg">gpg</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?1+tar">tar</A></B>(1),
<P>
The full documentation for this tool is maintained as a Texinfo manual.
If GnuPG and the info program are properly installed at your site, the
command
<P>
<DL COMPACT><DT id="28"><DD>
<PRE>
info gnupg
</PRE>
</DL>
<P>
should give you access to the complete manual including a menu structure
and an index.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="29"><A HREF="#lbAB">NAME</A><DD>
<DT id="30"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="31"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="32"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="33"><A HREF="#lbAF">EXAMPLES</A><DD>
<DT id="34"><A HREF="#lbAG">DIAGNOSTICS</A><DD>
<DT id="35"><A HREF="#lbAH">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:15 GMT, March 31, 2021
</BODY>
</HTML>