[Findutils-patches] [PATCH] Fixed further typos in find.1

[James Youngman]

2007-07-21  James Youngman  <address@hidden>

        * find/find.1: Fixed more typos, mostly missing \ before -.
          Also separated the paragraphs for -readable, -writable and
          -executable.  Updated the options description to mention --,
          -D and -O.  Indicated that -regextype is a positional
          option. Updated the usage message in the NON-BUGS section.

Signed-off-by: James Youngman <address@hidden>
---
 find/find.1 |   84 +++++++++++++++++++++++++++++++++++++++++-----------------
 1 files changed, 59 insertions(+), 25 deletions(-)

diff --git a/find/find.1 b/find/find.1
index be1a791..230ed9f 100644
--- a/find/find.1
+++ b/find/find.1
@@ -3,7 +3,7 @@
 find \- search for files in a directory hierarchy
 .SH SYNOPSIS
 .B find 
-[\-H] [\-L] [\-P] [-D debugopts] [-Olevel] [path...] [expression]
+[\-H] [\-L] [\-P] [\-D debugopts] [\-Olevel] [path...] [expression]
 .SH DESCRIPTION
 This manual page
 documents the GNU version of
@@ -40,9 +40,12 @@ used.  If no expression is given, the expression `\-print' 
is used
 This manual page talks about `options' within the expression list.
 These options control the behaviour of 
 .B find
-but are specified immediately after the last path name.  The three
-`real' options `\-H', `\-L' and `\-P' must appear before the first
-path name, if at all.
+but are specified immediately after the last path name.  The five
+`real' options `\-H', `\-L', `\-P', `\-D' and `\-O' must appear before
+the first path name, if at all.  A double dash `\-\-' can also be used
+to signal that any remaining arguments are not options (though
+ensuring that all start points begin with either `./' or `/' is
+generally safer if you use wildcards in the list of start points).
 .IP \-P
 Never follow symbolic links.  This is the default behaviour.  When 
 .B find
@@ -211,15 +214,15 @@ performed on all files for which the expression is true.
 
 .SS OPTIONS
 .P
-All options always return true.  Except for \-follow and \-daystart,
-the options affect all tests, including tests specified before the
-option.  This is because the options are processed when the command
-line is parsed, while the tests don't do anything until files are
-examined.  The \-follow and \-daystart options are different in this
-respect, and have an effect only on tests which appear later in the
-command line.  Therefore, for clarity, it is best to place them at the
-beginning of the expression.  A warning is issued if you don't do
-this.
+All options always return true.  Except for \-daystart, \-follow and
+\-regextype, the options affect all tests, including tests specified
+before the option.  This is because the options are processed when the
+command line is parsed, while the tests don't do anything until files
+are examined.  The \-daystart, \-follow and \-regextype options are
+different in this respect, and have an effect only on tests which
+appear later in the command line.  Therefore, for clarity, it is best
+to place them at the beginning of the expression.  A warning is issued
+if you don't do this.
 
 .IP \-d
 A synonym for \-depth, for compatibility with FreeBSD, NetBSD, MacOS X and 
OpenBSD.
@@ -330,7 +333,7 @@ options
 .BR \-H , 
 .B \-L 
 and 
-.B -P
+.B \-P
 and any previous 
 .BR \-follow ,
 but the reference file is only examined once, at the time the command
@@ -391,6 +394,23 @@ change times.
 .IP \-empty
 File is empty and is either a regular file or a directory.
 
+.IP \-executable
+Matches files which are executable and directories which are
+searchable (in a file name resolution sense).  This takes into account
+access control lists and other permissions artefacts which the
+.B \-perm 
+test ignores.  This test makes use of the
+.BR access (2)
+system call, and so can be fooled by NFS servers which do UID
+mapping (or root-squashing), since many systems implement 
+.BR access (2) 
+in the client's kernel and so cannot make use of the UID mapping
+information held on the server.  Because this test is based only on
+the result of the 
+.BR access (2)
+system call, there is no guarantee that a file for which this test
+succeeds can actually be executed.
+
 .IP \-false
 Always false.
 
