From cec0ddc8ec4ce81685a51998b978e22167e461f9 Mon Sep 17 00:00:00 2001 From: Lasse Collin Date: Mon, 27 Sep 2010 23:29:34 +0300 Subject: Major man page updates. Lots of content was updated on the xz man page. Technical improvements: - Start a new sentence on a new line. - Use fairly short lines. - Use constant-width font for examples (where supported). - Some minor cleanups. Thanks to Jonathan Nieder for some language fixes. --- src/scripts/xzdiff.1 | 15 ++++++++------- src/scripts/xzgrep.1 | 11 ++++++----- src/scripts/xzless.1 | 13 ++++++++----- src/scripts/xzmore.1 | 9 +++++---- 4 files changed, 27 insertions(+), 21 deletions(-) (limited to 'src/scripts') diff --git a/src/scripts/xzdiff.1 b/src/scripts/xzdiff.1 index 318d06fb..d97f3cb8 100644 --- a/src/scripts/xzdiff.1 +++ b/src/scripts/xzdiff.1 @@ -6,7 +6,7 @@ .\" .\" License: GNU GPLv2+ .\" -.TH XZDIFF 1 "2009-07-05" "Tukaani" "XZ Utils" +.TH XZDIFF 1 "2010-09-27" "Tukaani" "XZ Utils" .SH NAME xzcmp, xzdiff, lzcmp, lzdiff \- compare compressed files .SH SYNOPSIS @@ -22,7 +22,7 @@ xzcmp, xzdiff, lzcmp, lzdiff \- compare compressed files .B lzdiff .RI [ diff_options "] " file1 " [" file2 ] .SH DESCRIPTION -.B xzcmp +.B xzcmp and .B xzdiff invoke @@ -36,22 +36,23 @@ on files compressed with or .BR bzip2 (1). All options specified are passed directly to -.B cmp +.BR cmp (1) or -.BR diff . +.BR diff (1). If only one file is specified, then the files compared are .I file1 (which must have a suffix of a supported compression format) and .I file1 from which the compression format suffix has been stripped. -If two files are specified, then they are uncompressed if necessary and fed to +If two files are specified, +then they are uncompressed if necessary and fed to .BR cmp (1) or .BR diff (1). The exit status from -.B cmp +.BR cmp (1) or -.B diff +.BR diff (1) is preserved. .PP The names diff --git a/src/scripts/xzgrep.1 b/src/scripts/xzgrep.1 index 996d64ae..a96f1b89 100644 --- a/src/scripts/xzgrep.1 +++ b/src/scripts/xzgrep.1 @@ -6,15 +6,15 @@ .\" .\" License: GNU GPLv2+ .\" -.TH XZGREP 1 "2009-07-05" "Tukaani" "XZ Utils" +.TH XZGREP 1 "2010-09-27" "Tukaani" "XZ Utils" .SH NAME xzgrep \- search compressed files for a regular expression .SH SYNOPSIS .B xzgrep .RI [ grep_options ] -.RB [ \-e ] +.RB [ \-e ] .I pattern -.IR file ".\|.\|." +.IR file "..." .br .B xzegrep .RB ... @@ -31,7 +31,7 @@ xzgrep \- search compressed files for a regular expression .B lzfgrep .RB ... .SH DESCRIPTION -.B xzgrep +.B xzgrep invokes .BR grep (1) on @@ -47,7 +47,8 @@ All options specified are passed directly to .PP If no .I file -is specified, then the standard input is decompressed if necessary and fed to +is specified, then standard input is decompressed if necessary +and fed to .BR grep (1). When reading from standard input, .BR gzip (1) diff --git a/src/scripts/xzless.1 b/src/scripts/xzless.1 index 299806fd..2d05459d 100644 --- a/src/scripts/xzless.1 +++ b/src/scripts/xzless.1 @@ -7,7 +7,7 @@ .\" .\" (Note that this file is not based on gzip's zless.1.) .\" -.TH XZLESS 1 "2009-07-05" "Tukaani" "XZ Utils" +.TH XZLESS 1 "2010-09-27" "Tukaani" "XZ Utils" .SH NAME xzless, lzless \- view xz or lzma compressed (text) files .SH SYNOPSIS @@ -17,7 +17,7 @@ xzless, lzless \- view xz or lzma compressed (text) files .B lzless .RI [ file ...] .SH DESCRIPTION -.B xzless +.B xzless is a filter that displays text from compressed files to a terminal. It works on files compressed with .BR xz (1) @@ -32,9 +32,11 @@ reads from standard input. .B xzless uses .BR less (1) -to present its output. Unlike +to present its output. +Unlike .BR xzmore , -its choice of pager cannot be altered by setting an environment variable. +its choice of pager cannot be altered by +setting an environment variable. Commands are based on both .BR more (1) and @@ -50,7 +52,8 @@ is provided for backward compatibility with LZMA Utils. .SH ENVIRONMENT .TP .B LESSMETACHARS -A list of characters special to the shell. Set by +A list of characters special to the shell. +Set by .B xzless unless it is already set in the environment. .TP diff --git a/src/scripts/xzmore.1 b/src/scripts/xzmore.1 index 42542bfe..30dad687 100644 --- a/src/scripts/xzmore.1 +++ b/src/scripts/xzmore.1 @@ -4,22 +4,23 @@ .\" .\" License: GNU GPLv2+ .\" -.TH XZMORE 1 "2009-07-05" "Tukaani" "XZ Utils" +.TH XZMORE 1 "2010-09-27" "Tukaani" "XZ Utils" .SH NAME xzmore, lzmore \- view xz or lzma compressed (text) files .SH SYNOPSIS .B xzmore -.RI [ "filename ..." ] +.RI [ "filename ..." ] .br .B lzmore -.RI [ "filename ..." ] +.RI [ "filename ..." ] .SH DESCRIPTION .B xzmore is a filter which allows examination of .BR xz (1) or .BR lzma (1) -compressed text files one screenful at a time on a soft-copy terminal. +compressed text files one screenful at a time +on a soft-copy terminal. .PP To use a pager other than the default .B more, -- cgit v1.2.3