Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / tail / tail.1
1 .\" Copyright (c) 1980, 1990, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the Institute of Electrical and Electronics Engineers, Inc.
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. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by the University of
18 .\"     California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\"     @(#)tail.1      8.1 (Berkeley) 6/6/93
36 .\" $FreeBSD: src/usr.bin/tail/tail.1,v 1.5.2.4 2002/07/15 07:46:27 keramida Exp $
37 .\"
38 .Dd June 6, 1993
39 .Dt TAIL 1
40 .Os
41 .Sh NAME
42 .Nm tail
43 .Nd display the last part of a file
44 .Sh SYNOPSIS
45 .Nm
46 .Oo
47 .Fl F |
48 .Fl f |
49 .Fl r
50 .Oc
51 .Oo
52 .Fl b Ar number |
53 .Fl c Ar number |
54 .Fl n Ar number
55 .Oc
56 .Op Ar
57 .Sh DESCRIPTION
58 The
59 .Nm
60 utility displays the contents of
61 .Ar file
62 or, by default, its standard input, to the standard output.
63 .Pp
64 The display begins at a byte, line or 512-byte block location in the
65 input.
66 Numbers having a leading plus (``+'') sign are relative to the beginning
67 of the input, for example,
68 .Dq -c +2
69 starts the display at the second
70 byte of the input.
71 Numbers having a leading minus (``-'') sign or no explicit sign are
72 relative to the end of the input, for example,
73 .Dq -n 2
74 displays the last two lines of the input.
75 The default starting location is
76 .Dq -n 10 ,
77 or the last 10 lines of the input.
78 .Pp
79 The options are as follows:
80 .Bl -tag -width Ds
81 .It Fl b Ar number
82 The location is
83 .Ar number
84 512-byte blocks.
85 .It Fl c Ar number
86 The location is
87 .Ar number
88 bytes.
89 .It Fl f
90 The
91 .Fl f
92 option causes
93 .Nm
94 to not stop when end of file is reached, but rather to wait for additional
95 data to be appended to the input.
96 The
97 .Fl f
98 option is ignored if the standard input is a pipe, but not if it is a FIFO.
99 .It Fl F
100 The
101 .Fl F
102 option implies the
103 .Fl f
104 option, but
105 .Nm
106 will also check to see if the file being followed has been renamed or rotated.
107 The file is closed and reopened when
108 .Nm
109 detects that the filename being read from has a new inode number.
110 The
111 .Fl F
112 option is ignored if reading from standard input rather than a file.
113 .It Fl n Ar number
114 The location is
115 .Ar number
116 lines.
117 .It Fl r
118 The
119 .Fl r
120 option causes the input to be displayed in reverse order, by line.
121 Additionally, this option changes the meaning of the
122 .Fl b ,
123 .Fl c
124 and
125 .Fl n
126 options.
127 When the
128 .Fl r
129 option is specified, these options specify the number of bytes, lines
130 or 512-byte blocks to display, instead of the bytes, lines or blocks
131 from the beginning or end of the input from which to begin the display.
132 The default for the
133 .Fl r
134 option is to display all of the input.
135 .El
136 .Pp
137 If more than a single file is specified, each file is preceded by a
138 header consisting of the string
139 .Dq ==> XXX <==
140 where
141 .Dq XXX
142 is the name of the file.
143 .Sh DIAGNOSTICS
144 .Ex -std
145 .Sh SEE ALSO
146 .Xr cat 1 ,
147 .Xr head 1 ,
148 .Xr sed 1
149 .Sh STANDARDS
150 The
151 .Nm
152 utility is expected to be a superset of the
153 .St -p1003.2-92
154 specification.
155 In particular, the
156 .Fl F ,
157 .Fl b
158 and
159 .Fl r
160 options are extensions to that standard.
161 .Pp
162 The historic command line syntax of
163 .Nm
164 is supported by this implementation.
165 The only difference between this implementation and historic versions
166 of
167 .Nm ,
168 once the command line syntax translation has been done, is that the
169 .Fl b ,
170 .Fl c
171 and
172 .Fl n
173 options modify the
174 .Fl r
175 option, i.e. ``-r -c 4'' displays the last 4 characters of the last line
176 of the input, while the historic tail (using the historic syntax ``-4cr'')
177 would ignore the
178 .Fl c
179 option and display the last 4 lines of the input.
180 .Sh HISTORY
181 A
182 .Nm
183 command appeared in PWB UNIX.