summaryrefslogtreecommitdiff
path: root/usr.bin/head/head.1
blob: c490e71ebdd7526cbf7fde34afeaca6654c65214 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
.\"	$OpenBSD: head.1,v 1.20 2014/03/21 11:20:41 jmc Exp $
.\"
.\" Copyright (c) 1980, 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	from: @(#)head.1	6.6 (Berkeley) 7/24/91
.\"
.Dd $Mdocdate: March 21 2014 $
.Dt HEAD 1
.Os
.Sh NAME
.Nm head
.Nd display first few lines of files
.Sh SYNOPSIS
.Nm head
.Op Fl Ns Ar count | Fl n Ar count
.Op Ar
.Sh DESCRIPTION
The
.Nm
utility copies the first
.Ar count
lines of each specified
.Ar file
to the standard output.
If no files are named,
.Nm
copies lines from the standard input.
If
.Ar count
is omitted, it defaults to 10.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl Ns Ar count | Fl n Ar count
Copy the first
.Ar count
lines of each input file to the standard output.
.Ar count
must be a positive decimal integer.
.El
.Pp
If more than one file is specified,
.Nm
precedes the output of each file with the following, in order to distinguish
the head of each file:
.Pp
.Dl ==> Ar file No <==
.Sh EXIT STATUS
.Ex -std head
.Sh EXAMPLES
To display the first 500 lines of the file
.Ar foo :
.Pp
.Dl $ head -n 500 foo
.Pp
.Nm
can be used in conjunction with
.Xr tail 1
in the following way to, for example, display only line 500 from the file
.Ar foo :
.Pp
.Dl $ head -n 500 foo | tail -1
.Sh SEE ALSO
.Xr cat 1 ,
.Xr less 1 ,
.Xr more 1 ,
.Xr tail 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2008
specification.
.Pp
The historic syntax
.Fl Ns Ar count
is supported by this implementation.
.Sh HISTORY
The
.Nm
utility first appeared in
.Bx 1 .
.Sh AUTHORS
.An Bill Joy ,
August 24, 1977.