[thirdparty/util-linux.git] / misc-utils / look.1

.\" Copyright (c) 1990, 1993
.\"	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. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. 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.
.\"
.\"     @(#)look.1	8.1 (Berkeley) 6/14/93
.\"
.Dd June 14, 1993
.Dt LOOK 1
.Os
.Sh NAME
.Nm look
.Nd display lines beginning with a given string
.Sh SYNOPSIS
.Nm look
.Op Fl dfa
.Op Fl t Ar termchar
.Ar string
.Op Ar file
.Sh DESCRIPTION
The 
.Nm look
utility displays any lines in
.Ar file
which contain
.Ar string
as a prefix.
As
.Nm look
performs a binary search, the lines in
.Ar file
must be sorted (where
.Xr sort 1
got the same options \-d and/or \-f that
.Nm look
is invoked with).
.Pp
If
.Ar file
is not specified, the file
.Pa /usr/share/dict/words
is used, only alphanumeric characters are compared and the case of
alphabetic characters is ignored.
.Pp
Options:
.Bl -tag -width Ds
.It Fl d
Dictionary character set and order, i.e. only alphanumeric characters
are compared.
.It Fl f
Ignore the case of alphabetic characters.
.It Fl a
Use the alternate dictionary
.Pa /usr/share/dict/web2
.It Fl t
Specify a string termination character, i.e. only the characters
in
.Ar string
up to and including the first occurrence of
.Ar termchar
are compared.
.El
.Pp
The
.Nm look
utility exits 0 if one or more lines were found and displayed,
1 if no lines were found, and >1 if an error occurred.
.Sh FILES
.Bl -tag -width /usr/share/dict/words -compact
.It Pa /usr/share/dict/words
the dictionary
.It Pa /usr/share/dict/web2
the alternate dictionary
.El
.Sh SEE ALSO
.Xr grep 1 ,
.Xr sort 1
.Sh COMPATIBILITY
The original manual page stated that tabs and blank characters participated
in comparisons when the
.Fl d
option was specified.
This was incorrect and the current man page matches the historic
implementation.
.Sh HISTORY
.Nm Look
appeared in Version 7 AT&T Unix.
.Sh AVAILABILITY
The look command is part of the util-linux-ng package and is available from
ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.
Commit	Line	Data
6dbe3af9 KZ	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	.\"
	34	.Dd June 14, 1993
	35	.Dt LOOK 1
	36	.Os
	37	.Sh NAME
	38	.Nm look
	39	.Nd display lines beginning with a given string
	40	.Sh SYNOPSIS
	41	.Nm look
	42	.Op Fl dfa
	43	.Op Fl t Ar termchar
	44	.Ar string
	45	.Op Ar file
	46	.Sh DESCRIPTION
	47	The
	48	.Nm look
	49	utility displays any lines in
	50	.Ar file
	51	which contain
	52	.Ar string
	53	as a prefix.
	54	As
	55	.Nm look
	56	performs a binary search, the lines in
	57	.Ar file
eb63b9b8 KZ	58	must be sorted (where
	59	.Xr sort 1
	60	got the same options \-d and/or \-f that
	61	.Nm look
	62	is invoked with).
6dbe3af9 KZ	63	.Pp
	64	If
	65	.Ar file
	66	is not specified, the file
364cda48	67	.Pa /usr/share/dict/words
6dbe3af9 KZ	68	is used, only alphanumeric characters are compared and the case of
	69	alphabetic characters is ignored.
	70	.Pp
	71	Options:
	72	.Bl -tag -width Ds
	73	.It Fl d
	74	Dictionary character set and order, i.e. only alphanumeric characters
	75	are compared.
	76	.It Fl f
	77	Ignore the case of alphabetic characters.
	78	.It Fl a
	79	Use the alternate dictionary
364cda48	80	.Pa /usr/share/dict/web2
6dbe3af9 KZ	81	.It Fl t
	82	Specify a string termination character, i.e. only the characters
	83	in
	84	.Ar string
	85	up to and including the first occurrence of
	86	.Ar termchar
	87	are compared.
	88	.El
	89	.Pp
	90	The
	91	.Nm look
	92	utility exits 0 if one or more lines were found and displayed,
	93	1 if no lines were found, and >1 if an error occurred.
	94	.Sh FILES
364cda48 KZ	95	.Bl -tag -width /usr/share/dict/words -compact
364cda48 KZ	96	.It Pa /usr/share/dict/words
6dbe3af9	97	the dictionary
364cda48	98	.It Pa /usr/share/dict/web2
6dbe3af9 KZ	99	the alternate dictionary
	100	.El
	101	.Sh SEE ALSO
	102	.Xr grep 1 ,
	103	.Xr sort 1
	104	.Sh COMPATIBILITY
	105	The original manual page stated that tabs and blank characters participated
	106	in comparisons when the
	107	.Fl d
	108	option was specified.
	109	This was incorrect and the current man page matches the historic
	110	implementation.
	111	.Sh HISTORY
	112	.Nm Look
	113	appeared in Version 7 AT&T Unix.
86d62711 KZ	114	.Sh AVAILABILITY
	115	The look command is part of the util-linux-ng package and is available from
	116	ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.