1
0
Fork 0
mirror of https://git.tukaani.org/xz.git synced 2024-04-04 12:36:23 +02:00
xz-archive/src/scripts/xzmore.1
Lasse Collin e48287bf51 xzdiff, xzgrep, and xzmore: Rewrite the man pages.
The main reason is a kind of silly one:

xz-man.pot contains strings from all man pages in XZ Utils.
The man pages of xzdiff, xzgrep, and xzmore were under GPLv2
and the rest under 0BSD. Thus xz-man.pot contained strings
under two licences. po4a creates the translated man pages
from the combined 0BSD+GPLv2 xz-man.pot.

I haven't liked this mixing in xz-man.pot but the
Translation Project requires that all man pages must be
in the same .pot file. So a separate xz-man-gpl.pot
wasn't an option.

Since these man pages are short, rewriting them was quick enough.
Now xz-man.pot is entirely under 0BSD and marking the per-file
licenses is simpler.

As a bonus, some wording hopefully is now slightly better
although it's perhaps a matter of taste.

NOTE: In xzgrep.1, the EXIT STATUS section was written by me
in the commit d796b6d7fd so that's
why that section could be taken as is from the old xzgrep.1.
2024-02-14 18:31:16 +02:00

65 lines
1.2 KiB
Groff

.\" SPDX-License-Identifier: 0BSD
.\"
.\" Authors: Andrew Dudman
.\" Lasse Collin
.\"
.\" (Note that this file is based on xzless.1 instead of gzip's zmore.1.)
.\"
.TH XZMORE 1 "2024-02-12" "Tukaani" "XZ Utils"
.SH NAME
xzmore, lzmore \- view xz or lzma compressed (text) files
.
.SH SYNOPSIS
.B xzmore
.RI [ file ...]
.br
.B lzmore
.RI [ file ...]
.
.SH DESCRIPTION
.B xzmore
displays text from compressed files to a terminal using
.BR more (1).
Files supported by
.BR xz (1)
are decompressed;
other files are assumed to be in uncompressed form already.
If no
.I files
are given,
.B xzmore
reads from standard input.
See the
.BR more (1)
manual for the keyboard commands.
.PP
Note that scrolling backwards might not be possible
depending on the implementation of
.BR more (1).
This is because
.B xzmore
uses a pipe to pass the decompressed data to
.BR more (1).
.BR xzless (1)
uses
.BR less (1)
which provides more advanced features.
.PP
The command
.B lzmore
is provided for backward compatibility with LZMA Utils.
.
.SH ENVIRONMENT
.TP
.B PAGER
If
.B PAGER
is set,
it's value is used as the pager instead of
.BR more (1).
.
.SH "SEE ALSO"
.BR more (1),
.BR xz (1),
.BR xzless (1),
.BR zmore (1)