sbase/tar.1

.Dd October 8, 2015
.Dt TAR 1
.Os sbase
.Sh NAME
.Nm tar
.Nd create, list or extract a tape archive
.Sh SYNOPSIS
.Nm
.Op Fl C Ar dir
.Op Fl J | Fl Z | Fl a | Fl j | Fl z
.Fl x Op Fl m | Fl t
.Op Fl f Ar file
.Op Ar file ...
.Nm
.Op Fl C Ar dir
.Op Fl J | Fl Z | Fl a | Fl j | Fl z
.Op Fl h
.Fl c Ar path ...
.Op Fl f Ar file
.Sh DESCRIPTION
.Nm
is the standard file archiver.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl c Ar path ...
Create archive from
.Ar path .
.It Fl C Ar dir
Change directory to
.Ar dir
before beginning.
.It Fl f Ar file
Set
.Ar file
as input | output archive instead of stdin | stdout.
If '-', stdin | stdout is used.
.It Fl m
Do not preserve modification time.
.It Fl t
List all files in the archive.
.It Fl x
Extract archive.
.It Fl h
Always dereference symbolic links while recursively traversing directories.
.It Fl J | Fl Z | Fl a | Fl j | Fl z
Use xz | compress | lzma | bzip2 | gzip compression or decompression.
These utilities must be installed separately.
Using these flags is discouraged in favour of the flexibility
and clarity of pipes:
.Bd -literal -offset indent
$ bzip2 -cd archive.tar.bz2 | tar -x
$ gzip -cd archive.tar.gz | tar -x
.Ed
.Bd -literal -offset indent
$ tar -c file ... | bzip2 > archive.tar.bz2
$ tar -c file ... | gzip2 > archive.tar.gz
.Ed
.El
.Sh SEE ALSO
.Xr ar 1 ,
.Xr bzip2 1 ,
.Xr gzip 1
.Sh STANDARDS
The
.Nm
utility is compliant with the UStar (Uniform Standard Tape ARchive)
format defined in the
.St -p1003.1-88
specification.
fix: update man pages to standard mdoc date format When viewing sbase's man pages the date displayed at the bottom is the current date rather than the date entered in the <program>.1 file. According to this: https://mandoc.bsd.lv/mdoc/details/date.html The traditional man date format used by sbase (.Dd year-month-day) is no longer recommended and no longer supported by GNU troff or Heirloom Docs and as a result the current date is displayed instead. Although this format is still accepted by mandoc for backward compatibility. For portability it states the standard mdoc date format should be used instead: .Dd month day, year I applied the following patch to sbase's last commit b30fb56 and it fixes the issue. 2024-09-07 22:57:31 +00:00			`.Dd October 8, 2015`
remove sbase-VERSION from man page, fix sponge.1 date 2015-01-31 13:20:02 +00:00			`.Dt TAR 1`
Add .Os sbase and sed replace to .Os sbase $(VERSION) in make install 2015-01-31 19:37:03 +00:00			`.Os sbase`
tar.1: convert to mandoc - simplify usage line. - add new flags (-m, -j and -z). - fix typos. 2015-01-31 13:05:23 +00:00			`.Sh NAME`
			`.Nm tar`
			`.Nd create, list or extract a tape archive`
			`.Sh SYNOPSIS`
			`.Nm`
			`.Op Fl C Ar dir`
tar: add support for compressing with an external tool ... and add xz, compress and lzma as options 2015-05-08 10:43:33 +00:00			`.Op Fl J \| Fl Z \| Fl a \| Fl j \| Fl z`
Refactor tar(1) manpage and mark it as finished in the README. Specifically, add a small section on the compression flags, which are basically an infected GNU limb which should be removed from the face of the earth as soon as possible. 2015-02-08 22:16:27 +00:00			`.Fl x Op Fl m \| Fl t`
			`.Op Fl f Ar file`
tar: Briefly update manpage and usage for the latest changes 2015-04-21 14:35:05 +00:00			`.Op Ar file ...`
tar.1: convert to mandoc - simplify usage line. - add new flags (-m, -j and -z). - fix typos. 2015-01-31 13:05:23 +00:00			`.Nm`
			`.Op Fl C Ar dir`
tar: add support for compressing with an external tool ... and add xz, compress and lzma as options 2015-05-08 10:43:33 +00:00			`.Op Fl J \| Fl Z \| Fl a \| Fl j \| Fl z`
tar.1: add symbolic link dereferencing to manpage 2015-02-09 21:42:56 +00:00			`.Op Fl h`
tar: Briefly update manpage and usage for the latest changes 2015-04-21 14:35:05 +00:00			`.Fl c Ar path ...`
Refactor tar(1) manpage and mark it as finished in the README. Specifically, add a small section on the compression flags, which are basically an infected GNU limb which should be removed from the face of the earth as soon as possible. 2015-02-08 22:16:27 +00:00			`.Op Fl f Ar file`
tar.1: convert to mandoc - simplify usage line. - add new flags (-m, -j and -z). - fix typos. 2015-01-31 13:05:23 +00:00			`.Sh DESCRIPTION`
			`.Nm`
Refactor tar(1) manpage and mark it as finished in the README. Specifically, add a small section on the compression flags, which are basically an infected GNU limb which should be removed from the face of the earth as soon as possible. 2015-02-08 22:16:27 +00:00			`is the standard file archiver.`
tar.1: convert to mandoc - simplify usage line. - add new flags (-m, -j and -z). - fix typos. 2015-01-31 13:05:23 +00:00			`.Sh OPTIONS`
			`.Bl -tag -width Ds`
