add UNLEASHED_OBJ to unleashed.mk
[unleashed/tickless.git] / share / man / man1 / tail.1
blob1959e9b9c40f3e075b3a33578d4c5281737861ef
1 '\" te
2 .\"  Copyright 1989 AT&T  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions Copyright (c) 2005, Sun Microsystems, Inc.  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 TAIL 1 "Oct 25, 2017"
11 .SH NAME
12 tail \- deliver the last part of a file
13 .SH SYNOPSIS
14 .LP
15 .nf
16 \fB/usr/bin/tail\fR [\fB-f\fR | \fB-r\fR] [\fB-c\fR \fInumber\fR | \fB-n\fR \fInumber\fR] [\fIfile\fR]
17 .fi
19 .LP
20 .nf
21 \fB/usr/bin/tail\fR [\(+- \fInumber\fR [l | b | c] [f]] [\fIfile\fR]
22 .fi
24 .LP
25 .nf
26 \fB/usr/bin/tail\fR [\(+- \fInumber\fR [l] [f | r]] [\fIfile\fR]
27 .fi
29 .SH DESCRIPTION
30 .sp
31 .LP
32 The \fBtail\fR utility copies the named file to the standard output beginning
33 at a designated place. If no file is named, the standard input is used.
34 .sp
35 .LP
36 Copying begins at a point in the file indicated by the \fB-c\fR\fInumber\fR,
37 \fB-n\fR\fInumber\fR, or \fB\(+-\fR\fInumber\fR options (if \fB+\fR\fInumber\fR
38 is specified, begins at distance number from the beginning; if
39 \fB-\fR\fInumber\fR is specified, from the end of the input; if \fInumber\fR is
40 \fINULL\fR, the value \fB10\fR is assumed). \fInumber\fR is counted in units of
41 lines or byte according to the \fB-c\fR \fB or \fR \fB-n\fR options, or lines,
42 blocks, or bytes, according to the appended option \fBl\fR, \fBb\fR, or
43 \fBc\fR. When no units are specified, counting is by lines.
44 .SH OPTIONS
45 .sp
46 .LP
47 The following options are supported. The \fB-r\fR and \fB-f\fR options are mutually
48 exclusive. If both are specified on the command line, the \fB-f\fR option is
49 ignored.
50 .sp
51 .ne 2
52 .na
53 \fB\fB-b\fR \fR
54 .ad
55 .RS 7n
56 Units of blocks.
57 .RE
59 .sp
60 .ne 2
61 .na
62 \fB\fB-c\fR \fR
63 .ad
64 .RS 7n
65 Units of bytes.
66 .RE
68 .sp
69 .ne 2
70 .na
71 \fB\fB-f\fR \fR
72 .ad
73 .RS 7n
74 Follow. If the input-file is not a pipe, \fBtail\fR does not terminate after
75 the last line of the input-file has been copied, but enters an endless loop,
76 wherein it watches the file for modifications and attempts to read and copy
77 further records from the input-file. Thus it can be used to monitor the growth
78 of a file that is being written by some other process. If the watched file is
79 truncated \fBtail\fR will begin reading records from the start of the file.
80 .RE
82 .sp
83 .ne 2
84 .na
85 \fB\fB-F\fR \fR
86 .ad
87 .RS 7n
88 Follow named file. Operates as with \fB-f\fR, except that if the file is moved
89 (e.g. if a watched log file is rotated) \fBtail\fR will close the original file
90 and begin reading records from the start of the file with the specified name
91 if and when that file is recreated.
92 .RE
94 .sp
95 .ne 2
96 .na
97 \fB\fB-l\fR \fR
98 .ad
99 .RS 7n
100 Units of lines.
104 .ne 2
106 \fB\fB-r\fR \fR
108 .RS 7n
109 Reverse. Copies lines from the specified starting point in the file in reverse
110 order. The default for \fBr\fR is to print the entire file in reverse order.
114 .ne 2
116 \fB\fB-c\fR \fInumber\fR \fR
118 .RS 14n
119 The \fInumber\fR option-argument must be a decimal integer whose sign affects
120 the location in the file, measured in bytes, to begin the copying:
122 .ne 2
124 \fB\fB+\fR \fR
126 .RS 9n
127 Copying starts relative to the beginning of the file.
131 .ne 2
133 \fB\fB\(mi\fR \fR
135 .RS 9n
136 Copying starts relative to the end of the file.
140 .ne 2
142 \fBnone\fR
144 .RS 9n
145 Copying starts relative to the end of the file.
148 The origin for counting is 1; that is, \fB\fR\fB-c\fR\fB+1\fR represents the
149 first byte of the file, \fB\fR\fB-c\fR\fB\(mi1\fR the last.
153 .ne 2
155 \fB\fB-n\fR \fInumber\fR \fR
157 .RS 14n
158 Equivalent to \fB-c\fR\fInumber,\fR except the starting location in the file is
159 measured in lines instead of bytes. The origin for counting is \fB1\fR. That
160 is, \fB-n\fR\fB+1\fR represents the first line of the file, \fB-n\fR\fB\(mi1\fR
161 the last.
164 .SH OPERANDS
167 The following operand is supported:
169 .ne 2
171 \fB\fIfile\fR \fR
173 .RS 9n
174 A path name of an input file. If no \fIfile\fR operands are specified, the
175 standard input is used.
178 .SH USAGE
181 See \fBlargefile\fR(5) for the description of the behavior of \fBtail\fR when
182 encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
183 .SH EXAMPLES
185 \fBExample 1 \fRUsing the tail Command
188 The following command prints the last ten lines of the file \fBfred\fR,
189 followed by any lines that are appended to \fBfred\fR between the time
190 \fBtail\fR is initiated and killed.
193 .in +2
195 example% \fBtail -f fred\fR
197 .in -2
202 The next command prints the last 15 bytes of the file \fBfred\fR, followed by
203 any lines that are appended to \fBfred\fR between the time \fBtail\fR is
204 initiated and killed:
207 .in +2
209 example% \fBtail -15cf fred\fR
211 .in -2
214 .SH ENVIRONMENT VARIABLES
217 See \fBenviron\fR(5) for descriptions of the following environment variables
218 that affect the execution of \fBtail\fR: \fBLANG\fR, \fBLC_ALL\fR,
219 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
220 .SH EXIT STATUS
223 The following exit values are returned:
225 .ne 2
227 \fB\fB0\fR \fR
229 .RS 7n
230 Successful completion.
234 .ne 2
236 \fB\fB>0\fR \fR
238 .RS 7n
239 An error occurred.
242 .SH ATTRIBUTES
245 See \fBattributes\fR(5) for descriptions of the following attributes:
246 .SS "/usr/bin/tail"
251 box;
252 c | c
253 l | l .
254 ATTRIBUTE TYPE  ATTRIBUTE VALUE
256 CSI     Enabled
258 Interface Stability     Standard
261 .SH SEE ALSO
264 \fBcat\fR(1), \fBhead\fR(1), \fBmore\fR(1), \fBpg\fR(1), \fBdd\fR(1M),
265 \fBattributes\fR(5), \fBenviron\fR(5), \fBlargefile\fR(5), \fBstandards\fR(5)
266 .SH NOTES
269 Piped tails relative to the end of the file are stored in a buffer, and thus
270 are limited in length. Various kinds of anomalous behavior can happen with
271 character special files.