Skip to content

Commit

Permalink
Merge pull request #296 from Tarsnap/man-clarifications
Browse files Browse the repository at this point in the history
Man page clarifications
  • Loading branch information
cperciva committed Nov 27, 2017
2 parents b6ff809 + de372a0 commit b10062b
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 16 deletions.
43 changes: 35 additions & 8 deletions tar/tarsnap.1-man.in
Expand Up @@ -409,6 +409,10 @@ name of the option.
\fB\--iso-dates\fP
(-t mode only)
Print file and directory dates as yyyy-mm-dd hh:mm:ss.
.PP
The default is to use the same format as 'ls -l': If the files were modified
within the past six months, print the month, day, hour, and minutes; otherwise,
print the month, day, and year.
.TP
\fB\-k\fP
(x mode only)
Expand Down Expand Up @@ -910,14 +914,34 @@ current position and exit (see "INTERRUPTING ARCHIVAL" below).
.RE
.SH PRINTING ARCHIVE STATISTICS
.ad l
Statistics on archives can be printed by running
\fB\%tarsnap\fP
\fB\--print-stats\fP
and during archive creation or deletion statistics on the created or
deleted archive can be printed using the
\fB\--print-stats\fP
option.
In either case,
There are four commands which print statistics about archives:
.RS 5
.IP \(bu
Global statistics:
.RS 4
\fB\%tarsnap\fP \fB\--print-stats\fP
.RE
.IP \(bu
Global statistics and info about specific archive(s):
.RS 4
\fB\%tarsnap\fP \fB\--print-stats\fP \fB\-f\fP \fIarchive-name1\fP [\fB\-f\fP \fI...\fP]
.RE
.IP \(bu
Global statistics and info about all archives:
.RS 4
\fB\%tarsnap\fP \fB\--print-stats\fP \fB\-f\fP \fI'*'\fP
.RE
.IP \(bu
Global statistics and info about the archive(s) that were just created or
deleted:
.RS 4
\fB\%tarsnap\fP \fB\-c\fP \fB\--print-stats\fP \fB\-f\fP \fIarchive-name\fP \fIDIR\fP
.RE
.RS 4
\fB\%tarsnap\fP \fB\-d\fP \fB\--print-stats\fP \fB\-f\fP \fIarchive-name1\fP [\fB\-f\fP \fI...\fP]
.RE
.RE
.PP
\fB\%tarsnap\fP
will print a table in the following format:
.RS 4
Expand Down Expand Up @@ -948,6 +972,9 @@ when the
\fB\--print-stats\fP
option is used while creating or deleting archives, the table is printed
to the standard error device.
.PP
Global statistics are calculated based on the current cache directory, without
using the keyfile or querying the Tarsnap servers.
.SH INTERRUPTING ARCHIVAL
.ad l
Upon receipt of the
Expand Down
33 changes: 25 additions & 8 deletions tar/tarsnap.1-mdoc.in
Expand Up @@ -383,6 +383,10 @@ name of the option.
.It Fl -iso-dates
(-t mode only)
Print file and directory dates as yyyy-mm-dd hh:mm:ss.
.Pp
The default is to use the same format as 'ls -l': If the files were modified
within the past six months, print the month, day, hour, and minutes; otherwise,
print the month, day, and year.
.It Fl k
(x mode only)
Do not overwrite existing files.
Expand Down Expand Up @@ -815,14 +819,24 @@ is creating an archive (mode c) it will truncate the archive at the
current position and exit (see "INTERRUPTING ARCHIVAL" below).
.El
.Sh PRINTING ARCHIVE STATISTICS
Statistics on archives can be printed by running
.Nm
.Fl -print-stats
and during archive creation or deletion statistics on the created or
deleted archive can be printed using the
.Fl -print-stats
option.
In either case,
There are four commands which print statistics about archives:
.Bl -bullet -width indent
.It
Global statistics:
.Dl Nm Fl -print-stats
.It
Global statistics and info about specific archive(s):
.Dl Nm Fl -print-stats Fl f Ar archive-name1 Op Fl f Ar ...
.It
Global statistics and info about all archives:
.Dl Nm Fl -print-stats Fl f Ar '*'
.It
Global statistics and info about the archive(s) that were just created or
deleted:
.Dl Nm Fl c Fl -print-stats Fl f Ar archive-name Ar DIR
.Dl Nm Fl d Fl -print-stats Fl f Ar archive-name1 Op Fl f Ar ...
.El
.Pp
.Nm
will print a table in the following format:
.Bd -literal
Expand Down Expand Up @@ -852,6 +866,9 @@ when the
.Fl -print-stats
option is used while creating or deleting archives, the table is printed
to the standard error device.
.Pp
Global statistics are calculated based on the current cache directory, without
using the keyfile or querying the Tarsnap servers.
.Sh INTERRUPTING ARCHIVAL
Upon receipt of the
.Dv SIGQUIT
Expand Down

0 comments on commit b10062b

Please sign in to comment.