tar: Briefly update manpage and usage for the latest changes 2015-04-21 14:35:05 +00:00			`.It Fl c Ar path ...`
Refactor tar(1) manpage and mark it as finished in the README. Specifically, add a small section on the compression flags, which are basically an infected GNU limb which should be removed from the face of the earth as soon as possible. 2015-02-08 22:16:27 +00:00			`Create archive from`
tar.1: convert to mandoc - simplify usage line. - add new flags (-m, -j and -z). - fix typos. 2015-01-31 13:05:23 +00:00			`.Ar path .`
			`.It Fl C Ar dir`
			`Change directory to`
			`.Ar dir`
			`before beginning.`
Refactor tar(1) manpage and mark it as finished in the README. Specifically, add a small section on the compression flags, which are basically an infected GNU limb which should be removed from the face of the earth as soon as possible. 2015-02-08 22:16:27 +00:00			`.It Fl f Ar file`
			`Set`
			`.Ar file`
Fix various lint warnings in manuals Fix "new sentence, new line" warnings throughout so that formatters can produce correct spacing between sentences. join.1 Remove unnecessary Ns macros. These are not necessary for delimeters, which get special treatment. xinstall.1 Fix date in manual. The contents were last modified on 2016-12-03, so use that instead of the invalid date. grep.1 Fix escape sequence for `\<` and `\>`. ed.1 Remove spurious `\\n` escape for the null-command. 2020-03-01 22:37:31 +00:00			`as input \| output archive instead of stdin \| stdout.`
			`If '-', stdin \| stdout is used.`
tar.1: convert to mandoc - simplify usage line. - add new flags (-m, -j and -z). - fix typos. 2015-01-31 13:05:23 +00:00			`.It Fl m`
			`Do not preserve modification time.`
			`.It Fl t`
Refactor tar(1) manpage and mark it as finished in the README. Specifically, add a small section on the compression flags, which are basically an infected GNU limb which should be removed from the face of the earth as soon as possible. 2015-02-08 22:16:27 +00:00			`List all files in the archive.`
tar.1: convert to mandoc - simplify usage line. - add new flags (-m, -j and -z). - fix typos. 2015-01-31 13:05:23 +00:00			`.It Fl x`
Refactor tar(1) manpage and mark it as finished in the README. Specifically, add a small section on the compression flags, which are basically an infected GNU limb which should be removed from the face of the earth as soon as possible. 2015-02-08 22:16:27 +00:00			`Extract archive.`
tar.1: add symbolic link dereferencing to manpage 2015-02-09 21:42:56 +00:00			`.It Fl h`
			`Always dereference symbolic links while recursively traversing directories.`
tar: add support for compressing with an external tool ... and add xz, compress and lzma as options 2015-05-08 10:43:33 +00:00			`.It Fl J \| Fl Z \| Fl a \| Fl j \| Fl z`
Fix various lint warnings in manuals Fix "new sentence, new line" warnings throughout so that formatters can produce correct spacing between sentences. join.1 Remove unnecessary Ns macros. These are not necessary for delimeters, which get special treatment. xinstall.1 Fix date in manual. The contents were last modified on 2016-12-03, so use that instead of the invalid date. grep.1 Fix escape sequence for `\<` and `\>`. ed.1 Remove spurious `\\n` escape for the null-command. 2020-03-01 22:37:31 +00:00			`Use xz \| compress \| lzma \| bzip2 \| gzip compression or decompression.`
			`These utilities must be installed separately.`
Refactor tar(1) manpage and mark it as finished in the README. Specifically, add a small section on the compression flags, which are basically an infected GNU limb which should be removed from the face of the earth as soon as possible. 2015-02-08 22:16:27 +00:00			`Using these flags is discouraged in favour of the flexibility`
			`and clarity of pipes:`
			`.Bd -literal -offset indent`
tar: add support for compressing with an external tool ... and add xz, compress and lzma as options 2015-05-08 10:43:33 +00:00			`$ bzip2 -cd archive.tar.bz2 \| tar -x`
			`$ gzip -cd archive.tar.gz \| tar -x`
Refactor tar(1) manpage and mark it as finished in the README. Specifically, add a small section on the compression flags, which are basically an infected GNU limb which should be removed from the face of the earth as soon as possible. 2015-02-08 22:16:27 +00:00			`.Ed`
			`.Bd -literal -offset indent`
			`$ tar -c file ... \| bzip2 > archive.tar.bz2`
			`$ tar -c file ... \| gzip2 > archive.tar.gz`
			`.Ed`
tar.1: convert to mandoc - simplify usage line. - add new flags (-m, -j and -z). - fix typos. 2015-01-31 13:05:23 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr ar 1 ,`
			`.Xr bzip2 1 ,`
			`.Xr gzip 1`
Refactor tar(1) manpage and mark it as finished in the README. Specifically, add a small section on the compression flags, which are basically an infected GNU limb which should be removed from the face of the earth as soon as possible. 2015-02-08 22:16:27 +00:00			`.Sh STANDARDS`
			`The`
			`.Nm`
			`utility is compliant with the UStar (Uniform Standard Tape ARchive)`
			`format defined in the`
			`.St -p1003.1-88`
			`specification.`