Merge branch 'dmverity_options' of https://github.com/bluca/util-linux

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

diff --git a/misc-utils/look.1 b/misc-utils/look.1
index a6ab56880218645ea0d62c38a7f867139c6f3951..cca83416ece16adf2919842ae39db5f888dcd298 100644 (file)
--- a/misc-utils/look.1
+++ b/misc-utils/look.1
@@ -31,25 +31,28 @@
 .\"
 .\"     @(#)look.1     8.1 (Berkeley) 6/14/93
 .\"
-.TH LOOK "1" "June 2011" "util-linux" "User Commands"
+.TH LOOK 1 "June 2011" "util-linux" "User Commands"
 .SH NAME
 look \- display lines beginning with a given string
 .SH SYNOPSIS
 .B look
-[\fIoptions\fR] \fIstring \fR[\fIfile\fR]
+[options]
+.IR "string " [ file ]
 .SH DESCRIPTION
-The 
+The
 .B look
 utility displays any lines in
 .I file
 which contain
-.I string
+.IR string .
 As
 .B look
 performs a binary search, the lines in
 .I file
-must be sorted (where sort(1) got the same options \-d and/or \-f
-that
+must be sorted (where
+.BR sort (1)
+was given the same options
+.BR "\-d " and/or " \-f " that
 .B look
 is invoked with).
 .PP
@@ -61,52 +64,60 @@ is used, only alphanumeric characters are compared and the case of
 alphabetic characters is ignored.
 .SH OPTIONS
 .TP
-\fB\-a\fR, \fB\-\-alternative\fR
-Use alternative dictionary file.
+.BR \-a , " \-\-alternative"
+Use the alternative dictionary file.
 .TP
-\fB\-d\fR, \fB\-\-alphanum\fR
-Dictionary character set and order, i.e. only alphanumeric characters are
-compared. (On by default if no file is specified).
+.BR \-d , " \-\-alphanum"
+Use normal dictionary character set and order, i.e. only blanks and
+alphanumeric characters are compared.  This is on by default if no file is
+specified.
+
+Note that blanks have been added to dictionary character set for
+compatibility with \fBsort \-d\fR command since version 2.28.
 .TP
-\fB\-f\fR, \fB\-\-ignore\-case\fR
-Ignore the case of alphabetic characters. (On by default if no file is
-specified).
+.BR \-f , " \-\-ignore\-case"
+Ignore the case of alphabetic characters.  This is on by default if no file is
+specified.
 .TP
-\fB\-t\fR, \fB\-\-terminate\fR=\fIC\fR
+.BR \-t , " \-\-terminate " \fIcharacter\fR
 Specify a string termination character, i.e. only the characters
-in string up to and including the first occurrence of termchar
+in \fIstring\fR up to and including the first occurrence of \fIcharacter\fR
 are compared.
 .TP
-\fB\-V\fR, \fB\-\-version\fR
-Output version information and exit.
+.BR \-V , " \-\-version"
+Display version information and exit.
 .TP
-\fB\-h\fR, \fB\-\-help\fR
-Display help screen and exit.
+.BR \-h , " \-\-help"
+Display help text and exit.
 .PP
-The look utility exits 0 if one or more lines were found and displayed, 1 if
+The
+.B 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 EXAMPLE
+.RS
 .nf
 sort -d /etc/passwd -o /tmp/look.dict
 look -t: root:foobar /tmp/look.dict
 .nf
+.RE
+.SH ENVIRONMENT
+.TP
+.B WORDLIST
+Path to a dictionary file.  The environment variable has greater priority
+than the dictionary path defined in FILES segment.
 .SH FILES
-.IX Header "FILES"
 .IP "\fB/usr/share/dict/words\fR" 4
 the dictionary
 .IP "\fB/usr/share/dict/web2\fR" 4
-the alternate dictionary
+the alternative dictionary
 .SH "SEE ALSO"
 .BR grep (1),
 .BR sort (1)
-.SH COMPATIBILITY
-The original manual page stated that tabs and blank characters participated
-in comparisons when the alphanum option was specified. This was incorrect
-and the current man page matches the historic implementation.
 .SH HISTORY
 The
-look
+.B look
 utility appeared in Version 7 AT&T Unix.
 .SH AVAILABILITY
 The look command is part of the util-linux package and is available from
-ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
+https://www.kernel.org/pub/linux/utils/util-linux/.