From 81c5b35dce06313766162ec6a5dc02ec44528f9f Mon Sep 17 00:00:00 2001 From: Brendan Coles Date: Wed, 6 Jan 2021 13:48:09 +0000 Subject: [PATCH] Base: Add tar man page documentation --- Base/usr/share/man/man1/tar.md | 44 ++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 Base/usr/share/man/man1/tar.md diff --git a/Base/usr/share/man/man1/tar.md b/Base/usr/share/man/man1/tar.md new file mode 100644 index 00000000000..036d2c712e2 --- /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) +