xref: /dragonfly/usr.bin/head/head.1 (revision 029e6489)
1.\" Copyright (c) 1980, 1990, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"	@(#)head.1	8.1 (Berkeley) 6/6/93
29.\" $FreeBSD: src/usr.bin/head/head.1,v 1.4.2.6 2002/07/15 06:33:12 keramida Exp $
30.\"
31.Dd June 19, 2020
32.Dt HEAD 1
33.Os
34.Sh NAME
35.Nm head
36.Nd display the first part of files
37.Sh SYNOPSIS
38.Nm
39.Op Fl q | Fl v
40.Op Fl n Ar count | Fl c Ar bytes
41.Op Ar
42.Sh DESCRIPTION
43This filter displays the first
44.Ar count
45lines or
46.Ar bytes
47of each of the specified files, or of the standard input if no
48files are specified.
49If
50.Ar count
51is omitted it defaults to 10.
52.Pp
53If more than a single file is specified, or the
54.Fl v
55flag is used, each file is preceded by a header consisting of the string
56.Dq ==> XXX <==
57where
58.Dq XXX
59is the name of the file.
60The
61.Fl q
62flag disables the printing of the header in both cases.
63.Sh EXIT STATUS
64.Ex -std
65.Sh COMPATIBILITY
66The historic command line syntax of
67.Nm
68is supported by this implementation.
69.Pp
70This command is mostly compatible with GNU extensions to
71.Nm .
72.Sh SEE ALSO
73.Xr tail 1
74.Sh STANDARDS
75The
76.Nm
77utility conforms to
78.St -p1003.2-92 .
79.Sh HISTORY
80The
81.Nm
82command appeared in PWB
83.Ux .
84