Expand PMF_FN_* macros.
[netbsd-mini2440.git] / distrib / utils / more / more.1
blob8f518d70f0674d0392a38083f532c262eceb3969
1 .\"     $NetBSD: more.1,v 1.7 2003/02/25 10:34:44 wiz Exp $
2 .\"
3 .\" Copyright (c) 1988, 1990, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. Neither the name of the University nor the names of its contributors
16 .\"    may be used to endorse or promote products derived from this software
17 .\"    without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\"     @(#)more.1      8.2 (Berkeley) 4/18/94
32 .\"
33 .Dd April 18, 1994
34 .Dt MORE 1
35 .Os
36 .Sh NAME
37 .Nm more
38 .Nd file perusal filter for CRT viewing
39 .Sh SYNOPSIS
40 .Nm
41 .Op Fl ceinus
42 .Op Fl t Ar tag
43 .Op Fl x Ar tabs
44 .Op Fl / Ar pattern
45 .Op Fl #
46 .Op Ar
47 .Sh DESCRIPTION
48 The
49 .Nm
50 command is a filter for paging through text one screenful at a time.
51 It uses
52 .Xr termcap  3
53 so it can run on a variety of terminals.
54 There is even limited support for hardcopy terminals.
55 (On a hardcopy terminal, lines which should be printed at the top
56 of the screen are prefixed with an up-arrow).
57 .Ar File
58 may be a single dash (``-''), implying stdin.
59 .Sh OPTIONS
60 Command line options are described below.
61 Options are also taken from the environment variable
62 .Ev MORE
63 (make sure to precede them with a dash (``-'')) but command
64 line options will override them.
65 .Bl -tag -width flag
66 .It Fl c
67 Normally,
68 .Nm
69 will repaint the screen by scrolling from the bottom of the screen.
70 If the
71 .Fl c
72 option is set, when
73 .Nm
74 needs to change the entire display, it will paint from the top line down.
75 .It Fl e
76 Normally, if displaying a single file,
77 .Nm
78 exits as soon as it reaches end-of-file.  The
79 .Fl e
80 option tells more to
81 exit if it reaches end-of-file twice without an intervening operation.
82 If the file is shorter than a single screen
83 .Nm
84 will exit at end-of-file regardless.
85 .It Fl i
86 The
87 .Fl i
88 option causes searches to ignore case; that is,
89 uppercase and lowercase are considered identical.
90 .It Fl n
91 The
92 .Fl n
93 flag suppresses line numbers.
94 The default (to use line numbers) may cause
95 .Nm
96 to run more slowly in some cases, especially with a very large input file.
97 Suppressing line numbers with the
98 .Fl n
99 flag will avoid this problem.
100 Using line numbers means: the line number will be displayed in the
101 .Cm =
102 command, and the
103 .Cm v
104 command will pass the current line number to the editor.
105 .It Fl s
107 .Fl s
108 option causes
109 consecutive blank lines to be squeezed into a single blank line.
110 .It Fl t
112 .Fl t
113 option, followed immediately by a tag, will edit the file
114 containing that tag.  For more information, see the
115 .Xr ctags  1
116 command.
117 .It Fl u
118 By default,
120 treats backspaces and
121 .Dv CR-LF
122 sequences specially.  Backspaces which appear
123 adjacent to an underscore character are displayed as underlined text.
124 Backspaces which appear between two identical characters are displayed
125 as emboldened text.
126 .Dv CR-LF
127 sequences are compressed to a single linefeed
128 character.  The
129 .Fl u
130 option causes backspaces to always be displayed as
131 control characters, i.e. as the two character sequence ``^H'', and
132 .Dv CR-LF
133 to be left alone.
134 .It Fl x
136 .Fl x
137 option sets tab stops every
138 .Ar N
139 positions. The default for
140 .Ar N
141 is 8.
142 .It Fl /
144 .Fl /
145 option specifies a string that will be searched for before
146 each file is displayed.
148 .Sh COMMANDS
149 Interactive commands for
151 are based on
152 .Xr vi  1  .
153 Some commands may be preceded by a decimal number, called N in the
154 descriptions below.
155 In the following descriptions, ^X means control-X.
157 .Bl -tag -width Ic
158 .It Ic h
159 Help: display a summary of these commands.
160 If you forget all the other commands, remember this one.
161 .It Xo
162 .Ic SPACE
163 .No or
164 .Ic f
165 .No or
166 .Ic \&^F
168 Scroll forward N lines, default one window.
169 If N is more than the screen size, only the final screenful is displayed.
170 .It Ic b No or Ic \&^B
171 Scroll backward N lines, default one window (see option -z below).
172 If N is more than the screen size, only the final screenful is displayed.
173 .It Ic j No or Ic RETURN
174 Scroll forward N lines, default 1.
175 The entire N lines are displayed, even if N is more than the screen size.
176 .It Ic k
177 Scroll backward N lines, default 1.
178 The entire N lines are displayed, even if N is more than the screen size.
179 .It Ic d No or Ic \&^D
180 Scroll forward N lines, default one half of the screen size.
181 If N is specified, it becomes the new default for
182 subsequent d and u commands.
183 .It Ic u No or Ic \&^U
184 Scroll backward N lines, default one half of the screen size.
185 If N is specified, it becomes the new default for
186 subsequent d and u commands.
187 .It Ic g
188 Go to line N in the file, default 1 (beginning of file).
189 .It Ic G
190 Go to line N in the file, default the end of the file.
191 .It Ic p No or Ic \&%
192 Go to a position N percent into the file.  N should be between 0
193 and 100.  (This works if standard input is being read, but only if
195 has already read to the end of the file.  It is always fast, but
196 not always useful.)
197 .It Ic r No or Ic \&^L
198 Repaint the screen.
199 .It Ic R
200 Repaint the screen, discarding any buffered input.
201 Useful if the file is changing while it is being viewed.
202 .It Ic m
203 Followed by any lowercase letter,
204 marks the current position with that letter.
205 .It Ic \&'
206 (Single quote.)
207 Followed by any lowercase letter, returns to the position which
208 was previously marked with that letter.
209 Followed by another single quote, returns to the position at
210 which the last "large" movement command was executed, or the
211 beginning of the file if no such movements have occurred.
212 All marks are lost when a new file is examined.
213 .It Ic \&/ Ns Ar pattern
214 Search forward in the file for the N-th line containing the pattern.
215 N defaults to 1.
216 The pattern is a regular expression, as recognized by
217 .Xr ed 1 .
218 The search starts at the second line displayed.
219 .It Ic \&? Ns Ar pattern
220 Search backward in the file for the N-th line containing the pattern.
221 The search starts at the line immediately before the top line displayed.
222 .It Ic \&/\&! Ns Ar pattern
223 Like /, but the search is for the N-th line
224 which does NOT contain the pattern.
225 .It Ic \&?\&! Ns Ar pattern
226 Like ?, but the search is for the N-th line
227 which does NOT contain the pattern.
228 .It Ic n
229 Repeat previous search, for N-th line containing the last pattern
231 .Tn NOT
232 containing the last pattern, if the previous search
233 was /! or ?!).
234 .It Ic E Ns Op Ar filename
235 Examine a new file.
236 If the filename is missing, the "current" file (see the N and P commands
237 below) from the list of files in the command line is re-examined.
238 If the filename is a pound sign (#), the previously examined file is
239 re-examined.
240 .It Ic N No or Ic \&:n
241 Examine the next file (from the list of files given in the command line).
242 If a number N is specified (not to be confused with the command N),
243 the N-th next file is examined.
244 .It Ic P No or Ic \&:p
245 Examine the previous file.
246 If a number N is specified, the N-th previous file is examined.
247 .It Ic \&:t
248 Go to supplied tag.
249 .It Ic v
250 Invokes an editor to edit the current file being viewed.
251 The editor is taken from the environment variable
252 .Ev EDITOR ,
253 or defaults to
254 .Xr vi  1  .
255 .It Ic \&= No or Ic \&^G
256 These options print out the number of the file currently being displayed
257 relative to the total number of files there are to display, the current
258 line number, the current byte number and the total bytes to display, and
259 what percentage of the file has been displayed.
262 is reading from stdin, or the file is shorter than a single screen, some
263 of these items may not be available.  Note, all of these items reference
264 the first byte of the last line displayed on the screen.
265 .It Xo
266 .Ic q
267 .No or
268 .Ic \&:q
269 .No or
270 .Ic ZZ
272 Exits
273 .Nm .
275 .Sh ENVIRONMENT
278 command uses the following environment variables, if they exist:
279 .Bl -tag -width Fl
280 .It Ev MORE
281 This variable may be set with favored options to
282 .Nm .
283 .It Ev EDITOR
284 Specify default editor.
285 .It Ev SHELL
286 Current shell in use (normally set by the shell at login time).
287 .It Ev TERM
288 Specifies terminal type, used by more to get the terminal
289 characteristics necessary to manipulate the screen.
291 .Sh SEE ALSO
292 .Xr ctags 1 ,
293 .Xr vi 1
294 .Sh HISTORY
297 command appeared in
298 .Bx 3.0 .
299 .Sh AUTHORS
300 This software is derived from software contributed to Berkeley
301 by Mark Nudleman.