@@ -584,10 +604,9 @@ test is deprecated because the POSIX specification 
requires the
 interpretation of a leading `+' as being part of a symbolic mode, and
 so we switched to using `/' instead.
 
-.IP "\-readable, \-writable, \-executable"
-Matches files which are readable, writable and executable,
-respectively.  This takes into account access control lists and other
-permissions artefacts which the 
+.IP \-readable
+Matches files which are readable.  This takes into account access
+control lists and other permissions artefacts which the
 .B \-perm 
 test ignores.  This test makes use of the
 .BR access (2)
@@ -663,10 +682,13 @@ door (Solaris)
 .RE
 .IP "\-uid \fIn\fR"
 File's numeric user ID is \fIn\fR.
+
 .IP "\-used \fIn\fR"
 File was last accessed \fIn\fR days after its status was last changed.
+
 .IP "\-user \fIuname\fR"
 File is owned by user \fIuname\fR (numeric user ID allowed).
+
 .IP "\-wholename \fIpattern\fR"
 File name matches shell pattern \fIpattern\fR.  The metacharacters do
 not treat `/' or `.' specially; so, for example,
@@ -686,6 +708,18 @@ find . \-wholename ./src/emacs \-prune \-o \-print
 .br
 .in -1i
 
+.IP "\-writable"
+Matches files which are writable.  This takes into account access
+control lists and other permissions artefacts which the
+.B \-perm 
+test ignores.  This test makes use of the
+.BR access (2)
+system call, and so can be fooled by NFS servers which do UID
+mapping (or root-squashing), since many systems implement 
+.BR access (2) 
+in the client's kernel and so cannot make use of the UID mapping
+information held on the server.
+
 .IP "\-xtype \fIc\fR"
 The same as \-type unless the file is a symbolic link.  For symbolic
 links: if the \-H or \-P option was specified, true if the file is a
@@ -1408,7 +1442,7 @@ example if someone can execute the file) will not be 
matched.
 
 .P
 .nf
-.B find . \-perm -664
+.B find . \-perm \-664
 
 .fi
 Search for files which have read and write permission for their owner
@@ -1440,7 +1474,7 @@ do.
 
 .P
 .nf
-.B find . \-perm -220
+.B find . \-perm \-220
 .B find . \-perm \-g+w,u+w
 
 .fi
@@ -1462,7 +1496,7 @@ set (\-perm /222 or \-perm /a+w) but are not executable 
for anybody (!
 .nf
 .B cd /source-dir
 .B find . \-name .snapshot \-prune \-o \e( \e! \-name "*~" \-print0 \e)|
-.B cpio -pmd0   /dest-dir
+.B cpio \-pmd0   /dest-dir
 
 .fi 
 This command copies the contents of 
@@ -1517,9 +1551,9 @@ example) used in filename patterns will match a leading 
`.', because
 IEEE POSIX interpretation 126 requires this.
 .P
 The syntax 
-\.B -perm +MODE 
+\.B \-perm +MODE 
 was deprecated in findutils-4.2.21, in favour of
-\.B -perm 
+\.B \-perm 
 .BR /MODE .
 As of findutils-4.3.3, 
 .B \-perm /000
@@ -1548,7 +1582,7 @@ Feature   Added in        Also occurs in
 \-quit 4.2.3
 \-d    4.2.3   BSD
 \-wholename    4.2.0
--\iwholename   4.2.0
+\-iwholename   4.2.0
 \-ignore_readdir_race  4.2.0
 \-fls  4.0
 \-ilname       3.8
@@ -1560,7 +1594,7 @@ Feature   Added in        Also occurs in
 .nf
 .B $ find . \-name *.c \-print
 find: paths must precede expression
-Usage: find [-H] [-L] [-P] [path...] [expression]
+Usage: find [\-H] [\-L] [\-P] [\-Olevel] [\-D 
help|tree|search|stat|rates|opt|exec] [path...] [expression]
 .fi
 .P
 This happens because 
-- 
1.5.2.1