sbase/tar.1
Hiltjo Posthuma a0998d0252 sbase: improve man pages and some warnings.
From ed5e4d34a16436a37c0e084666fcfb77cc4859c3 Mon Sep 17 00:00:00 2001
From: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Thu, 31 Jul 2025 14:42:59 +0200
Subject: [PATCH 4/4] improve man pages and some warnings.

Checking for warnings: mandoc -Tlint *.1

- Swap .St -p1003.1-2013 macro with text:
  mdoc does not support this macro and some texts were changed, like commit
  d4dfd42d3580ad36bedfdc5b8924ff6683981f53
- Typo fixes:
  exeption -> exception.
- xargs.1: document -P extension.
- sed.1: remove use of .Pp of .Ss.
- Wrap lines to less than 80 characters and use a new sentence for each line.
- find.1: Xr reference C library functions.
2025-09-19 09:16:25 +02:00

77 lines
1.8 KiB
Groff

.Dd October 8, 2015
.Dt TAR 1
.Os sbase
.Sh NAME
.Nm tar
.Nd create, list or extract a tape archive
.Sh SYNOPSIS
.Nm
.Cm x | Cm t | Fl x | Fl t
.Op Fl C Ar dir
.Op Fl J | Fl Z | Fl a | Fl j | Fl z
.Op Fl m
.Op Fl p
.Op Fl f Ar file
.Op Ar file ...
.Nm
.Cm c | Fl c Op Fl C Ar dir
.Op Fl J | Fl Z | Fl a | Fl j | Fl z
.Op Fl h
.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.
For long file paths (>99 bytes), the UStar, 'L' and 'x' header formats are
supported for reading (to a maximum size of PATH_MAX or 255 bytes, depending on
format), and the 'L' format is supported for writing (with unlimited path
size).
Link targets are limited to the UStar maximum of 100 bytes.