Merge branch 'vendor/LDNS'
[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. 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 .\"     @(#)look.1      8.1 (Berkeley) 6/14/93
29 .\" $FreeBSD: src/usr.bin/look/look.1,v 1.6.2.3 2002/06/21 15:27:58 charnier Exp $
30 .\" $DragonFly: src/usr.bin/look/look.1,v 1.3 2006/02/17 19:39:09 swildner Exp $
31 .\"
32 .Dd June 14, 1993
33 .Dt LOOK 1
34 .Os
35 .Sh NAME
36 .Nm look
37 .Nd display lines beginning with a given string
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl df
41 .Op Fl t Ar termchar
42 .Ar string
43 .Op Ar
44 .Sh DESCRIPTION
45 The
46 .Nm
47 utility displays any lines in
48 .Ar file
49 which contain
50 .Ar string
51 as a prefix.
52 As
53 .Nm
54 performs a binary search, the lines in
55 .Ar file
56 must be sorted.
57 .Pp
58 If
59 .Ar file
60 is not specified, the file
61 .Pa /usr/share/dict/words
62 is used, only alphanumeric characters are compared and the case of
63 alphabetic characters is ignored.
64 .Pp
65 Options:
66 .Bl -tag -width Ds
67 .It Fl d
68 Dictionary character set and order, i.e. only alphanumeric characters
69 are compared.
70 .It Fl f
71 Ignore the case of alphabetic characters.
72 .It Fl t
73 Specify a string termination character, i.e. only the characters
74 in
75 .Ar string
76 up to and including the first occurrence of
77 .Ar termchar
78 are compared.
79 .El
80 .Pp
81 The
82 .Nm
83 utility exits 0 if one or more lines were found and displayed,
84 1 if no lines were found, and >1 if an error occurred.
85 .Sh FILES
86 .Bl -tag -width /usr/share/dict/words -compact
87 .It Pa /usr/share/dict/words
88 the dictionary
89 .El
90 .Sh COMPATIBILITY
91 The original manual page stated that tabs and blank characters participated
92 in comparisons when the
93 .Fl d
94 option was specified.
95 This was incorrect and the current man page matches the historic
96 implementation.
97 .Sh SEE ALSO
98 .Xr grep 1 ,
99 .Xr sort 1
100 .Sh HISTORY
101 A
102 .Nm
103 utility appeared in
104 .At v7 .