diff options
author | Brendan Coles <bcoles@gmail.com> | 2021-01-06 13:48:09 +0000 |
---|---|---|
committer | Andreas Kling <kling@serenityos.org> | 2021-01-06 15:40:26 +0100 |
commit | 81c5b35dce06313766162ec6a5dc02ec44528f9f (patch) | |
tree | a27a4a1816608e599d89aea26cf39bff4297db95 /Base/usr/share | |
parent | 612827eff3c19af06bd13de99d204b720e576d6e (diff) | |
download | serenity-81c5b35dce06313766162ec6a5dc02ec44528f9f.zip |
Base: Add tar man page documentation
Diffstat (limited to 'Base/usr/share')
-rw-r--r-- | Base/usr/share/man/man1/tar.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/Base/usr/share/man/man1/tar.md b/Base/usr/share/man/man1/tar.md new file mode 100644 index 0000000000..036d2c712e --- /dev/null +++ b/Base/usr/share/man/man1/tar.md @@ -0,0 +1,44 @@ +## Name + +tar - file archiving utility + +## Synopsis + +```**sh +$ tar [--create] [--extract] [--list] [--verbose] [--gzip] [--file FILE] [PATHS...] +``` + +## Description + +tar is an archiving utility designed to store multiple files in an archive file +(tarball). + +Files may also be compressed and decompressed using GNU Zip (GZIP) compression. + +## Options + +* `-c`, `--create`: Create archive +* `-x`, `--extract`: Extract archive +* `-t`, `--list`: List contents +* `-v`, `--verbose`: Print paths +* `-z`, `--gzip`: compress or uncompress file using gzip +* `-f`, `--file`: Archive file + +## Examples + +```sh +# List the contents of archive.tar +$ tar -t -f archive.tar + +# Extract the contents from archive.tar.gz +$ tar -x -z -f archive.tar.gz + +# Extract the contents from archive.tar +$ tar -x -f archive.tar +``` + +## See also + +* [`gunzip`(1)](gunzip.md) +* [`unzip`(1)](unzip.md) + |