Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / look / look.1
1 .\" Copyright (c) 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. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)look.1      8.1 (Berkeley) 6/14/93
33 .\" $FreeBSD: src/usr.bin/look/look.1,v 1.6.2.3 2002/06/21 15:27:58 charnier Exp $
34 .\"
35 .Dd June 14, 1993
36 .Dt LOOK 1
37 .Os
38 .Sh NAME
39 .Nm look
40 .Nd display lines beginning with a given string
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl df
44 .Op Fl t Ar termchar
45 .Ar string
46 .Op Ar
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility displays any lines in
51 .Ar file
52 which contain
53 .Ar string
54 as a prefix.
55 As
56 .Nm
57 performs a binary search, the lines in
58 .Ar file
59 must be sorted.
60 .Pp
61 If
62 .Ar file
63 is not specified, the file
64 .Pa /usr/share/dict/words
65 is used, only alphanumeric characters are compared and the case of
66 alphabetic characters is ignored.
67 .Pp
68 Options:
69 .Bl -tag -width Ds
70 .It Fl d
71 Dictionary character set and order, i.e. only alphanumeric characters
72 are compared.
73 .It Fl f
74 Ignore the case of alphabetic characters.
75 .It Fl t
76 Specify a string termination character, i.e. only the characters
77 in
78 .Ar string
79 up to and including the first occurrence of
80 .Ar termchar
81 are compared.
82 .El
83 .Pp
84 The
85 .Nm
86 utility exits 0 if one or more lines were found and displayed,
87 1 if no lines were found, and >1 if an error occurred.
88 .Sh FILES
89 .Bl -tag -width /usr/share/dict/words -compact
90 .It Pa /usr/share/dict/words
91 the dictionary
92 .El
93 .Sh SEE ALSO
94 .Xr grep 1 ,
95 .Xr sort 1
96 .Sh COMPATIBILITY
97 The original manual page stated that tabs and blank characters participated
98 in comparisons when the
99 .Fl d
100 option was specified.
101 This was incorrect and the current man page matches the historic
102 implementation.
103 .Sh HISTORY
104 A
105 .Nm
106 utility appeared in
107 .At v7 .