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.9 2007/05/31 19:20:09 jmc Exp $
   3 .\"     $DragonFly: src/usr.bin/gzip/zmore.1,v 1.2 2007/07/29 17:27:45 swildner 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 May 31, 2008
  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
  32 .Op Ar flags
  33 .Op Ar file ...
  34 .Nm zless
  35 .Op Ar flags
  36 .Op Ar file ...
  37 .Sh DESCRIPTION
  38 .Nm
  39 is a filter that allows the viewing of files compressed with Lempel-Ziv
  40 encoding.
  41 Such files generally have a
  42 .Dq Z
  43 or
  44 .Dq gz
  45 extension (both the
  46 .Xr compress 1
  47 and
  48 .Xr gzip 1
  49 formats are supported).
  50 Any
  51 .Ar flags
  52 that are specified are passed to the user's preferred
  53 .Ev PAGER
  54 (which is
  55 .Pa /usr/bin/more
  56 by default).
  57 .Pp
  58 .Nm zless
  59 is equivalent to
  60 .Nm zmore
  61 but uses
  62 .Xr less 1
  63 as a pager instead of
  64 .Xr more 1 .
  65 .Pp
  66 When multiple files are specified,
  67 .Nm
  68 will pause at the end of each file and present the following prompt to the user:
  69 .Bd -literal -offset indent
  70 prev_file (END) - Next: next_file
  71 .Ed
  72 .Pp
  73 Where
  74 .Sy prev_file
  75 is the file that was just displayed and
  76 .Sy next_file
  77 is the next file to be displayed.
  78 The following keys are recognized at the prompt:
  79 .Bl -tag -width "e or q" -offset indent
  80 .It Ic e No or Ic q
  81 quit
  82 .Nm .
  83 .It Ic s
  84 skip the next file (or exit if the next file is the last).
  85 .El
  86 .Pp
  87 If no files are specified,
  88 .Nm
  89 will read from the standard input.
  90 In this mode
  91 .Nm
  92 will assume
  93 .Xr gzip 1
  94 style compression since there is no suffix on which to make a decision.
  95 .Sh ENVIRONMENT
  96 .Bl -tag -width "PAGER"
  97 .It Ev PAGER
  98 Program used to display files.
  99 If unset,
 100 .Pa /usr/bin/more
 101 is used
 102 .Pq Nm zmore
 103 or
 104 .Pa /usr/bin/less
 105 .Pq Nm zless .
 106 .El
 107 .Sh SEE ALSO
 108 .Xr gzip 1 ,
 109 .Xr less 1 ,
 110 .Xr more 1