add UNLEASHED_OBJ to unleashed.mk
[unleashed/tickless.git] / share / man / man1 / more.1
blob68a2d8d18439c05d5b948b8189a2364766513b58
1 '\" te
2 .\"  Copyright 1989 AT&T  Copyright (c) 2005, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
4 .\" http://www.opengroup.org/bookstore/.
5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
6 .\"  This notice shall appear on any product containing this material.
7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
10 .TH MORE 1 "Nov 4, 2005"
11 .SH NAME
12 more, page \- browse or page through a text file
13 .SH SYNOPSIS
14 .LP
15 .nf
16 \fBmore\fR [\fB-cdflrsuw\fR] [\fB-lines\fR] [+ \fIlinenumber\fR]
17      [+/ \fIpattern\fR] [\fIfile\fR]...
18 .fi
20 .LP
21 .nf
22 \fBpage\fR [\fB-cdflrsuw\fR] [\fB-lines\fR] [+ \fIlinenumber\fR]
23      [+/ \fIpattern\fR] [\fIfile\fR]...
24 .fi
26 .SH DESCRIPTION
27 .sp
28 .LP
29 The \fBmore\fR utility is a filter that displays the contents of a text file on
30 the terminal, one screenful at a time.  It normally pauses after each
31 screenful. \fBmore\fR then prints \fB--More--\fR
32 at the bottom of the screen. If
33 \fBmore\fR is reading from a file rather than a pipe, the percentage of
34 characters displayed so far is also shown.
35 .sp
36 .LP
37 The \fBmore\fR utility scrolls up to display one more line in response to a
38 \fBRETURN\fR character. \fBmore\fR displays another screenful in response to a
39 \fBSPACE\fR character. Other commands are listed below.
40 .sp
41 .LP
42 The \fBpage\fR utility clears the screen before displaying the next screenful
43 of text. \fBpage\fR only provides a one-line overlap between screens.
44 .sp
45 .LP
46 The \fBmore\fR utility sets the terminal to \fBNOECHO\fR mode, so that the
47 output can be continuous. Commands that you type do not normally show up on
48 your terminal, except for the \fB/\fR and \fB!\fR commands.
49 .sp
50 .LP
51 The \fBmore\fR utility exits after displaying the last specified file.
52 .sp
53 .LP
54 If the standard output is not a terminal, \fBmore\fR acts just like
55 \fBcat\fR(1), except that a header is printed before each file in a series.
56 .SH OPTIONS
57 .sp
58 .LP
59 The following options are supported:
60 .sp
61 .ne 2
62 .na
63 \fB\fB-c\fR \fR
64 .ad
65 .RS 7n
66 Clears before displaying. Redraws the screen instead of scrolling for faster
67 displays. This option is ignored if the terminal does not have the ability to
68 clear to the end of a line.
69 .RE
71 .sp
72 .ne 2
73 .na
74 \fB\fB-d\fR \fR
75 .ad
76 .RS 7n
77 Displays error messages rather than ringing the terminal bell if an
78 unrecognized command is used. This is helpful for inexperienced users.
79 .RE
81 .sp
82 .ne 2
83 .na
84 \fB\fB-s\fR \fR
85 .ad
86 .RS 7n
87 Squeeze.  Replaces multiple blank lines with a single blank line. This is
88 helpful when viewing \fBnroff\fR(1) output on the screen.
89 .RE
91 .sp
92 .ne 2
93 .na
94 \fB\fB-f\fR \fR
95 .ad
96 .RS 7n
97 Does not fold long lines. This is useful when lines contain nonprinting
98 characters or escape sequences, such as those generated when \fBnroff\fR(1)
99 output is piped through \fBul\fR(1).
103 .ne 2
105 \fB\fB-l\fR \fR
107 .RS 7n
108 Does not treat \fBFORMFEED\fR characters (Control-l) as page breaks. If
109 \fB-l\fR is not used, \fBmore\fR pauses to accept commands after any line
110 containing a \fB^L\fR character (Control-l). Also, if a file begins with a
111 \fBFORMFEED\fR, the screen is cleared before the file is printed.
115 .ne 2
117 \fB\fB-r\fR \fR
119 .RS 7n
120 Normally, \fBmore\fR ignores control characters that it does not interpret in
121 some way. The \fB-r\fR option causes these to be displayed as \fB^\fR\fIC\fR
122 where \fIC\fR stands for any such control character.
126 .ne 2
128 \fB\fB-u\fR \fR
130 .RS 7n
131 Suppresses generation of underlining escape sequences. Normally, \fBmore\fR
132 handles underlining, such as that produced by \fBnroff\fR(1), in a manner
133 appropriate to the terminal. If the terminal can perform underlining or has a
134 stand-out mode, \fBmore\fR supplies appropriate escape sequences as called for
135 in the text file.
139 .ne 2
141 \fB\fB-w\fR \fR
143 .RS 7n
144 Normally, \fBmore\fR exits when it comes to the end of its input. With
145 \fB-w\fR, however, \fBmore\fR prompts and waits for any key to be struck before
146 exiting.
150 .ne 2
152 \fB\fB-\fR\fIlines\fR\fR
154 .RS 7n
155 Displays the indicated number of \fIlines\fR in each screenful, rather than the
156 default (the number of lines in the terminal screen less two).
160 .ne 2
162 \fB\fB+\fR\fIlinenumber\fR\fR
164 .RS 7n
165 Start up at \fIlinenumber\fR.
169 .ne 2
171 \fB\fB+/\fR\fIpattern\fR\fR
173 .RS 7n
174 Start up two lines above the line containing the regular expression
175 \fIpattern\fR. \fBNote:\fR Unlike editors, this construct should \fInot\fR end
176 with a `\fB/\fR.' If it does, then the trailing slash is taken as a character
177 in the search pattern.
180 .SH USAGE
181 .SS "Environment"
184 \fBmore\fR uses the terminal's \fBterminfo\fR(4) entry to determine its display
185 characteristics.
188 \fBmore\fR looks in the environment variable \fBMORE\fR for any preset options.
189 For instance, to page through files using the \fB-c\fR mode by default, set the
190 value of this variable to \fB-c\fR. (Normally, the command sequence to set up
191 this environment variable is placed in the \fB\&.login\fR or \fB\&.profile\fR
192 file).
193 .SS "Commands"
196 The commands take effect immediately. It is not necessary to type a carriage
197 return unless the command requires a \fIfile\fR, \fIcommand\fR,
198 \fItagstring\fR, or \fIpattern\fR. Up to the time when the command character
199 itself is given, the user may type the line kill character to cancel the
200 numerical argument being formed. In addition, the user may type the erase
201 character to redisplay the `\fB--More--(\fR\fIxx\fR%)' or \fIfile\fR message.
204 In the following commands, \fIi\fR is a numerical argument (\fB1\fR by
205 default).
207 .ne 2
209 \fB\fIi\fRSPACE \fR
211 .RS 13n
212 Display another screenful, or \fIi\fR more lines if \fIi\fR is specified.
216 .ne 2
218 \fB\fIi\fRRETURN \fR
220 .RS 13n
221 Display another line, or \fIi\fR more lines, if specified.
225 .ne 2
227 \fB\fIi\fR\fBb\fR\fR
231 \fB\fIi\fR\fB^B\fR\fR
233 .RS 13n
234 (Control-b) Skip back \fIi\fR screenfuls and then print a screenful.
238 .ne 2
240 \fB\fIi\fR\fBd\fR\fR
244 \fB\fIi\fR\fB^D\fR\fR
246 .RS 13n
247 (Control-d) Scroll forward one half screenful or \fIi\fR more lines. If \fIi\fR
248 is specified, the count becomes the default for subsequent \fBd\fR and \fBu\fR
249 commands.
253 .ne 2
255 \fB\fIi\fR\fBf\fR\fR
257 .RS 13n
258 Skip \fIi\fR screens full and then print a screenful.
262 .ne 2
264 \fB\fBh\fR\fR
266 .RS 13n
267 Help. Give a description of all the \fBmore\fR commands.
271 .ne 2
273 \fB\fB^L\fR \fR
275 .RS 13n
276 (Control-l) Refresh.
280 .ne 2
282 \fB\fIi\fR\fBn\fR\fR
284 .RS 13n
285 Search for the \fIi\|\fRth occurrence of the last \fIpattern\fR entered.
289 .ne 2
291 \fB\fBq\fR \fR
295 \fB\fBQ\fR \fR
297 .RS 13n
298 Exit from \fBmore\fR.
302 .ne 2
304 \fB\fIi\fR\fBs\fR\fR
306 .RS 13n
307 Skip \fIi\fR lines and then print a screenful.
311 .ne 2
313 \fB\fBv\fR\fR
315 .RS 13n
316 Drop into the \fBvi\fR editor at the current line of the current file.
320 .ne 2
322 \fB\fIi\fR\fBz\fR\fR
324 .RS 13n
325 Same as SPACE, except that \fIi\fR, if present, becomes the new default number
326 of lines per screenful.
330 .ne 2
332 \fB\fB=\fR \fR
334 .RS 13n
335 Display the current line number.
339 .ne 2
341 \fB\fIi\fR\fB/\fR\fIpattern\fR\fR
343 .RS 13n
344 Search forward for the \fIi\|\fRth occurrence of the regular expression
345 \fIpattern\fR. Display the screenful starting two lines before the line that
346 contains the \fIi\|\fRth match for the regular expression \fIpattern\fR, or the
347 end of a pipe, whichever comes first. If \fBmore\fR is displaying a file and
348 there is no match, its position in the file remains unchanged. Regular
349 expressions can be edited using erase and kill characters. Erasing back past
350 the first column cancels the search command.
354 .ne 2
356 \fB\fB!\fR\fIcommand\fR\fR
358 .RS 13n
359 Invoke a shell to execute \fIcommand\|\fR. The characters \fB%\fR and \fB!\fR,
360 when used within \fIcommand\fR are replaced with the current filename and the
361 previous shell command, respectively. If there is no current filename, \fB%\fR
362 is not expanded. Prepend a backslash to these characters to escape expansion.
366 .ne 2
368 \fB\fB:f\fR\fR
370 .RS 13n
371 Display the current filename and line number.
375 .ne 2
377 \fB\fIi\fR\fB:n\fR\fR
379 .RS 13n
380 Skip to the \fIi\|\fRth next filename given in the command line, or to the last
381 filename in the list if \fIi\fR is out of range.
385 .ne 2
387 \fB\fIi\fR\fB:p\fR\fR
389 .RS 13n
390 Skip to the \fIi\|\fRth previous filename given in the command line, or to the
391 first filename if \fIi\fR is out of range. If given while \fBmore\fR is
392 positioned within a file, go to the beginning of the file. If \fBmore\fR is
393 reading from a pipe, \fBmore\fR simply rings the terminal bell.
397 .ne 2
399 \fB\fB:q\fR\fR
403 \fB\fB:Q\fR\fR
405 .RS 13n
406 Exit from \fBmore\fR (same as \fBq\fR or \fBQ\fR).
410 .ne 2
412 \fB\fB\&'\fR\fR
414 .RS 9n
415 Single quote. Go to the point from which the last search started. If no search
416 has been performed in the current file, go to the beginning of the file.
420 .ne 2
422 \fB\fB\&.\fR\fR
424 .RS 9n
425 Dot. Repeat the previous command.
429 .ne 2
431 \fB\fB^\|\e\fR\fR
433 .RS 9n
434 Halt a partial display of text. \fBmore\fR stops sending output, and displays
435 the usual \fB--More--\fR prompt. Some output is lost as a result.
438 .SS "Large File Behavior"
441 See \fBlargefile\fR(5) for the description of the behavior of \fBmore\fR and
442 \fBpage\fR when encountering files greater than or equal to 2 Gbyte ( 2^31
443 bytes).
444 .SH ENVIRONMENT VARIABLES
447 See \fBenviron\fR(5) for descriptions of the following environment variables
448 that affect the execution of \fBmore\fR: \fBLANG\fR, \fBLC_ALL\fR,
449 \fBLC_CTYPE\fR,
450 \fBLC_MESSAGES\fR, \fBNLSPATH\fR, and \fBTERM\fR.
452 .SH EXIT STATUS
455 The following exit values are returned:
457 .ne 2
459 \fB\fB0\fR \fR
461 .RS 7n
462 Successful completion.
466 .ne 2
468 \fB\fB>0\fR \fR
470 .RS 7n
471 An error occurred.
474 .SH FILES
476 .ne 2
478 \fB\fB/usr/lib/more.help\fR\fR
480 .RS 22n
481 help file for \fBmore\fR and \fBpage\fR.
484 .SH ATTRIBUTES
487 See \fBattributes\fR(5) for descriptions of the following attributes:
491 box;
492 c | c
493 l | l .
494 ATTRIBUTE TYPE  ATTRIBUTE VALUE
496 CSI     Not enabled
499 .SH SEE ALSO
502 \fBcat\fR(1), \fBcsh\fR(1), \fBctags\fR(1), \fBman\fR(1), \fBnroff\fR(1),
503 \fBscript\fR(1), \fBsh\fR(1), \fBul\fR(1), \fBterminfo\fR(4),
504 \fBattributes\fR(5), \fBenviron\fR(5), \fBlargefile\fR(5), \fBstandards\fR(5),
505 \fBregcomp(3C)
506 .SH NOTES
508 Skipping backwards is too slow on large files.