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