Manual pages: order NOTES / HISTORY / BUGS / EXAMPLE consistently

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

diff --git a/misc-utils/look.1 b/misc-utils/look.1
index d1d8f1bd4f41e18ad79fdbbc875323f5168e5476..d33139e98ec375b282fce18c1c5e90388700ff0f 100644 (file)
--- a/misc-utils/look.1
+++ b/misc-utils/look.1
@@ -36,9 +36,10 @@
 look \- display lines beginning with a given string
 .SH SYNOPSIS
 .B look
-.RI [ options ] " string " [ file ]
+[options]
+.IR "string " [ file ]
 .SH DESCRIPTION
-The 
+The
 .B look
 utility displays any lines in
 .I file
@@ -48,7 +49,9 @@ As
 .B look
 performs a binary search, the lines in
 .I file
-must be sorted (where sort(1) got the same options
+must be sorted (where
+.BR sort (1)
+was given the same options
 .BR "\-d " and/or " \-f " that
 .B look
 is invoked with).
@@ -65,52 +68,56 @@ alphabetic characters is ignored.
 Use the alternative dictionary file.
 .TP
 .BR \-d , " \-\-alphanum"
-Use normal dictionary character set and order, i.e. only alphanumeric characters
-are compared.  (This is on by default if no file is specified.)
+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
 .BR \-f , " \-\-ignore\-case"
-Ignore the case of alphabetic characters.  (This is on by default if no file is
-specified.)
+Ignore the case of alphabetic characters.  This is on by default if no file is
+specified.
 .TP
 .BR \-t , " \-\-terminate " \fIcharacter\fR
-Specify a string termination character, i.e. only the characters
+Specify a string termination character, i.e., only the characters
 in \fIstring\fR up to and including the first occurrence of \fIcharacter\fR
 are compared.
 .TP
-.BR \-h , " \-\-help"
-Display help text and exit.
-.TP
 .BR \-V , " \-\-version"
 Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 .PP
 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 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
 .B look
 utility appeared in Version 7 AT&T Unix.
+.SH EXAMPLE
+.RS
+.nf
+sort \-d /etc/passwd \-o /tmp/look.dict
+look \-t: root:foobar /tmp/look.dict
+.nf
+.RE
+.SH SEE ALSO
+.BR grep (1),
+.BR sort (1)
 .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/.