{ "content": [ { "type": "text", "text": "# gpgtar(1) (man)\n\n**Summary:** gpgtar - Encrypt or sign files into an archive\n\n**Synopsis:** gpgtar [options] filename1 [ filename2, ... ] directory1 [ directory2, ... ]\n\n## Flags\n\n| Flag | Long | Arg | Description |\n|------|------|-----|-------------|\n| — | --create | — | Put given files and directories into a vanilla ``ustar'' archive. |\n| — | --extract | — | Extract all files from a vanilla ``ustar'' archive. |\n| — | --encrypt | — | |\n| -e | — | — | option --symmetric for an archive that may be decrypted via a secret key or a passphrase. |\n| — | --decrypt | — | |\n| -d | — | — | |\n| — | --sign | — | |\n| -s | — | — | option --encrypt to create a signed and then encrypted archive. |\n| — | --list-archive | — | |\n| -t | — | — | |\n| — | --symmetric | — | |\n| -c | — | — | is AES-128, but may be chosen with the --cipher-algo option to gpg. --recipient user |\n| -r | — | — | Encrypt for user id user. For details see gpg. --local-user user |\n| -u | — | — | Use user as the key to sign with. For details see gpg. --output file |\n| -o | — | — | Write the archive to the specified file file. |\n| — | --verbose | — | |\n| -v | — | — | |\n| — | --quiet | — | |\n| -q | — | — | |\n| — | --skip-crypto | — | Skip all crypto operations and create or extract vanilla ``ustar'' archives. |\n| — | --dry-run | — | Do not actually output the extracted files. --directory dir |\n| -C | — | — | from the input filename. If no input filename is known a directory named ‘GPGARCH’ is used. For tarball creation, switch |\n| -T | — | — | Take the file names to work from the file file; one file per line. --null Modify option --files-from to use a binary nul |\n| — | --utf8-strings | — | Assume that the file names read by --files-from are UTF-8 encoded. This option has an effect only on Windows where the a |\n| — | --openpgp | — | This option has no effect because OpenPGP encryption and signing is the default. --cms This option is reserved and shall |\n| — | --version | — | Print version of the program and exit. --help Display a brief help page and exit. |\n\n## Examples\n\n- `Encrypt the contents of directory ‘mydocs’ for user Bob to file ‘test1’:`\n- `gpgtar --encrypt --output test1 -r Bob mydocs`\n- `List the contents of archive ‘test1’:`\n- `gpgtar --list-archive test1`\n\n## See Also\n\n- gpg(1)\n- tar(1)\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (3 lines)\n- **DESCRIPTION** (4 lines)\n- **OPTIONS** (4 lines) — 26 subsections\n - --create (3 lines)\n - --extract (3 lines)\n - --encrypt (1 lines)\n - -e (4 lines)\n - --decrypt (1 lines)\n - -d (1 lines)\n - --sign (1 lines)\n - -s (3 lines)\n - --list-archive (1 lines)\n - -t (1 lines)\n - --symmetric (1 lines)\n - -c (4 lines)\n - -r (4 lines)\n - -u (4 lines)\n - -o (3 lines)\n - --verbose (1 lines)\n - -v (1 lines)\n - --quiet (1 lines)\n - -q (1 lines)\n - --skip-crypto (3 lines)\n - --dry-run (4 lines)\n - -C (5 lines)\n - -T (7 lines)\n - --utf8-strings (4 lines)\n - --openpgp (28 lines)\n - --version (6 lines)\n- **EXAMPLES** (11 lines)\n- **DIAGNOSTICS** (4 lines)\n- **SEE ALSO** (12 lines)\n\n## Full Content\n\n### NAME\n\ngpgtar - Encrypt or sign files into an archive\n\n### SYNOPSIS\n\ngpgtar [options] filename1 [ filename2, ... ] directory1 [ directory2, ... ]\n\n### DESCRIPTION\n\ngpgtar encrypts or signs files into an archive. It is an gpg-ized tar using the same format\nas used by PGP's PGP Zip.\n\n### OPTIONS\n\ngpgtar understands these options:\n\n#### --create\n\nPut given files and directories into a vanilla ``ustar'' archive.\n\n#### --extract\n\nExtract all files from a vanilla ``ustar'' archive.\n\n#### --encrypt\n\n#### -e\n\noption --symmetric for an archive that may be decrypted via a secret key or a\npassphrase.\n\n#### --decrypt\n\n#### -d\n\n#### --sign\n\n#### -s\n\noption --encrypt to create a signed and then encrypted archive.\n\n#### --list-archive\n\n#### -t\n\n#### --symmetric\n\n#### -c\n\nis AES-128, but may be chosen with the --cipher-algo option to gpg.\n\n\n--recipient user\n\n#### -r\n\nEncrypt for user id user. For details see gpg.\n\n\n--local-user user\n\n#### -u\n\nUse user as the key to sign with. For details see gpg.\n\n\n--output file\n\n#### -o\n\nWrite the archive to the specified file file.\n\n#### --verbose\n\n#### -v\n\n#### --quiet\n\n#### -q\n\n#### --skip-crypto\n\nSkip all crypto operations and create or extract vanilla ``ustar'' archives.\n\n#### --dry-run\n\nDo not actually output the extracted files.\n\n\n--directory dir\n\n#### -C\n\nfrom the input filename. If no input filename is known a directory named ‘GPGARCH’ is\nused. For tarball creation, switch to directory dir before performing any operations.\n\n\n--files-from file\n\n#### -T\n\nTake the file names to work from the file file; one file per line.\n\n\n--null Modify option --files-from to use a binary nul instead of a linefeed to separate file\nnames.\n\n#### --utf8-strings\n\nAssume that the file names read by --files-from are UTF-8 encoded. This option has an\neffect only on Windows where the active code page is otherwise assumed.\n\n#### --openpgp\n\nThis option has no effect because OpenPGP encryption and signing is the default.\n\n\n--cms This option is reserved and shall not be used. It will eventually be used to encrypt\nor sign using the CMS protocol; but that is not yet implemented.\n\n\n\n--set-filename file\nUse the last component of file as the output directory. The default is to take the\ndirectory name from the input filename. If no input filename is known a directory\nnamed ‘GPGARCH’ is used. This option is deprecated in favor of option --directory.\n\n\n--gpg gpgcmd\nUse the specified command gpgcmd instead of gpg.\n\n\n--gpg-args args\nPass the specified extra options to gpg.\n\n\n--tar-args args\nAssume args are standard options of the command tar and parse them. The only sup‐\nported tar options are \"--directory\", \"--files-from\", and \"--null\" This is an obsolete\noptions because those supported tar options can also be given directly.\n\n#### --version\n\nPrint version of the program and exit.\n\n\n--help Display a brief help page and exit.\n\n### EXAMPLES\n\nEncrypt the contents of directory ‘mydocs’ for user Bob to file ‘test1’:\n\ngpgtar --encrypt --output test1 -r Bob mydocs\n\n\nList the contents of archive ‘test1’:\n\ngpgtar --list-archive test1\n\n### DIAGNOSTICS\n\nThe program returns 0 if everything was fine, 1 otherwise.\n\n### SEE ALSO\n\ngpg(1), tar(1),\n\nThe full documentation for this tool is maintained as a Texinfo manual. If GnuPG and the\ninfo program are properly installed at your site, the command\n\ninfo gnupg\n\nshould give you access to the complete manual including a menu structure and an index.\n\n\n\nGnuPG 2.2.27 2020-12-21 GPGTAR(1)\n\n" } ], "structuredContent": { "command": "gpgtar", "section": "1", "mode": "man", "summary": "gpgtar - Encrypt or sign files into an archive", "synopsis": "gpgtar [options] filename1 [ filename2, ... ] directory1 [ directory2, ... ]", "flags": [ { "flag": "", "long": "--create", "arg": null, "description": "Put given files and directories into a vanilla ``ustar'' archive." }, { "flag": "", "long": "--extract", "arg": null, "description": "Extract all files from a vanilla ``ustar'' archive." }, { "flag": "", "long": "--encrypt", "arg": null, "description": "" }, { "flag": "-e", "long": null, "arg": null, "description": "option --symmetric for an archive that may be decrypted via a secret key or a passphrase." }, { "flag": "", "long": "--decrypt", "arg": null, "description": "" }, { "flag": "-d", "long": null, "arg": null, "description": "" }, { "flag": "", "long": "--sign", "arg": null, "description": "" }, { "flag": "-s", "long": null, "arg": null, "description": "option --encrypt to create a signed and then encrypted archive." }, { "flag": "", "long": "--list-archive", "arg": null, "description": "" }, { "flag": "-t", "long": null, "arg": null, "description": "" }, { "flag": "", "long": "--symmetric", "arg": null, "description": "" }, { "flag": "-c", "long": null, "arg": null, "description": "is AES-128, but may be chosen with the --cipher-algo option to gpg. --recipient user" }, { "flag": "-r", "long": null, "arg": null, "description": "Encrypt for user id user. For details see gpg. --local-user user" }, { "flag": "-u", "long": null, "arg": null, "description": "Use user as the key to sign with. For details see gpg. --output file" }, { "flag": "-o", "long": null, "arg": null, "description": "Write the archive to the specified file file." }, { "flag": "", "long": "--verbose", "arg": null, "description": "" }, { "flag": "-v", "long": null, "arg": null, "description": "" }, { "flag": "", "long": "--quiet", "arg": null, "description": "" }, { "flag": "-q", "long": null, "arg": null, "description": "" }, { "flag": "", "long": "--skip-crypto", "arg": null, "description": "Skip all crypto operations and create or extract vanilla ``ustar'' archives." }, { "flag": "", "long": "--dry-run", "arg": null, "description": "Do not actually output the extracted files. --directory dir" }, { "flag": "-C", "long": null, "arg": null, "description": "from the input filename. If no input filename is known a directory named ‘GPGARCH’ is used. For tarball creation, switch to directory dir before performing any operations. --files-from file" }, { "flag": "-T", "long": null, "arg": null, "description": "Take the file names to work from the file file; one file per line. --null Modify option --files-from to use a binary nul instead of a linefeed to separate file names." }, { "flag": "", "long": "--utf8-strings", "arg": null, "description": "Assume that the file names read by --files-from are UTF-8 encoded. This option has an effect only on Windows where the active code page is otherwise assumed." }, { "flag": "", "long": "--openpgp", "arg": null, "description": "This option has no effect because OpenPGP encryption and signing is the default. --cms 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. --set-filename file Use the last component of file 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 ‘GPGARCH’ is used. This option is deprecated in favor of option --directory. --gpg gpgcmd Use the specified command gpgcmd instead of gpg. --gpg-args args Pass the specified extra options to gpg. --tar-args args Assume args are standard options of the command tar and parse them. The only sup‐ ported tar options are \"--directory\", \"--files-from\", and \"--null\" This is an obsolete options because those supported tar options can also be given directly." }, { "flag": "", "long": "--version", "arg": null, "description": "Print version of the program and exit. --help Display a brief help page and exit." } ], "examples": [ "Encrypt the contents of directory ‘mydocs’ for user Bob to file ‘test1’:", "gpgtar --encrypt --output test1 -r Bob mydocs", "List the contents of archive ‘test1’:", "gpgtar --list-archive test1" ], "see_also": [ { "name": "gpg", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/gpg/1/json" }, { "name": "tar", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/tar/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 3, "subsections": [] }, { "name": "DESCRIPTION", "lines": 4, "subsections": [] }, { "name": "OPTIONS", "lines": 4, "subsections": [ { "name": "--create", "lines": 3, "long": "--create" }, { "name": "--extract", "lines": 3, "long": "--extract" }, { "name": "--encrypt", "lines": 1, "long": "--encrypt" }, { "name": "-e", "lines": 4, "flag": "-e" }, { "name": "--decrypt", "lines": 1, "long": "--decrypt" }, { "name": "-d", "lines": 1, "flag": "-d" }, { "name": "--sign", "lines": 1, "long": "--sign" }, { "name": "-s", "lines": 3, "flag": "-s" }, { "name": "--list-archive", "lines": 1, "long": "--list-archive" }, { "name": "-t", "lines": 1, "flag": "-t" }, { "name": "--symmetric", "lines": 1, "long": "--symmetric" }, { "name": "-c", "lines": 4, "flag": "-c" }, { "name": "-r", "lines": 4, "flag": "-r" }, { "name": "-u", "lines": 4, "flag": "-u" }, { "name": "-o", "lines": 3, "flag": "-o" }, { "name": "--verbose", "lines": 1, "long": "--verbose" }, { "name": "-v", "lines": 1, "flag": "-v" }, { "name": "--quiet", "lines": 1, "long": "--quiet" }, { "name": "-q", "lines": 1, "flag": "-q" }, { "name": "--skip-crypto", "lines": 3, "long": "--skip-crypto" }, { "name": "--dry-run", "lines": 4, "long": "--dry-run" }, { "name": "-C", "lines": 5, "flag": "-C" }, { "name": "-T", "lines": 7, "flag": "-T" }, { "name": "--utf8-strings", "lines": 4, "long": "--utf8-strings" }, { "name": "--openpgp", "lines": 28, "long": "--openpgp" }, { "name": "--version", "lines": 6, "long": "--version" } ] }, { "name": "EXAMPLES", "lines": 11, "subsections": [] }, { "name": "DIAGNOSTICS", "lines": 4, "subsections": [] }, { "name": "SEE ALSO", "lines": 12, "subsections": [] } ] } }