Print this page
5025 import and use mandoc
Reviewed by: Hans Rosenfeld <hans.rosenfeld@nexenta.com>
Reviewed by: Igor Kozhukhov <ikozhukhov@gmail.com>
Reviewed by: Robert Mustacchi <rm@joyent.com>
Reviewed by: Albert Lee <trisk@nexenta.com>
Approved by: TBD
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man1/head.1
+++ new/usr/src/man/man1/head.1
1 1 '\" te
2 2 .\" Portions Copyright (c) 2013, Joyent, Inc. All Rights Reserved
3 3 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved Portions
↓ open down ↓ |
3 lines elided |
↑ open up ↑ |
4 4 .\" Copyright 1989 AT&T
5 5 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
6 6 .\" Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures
7 7 .\" 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
8 8 .\" http://www.opengroup.org/bookstore/.
9 9 .\" 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.
10 10 .\" This notice shall appear on any product containing this material.
11 11 .\" 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.
12 12 .\" 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.
13 13 .\" 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]
14 -.TH HEAD 1 "Mar 4, 2013"
14 +.TH HEAD 1 "Mar 4, 2013"
15 15 .SH NAME
16 16 head \- display first few lines of files
17 17 .SH SYNOPSIS
18 18 .SS "/usr/bin/head"
19 19 .LP
20 20 .nf
21 21 \fB/usr/bin/head\fR [\fB-q\fR] [\fB-v\fR] [\fB-number\fR ] [ \fB-n\fR \fInumber\fR ] [ \fB-c\fR \fInumber\fR] [\fIfilename\fR]...
22 22 .fi
23 23
24 24 .SS "ksh93"
25 25 .LP
26 26 .nf
27 27 \fBhead\fR [\fB-qv\fR] [\fB-n\fR \fIlines\fR] [\fB-c\fR \fIchars\fR] [\fB-s\fR \fIskip\fR] [\fIfilename\fR]...
28 28 .fi
29 29
30 30 .SH DESCRIPTION
31 31 .SS "/usr/bin/head"
32 32 .sp
33 33 .LP
34 34 The \fBhead\fR utility copies the first \fInumber\fR of lines of each
35 35 \fIfilename\fR to the standard output. If no \fIfilename\fR is given,
36 36 \fBhead\fR copies lines from the standard input. The default value of
37 37 \fInumber\fR is \fB10\fR lines. If \fB-c\fR is specified, \fBhead\fR
38 38 copies the first \fInumber\fR of bytes of each filename.
39 39 .sp
40 40 .LP
41 41 When more than one file is specified, the start of each file looks like:
42 42 .sp
43 43 .in +2
44 44 .nf
45 45 \fB==>\fR \fIfilename\fR \fB<==\fR
46 46 .fi
47 47 .in -2
48 48
49 49 .sp
50 50 .LP
51 51 Thus, a common way to display a set of short files, identifying each one, is:
52 52 .sp
53 53 .in +2
54 54 .nf
55 55 example% \fBhead -9999 filename1 filename2 ...\fR
56 56 .fi
57 57 .in -2
58 58 .sp
59 59
60 60 .SS "ksh93"
61 61 .sp
62 62 .LP
63 63 The \fBhead\fR built-in in \fBksh93\fR is associated with the \fB/bin\fR and
64 64 \fB/usr/bin\fR paths. It is invoked when \fBhead\fR is executed without a
65 65 pathname prefix and the pathname search finds a \fB/bin/head\fR or
66 66 \fB/usr/bin/head\fR executable.
67 67 .sp
68 68 .LP
69 69 \fBhead\fR copies one or more input files to standard output, stopping at a
70 70 designated point for each file or to the end of the file whichever comes first.
71 71 Copying ends at the point indicated by the options. By default, a header of the
72 72 form \fB==> filename <==\fR is output before all but the first file but this
73 73 can be changed with the \fB-q\fR and \fB-v\fR options. If no file is given, or
74 74 if the file is \fB-\fR, \fBhead\fR copies from standard input starting at the
75 75 current location.
76 76 .sp
77 77 .LP
78 78 The option argument for \fB-c\fR and \fB-s\fR can optionally be followed by one
79 79 of the following characters to specify a different unit other than a single
80 80 byte:
81 81 .sp
82 82 .ne 2
83 83 .na
84 84 \fB\fBb\fR\fR
85 85 .ad
86 86 .RS 5n
87 87 512 bytes
88 88 .RE
89 89
90 90 .sp
91 91 .ne 2
92 92 .na
93 93 \fB\fBk\fR\fR
94 94 .ad
95 95 .RS 5n
96 96 1-kilobyte
97 97 .RE
98 98
99 99 .sp
100 100 .ne 2
101 101 .na
102 102 \fB\fBm\fR\fR
103 103 .ad
104 104 .RS 5n
105 105 1-megabyte
106 106 .RE
107 107
108 108 .sp
109 109 .LP
110 110 For backwards compatibility, \fB-number\fR is equivalent to \fB-n\fR number.
111 111 .SH OPTIONS
112 112 .SS "/usr/bin/head"
113 113 .sp
114 114 .LP
115 115 The following options are supported by \fB/usr/bin/head\fR:
116 116 .sp
117 117 .ne 2
118 118 .na
119 119 \fB\fB-n\fR \fInumber\fR\fR
120 120 .ad
121 121 .RS 13n
122 122 The first \fInumber\fR lines of each input file is copied to standard output.
123 123 The \fInumber\fR option-argument must be a positive decimal integer.
124 124 .RE
125 125
126 126 .sp
127 127 .ne 2
128 128 .na
129 129 \fB\fB-c\fR \fInumber\fR\fR
130 130 .ad
131 131 .RS 13n
132 132 The first \fInumber\fR bytes of each input file is copied to standard output.
133 133 The \fInumber\fR option-argument must be a positive decimal integer. Note,
134 134 output may end in the middle of a character if a file contains multi-byte
135 135 characters.
136 136 .RE
137 137
138 138 .sp
139 139 .ne 2
140 140 .na
141 141 \fB\fB-\fR\fInumber\fR\fR
142 142 .ad
143 143 .RS 13n
144 144 The \fInumber\fR argument is a positive decimal integer with the same effect as
145 145 the \fB-n\fR \fInumber\fR option.
146 146 .RE
147 147
148 148 .sp
149 149 .ne 2
150 150 .na
151 151 \fB\FB-q\fR\fR
152 152 .ad
153 153 .RS 13n
154 154 \fBhead\fR will not print a header in between each specified file.
155 155 .RE
156 156
157 157 .sp
158 158 .ne 2
159 159 .na
160 160 \fB\FB-v\fR\fR
161 161 .ad
162 162 .RS 13n
163 163 \fBhead\fR will always print a header in between each specified file.
164 164 .RE
165 165
166 166 .sp
167 167 .LP
168 168 If no options are specified, \fBhead\fR acts as if \fB-n\fR \fB10\fR had been
169 169 specified.
170 170 .SS "ksh93"
171 171 .sp
172 172 .LP
173 173 The following options are supported by the head built-in command in
174 174 \fBksh93\fR:
175 175 .sp
176 176 .ne 2
177 177 .na
178 178 \fB\fB-n\fR\fR
179 179 .ad
180 180 .br
181 181 .na
182 182 \fB\fB--lines=\fR\fIlines\fR\fR
183 183 .ad
184 184 .RS 18n
185 185 Copy lines from each file. The default value is \fB10\fR.
186 186 .RE
187 187
188 188 .sp
189 189 .ne 2
190 190 .na
191 191 \fB\fB-c\fR\fR
192 192 .ad
193 193 .br
194 194 .na
195 195 \fB\fB--bytes=\fR\fIchars\fR\fR
196 196 .ad
197 197 .RS 18n
198 198 Copy \fIchars\fR bytes from each file.
199 199 .RE
200 200
201 201 .sp
202 202 .ne 2
203 203 .na
204 204 \fB\fB-q\fR\fR
205 205 .ad
206 206 .br
207 207 .na
208 208 \fB\fB--quiet|silent\fR\fR
209 209 .ad
210 210 .RS 18n
211 211 Never output filename headers.
212 212 .RE
213 213
214 214 .sp
215 215 .ne 2
216 216 .na
217 217 \fB\fB-s\fR\fR
218 218 .ad
219 219 .br
220 220 .na
221 221 \fB\fB--skip=\fR\fIskip\fR\fR
222 222 .ad
223 223 .RS 18n
224 224 Skip \fIskip\fR characters or lines from each file before copying.
225 225 .RE
226 226
227 227 .sp
228 228 .ne 2
229 229 .na
230 230 \fB\fB-v\fR\fR
231 231 .ad
232 232 .br
233 233 .na
234 234 \fB\fB--verbose\fR\fR
235 235 .ad
236 236 .RS 18n
237 237 Always output filename headers.
238 238 .RE
239 239
240 240 .SH OPERANDS
241 241 .sp
242 242 .LP
243 243 The following operand is supported:
244 244 .sp
245 245 .ne 2
246 246 .na
247 247 \fB\fB\fIfilename\fR\fR\fR
248 248 .ad
249 249 .RS 12n
250 250 A path name of an input file. If no \fIfile\fR operands are specified, the
251 251 standard input is used.
252 252 .RE
253 253
254 254 .SH USAGE
255 255 .sp
256 256 .LP
257 257 See \fBlargefile\fR(5) for the description of the behavior of \fBhead\fR when
258 258 encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
259 259 .SH EXAMPLES
260 260 .LP
261 261 \fBExample 1 \fRWriting the First Ten Lines of All Files
262 262 .sp
263 263 .LP
264 264 The following example writes the first ten lines of all files, except those
265 265 with a leading period, in the directory:
266 266
267 267 .sp
268 268 .in +2
269 269 .nf
270 270 example% \fBhead *\fR
271 271 .fi
272 272 .in -2
273 273 .sp
274 274
275 275 .SH ENVIRONMENT VARIABLES
276 276 .sp
277 277 .LP
278 278 See \fBenviron\fR(5) for descriptions of the following environment variables
279 279 that affect the execution of \fBhead\fR: \fBLANG\fR, \fBLC_ALL\fR,
280 280 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
281 281 .SH EXIT STATUS
282 282 .sp
283 283 .LP
284 284 The following exit values are returned:
285 285 .sp
286 286 .ne 2
287 287 .na
288 288 \fB\fB0\fR\fR
289 289 .ad
290 290 .RS 6n
291 291 Successful completion.
292 292 .RE
293 293
294 294 .sp
295 295 .ne 2
296 296 .na
297 297 \fB\fB>0\fR\fR
298 298 .ad
299 299 .RS 6n
300 300 An error occurred.
301 301 .RE
302 302
303 303 .SH ATTRIBUTES
304 304 .sp
305 305 .LP
306 306 See \fBattributes\fR(5) for descriptions of the following attributes:
307 307 .SS "/usr/bin/head"
308 308 .sp
309 309
310 310 .sp
311 311 .TS
312 312 box;
313 313 c | c
314 314 l | l .
315 315 ATTRIBUTE TYPE ATTRIBUTE VALUE
316 316 _
317 317 CSI Enabled
318 318 _
319 319 Interface Stability Committed
320 320 _
321 321 Standard See \fBstandards\fR(5).
322 322 .TE
323 323
324 324 .SS "ksh93"
325 325 .sp
326 326
327 327 .sp
328 328 .TS
329 329 box;
330 330 c | c
331 331 l | l .
332 332 ATTRIBUTE TYPE ATTRIBUTE VALUE
333 333 _
334 334 Interface Stability See below.
335 335 .TE
336 336
337 337 .sp
338 338 .LP
339 339 The \fBksh93\fR built-in binding to \fB/bin\fR and \fB/usr/bin\fR is Volatile.
340 340 The built-in interfaces are Uncommitted.
341 341 .SH SEE ALSO
342 342 .sp
343 343 .LP
344 344 \fBcat\fR(1), \fBksh93\fR(1), \fBmore\fR(1), \fBpg\fR(1), \fBtail\fR(1),
345 345 \fBattributes\fR(5), \fBenviron\fR(5), \fBlargefile\fR(5), \fBstandards\fR(5)
↓ open down ↓ |
321 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX