Doc: Rename Doxygen HTML doc directory name liblzma => api.
[xz/debian.git] / src / scripts / xzless.1
blob2d05459d00c0e68065bebebaebec9de17d6e3bea
1 .\"
2 .\" Authors: Andrew Dudman
3 .\"          Lasse Collin
4 .\"
5 .\" This file has been put into the public domain.
6 .\" You can do whatever you want with this file.
7 .\"
8 .\" (Note that this file is not based on gzip's zless.1.)
9 .\"
10 .TH XZLESS 1 "2010-09-27" "Tukaani" "XZ Utils"
11 .SH NAME
12 xzless, lzless \- view xz or lzma compressed (text) files
13 .SH SYNOPSIS
14 .B xzless
15 .RI [ file ...]
16 .br
17 .B lzless
18 .RI [ file ...]
19 .SH DESCRIPTION
20 .B xzless
21 is a filter that displays text from compressed files to a terminal.
22 It works on files compressed with
23 .BR xz (1)
25 .BR lzma (1).
26 If no
27 .I files
28 are given,
29 .B xzless
30 reads from standard input.
31 .PP
32 .B xzless
33 uses
34 .BR less (1)
35 to present its output.
36 Unlike
37 .BR xzmore ,
38 its choice of pager cannot be altered by
39 setting an environment variable.
40 Commands are based on both
41 .BR more (1)
42 and
43 .BR vi (1)
44 and allow back and forth movement and searching.
45 See the
46 .BR less (1)
47 manual for more information.
48 .PP
49 The command named
50 .B lzless
51 is provided for backward compatibility with LZMA Utils.
52 .SH ENVIRONMENT
53 .TP
54 .B LESSMETACHARS
55 A list of characters special to the shell.
56 Set by
57 .B xzless
58 unless it is already set in the environment.
59 .TP
60 .B LESSOPEN
61 Set to a command line to invoke the
62 .BR xz (1)
63 decompressor for preprocessing the input files to
64 .BR less (1).
65 .SH "SEE ALSO"
66 .BR less (1),
67 .BR xz (1),
68 .BR xzmore (1),
69 .BR zless (1)