diff options
| author |   aaron <aaron@openbsd.org> | 1999-07-21 13:19:20 +0000 |
|---|---|---|
| committer | aaron <aaron@openbsd.org> | 1999-07-21 13:19:20 +0000 |
| commit | f27ab9a4a1dca1d18082961a46053e3fdb4e5109 (patch) | |
| tree | 85b190782a7c2e181a6fe80cf783a2ac3bdf9839 | |
| parent | sync names of arguments in SYNOPSIS with those in the option's description (diff) | |
| download | wireguard-openbsd-f27ab9a4a1dca1d18082961a46053e3fdb4e5109.tar.xz wireguard-openbsd-f27ab9a4a1dca1d18082961a46053e3fdb4e5109.zip | |
Improve the description and add examples, including one that demonstrates how
head(1) is often used in conjunction with tail -1 to display a single arbitrary
line from a file.
| -rw-r--r-- | usr.bin/head/head.1 | 61 |
1 files changed, 54 insertions, 7 deletions
diff --git a/usr.bin/head/head.1 b/usr.bin/head/head.1 index 88832fb3088..274eb54c185 100644 --- a/usr.bin/head/head.1 +++ b/usr.bin/head/head.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: head.1,v 1.3 1999/06/05 01:21:27 aaron Exp $ +.\" $OpenBSD: head.1,v 1.4 1999/07/21 13:19:20 aaron Exp $ .\" Copyright (c) 1980, 1990 The Regents of the University of California. .\" All rights reserved. .\" @@ -37,24 +37,71 @@ .Os .Sh NAME .Nm head -.Nd give first few lines +.Nd display first few lines of files .Sh SYNOPSIS .Nm head -.Op Fl n Ar count +.Oo +.Fl Ns Ar count No \&| +.Fl n Ar count +.Oc .Op Ar .Sh DESCRIPTION -This filter copies the first +The +.Nm +utility copies the first .Ar count -lines of each of the specified files, or of the standard input. +lines of each specified +.Ar file +to the standard output. +If no +.Ar file +is given, +.Nm +copies lines from the standard input. If .Ar count -is omitted it defaults to -10. +is omitted, it defaults to 10. +.Pp +The options are as follows: +.Pp +.Bl -tag -width Ds +.It Xo Fl Ns Ar count No \&| +.Fl n Ar count +.Xc +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 EXAMPLES +To display the first 500 lines of the file +.Ar foo : +.Pp +.Dl $ head -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 -500 foo | tail -1 .Sh COMPATIBILITY The historic command line syntax of .Nm is supported by this implementation. .Sh SEE ALSO +.Xr cat 1 , +.Xr less 1 , +.Xr more 1 , .Xr tail 1 .Sh STANDARDS The |