xref: /freebsd/usr.bin/tail/tail.1 (revision d056fa046c6a91b90cd98165face0e42a33a5173)
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$
37.\"
38.Dd June 29, 2006
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.Op Fl q
52.Oo
53.Fl b Ar number |
54.Fl c Ar number |
55.Fl n Ar number
56.Oc
57.Op Ar
58.Sh DESCRIPTION
59The
60.Nm
61utility displays the contents of
62.Ar file
63or, by default, its standard input, to the standard output.
64.Pp
65The display begins at a byte, line or 512-byte block location in the
66input.
67Numbers having a leading plus (``+'') sign are relative to the beginning
68of the input, for example,
69.Dq -c +2
70starts the display at the second
71byte of the input.
72Numbers having a leading minus (``-'') sign or no explicit sign are
73relative to the end of the input, for example,
74.Dq -n 2
75displays the last two lines of the input.
76The default starting location is
77.Dq -n 10 ,
78or the last 10 lines of the input.
79.Pp
80The options are as follows:
81.Bl -tag -width Ds
82.It Fl b Ar number
83The location is
84.Ar number
85512-byte blocks.
86.It Fl c Ar number
87The location is
88.Ar number
89bytes.
90.It Fl f
91The
92.Fl f
93option causes
94.Nm
95to not stop when end of file is reached, but rather to wait for additional
96data to be appended to the input.
97The
98.Fl f
99option is ignored if the standard input is a pipe, but not if it is a FIFO.
100.It Fl F
101The
102.Fl F
103option implies the
104.Fl f
105option, but
106.Nm
107will also check to see if the file being followed has been renamed or rotated.
108The file is closed and reopened when
109.Nm
110detects that the filename being read from has a new inode number.
111The
112.Fl F
113option is ignored if reading from standard input rather than a file.
114.It Fl n Ar number
115The location is
116.Ar number
117lines.
118.It Fl q
119Suppresses printing of headers when multiple files are being examined.
120.It Fl r
121The
122.Fl r
123option causes the input to be displayed in reverse order, by line.
124Additionally, this option changes the meaning of the
125.Fl b ,
126.Fl c
127and
128.Fl n
129options.
130When the
131.Fl r
132option is specified, these options specify the number of bytes, lines
133or 512-byte blocks to display, instead of the bytes, lines or blocks
134from the beginning or end of the input from which to begin the display.
135The default for the
136.Fl r
137option is to display all of the input.
138.El
139.Pp
140If more than a single file is specified, each file is preceded by a
141header consisting of the string
142.Dq ==> XXX <==
143where
144.Dq XXX
145is the name of the file unless
146.Fl q
147flag is specified.
148.Sh EXIT STATUS
149.Ex -std
150.Sh SEE ALSO
151.Xr cat 1 ,
152.Xr head 1 ,
153.Xr sed 1
154.Sh STANDARDS
155The
156.Nm
157utility is expected to be a superset of the
158.St -p1003.2-92
159specification.
160In particular, the
161.Fl F ,
162.Fl b
163and
164.Fl r
165options are extensions to that standard.
166.Pp
167The historic command line syntax of
168.Nm
169is supported by this implementation.
170The only difference between this implementation and historic versions
171of
172.Nm ,
173once the command line syntax translation has been done, is that the
174.Fl b ,
175.Fl c
176and
177.Fl n
178options modify the
179.Fl r
180option, i.e., ``-r -c 4'' displays the last 4 characters of the last line
181of the input, while the historic tail (using the historic syntax ``-4cr'')
182would ignore the
183.Fl c
184option and display the last 4 lines of the input.
185.Sh HISTORY
186A
187.Nm
188command appeared in PWB UNIX.
189