xref: /freebsd/usr.bin/gzip/zmore.1 (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1.\"	$NetBSD: zmore.1,v 1.4 2013/11/12 21:58:37 pettai Exp $
2.\"	$OpenBSD: zmore.1,v 1.10 2009/08/16 09:41:08 sobrado Exp $
3.\"
4.\" Copyright (c) 2003 Todd C. Miller <Todd.Miller@courtesan.com>
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.\" Sponsored in part by the Defense Advanced Research Projects
19.\" Agency (DARPA) and Air Force Research Laboratory, Air Force
20.\" Materiel Command, USAF, under agreement number F39502-99-1-0512.
21.\"
22.\" $FreeBSD$
23.Dd October 22, 2014
24.Dt ZMORE 1
25.Os
26.Sh NAME
27.Nm zmore ,
28.Nm zless
29.Nd view compressed files
30.Sh SYNOPSIS
31.Nm zmore
32.Op Ar flags
33.Op Ar
34.Nm zless
35.Op Ar flags
36.Op Ar
37.Sh DESCRIPTION
38.Nm
39is a filter that allows the viewing of files compressed with Lempel-Ziv
40encoding.
41Such files generally have a
42.Dq Z
43or
44.Dq gz
45extension (both the
46.Xr compress 1
47and
48.Xr gzip 1
49formats are supported).
50Any
51.Ar flags
52that are specified are passed to the user's preferred
53.Ev PAGER
54(which is
55.Pa /usr/bin/more
56by default).
57.Pp
58.Nm zless
59is equivalent to
60.Nm zmore
61but uses
62.Xr less 1
63as a pager instead of
64.Xr more 1 .
65.Pp
66When multiple files are specified,
67.Nm
68will pause at the end of each file and present the following prompt to the user:
69.Bd -literal -offset indent
70prev_file (END) - Next: next_file
71.Ed
72.Pp
73Where
74.Sy prev_file
75is the file that was just displayed and
76.Sy next_file
77is the next file to be displayed.
78The following keys are recognized at the prompt:
79.Bl -tag -width "e or q" -offset indent
80.It Ic e No or Ic q
81quit
82.Nm zmore .
83.It Ic s
84skip the next file (or exit if the next file is the last).
85.El
86.Pp
87If no files are specified,
88.Nm
89will read from the standard input.
90In this mode
91.Nm
92will assume
93.Xr gzip 1
94style compression since there is no suffix on which to make a decision.
95.Sh ENVIRONMENT
96.Bl -tag -width "PAGER"
97.It Ev PAGER
98Program used to display files.
99If unset,
100.Pa /usr/bin/more
101is used
102.Pq Nm zmore
103or
104.Pa /usr/bin/less
105.Pq Nm zless .
106.El
107.Sh SEE ALSO
108.Xr compress 1 ,
109.Xr less 1 ,
110.Xr more 1
111