Merge from vendor branch LESS:
[dragonfly.git] / contrib / less-4 / less.nro
1 .TH LESS 1 "Version 415: 15 Nov 2007"
2 .SH NAME
3 less \- opposite of more
4 .SH SYNOPSIS
5 .B "less \-?"
6 .br
7 .B "less \-\-help"
8 .br
9 .B "less \-V"
10 .br
11 .B "less \-\-version"
12 .br
13 .B "less [\-[+]aBcCdeEfFgGiIJKLmMnNqQrRsSuUVwWX~]"
14 .br
15 .B "     [\-b \fIspace\fP] [\-h \fIlines\fP] [\-j \fIline\fP] [\-k \fIkeyfile\fP]"
16 .br
17 .B "     [\-{oO} \fIlogfile\fP] [\-p \fIpattern\fP] [\-P \fIprompt\fP] [\-t \fItag\fP]"
18 .br
19 .B "     [\-T \fItagsfile\fP] [\-x \fItab\fP,...] [\-y \fIlines\fP] [\-[z] \fIlines\fP]"
20 .br
21 .B "     [\-# \fIshift\fP] [+[+]\fIcmd\fP] [\-\-] [\fIfilename\fP]..."
22 .br
23 (See the OPTIONS section for alternate option syntax with long option names.)
24
25 .SH DESCRIPTION
26 .I Less
27 is a program similar to 
28 .I more
29 (1), but which allows backward movement
30 in the file as well as forward movement.
31 Also,
32 .I less
33 does not have to read the entire input file before starting,
34 so with large input files it starts up faster than text editors like
35 .I vi
36 (1).
37 .I Less
38 uses termcap (or terminfo on some systems),
39 so it can run on a variety of terminals.
40 There is even limited support for hardcopy terminals.
41 (On a hardcopy terminal, lines which should be printed at the top
42 of the screen are prefixed with a caret.)
43 .PP
44 Commands are based on both
45 .I more
46 and
47 .I vi.
48 Commands may be preceded by a decimal number, 
49 called N in the descriptions below.
50 The number is used by some commands, as indicated.
51
52 .SH COMMANDS
53 In the following descriptions, ^X means control-X.
54 ESC stands for the ESCAPE key; for example ESC-v means the
55 two character sequence "ESCAPE", then "v".
56 .IP "h or H"
57 Help: display a summary of these commands.
58 If you forget all the other commands, remember this one.
59 .IP "SPACE or ^V or f or ^F"
60 Scroll forward N lines, default one window (see option \-z below).
61 If N is more than the screen size, only the final screenful is displayed.
62 Warning: some systems use ^V as a special literalization character.
63 .IP "z"
64 Like SPACE, but if N is specified, it becomes the new window size.
65 .IP "ESC-SPACE"
66 Like SPACE, but scrolls a full screenful, even if it reaches
67 end-of-file in the process.
68 .IP "RETURN or ^N or e or ^E or j or ^J"
69 Scroll forward N lines, default 1.
70 The entire N lines are displayed, even if N is more than the screen size.
71 .IP "d or ^D"
72 Scroll forward N lines, default one half of the screen size.
73 If N is specified, it becomes the new default for 
74 subsequent d and u commands.
75 .IP "b or ^B or ESC-v"
76 Scroll backward N lines, default one window (see option \-z below).
77 If N is more than the screen size, only the final screenful is displayed.
78 .IP "w"
79 Like ESC-v, but if N is specified, it becomes the new window size.
80 .IP "y or ^Y or ^P or k or ^K"
81 Scroll backward N lines, default 1.
82 The entire N lines are displayed, even if N is more than the screen size.
83 Warning: some systems use ^Y as a special job control character.
84 .IP "u or ^U"
85 Scroll backward N lines, default one half of the screen size.
86 If N is specified, it becomes the new default for 
87 subsequent d and u commands.
88 .IP "ESC-) or RIGHTARROW"
89 Scroll horizontally right N characters, default half the screen width
90 (see the \-# option).
91 If a number N is specified, it becomes the default for future RIGHTARROW
92 and LEFTARROW commands.
93 While the text is scrolled, it acts as though the \-S option
94 (chop lines) were in effect.
95 .IP "ESC-( or LEFTARROW"
96 Scroll horizontally left N characters, default half the screen width
97 (see the \-# option).
98 If a number N is specified, it becomes the default for future RIGHTARROW
99 and LEFTARROW commands.
100 .IP "r or ^R or ^L"
101 Repaint the screen.
102 .IP R
103 Repaint the screen, discarding any buffered input.
104 Useful if the file is changing while it is being viewed.
105 .IP "F"
106 Scroll forward, and keep trying to read when the
107 end of file is reached.
108 Normally this command would be used when already at the end of the file.
109 It is a way to monitor the tail of a file which is growing
110 while it is being viewed.
111 (The behavior is similar to the "tail \-f" command.)
112 .IP "g or < or ESC-<"
113 Go to line N in the file, default 1 (beginning of file).
114 (Warning: this may be slow if N is large.)
115 .IP "G or > or ESC->"
116 Go to line N in the file, default the end of the file.
117 (Warning: this may be slow if N is large,
118 or if N is not specified and
119 standard input, rather than a file, is being read.)
120 .IP "p or %"
121 Go to a position N percent into the file.
122 N should be between 0 and 100, and may contain a decimal point.
123 .IP "P"
124 Go to the line containing byte offset N in the file.
125 .IP "{"
126 If a left curly bracket appears in the top line displayed
127 on the screen,
128 the { command will go to the matching right curly bracket.
129 The matching right curly bracket is positioned on the bottom
130 line of the screen.
131 If there is more than one left curly bracket on the top line,
132 a number N may be used to specify the N-th bracket on the line.
133 .IP "}"
134 If a right curly bracket appears in the bottom line displayed
135 on the screen,
136 the } command will go to the matching left curly bracket.
137 The matching left curly bracket is positioned on the top
138 line of the screen.
139 If there is more than one right curly bracket on the top line,
140 a number N may be used to specify the N-th bracket on the line.
141 .IP "("
142 Like {, but applies to parentheses rather than curly brackets.
143 .IP ")"
144 Like }, but applies to parentheses rather than curly brackets.
145 .IP "["
146 Like {, but applies to square brackets rather than curly brackets.
147 .IP "]"
148 Like }, but applies to square brackets rather than curly brackets.
149 .IP "ESC-^F"
150 Followed by two characters,
151 acts like {, but uses the two characters as open and close brackets,
152 respectively.
153 For example, "ESC ^F < >" could be used to 
154 go forward to the > which matches the < in the top displayed line.
155 .IP "ESC-^B"
156 Followed by two characters,
157 acts like }, but uses the two characters as open and close brackets,
158 respectively.
159 For example, "ESC ^B < >" could be used to 
160 go backward to the < which matches the > in the bottom displayed line.
161 .IP m
162 Followed by any lowercase letter, 
163 marks the current position with that letter.
164 .IP "'"
165 (Single quote.)
166 Followed by any lowercase letter, returns to the position which
167 was previously marked with that letter.
168 Followed by another single quote, returns to the position at
169 which the last "large" movement command was executed.
170 Followed by a ^ or $, jumps to the beginning or end of the
171 file respectively.
172 Marks are preserved when a new file is examined,
173 so the ' command can be used to switch between input files.
174 .IP "^X^X"
175 Same as single quote.
176 .IP /pattern
177 Search forward in the file for the N-th line containing the pattern.
178 N defaults to 1.
179 The pattern is a regular expression, as recognized by
180 the regular expression library supplied by your system.
181 The search starts at the second line displayed
182 (but see the \-a and \-j options, which change this).
183 .sp
184 Certain characters are special
185 if entered at the beginning of the pattern;
186 they modify the type of search rather than become part of the pattern:
187 .RS
188 .IP "^N or !"
189 Search for lines which do NOT match the pattern.
190 .IP "^E or *"
191 Search multiple files.
192 That is, if the search reaches the END of the current file 
193 without finding a match,
194 the search continues in the next file in the command line list.
195 .IP "^F or @"
196 Begin the search at the first line of the FIRST file
197 in the command line list,
198 regardless of what is currently displayed on the screen
199 or the settings of the \-a or \-j options.
200 .IP "^K"
201 Highlight any text which matches the pattern on the current screen, 
202 but don't move to the first match (KEEP current position).
203 .IP "^R"
204 Don't interpret regular expression metacharacters;
205 that is, do a simple textual comparison.
206 .RE
207 .IP ?pattern
208 Search backward in the file for the N-th line containing the pattern.
209 The search starts at the line immediately before the top line displayed.
210 .sp
211 Certain characters are special as in the / command:
212 .RS
213 .IP "^N or !"
214 Search for lines which do NOT match the pattern.
215 .IP "^E or *"
216 Search multiple files.
217 That is, if the search reaches the beginning of the current file 
218 without finding a match,
219 the search continues in the previous file in the command line list.
220 .IP "^F or @"
221 Begin the search at the last line of the last file
222 in the command line list,
223 regardless of what is currently displayed on the screen
224 or the settings of the \-a or \-j options.
225 .IP "^K"
226 As in forward searches.
227 .IP "^R"
228 As in forward searches.
229 .RE
230 .IP "ESC-/pattern"
231 Same as "/*".
232 .IP "ESC-?pattern"
233 Same as "?*".
234 .IP n
235 Repeat previous search, for N-th line containing the last pattern.
236 If the previous search was modified by ^N, the search is made for the
237 N-th line NOT containing the pattern.
238 If the previous search was modified by ^E, the search continues
239 in the next (or previous) file if not satisfied in the current file.
240 If the previous search was modified by ^R, the search is done
241 without using regular expressions.
242 There is no effect if the previous search was modified by ^F or ^K.
243 .IP N
244 Repeat previous search, but in the reverse direction.
245 .IP "ESC-n"
246 Repeat previous search, but crossing file boundaries.
247 The effect is as if the previous search were modified by *.
248 .IP "ESC-N"
249 Repeat previous search, but in the reverse direction
250 and crossing file boundaries.
251 .IP "ESC-u"
252 Undo search highlighting.
253 Turn off highlighting of strings matching the current search pattern. 
254 If highlighting is already off because of a previous ESC-u command,
255 turn highlighting back on.
256 Any search command will also turn highlighting back on.
257 (Highlighting can also be disabled by toggling the \-G option;
258 in that case search commands do not turn highlighting back on.)
259 .IP ":e [filename]"
260 Examine a new file.
261 If the filename is missing, the "current" file (see the :n and :p commands
262 below) from the list of files in the command line is re-examined.
263 A percent sign (%) in the filename is replaced by the name of the
264 current file.  
265 A pound sign (#) is replaced by the name of the previously examined file.
266 However, two consecutive percent signs are simply 
267 replaced with a single percent sign.  
268 This allows you to enter a filename that contains a percent sign
269 in the name.
270 Similarly, two consecutive pound signs are replaced with a single pound sign.
271 The filename is inserted into the command line list of files
272 so that it can be seen by subsequent :n and :p commands.
273 If the filename consists of several files, they are all inserted into
274 the list of files and the first one is examined.
275 If the filename contains one or more spaces,
276 the entire filename should be enclosed in double quotes
277 (also see the \-" option).
278 .IP "^X^V or E"
279 Same as :e.
280 Warning: some systems use ^V as a special literalization character.
281 On such systems, you may not be able to use ^V.
282 .IP ":n"
283 Examine the next file (from the list of files given in the command line).
284 If a number N is specified, the N-th next file is examined.
285 .IP ":p"
286 Examine the previous file in the command line list.
287 If a number N is specified, the N-th previous file is examined.
288 .IP ":x"
289 Examine the first file in the command line list.
290 If a number N is specified, the N-th file in the list is examined.
291 .IP ":d"
292 Remove the current file from the list of files.
293 .IP "t"
294 Go to the next tag, if there were more than one matches for the current tag.
295 See the \-t option for more details about tags.
296 .IP "T"
297 Go to the previous tag, if there were more than one matches for the current tag.
298 .IP "= or ^G or :f"
299 Prints some information about the file being viewed,
300 including its name
301 and the line number and byte offset of the bottom line being displayed.
302 If possible, it also prints the length of the file,
303 the number of lines in the file
304 and the percent of the file above the last displayed line.
305 .IP \-
306 Followed by one of the command line option letters (see OPTIONS below),
307 this will change the setting of that option
308 and print a message describing the new setting.
309 If a ^P (CONTROL-P) is entered immediately after the dash,
310 the setting of the option is changed but no message is printed.
311 If the option letter has a numeric value (such as \-b or \-h),
312 or a string value (such as \-P or \-t),
313 a new value may be entered after the option letter.
314 If no new value is entered, a message describing
315 the current setting is printed and nothing is changed.
316 .IP \-\-
317 Like the \- command, but takes a long option name (see OPTIONS below)
318 rather than a single option letter.
319 You must press RETURN after typing the option name.
320 A ^P immediately after the second dash suppresses printing of a 
321 message describing the new setting, as in the \- command.
322 .IP \-+
323 Followed by one of the command line option letters
324 this will reset the option to its default setting
325 and print a message describing the new setting.
326 (The "\-+\fIX\fP" command does the same thing
327 as "\-+\fIX\fP" on the command line.)
328 This does not work for string-valued options.
329 .IP \-\-+
330 Like the \-+ command, but takes a long option name
331 rather than a single option letter.
332 .IP \-!
333 Followed by one of the command line option letters,
334 this will reset the option to the "opposite" of its default setting
335 and print a message describing the new setting.
336 This does not work for numeric or string-valued options.
337 .IP \-\-!
338 Like the \-! command, but takes a long option name
339 rather than a single option letter.
340 .IP _
341 (Underscore.)
342 Followed by one of the command line option letters,
343 this will print a message describing the current setting of that option.
344 The setting of the option is not changed.
345 .IP __
346 (Double underscore.)
347 Like the _ (underscore) command, but takes a long option name
348 rather than a single option letter.
349 You must press RETURN after typing the option name.
350 .IP +cmd
351 Causes the specified cmd to be executed each time a new file is examined.
352 For example, +G causes 
353 .I less
354 to initially display each file starting at the end 
355 rather than the beginning.
356 .IP V
357 Prints the version number of 
358 .I less 
359 being run.
360 .IP "q or Q or :q or :Q or ZZ"
361 Exits
362 .I less.
363 .PP
364 The following 
365 four
366 commands may or may not be valid, depending on your particular installation.
367 .PP
368 .IP v
369 Invokes an editor to edit the current file being viewed.
370 The editor is taken from the environment variable VISUAL if defined,
371 or EDITOR if VISUAL is not defined,
372 or defaults to "vi" if neither VISUAL nor EDITOR is defined.
373 See also the discussion of LESSEDIT under the section on PROMPTS below.
374 .IP "! shell-command"
375 Invokes a shell to run the shell-command given.
376 A percent sign (%) in the command is replaced by the name of the
377 current file.  
378 A pound sign (#) is replaced by the name of the previously examined file.
379 "!!" repeats the last shell command.
380 "!" with no shell command simply invokes a shell.
381 On Unix systems, the shell is taken from the environment variable SHELL,
382 or defaults to "sh".
383 On MS-DOS and OS/2 systems, the shell is the normal command processor.
384 .IP "| <m> shell-command"
385 <m> represents any mark letter.
386 Pipes a section of the input file to the given shell command.
387 The section of the file to be piped is between the first line on
388 the current screen and the position marked by the letter.
389 <m> may also be ^ or $ to indicate beginning or end of file respectively.
390 If <m> is . or newline, the current screen is piped.
391 .IP "s filename"
392 Save the input to a file.
393 This only works if the input is a pipe, not an ordinary file.
394 .PP
395 .SH OPTIONS
396 Command line options are described below.
397 Most options may be changed while
398 .I less 
399 is running, via the "\-" command.
400 .PP
401 Most options may be given in one of two forms: 
402 either a dash followed by a single letter,
403 or two dashes followed by a long option name.
404 A long option name may be abbreviated as long as
405 the abbreviation is unambiguous.
406 For example, \-\-quit-at-eof may be abbreviated \-\-quit, but not
407 --qui, since both \-\-quit-at-eof and \-\-quiet begin with \-\-qui.
408 Some long option names are in uppercase, such as \-\-QUIT-AT-EOF, as
409 distinct from \-\-quit-at-eof.
410 Such option names need only have their first letter capitalized;
411 the remainder of the name may be in either case.
412 For example, \-\-Quit-at-eof is equivalent to \-\-QUIT-AT-EOF.
413 .PP
414 Options are also taken from the environment variable "LESS".
415 For example, 
416 to avoid typing "less \-options ..." each time 
417 .I less 
418 is invoked, you might tell 
419 .I csh:
420 .sp
421 setenv LESS "-options"
422 .sp
423 or if you use 
424 .I sh:
425 .sp
426 LESS="-options"; export LESS
427 .sp
428 On MS-DOS, you don't need the quotes, but you should replace any 
429 percent signs in the options string by double percent signs.
430 .sp
431 The environment variable is parsed before the command line,
432 so command line options override the LESS environment variable.
433 If an option appears in the LESS variable, it can be reset
434 to its default value on the command line by beginning the command
435 line option with "\-+".
436 .sp
437 For options like \-P or \-D which take a following string,
438 a dollar sign ($) must be used to signal the end of the string.
439 For example, to set two \-D options on MS-DOS, you must have
440 a dollar sign between them, like this:
441 .sp
442 LESS="-Dn9.1$-Ds4.1"
443 .sp
444 .IP "\-? or \-\-help"
445 This option displays a summary of the commands accepted by
446 .I less
447 (the same as the h command).
448 (Depending on how your shell interprets the question mark,
449 it may be necessary to quote the question mark, thus: "\-\e?".)
450 .IP "\-a or \-\-search-skip-screen"
451 Causes searches to start after the last line
452 displayed on the screen, 
453 thus skipping all lines displayed on the screen.
454 By default, searches start at the second line on the screen
455 (or after the last found line; see the \-j option).
456 .IP "\-b\fIn\fP or \-\-buffers=\fIn\fP"
457 Specifies the amount of buffer space
458 .I less
459 will use for each file, in units of kilobytes (1024 bytes).
460 By default 64K of buffer space is used for each file
461 (unless the file is a pipe; see the \-B option).
462 The \-b option specifies instead that \fIn\fP kilobytes of 
463 buffer space should be used for each file.
464 If \fIn\fP is \-1, buffer space is unlimited; that is,
465 the entire file is read into memory.
466 .IP "\-B or \-\-auto-buffers"
467 By default, when data is read from a pipe,
468 buffers are allocated automatically as needed.
469 If a large amount of data is read from the pipe, this can cause
470 a large amount of memory to be allocated.
471 The \-B option disables this automatic allocation of buffers for pipes,
472 so that only 64K 
473 (or the amount of space specified by the \-b option)
474 is used for the pipe.
475 Warning: use of \-B can result in erroneous display, since only the
476 most recently viewed part of the file is kept in memory; 
477 any earlier data is lost.
478 .IP "\-c or \-\-clear-screen"
479 Causes full screen repaints to be painted from the top line down.
480 By default,
481 full screen repaints are done by scrolling from the bottom of the screen.
482 .IP "\-C or \-\-CLEAR-SCREEN"
483 Same as \-c, for compatibility with older versions of 
484 .I less.
485 .IP "\-d or \-\-dumb"
486 The \-d option suppresses the error message
487 normally displayed if the terminal is dumb;
488 that is, lacks some important capability,
489 such as the ability to clear the screen or scroll backward.
490 The \-d option does not otherwise change the behavior of
491 .I less
492 on a dumb terminal.
493 .IP "\-D\fBx\fP\fIcolor\fP or \-\-color=\fBx\fP\fIcolor\fP"
494 [MS-DOS only]
495 Sets the color of the text displayed.
496 \fBx\fP is a single character which selects the type of text whose color is 
497 being set: n=normal, s=standout, d=bold, u=underlined, k=blink.
498 \fIcolor\fP is a pair of numbers separated by a period.  
499 The first number selects the foreground color and the second selects 
500 the background color of the text.
501 A single number \fIN\fP is the same as \fIN.0\fP.
502 .IP "\-e or \-\-quit-at-eof"
503 Causes 
504 .I less 
505 to automatically exit
506 the second time it reaches end-of-file.
507 By default, the only way to exit 
508 .I less
509 is via the "q" command.
510 .IP "\-E or \-\-QUIT-AT-EOF"
511 Causes 
512 .I less
513 to automatically exit the first time it reaches end-of-file.
514 .IP "\-f or \-\-force"
515 Forces non-regular files to be opened.
516 (A non-regular file is a directory or a device special file.)
517 Also suppresses the warning message when a binary file is opened.
518 By default,
519 .I less
520 will refuse to open non-regular files.
521 Note that some operating systems will not allow directories
522 to be read, even if \-f is set.
523 .IP "\-F or \-\-quit-if-one-screen"
524 Causes
525 .I less
526 to automatically exit
527 if the entire file can be displayed on the first screen.
528 .IP "\-g or \-\-hilite-search"
529 Normally, 
530 .I less 
531 will highlight ALL strings which match the last search command.
532 The \-g option changes this behavior to highlight only the particular string 
533 which was found by the last search command.
534 This can cause 
535 .I less 
536 to run somewhat faster than the default.
537 .IP "\-G or \-\-HILITE-SEARCH"
538 The \-G option suppresses all highlighting of strings found by search commands.
539 .IP "\-h\fIn\fP or \-\-max-back-scroll=\fIn\fP"
540 Specifies a maximum number of lines to scroll backward.
541 If it is necessary to scroll backward more than \fIn\fP lines,
542 the screen is repainted in a forward direction instead.
543 (If the terminal does not have the ability to scroll
544 backward, \-h0 is implied.)
545 .IP "\-i or \-\-ignore-case"
546 Causes searches to ignore case; that is,
547 uppercase and lowercase are considered identical.
548 This option is ignored if any uppercase letters
549 appear in the search pattern; 
550 in other words,
551 if a pattern contains uppercase letters, then that search does not ignore case.
552 .IP "\-I or \-\-IGNORE-CASE"
553 Like \-i, but searches ignore case even if 
554 the pattern contains uppercase letters.
555 .IP "\-j\fIn\fP or \-\-jump-target=\fIn\fP"
556 Specifies a line on the screen where the "target" line
557 is to be positioned.
558 A target line is the object of a text search, 
559 tag search, jump to a line number,
560 jump to a file percentage, or jump to a marked position.
561 The screen line may be specified by a number: the top line on the screen
562 is 1, the next is 2, and so on.
563 The number may be negative to specify a line relative to the bottom
564 of the screen: the bottom line on the screen is \-1, the second
565 to the bottom is \-2, and so on.
566 Alternately, the screen line may be specified as a fraction of the height
567 of the screen, starting with a decimal point: .5 is in the middle of the
568 screen, .3 is three tenths down from the first line, and so on.
569 If the line is specified as a fraction, the actual line number
570 is recalculated if the terminal window is resized, so that the
571 target line remains at the specified fraction of the screen height.
572 If the \-j option is used, searches begin at the line immediately
573 after the target line.
574 For example, if "\-j4" is used, the target line is the
575 fourth line on the screen, so searches begin at the fifth line
576 on the screen.
577 .IP "\-J or \-\-status-column"
578 Displays a status column at the left edge of the screen.
579 The status column shows the lines that matched the current search.
580 The status column is also used if the \-w or \-W option is in effect.
581 .IP "\-k\fIfilename\fP or \-\-lesskey-file=\fIfilename\fP"
582 Causes
583 .I less
584 to open and interpret the named file as a
585 .I lesskey
586 (1) file.
587 Multiple \-k options may be specified.
588 If the LESSKEY or LESSKEY_SYSTEM environment variable is set, or
589 if a lesskey file is found in a standard place (see KEY BINDINGS),
590 it is also used as a 
591 .I lesskey
592 file.
593 .IP "\-K or \-\-quit-on-intr"
594 Causes
595 .I less
596 to exit immediately when an interrupt character (usually ^C) is typed.
597 Normally, an interrupt character causes
598 .I less
599 to stop whatever it is doing and return to its command prompt.
600 .IP "\-L or \-\-no-lessopen"
601 Ignore the LESSOPEN environment variable
602 (see the INPUT PREPROCESSOR section below).
603 This option can be set from within \fIless\fP, 
604 but it will apply only to files opened subsequently, not to the 
605 file which is currently open.
606 .IP "\-m or \-\-long-prompt"
607 Causes 
608 .I less
609 to prompt verbosely (like \fImore\fP),
610 with the percent into the file.
611 By default,
612 .I less
613 prompts with a colon.
614 .IP "\-M or \-\-LONG-PROMPT"
615 Causes 
616 .I less
617 to prompt even more verbosely than 
618 .I more.
619 .IP "\-n or \-\-line-numbers"
620 Suppresses line numbers.
621 The default (to use line numbers) may cause
622 .I less
623 to run more slowly in some cases, especially with a very large input file.
624 Suppressing line numbers with the \-n option will avoid this problem.
625 Using line numbers means: the line number will be displayed in the verbose
626 prompt and in the = command,
627 and the v command will pass the current line number to the editor
628 (see also the discussion of LESSEDIT in PROMPTS below).
629 .IP "\-N or \-\-LINE-NUMBERS"
630 Causes a line number to be displayed at the beginning of
631 each line in the display.
632 .IP "\-o\fIfilename\fP or \-\-log-file=\fIfilename\fP"
633 Causes
634 .I less
635 to copy its input to the named file as it is being viewed.
636 This applies only when the input file is a pipe,
637 not an ordinary file.
638 If the file already exists, 
639 .I less
640 will ask for confirmation before overwriting it.
641 .IP "\-O\fIfilename\fP or \-\-LOG-FILE=\fIfilename\fP"
642 The \-O option is like \-o, but it will overwrite an existing
643 file without asking for confirmation.
644 .sp
645 If no log file has been specified,
646 the \-o and \-O options can be used from within 
647 .I less
648 to specify a log file.
649 Without a file name, they will simply report the name of the log file.
650 The "s" command is equivalent to specifying \-o from within
651 .I less.
652 .IP "\-p\fIpattern\fP or \-\-pattern=\fIpattern\fP"
653 The \-p option on the command line is equivalent to 
654 specifying +/\fIpattern\fP;
655 that is, it tells
656 .I less
657 to start at the first occurrence of \fIpattern\fP in the file.
658 .IP "\-P\fIprompt\fP or \-\-prompt=\fIprompt\fP"
659 Provides a way to tailor the three prompt
660 styles to your own preference.
661 This option would normally be put in the LESS environment
662 variable, rather than being typed in with each 
663 .I less
664 command.
665 Such an option must either be the last option in the LESS variable,
666 or be terminated by a dollar sign.
667 -Ps followed by a string changes the default (short) prompt 
668 to that string.
669 -Pm changes the medium (\-m) prompt.
670 -PM changes the long (\-M) prompt.
671 -Ph changes the prompt for the help screen.
672 -P= changes the message printed by the = command.
673 -Pw changes the message printed while waiting for data (in the F command).
674 All prompt strings consist of a sequence of 
675 letters and special escape sequences.
676 See the section on PROMPTS for more details.
677 .IP "\-q or \-\-quiet or \-\-silent"
678 Causes moderately "quiet" operation:
679 the terminal bell is not rung 
680 if an attempt is made to scroll past the end of the file
681 or before the beginning of the file.
682 If the terminal has a "visual bell", it is used instead.
683 The bell will be rung on certain other errors,
684 such as typing an invalid character.
685 The default is to ring the terminal bell in all such cases.
686 .IP "\-Q or \-\-QUIET or \-\-SILENT"
687 Causes totally "quiet" operation:
688 the terminal bell is never rung.
689 .IP "\-r or \-\-raw-control-chars"
690 Causes "raw" control characters to be displayed.
691 The default is to display control characters using the caret notation;
692 for example, a control-A (octal 001) is displayed as "^A".
693 Warning: when the \-r option is used,
694 .I less
695 cannot keep track of the actual appearance of the screen
696 (since this depends on how the screen responds to
697 each type of control character).
698 Thus, various display problems may result,
699 such as long lines being split in the wrong place.
700 .IP "\-R or \-\-RAW-CONTROL-CHARS"
701 Like \-r, but only ANSI "color" escape sequences are output in "raw" form.
702 Unlike \-r, the screen appearance is maintained correctly in most cases.
703 ANSI "color" escape sequences are sequences of the form:
704 .sp
705         ESC [ ... m
706 .sp
707 where the "..." is zero or more color specification characters 
708 For the purpose of keeping track of screen appearance,
709 ANSI color escape sequences are assumed to not move the cursor.
710 You can make
711 .I less
712 think that characters other than "m" can end ANSI color escape sequences
713 by setting the environment variable LESSANSIENDCHARS to the list of
714 characters which can end a color escape sequence.
715 And you can make 
716 .I less 
717 think that characters other than the standard ones may appear between 
718 the ESC and the m by setting the environment variable LESSANSIMIDCHARS
719 to the list of characters which can appear.
720 .IP "\-s or \-\-squeeze-blank-lines"
721 Causes consecutive blank lines to be squeezed into a single blank line.
722 This is useful when viewing
723 .I nroff
724 output.
725 .IP "\-S or \-\-chop-long-lines"
726 Causes lines longer than the screen width to be
727 chopped rather than folded.
728 That is, the portion of a long line that does not fit in
729 the screen width is not shown.
730 The default is to fold long lines; that is, display the remainder
731 on the next line.
732 .IP "\-t\fItag\fP or \-\-tag=\fItag\fP"
733 The \-t option, followed immediately by a TAG,
734 will edit the file containing that tag.
735 For this to work, tag information must be available;
736 for example, there may be a file in the current directory called "tags",
737 which was previously built by 
738 .I ctags
739 (1) or an equivalent command.
740 If the environment variable LESSGLOBALTAGS is set, it is taken to be
741 the name of a command compatible with 
742 .I global
743 (1), and that command is executed to find the tag.
744 (See http://www.gnu.org/software/global/global.html).
745 The \-t option may also be specified from within 
746 .I less 
747 (using the \- command) as a way of examining a new file.
748 The command ":t" is equivalent to specifying \-t from within
749 .I less.
750 .IP "\-T\fItagsfile\fP or \-\-tag-file=\fItagsfile\fP"
751 Specifies a tags file to be used instead of "tags".
752 .IP "\-u or \-\-underline-special"
753 Causes backspaces and carriage returns to be treated as printable characters;
754 that is, they are sent to the terminal when they appear in the input.
755 .IP "\-U or \-\-UNDERLINE-SPECIAL"
756 Causes backspaces, tabs and carriage returns to be 
757 treated as control characters;
758 that is, they are handled as specified by the \-r option.
759 .sp
760 By default, if neither \-u nor \-U is given,
761 backspaces which appear adjacent to an underscore character
762 are treated specially:
763 the underlined text is displayed 
764 using the terminal's hardware underlining capability.
765 Also, backspaces which appear between two identical characters
766 are treated specially: 
767 the overstruck text is printed 
768 using the terminal's hardware boldface capability.
769 Other backspaces are deleted, along with the preceding character.
770 Carriage returns immediately followed by a newline are deleted.
771 other carriage returns are handled as specified by the \-r option.
772 Text which is overstruck or underlined can be searched for
773 if neither \-u nor \-U is in effect.
774 .IP "\-V or \-\-version"
775 Displays the version number of 
776 .I less.
777 .IP "\-w or \-\-hilite-unread"
778 Temporarily highlights the first "new" line after a forward movement
779 of a full page.
780 The first "new" line is the line immediately following the line previously
781 at the bottom of the screen.
782 Also highlights the target line after a g or p command.
783 The highlight is removed at the next command which causes movement.
784 The entire line is highlighted, unless the \-J option is in effect,
785 in which case only the status column is highlighted.
786 .IP "\-W or \-\-HILITE-UNREAD"
787 Like \-w, but temporarily highlights the first new line after any 
788 forward movement command larger than one line.
789 .IP "\-x\fIn\fP,... or \-\-tabs=\fIn\fP,..."
790 Sets tab stops.
791 If only one \fIn\fP is specified, tab stops are set at multiples of \fIn\fP.
792 If multiple values separated by commas are specified, tab stops
793 are set at those positions, and then continue with the same spacing as the
794 last two.
795 For example, \fI-x9,17\fP will set tabs at positions 9, 17, 25, 33, etc.
796 The default for \fIn\fP is 8.
797 .IP "\-X or \-\-no-init"
798 Disables sending the termcap initialization and deinitialization strings
799 to the terminal.
800 This is sometimes desirable if the deinitialization string does
801 something unnecessary, like clearing the screen.
802 .IP "\-y\fIn\fP or \-\-max-forw-scroll=\fIn\fP"
803 Specifies a maximum number of lines to scroll forward.
804 If it is necessary to scroll forward more than \fIn\fP lines,
805 the screen is repainted instead.
806 The \-c or \-C option may be used to repaint from the top of
807 the screen if desired.
808 By default, any forward movement causes scrolling.
809 .IP "\-[z]\fIn\fP or \-\-window=\fIn\fP"
810 Changes the default scrolling window size to \fIn\fP lines.
811 The default is one screenful.
812 The z and w commands can also be used to change the window size.
813 The "z" may be omitted for compatibility with some versions of 
814 .I more.
815 If the number
816 .I n
817 is negative, it indicates 
818 .I n
819 lines less than the current screen size.
820 For example, if the screen is 24 lines, \fI\-z-4\fP sets the 
821 scrolling window to 20 lines.  If the screen is resized to 40 lines,
822 the scrolling window automatically changes to 36 lines.
823 .IP "\-\fI\(dqcc\fP\ or\ \-\-quotes=\fIcc\fP"
824 Changes the filename quoting character.
825 This may be necessary if you are trying to name a file
826 which contains both spaces and quote characters.
827 Followed by a single character, this changes the quote character to that
828 character.
829 Filenames containing a space should then be surrounded by that character
830 rather than by double quotes.
831 Followed by two characters, changes the open quote to the first character,
832 and the close quote to the second character.
833 Filenames containing a space should then be preceded by the open quote
834 character and followed by the close quote character.
835 Note that even after the quote characters are changed, this option
836 remains \-" (a dash followed by a double quote).
837 .IP "\-~ or \-\-tilde"
838 Normally lines after end of file are displayed as a single tilde (~).
839 This option causes lines after end of file to be displayed as blank lines.
840 .IP "\-# or \-\-shift"
841 Specifies the default number of positions to scroll horizontally
842 in the RIGHTARROW and LEFTARROW commands.
843 If the number specified is zero, it sets the default number of
844 positions to one half of the screen width.
845 .IP "\-\-no-keypad"
846 Disables sending the keypad initialization and deinitialization strings
847 to the terminal.
848 This is sometimes useful if the keypad strings make the numeric
849 keypad behave in an undesirable manner.
850 .IP "\-\-follow-name"
851 Normally, if the input file is renamed while an F command is executing, 
852 .I less
853 will continue to display the contents of the original file despite
854 its name change.
855 If \-\-follow-name is specified, during an F command
856 .I less
857 will periodically attempt to reopen the file by name.
858 If the reopen succeeds and the file is a different file from the original
859 (which means that a new file has been created 
860 with the same name as the original (now renamed) file),
861 .I less
862 will display the contents of that new file.
863 .IP \-\-
864 A command line argument of "\-\-" marks the end of option arguments.
865 Any arguments following this are interpreted as filenames.
866 This can be useful when viewing a file whose name begins with a "\-" or "+".
867 .IP +
868 If a command line option begins with \fB+\fP,
869 the remainder of that option is taken to be an initial command to
870 .I less.
871 For example, +G tells
872 .I less
873 to start at the end of the file rather than the beginning,
874 and +/xyz tells it to start at the first occurrence of "xyz" in the file.
875 As a special case, +<number> acts like +<number>g; 
876 that is, it starts the display at the specified line number
877 (however, see the caveat under the "g" command above).
878 If the option starts with ++, the initial command applies to
879 every file being viewed, not just the first one.
880 The + command described previously
881 may also be used to set (or change) an initial command for every file.
882
883 .SH "LINE EDITING"
884 When entering command line at the bottom of the screen
885 (for example, a filename for the :e command,
886 or the pattern for a search command),
887 certain keys can be used to manipulate the command line.
888 Most commands have an alternate form in [ brackets ] which can be used if
889 a key does not exist on a particular keyboard. 
890 (The bracketed forms do not work in the MS-DOS version.)
891 Any of these special keys may be entered literally by preceding
892 it with the "literal" character, either ^V or ^A.
893 A backslash itself may also be entered literally by entering two backslashes.
894 .IP "LEFTARROW [ ESC-h ]"
895 Move the cursor one space to the left.
896 .IP "RIGHTARROW [ ESC-l ]"
897 Move the cursor one space to the right.
898 .IP "^LEFTARROW [ ESC-b or ESC-LEFTARROW ]"
899 (That is, CONTROL and LEFTARROW simultaneously.)
900 Move the cursor one word to the left.
901 .IP "^RIGHTARROW [ ESC-w or ESC-RIGHTARROW ]"
902 (That is, CONTROL and RIGHTARROW simultaneously.)
903 Move the cursor one word to the right.
904 .IP "HOME [ ESC-0 ]"
905 Move the cursor to the beginning of the line.
906 .IP "END [ ESC-$ ]"
907 Move the cursor to the end of the line.
908 .IP "BACKSPACE"
909 Delete the character to the left of the cursor,
910 or cancel the command if the command line is empty.
911 .IP "DELETE or [ ESC-x ]"
912 Delete the character under the cursor.
913 .IP "^BACKSPACE [ ESC-BACKSPACE ]"
914 (That is, CONTROL and BACKSPACE simultaneously.)
915 Delete the word to the left of the cursor.
916 .IP "^DELETE [ ESC-X or ESC-DELETE ]"
917 (That is, CONTROL and DELETE simultaneously.)
918 Delete the word under the cursor.
919 .IP "UPARROW [ ESC-k ]"
920 Retrieve the previous command line.
921 .IP "DOWNARROW [ ESC-j ]"
922 Retrieve the next command line.
923 .IP "TAB"
924 Complete the partial filename to the left of the cursor.
925 If it matches more than one filename, the first match
926 is entered into the command line.
927 Repeated TABs will cycle thru the other matching filenames.
928 If the completed filename is a directory, a "/" is appended to the filename.
929 (On MS-DOS systems, a "\e" is appended.)
930 The environment variable LESSSEPARATOR can be used to specify a 
931 different character to append to a directory name.
932 .IP "BACKTAB [ ESC-TAB ]"
933 Like, TAB, but cycles in the reverse direction thru the matching filenames.
934 .IP "^L"
935 Complete the partial filename to the left of the cursor.
936 If it matches more than one filename, all matches are entered into
937 the command line (if they fit).
938 .IP "^U (Unix and OS/2) or ESC (MS-DOS)"
939 Delete the entire command line,
940 or cancel the command if the command line is empty.
941 If you have changed your line-kill character in Unix to something
942 other than ^U, that character is used instead of ^U.
943
944 .SH "KEY BINDINGS"
945 You may define your own 
946 .I less
947 commands by using the program 
948 .I lesskey
949 (1)
950 to create a lesskey file.
951 This file specifies a set of command keys and an action
952 associated with each key.
953 You may also use
954 .I lesskey
955 to change the line-editing keys (see LINE EDITING),
956 and to set environment variables.
957 If the environment variable LESSKEY is set,
958 .I less
959 uses that as the name of the lesskey file.
960 Otherwise, 
961 .I less
962 looks in a standard place for the lesskey file:
963 On Unix systems,
964 .I less
965 looks for a lesskey file called "$HOME/.less".
966 On MS-DOS and Windows systems,
967 .I less
968 looks for a lesskey file called "$HOME/_less", and if it is not found there,
969 then looks for a lesskey file called "_less" in any directory specified
970 in the PATH environment variable.
971 On OS/2 systems,
972 .I less
973 looks for a lesskey file called "$HOME/less.ini", and if it is not found,
974 then looks for a lesskey file called "less.ini" in any directory specified
975 in the INIT environment variable, and if it not found there,
976 then looks for a lesskey file called "less.ini" in any directory specified
977 in the PATH environment variable.
978 See the
979 .I lesskey
980 manual page for more details.
981 .P
982 A system-wide lesskey file may also be set up to provide key bindings.
983 If a key is defined in both a local lesskey file and in the
984 system-wide file, key bindings in the local file take precedence over 
985 those in the system-wide file.
986 If the environment variable LESSKEY_SYSTEM is set,
987 .I less
988 uses that as the name of the system-wide lesskey file.
989 Otherwise,
990 .I less 
991 looks in a standard place for the system-wide lesskey file:
992 On Unix systems, the system-wide lesskey file is /usr/local/etc/sysless.
993 (However, if 
994 .I less 
995 was built with a different sysconf directory than /usr/local/etc,
996 that directory is where the sysless file is found.)
997 On MS-DOS and Windows systems, the system-wide lesskey file is c:\e_sysless.
998 On OS/2 systems, the system-wide lesskey file is c:\esysless.ini.
999
1000 .SH "INPUT PREPROCESSOR"
1001 You may define an "input preprocessor" for 
1002 .I less.
1003 Before
1004 .I less
1005 opens a file, it first gives your input preprocessor a chance to modify the
1006 way the contents of the file are displayed.
1007 An input preprocessor is simply an executable program (or shell script),
1008 which writes the contents of the file to a different file,
1009 called the replacement file.
1010 The contents of the replacement file are then displayed 
1011 in place of the contents of the original file.
1012 However, it will appear to the user as if the original file is opened;
1013 that is, 
1014 .I less
1015 will display the original filename as the name of the current file.
1016 .PP
1017 An input preprocessor receives one command line argument, the original filename,
1018 as entered by the user.
1019 It should create the replacement file, and when finished,
1020 print the name of the replacement file to its standard output.
1021 If the input preprocessor does not output a replacement filename, 
1022 .I less
1023 uses the original file, as normal.
1024 The input preprocessor is not called when viewing standard input.
1025 To set up an input preprocessor, set the LESSOPEN environment variable
1026 to a command line which will invoke your input preprocessor.
1027 This command line should include one occurrence of the string "%s", 
1028 which will be replaced by the filename
1029 when the input preprocessor command is invoked.
1030 .PP
1031 When 
1032 .I less
1033 closes a file opened in such a way, it will call another program,
1034 called the input postprocessor,
1035 which may perform any desired clean-up action (such as deleting the
1036 replacement file created by LESSOPEN).
1037 This program receives two command line arguments, the original filename
1038 as entered by the user, and the name of the replacement file.
1039 To set up an input postprocessor, set the LESSCLOSE environment variable 
1040 to a command line which will invoke your input postprocessor.
1041 It may include two occurrences of the string "%s"; 
1042 the first is replaced with the original name of the file and 
1043 the second with the name of the replacement file, 
1044 which was output by LESSOPEN.
1045 .PP
1046 For example, on many Unix systems, these two scripts will allow you
1047 to keep files in compressed format, but still let
1048 .I less
1049 view them directly:
1050 .PP
1051 lessopen.sh:
1052 .br
1053         #! /bin/sh
1054 .br
1055         case "$1" in
1056 .br
1057         *.Z)    uncompress -\c $1  >/tmp/less.$$  2>/dev/null
1058 .br
1059                 if [ \-s /tmp/less.$$ ]; then 
1060 .br
1061                         echo /tmp/less.$$
1062 .br
1063                 else
1064 .br
1065                         rm \-f /tmp/less.$$
1066 .br
1067                 fi
1068 .br
1069                 ;;
1070 .br
1071         esac
1072 .PP
1073 lessclose.sh:
1074 .br
1075         #! /bin/sh
1076 .br
1077         rm $2
1078 .PP
1079 To use these scripts, put them both where they can be executed and
1080 set LESSOPEN="lessopen.sh\ %s", and
1081 LESSCLOSE="lessclose.sh\ %s\ %s".
1082 More complex LESSOPEN and LESSCLOSE scripts may be written
1083 to accept other types of compressed files, and so on.
1084 .PP
1085 It is also possible to set up an input preprocessor to
1086 pipe the file data directly to 
1087 .I less,
1088 rather than putting the data into a replacement file.
1089 This avoids the need to decompress the entire file before 
1090 starting to view it.
1091 An input preprocessor that works this way is called an input pipe.
1092 An input pipe, instead of writing the name of a replacement file on
1093 its standard output,
1094 writes the entire contents of the replacement file on its standard output.
1095 If the input pipe does not write any characters on its standard output,
1096 then there is no replacement file and 
1097 .I less
1098 uses the original file, as normal.
1099 To use an input pipe,
1100 make the first character in the LESSOPEN environment variable a 
1101 vertical bar (|) to signify that the input preprocessor is an input pipe.
1102 .PP
1103 For example, on many Unix systems, this script will work like the
1104 previous example scripts:
1105 .PP
1106 lesspipe.sh:
1107 .br
1108         #! /bin/sh
1109 .br
1110         case "$1" in
1111 .br
1112         *.Z)    uncompress \-c $1  2>/dev/null
1113 .br
1114                 ;;
1115 .br
1116         esac
1117 .br
1118 .PP
1119 To use this script, put it where it can be executed and set
1120 LESSOPEN="|lesspipe.sh %s".
1121 When an input pipe is used, a LESSCLOSE postprocessor can be used,
1122 but it is usually not necessary since there is no replacement file
1123 to clean up.
1124 In this case, the replacement file name passed to the LESSCLOSE
1125 postprocessor is "\-".
1126
1127 .SH "NATIONAL CHARACTER SETS"
1128 There are three types of characters in the input file:
1129 .IP "normal characters"
1130 can be displayed directly to the screen.
1131 .IP "control characters"
1132 should not be displayed directly, but are expected to be found
1133 in ordinary text files (such as backspace and tab).
1134 .IP "binary characters"
1135 should not be displayed directly and are not expected to be found
1136 in text files.
1137 .PP
1138 A "character set" is simply a description of which characters are to
1139 be considered normal, control, and binary.
1140 The LESSCHARSET environment variable may be used to select a character set.
1141 Possible values for LESSCHARSET are:
1142 .IP ascii
1143 BS, TAB, NL, CR, and formfeed are control characters,
1144 all chars with values between 32 and 126 are normal,
1145 and all others are binary.
1146 .IP iso8859
1147 Selects an ISO 8859 character set.
1148 This is the same as ASCII, except characters between 160 and 255 are
1149 treated as normal characters.
1150 .IP latin1
1151 Same as iso8859.
1152 .IP latin9
1153 Same as iso8859.
1154 .IP dos
1155 Selects a character set appropriate for MS-DOS.
1156 .IP ebcdic
1157 Selects an EBCDIC character set.
1158 .IP IBM-1047
1159 Selects an EBCDIC character set used by OS/390 Unix Services.
1160 This is the EBCDIC analogue of latin1.  You get similar results
1161 by setting either LESSCHARSET=IBM-1047 or LC_CTYPE=en_US
1162 in your environment.
1163 .IP koi8-r
1164 Selects a Russian character set.
1165 .IP next
1166 Selects a character set appropriate for NeXT computers.
1167 .IP utf-8
1168 Selects the UTF-8 encoding of the ISO 10646 character set.
1169 UTF-8 is special in that it supports multi-byte characters in the input file.
1170 It is the only character set that supports multi-byte characters.
1171 .IP windows
1172 Selects a character set appropriate for Microsoft Windows (cp 1251).
1173 .PP
1174 In special cases, it may be desired to tailor
1175 .I less
1176 to use a character set other than the ones definable by LESSCHARSET.
1177 In this case, the environment variable LESSCHARDEF can be used
1178 to define a character set.
1179 It should be set to a string where each character in the string represents
1180 one character in the character set.
1181 The character "." is used for a normal character, "c" for control,
1182 and "b" for binary.
1183 A decimal number may be used for repetition.
1184 For example, "bccc4b." would mean character 0 is binary,
1185 1, 2 and 3 are control, 4, 5, 6 and 7 are binary, and 8 is normal.
1186 All characters after the last are taken to be the same as the last,
1187 so characters 9 through 255 would be normal.
1188 (This is an example, and does not necessarily 
1189 represent any real character set.)
1190 .PP
1191 This table shows the value of LESSCHARDEF which is equivalent
1192 to each of the possible values for LESSCHARSET:
1193 .sp
1194         ascii\  8bcccbcc18b95.b
1195 .br
1196         dos\ \ \        8bcccbcc12bc5b95.b.
1197 .br
1198         ebcdic  5bc6bcc7bcc41b.9b7.9b5.b..8b6.10b6.b9.7b
1199 .br
1200         \ \ \ \ \ \     9.8b8.17b3.3b9.7b9.8b8.6b10.b.b.b.
1201 .br
1202         IBM-1047        4cbcbc3b9cbccbccbb4c6bcc5b3cbbc4bc4bccbc
1203 .br
1204         \ \ \ \ \ \     191.b
1205 .br
1206         iso8859 8bcccbcc18b95.33b.
1207 .br
1208         koi8-r  8bcccbcc18b95.b128.
1209 .br
1210         latin1  8bcccbcc18b95.33b.
1211 .br
1212         next\ \         8bcccbcc18b95.bb125.bb
1213 .PP
1214 If neither LESSCHARSET nor LESSCHARDEF is set,
1215 but any of the strings "UTF-8", "UTF8", "utf-8" or "utf8" 
1216 is found in the LC_ALL, LC_TYPE or LANG
1217 environment variables, then the default character set is utf-8.
1218 .PP
1219 If that string is not found, but your system supports the
1220 .I setlocale
1221 interface,
1222 .I less
1223 will use setlocale to determine the character set.
1224 setlocale is controlled by setting the LANG or LC_CTYPE environment
1225 variables.
1226 .PP
1227 Finally, if the
1228 .I setlocale
1229 interface is also not available, the default character set is latin1.
1230 .PP
1231 Control and binary characters are displayed in standout (reverse video).
1232 Each such character is displayed in caret notation if possible
1233 (e.g. ^A for control-A).  Caret notation is used only if 
1234 inverting the 0100 bit results in a normal printable character.
1235 Otherwise, the character is displayed as a hex number in angle brackets.
1236 This format can be changed by 
1237 setting the LESSBINFMT environment variable.
1238 LESSBINFMT may begin with a "*" and one character to select 
1239 the display attribute:
1240 "*k" is blinking, "*d" is bold, "*u" is underlined, "*s" is standout,
1241 and "*n" is normal.
1242 If LESSBINFMT does not begin with a "*", normal attribute is assumed.
1243 The remainder of LESSBINFMT is a string which may include one
1244 printf-style escape sequence (a % followed by x, X, o, d, etc.).
1245 For example, if LESSBINFMT is "*u[%x]", binary characters
1246 are displayed in underlined hexadecimal surrounded by brackets.
1247 The default if no LESSBINFMT is specified is "*s<%X>".
1248 The default if no LESSBINFMT is specified is "*s<%02X>".
1249 Warning: the result of expanding the character via LESSBINFMT must
1250 be less than 31 characters.
1251 .PP
1252 When the character set is utf-8, the LESSUTFBINFMT environment variable
1253 acts similarly to LESSBINFMT but it applies to Unicode code points
1254 that were successfully decoded but are unsuitable for display (e.g.,
1255 unassigned code points).
1256 Its default value is "<U+%04lX>".
1257 Note that LESSUTFBINFMT and LESSBINFMT share their display attribute 
1258 setting ("*x") so specifying one will affect both; 
1259 LESSUTFBINFMT is read after LESSBINFMT so its setting, if any,
1260 will have priority. 
1261 Problematic octets in a UTF-8 file (octets of a truncated sequence,
1262 octets of a complete but non-shortest form sequence, illegal octets, 
1263 and stray trailing octets)
1264 are displayed individually using LESSBINFMT so as to facilitate diagnostic
1265 of how the UTF-8 file is ill-formed.
1266
1267 .SH "PROMPTS"
1268 The \-P option allows you to tailor the prompt to your preference.
1269 The string given to the \-P option replaces the specified prompt string.
1270 Certain characters in the string are interpreted specially.
1271 The prompt mechanism is rather complicated to provide flexibility,
1272 but the ordinary user need not understand the details of constructing
1273 personalized prompt strings.
1274 .sp
1275 A percent sign followed by a single character is expanded
1276 according to what the following character is:
1277 .IP "%b\fIX\fP"
1278 Replaced by the byte offset into the current input file.
1279 The b is followed by a single character (shown as \fIX\fP above)
1280 which specifies the line whose byte offset is to be used.
1281 If the character is a "t", the byte offset of the top line in the
1282 display is used,
1283 an "m" means use the middle line,
1284 a "b" means use the bottom line,
1285 a "B" means use the line just after the bottom line,
1286 and a "j" means use the "target" line, as specified by the \-j option.
1287 .IP "%B"
1288 Replaced by the size of the current input file.
1289 .IP "%c"
1290 Replaced by the column number of the text appearing in the first
1291 column of the screen.
1292 .IP "%d\fIX\fP"
1293 Replaced by the page number of a line in the input file.
1294 The line to be used is determined by the \fIX\fP, as with the %b option.
1295 .IP "%D"
1296 Replaced by the number of pages in the input file,
1297 or equivalently, the page number of the last line in the input file.
1298 .IP "%E"
1299 Replaced by the name of the editor (from the VISUAL environment variable,
1300 or the EDITOR environment variable if VISUAL is not defined).
1301 See the discussion of the LESSEDIT feature below.
1302 .IP "%f"
1303 Replaced by the name of the current input file.
1304 .IP "%i"
1305 Replaced by the index of the current file in the list of
1306 input files.
1307 .IP "%l\fIX\fP"
1308 Replaced by the line number of a line in the input file.
1309 The line to be used is determined by the \fIX\fP, as with the %b option.
1310 .IP "%L"
1311 Replaced by the line number of the last line in the input file.
1312 .IP "%m"
1313 Replaced by the total number of input files.
1314 .IP "%p\fIX\fP"
1315 Replaced by the percent into the current input file, based on byte offsets.
1316 The line used is determined by the \fIX\fP as with the %b option.
1317 .IP "%P\fIX\fP"
1318 Replaced by the percent into the current input file, based on line numbers.
1319 The line used is determined by the \fIX\fP as with the %b option.
1320 .IP "%s"
1321 Same as %B.
1322 .IP "%t"
1323 Causes any trailing spaces to be removed.
1324 Usually used at the end of the string, but may appear anywhere.
1325 .IP "%x"
1326 Replaced by the name of the next input file in the list.
1327 .PP
1328 If any item is unknown (for example, the file size if input
1329 is a pipe), a question mark is printed instead.
1330 .PP
1331 The format of the prompt string can be changed
1332 depending on certain conditions.
1333 A question mark followed by a single character acts like an "IF":
1334 depending on the following character, a condition is evaluated.
1335 If the condition is true, any characters following the question mark
1336 and condition character, up to a period, are included in the prompt.
1337 If the condition is false, such characters are not included.
1338 A colon appearing between the question mark and the
1339 period can be used to establish an "ELSE": any characters between
1340 the colon and the period are included in the string if and only if
1341 the IF condition is false.
1342 Condition characters (which follow a question mark) may be:
1343 .IP "?a"
1344 True if any characters have been included in the prompt so far.
1345 .IP "?b\fIX\fP"
1346 True if the byte offset of the specified line is known.
1347 .IP "?B"
1348 True if the size of current input file is known.
1349 .IP "?c"
1350 True if the text is horizontally shifted (%c is not zero).
1351 .IP "?d\fIX\fP"
1352 True if the page number of the specified line is known.
1353 .IP "?e"
1354 True if at end-of-file.
1355 .IP "?f"
1356 True if there is an input filename
1357 (that is, if input is not a pipe).
1358 .IP "?l\fIX\fP"
1359 True if the line number of the specified line is known.
1360 .IP "?L"
1361 True if the line number of the last line in the file is known.
1362 .IP "?m"
1363 True if there is more than one input file.
1364 .IP "?n"
1365 True if this is the first prompt in a new input file.
1366 .IP "?p\fIX\fP"
1367 True if the percent into the current input file, based on byte offsets,
1368 of the specified line is known.
1369 .IP "?P\fIX\fP"
1370 True if the percent into the current input file, based on line numbers,
1371 of the specified line is known.
1372 .IP "?s"
1373 Same as "?B".
1374 .IP "?x"
1375 True if there is a next input file
1376 (that is, if the current input file is not the last one).
1377 .PP
1378 Any characters other than the special ones
1379 (question mark, colon, period, percent, and backslash)
1380 become literally part of the prompt.
1381 Any of the special characters may be included in the prompt literally
1382 by preceding it with a backslash.
1383 .PP
1384 Some examples:
1385 .sp
1386 ?f%f:Standard input.
1387 .sp
1388 This prompt prints the filename, if known;
1389 otherwise the string "Standard input".
1390 .sp
1391 ?f%f .?ltLine %lt:?pt%pt\e%:?btByte %bt:-...
1392 .sp
1393 This prompt would print the filename, if known.
1394 The filename is followed by the line number, if known,
1395 otherwise the percent if known, otherwise the byte offset if known.
1396 Otherwise, a dash is printed.
1397 Notice how each question mark has a matching period,
1398 and how the % after the %pt
1399 is included literally by escaping it with a backslash.
1400 .sp
1401 ?n?f%f\ .?m(file\ %i\ of\ %m)\ ..?e(END)\ ?x-\ Next\e:\ %x..%t
1402 .sp
1403 This prints the filename if this is the first prompt in a file,
1404 followed by the "file N of N" message if there is more
1405 than one input file.
1406 Then, if we are at end-of-file, the string "(END)" is printed
1407 followed by the name of the next file, if there is one.
1408 Finally, any trailing spaces are truncated.
1409 This is the default prompt.
1410 For reference, here are the defaults for
1411 the other two prompts (\-m and \-M respectively).
1412 Each is broken into two lines here for readability only.
1413 .nf
1414 .sp
1415 ?n?f%f\ .?m(file\ %i\ of\ %m)\ ..?e(END)\ ?x-\ Next\e:\ %x.:
1416         ?pB%pB\e%:byte\ %bB?s/%s...%t
1417 .sp
1418 ?f%f\ .?n?m(file\ %i\ of\ %m)\ ..?ltlines\ %lt-%lb?L/%L.\ :
1419         byte\ %bB?s/%s.\ .?e(END)\ ?x-\ Next\e:\ %x.:?pB%pB\e%..%t
1420 .sp
1421 .fi
1422 And here is the default message produced by the = command:
1423 .nf
1424 .sp
1425 ?f%f\ .?m(file\ %i\ of\ %m)\ .?ltlines\ %lt-%lb?L/%L.\ .
1426         byte\ %bB?s/%s.\ ?e(END)\ :?pB%pB\e%..%t
1427 .fi
1428 .PP
1429 The prompt expansion features are also used for another purpose:
1430 if an environment variable LESSEDIT is defined, it is used
1431 as the command to be executed when the v command is invoked.
1432 The LESSEDIT string is expanded in the same way as the prompt strings.
1433 The default value for LESSEDIT is:
1434 .nf
1435 .sp
1436         %E\ ?lm+%lm.\ %f
1437 .sp
1438 .fi
1439 Note that this expands to the editor name, followed by a + and the
1440 line number, followed by the file name.
1441 If your editor does not accept the "+linenumber" syntax, or has other
1442 differences in invocation syntax, the LESSEDIT variable can be 
1443 changed to modify this default.
1444
1445 .SH SECURITY
1446 When the environment variable LESSSECURE is set to 1,
1447 .I less
1448 runs in a "secure" mode.
1449 This means these features are disabled:
1450 .RS
1451 .IP "!"
1452 the shell command
1453 .IP "|"
1454 the pipe command
1455 .IP ":e"
1456 the examine command.
1457 .IP "v"
1458 the editing command
1459 .IP "s  \-o"
1460 log files
1461 .IP "\-k"
1462 use of lesskey files
1463 .IP "\-t"
1464 use of tags files
1465 .IP " "
1466 metacharacters in filenames, such as *
1467 .IP " "
1468 filename completion (TAB, ^L)
1469 .RE
1470 .PP
1471 Less can also be compiled to be permanently in "secure" mode.
1472
1473 .SH "COMPATIBILITY WITH MORE"
1474 If the environment variable LESS_IS_MORE is set to 1,
1475 or if the program is invoked via a file link named "more",
1476 .I less
1477 behaves (mostly) in conformance with the POSIX "more" command specification.
1478 In this mode, less behaves differently in these ways:
1479 .PP
1480 The \-e option works differently.
1481 If the \-e option is not set, 
1482 .I less
1483 behaves as if the \-E option were set.
1484 If the \-e option is set, 
1485 .I less
1486 behaves as if the \-e and \-F options were set.
1487 .PP
1488 The \-m option works differently.
1489 If the \-m option is not set, the medium prompt is used,
1490 and it is prefixed with the string "--More--".
1491 If the \-m option is set, the short prompt is used.
1492 .PP
1493 The \-n option acts like the \-z option.
1494 The normal behavior of the \-n option is unavailable in this mode.
1495 .PP
1496 The parameter to the \-p option is taken to be a 
1497 .I less
1498 command rather than a search pattern.
1499 .PP
1500 The LESS environment variable is ignored,
1501 and the MORE environment variable is used in its place.
1502
1503 .SH "ENVIRONMENT VARIABLES"
1504 Environment variables may be specified either in the system environment
1505 as usual, or in a 
1506 .I lesskey
1507 (1) file.
1508 If environment variables are defined in more than one place, 
1509 variables defined in a local lesskey file take precedence over
1510 variables defined in the system environment, which take precedence
1511 over variables defined in the system-wide lesskey file.
1512 .IP COLUMNS
1513 Sets the number of columns on the screen.
1514 Takes precedence over the number of columns specified by the TERM variable.
1515 (But if you have a windowing system which supports TIOCGWINSZ or WIOCGETD,
1516 the window system's idea of the screen size takes precedence over the
1517 LINES and COLUMNS environment variables.)
1518 .IP EDITOR
1519 The name of the editor (used for the v command).
1520 .IP HOME
1521 Name of the user's home directory
1522 (used to find a lesskey file on Unix and OS/2 systems).
1523 .IP "HOMEDRIVE, HOMEPATH"
1524 Concatenation of the HOMEDRIVE and HOMEPATH environment variables is
1525 the name of the user's home directory if the HOME variable is not set
1526 (only in the Windows version).
1527 .IP INIT
1528 Name of the user's init directory (used to find a lesskey file on OS/2 systems).
1529 .IP LANG
1530 Language for determining the character set.
1531 .IP LC_CTYPE
1532 Language for determining the character set.
1533 .IP LESS
1534 Options which are passed to 
1535 .I less
1536 automatically.
1537 .IP LESSANSIENDCHARS
1538 Characters which may end an ANSI color escape sequence
1539 (default "m").
1540 .IP LESSANSIMIDCHARS
1541 Characters which may appear between the ESC character and the
1542 end character in an ANSI color escape sequence
1543 (default "0123456789;[?!"'#%()*+\ ".
1544 .IP LESSBINFMT
1545 Format for displaying non-printable, non-control characters.
1546 .IP LESSCHARDEF
1547 Defines a character set.
1548 .IP LESSCHARSET
1549 Selects a predefined character set.
1550 .IP LESSCLOSE
1551 Command line to invoke the (optional) input-postprocessor.
1552 .IP LESSECHO
1553 Name of the lessecho program (default "lessecho").
1554 The lessecho program is needed to expand metacharacters, such as * and ?,
1555 in filenames on Unix systems.
1556 .IP LESSEDIT
1557 Editor prototype string (used for the v command).
1558 See discussion under PROMPTS.
1559 .IP LESSGLOBALTAGS
1560 Name of the command used by the \-t option to find global tags.
1561 Normally should be set to "global" if your system has the
1562 .I global
1563 (1) command.  If not set, global tags are not used.
1564 .IP LESSHISTFILE
1565 Name of the history file used to remember search commands and
1566 shell commands between invocations of 
1567 .I less.
1568 If set to "\-" or "/dev/null", a history file is not used.
1569 The default is "$HOME/.lesshst" on Unix systems, "$HOME/_lesshst" on
1570 DOS and Windows systems, or "$HOME/lesshst.ini" or "$INIT/lesshst.ini" 
1571 on OS/2 systems.
1572 .IP LESSHISTSIZE
1573 The maximum number of commands to save in the history file.
1574 The default is 100.
1575 .IP LESSKEY
1576 Name of the default lesskey(1) file.
1577 .IP LESSKEY_SYSTEM
1578 Name of the default system-wide lesskey(1) file.
1579 .IP LESSMETACHARS
1580 List of characters which are considered "metacharacters" by the shell.
1581 .IP LESSMETAESCAPE
1582 Prefix which less will add before each metacharacter in a
1583 command sent to the shell.
1584 If LESSMETAESCAPE is an empty string, commands containing
1585 metacharacters will not be passed to the shell.
1586 .IP LESSOPEN
1587 Command line to invoke the (optional) input-preprocessor.
1588 .IP LESSSECURE
1589 Runs less in "secure" mode.
1590 See discussion under SECURITY.
1591 .IP LESSSEPARATOR
1592 String to be appended to a directory name in filename completion.
1593 .IP LESSUTFBINFMT
1594 Format for displaying non-printable Unicode code points.
1595 .IP LESS_IS_MORE
1596 Emulate the 
1597 .I more
1598 (1) command.
1599 .IP LINES
1600 Sets the number of lines on the screen.
1601 Takes precedence over the number of lines specified by the TERM variable.
1602 (But if you have a windowing system which supports TIOCGWINSZ or WIOCGETD,
1603 the window system's idea of the screen size takes precedence over the
1604 LINES and COLUMNS environment variables.)
1605 .IP PATH
1606 User's search path (used to find a lesskey file 
1607 on MS-DOS and OS/2 systems).
1608 .IP SHELL
1609 The shell used to execute the ! command, as well as to expand filenames.
1610 .IP TERM
1611 The type of terminal on which
1612 .I less
1613 is being run.
1614 .IP VISUAL
1615 The name of the editor (used for the v command).
1616
1617 .SH "SEE ALSO"
1618 lesskey(1)
1619
1620 .SH WARNINGS
1621 The = command and prompts (unless changed by \-P)
1622 report the line numbers of the lines at the top and bottom of the screen,
1623 but the byte and percent of the line after the one at the bottom of the screen.
1624 .PP
1625 On certain older terminals (the so-called "magic cookie" terminals),
1626 search highlighting will cause an erroneous display.
1627 On such terminals, search highlighting is disabled by default 
1628 to avoid possible problems.
1629 .PP
1630 When searching in a binary file, text which follows a null byte 
1631 may not be found.
1632 This problem does not occur when searching with regular expressions turned
1633 off via ^R, and also does not occur when
1634 .I less
1635 is compiled to use the PCRE regular expression library.
1636 .PP
1637 In certain cases, when search highlighting is enabled and 
1638 a search pattern begins with a ^,
1639 more text than the matching string may be highlighted.
1640 (This problem does not occur when less is compiled to use the POSIX
1641 regular expression package.)
1642 .PP
1643 On some systems,
1644 .I setlocale
1645 claims that ASCII characters 0 thru 31 are control characters 
1646 rather than binary characters.
1647 This causes 
1648 .I less 
1649 to treat some binary files as ordinary, non-binary files.
1650 To workaround this problem, set the environment variable
1651 LESSCHARSET to "ascii" (or whatever character set is appropriate).
1652 .PP
1653 This manual is too long.
1654 .PP
1655 See http://www.greenwoodsoftware.com/less for the latest list of known bugs in less.
1656
1657 .SH COPYRIGHT
1658 Copyright (C) 1984-2007  Mark Nudelman
1659 .PP
1660 less is part of the GNU project and is free software.
1661 You can redistribute it and/or modify it
1662 under the terms of either
1663 (1) the GNU General Public License as published by
1664 the Free Software Foundation; or (2) the Less License.
1665 See the file README in the less distribution for more details
1666 regarding redistribution.
1667 You should have received a copy of the GNU General Public License 
1668 along with the source for less; see the file COPYING.
1669 If not, write to the Free Software Foundation, 59 Temple Place,
1670 Suite 330, Boston, MA  02111-1307, USA.
1671 You should also have received a copy of the Less License;
1672 see the file LICENSE.
1673 .PP
1674 less is distributed in the hope that it will be useful, but
1675 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
1676 or FITNESS FOR A PARTICULAR PURPOSE.
1677 See the GNU General Public License for more details.
1678
1679 .SH AUTHOR
1680 .PP
1681 Mark Nudelman <markn@greenwoodsoftware.com>
1682 .br
1683 Send bug reports or comments to the above address or to 
1684 .br
1685 bug-less@gnu.org.
1686 .br
1687 For more information, see the less homepage at 
1688 .br
1689 http://www.greenwoodsoftware.com/less.