BSD 4_4_Lite2 release
[unix-history] / usr / src / usr.bin / find / find.1
index df12532..a5fc173 100644 (file)
-.\" Copyright (c) 1990 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1990, 1993
+.\"    The Regents of the University of California.  All rights reserved.
 .\"
 .\"
-.\" %sccs.include.redist.man%
+.\" This code is derived from software contributed to Berkeley by
+.\" the Institute of Electrical and Electronics Engineers, Inc.
 .\"
 .\"
-.\"    @(#)find.1      6.8 (Berkeley) %G%
+.\" 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.
 .\"
 .\"
-.TH FIND 1 ""
-.AT 3
-.SH NAME
-find \- walk a file hierarchy
-.SH SYNOPSIS
-.ft B
-find path ... expression
-.ft R
-.SH DESCRIPTION
-.I Find
+.\" 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.
+.\"
+.\"    @(#)find.1      8.7 (Berkeley) 5/9/95
+.\"
+.Dd May 9, 1995
+.Dt FIND 1
+.Os
+.Sh NAME
+.Nm find
+.Nd walk a file hierarchy
+.Sh SYNOPSIS
+.Nm find
+.Op Fl H | Fl L | Fl P
+.Op Fl Xdx
+.Op Fl f Ar file
+.Op Ar file ...
+.Ar expression
+.Sh DESCRIPTION
+.Nm Find
 recursively descends the directory tree for each
 recursively descends the directory tree for each
-.I path
-listed, evaluating an ``expression'' composed of the ``primaries''
-listed below (each of which is a separate argument to
-.IR find )
-in terms of each file in the tree.
-.PP
-All primaries which take a numeric argument allow the number to be
-preceded by a plus sign (``+'') or a minus sign (``\-'').
-A preceding plus sign means ``more than
-.BR n '',
-a preceding minus sign means ``less than
-.BR n ''
-and neither means ``exactly
-.BR n ''.
-.SH PRIMARIES
-.TP
-.B \-atime n
+.Ar file
+listed, evaluating an
+.Ar expression
+(composed of the ``primaries'' and ``operands'' listed below) in terms
+of each file in the tree.
+.Pp
+The options are as follows:
+.Pp
+.Bl -tag -width Ds
+.It Fl H
+The
+.Fl H
+option causes the file information and file type (see
+.Xr stat 2)
+returned for each symbolic link specified on the command line to be 
+those of the file referenced by the link, not the link itself.
+If the referenced file does not exist, the file information and type will
+be for the link itself.  File information of all symbolic links not on 
+the command line is that of the link itself.
+.It Fl L
+The
+.Fl L
+option causes the file information and file type (see
+.Xr stat 2)
+returned for each symbolic link to be those of the file referenced by the
+link, not the link itself.
+If the referenced file does not exist, the file information and type will
+be for the link itself.
+.It Fl P
+The
+.Fl P
+option causes the file information and file type (see
+.Xr stat 2)
+returned for each symbolic link to be those of the link itself.
+.It Fl X
+The
+.Fl X
+option is a modification to permit
+.Nm
+to be safely used in conjunction with
+.Xr xargs 1 .
+If a file name contains any of the delimiting characters used by
+.Xr xargs ,
+a diagnostic message is displayed on standard error, and the file
+is skipped.
+The delimiting characters include single (`` ' '') and double (`` " '')
+quotes, backslash (``\e''), space, tab and newline characters.
+.It Fl d
+The
+.Fl d
+option causes
+.Nm find
+to perform a depth\-first traversal, i.e. directories
+are visited in post\-order and all entries in a directory will be acted
+on before the directory itself.
+By default,
+.Nm find
+visits directories in pre\-order, i.e. before their contents.
+Note, the default is
+.Ar not
+a breadth\-first traversal.
+.It Fl f
+The
+.Fl f
+option specifies a file hierarchy for
+.Nm find
+to traverse.
+File hierarchies may also be specified as the operands immediately
+following the options.
+.It Fl x
+The
+.Fl x
+option prevents
+.Nm find
+from descending into directories that have a device number different
+than that of the file from which the descent began.
+.El
+.Sh PRIMARIES
+.Bl -tag -width Ds
+.It Ic -atime Ar n 
 True if the difference between the file last access time and the time
 True if the difference between the file last access time and the time
-.I find
+.Nm find
 was started, rounded up to the next full 24\-hour period, is
 was started, rounded up to the next full 24\-hour period, is
-.B n
+.Ar n
 24\-hour periods.
 24\-hour periods.
-.TP
-.B \-ctime n
+.It Ic -ctime Ar n 
 True if the difference between the time of last change of file status
 information and the time
 True if the difference between the time of last change of file status
 information and the time
-.I find
+.Nm find
 was started, rounded up to the next full 24\-hour period, is
 was started, rounded up to the next full 24\-hour period, is
-.B n
+.Ar n
 24\-hour periods.
 24\-hour periods.
-.TP
-.B \-depth
-This primary always evaluates to true.
-It causes find to perform a depth\-first traversal, i.e. directories are
-visited in post\-order and all entries in a directory will be acted on
-before the directory itself.
-By default,
-.I find
-visits directories in pre\-order, i.e. before their contents.
-Note, the default is not a breadth-first traversal.
-.TP
-.B \-exec  utility  [argument ...]  ;
+.It Ic -exec Ar utility Op argument ... ; 
 True if the program named
 True if the program named
-.B utility
+.Ar utility
 returns a zero value as its exit status.
 Optional arguments may be passed to the utility.
 The expression must be terminated by a semicolon (``;'').
 returns a zero value as its exit status.
 Optional arguments may be passed to the utility.
 The expression must be terminated by a semicolon (``;'').
-If the string ``{}'' appears anywhere in the utility name or the arguments
-it is replaced by the pathname of the current file.
-Utility will be executed in the directory from which
-.I find
+If the string ``{}'' appears anywhere in the utility name or the
+arguments it is replaced by the pathname of the current file.
+.Ar Utility
+will be executed from the directory from which
+.Nm find
 was executed.
 was executed.
-Note, the
-.IR utility ,
-optional
-.I arguments
-and terminating semicolon must each be a separate argument to
-.IR find .
-.TP
-.B \-follow
-This primary always evaluates to true.
-It causes the file information and file type (see
-.IR stat (2)),
-returned for each symbolic link to be those of the file referenced by the
-link, not the link itself.
-If the referenced file does not exist, the file information and type will
-be for the link itself.
-.TP
-.B \-fstype type
+.It Ic -fstype Ar type 
 True if the file is contained in a file system of type
 True if the file is contained in a file system of type
-.BR type.
-Currently supported types are ``mfs'', ``nfs'', ``pc'' and ``ufs''.
-.TP
-.B \-group gname
+.Ar type .
+The
+.Xr sysctl 8
+command can be used to find out the types of filesystems
+that are available on the system:
+.Bd -literal -offset indent
+sysctl vfs
+.Ed
+In addition, there are two pseudo-types, ``local'' and ``rdonly''.
+The former matches any file system physically mounted on the system where
+the
+.Nm find
+is being executed and the latter matches any file system which is
+mounted read-only.
+.It Ic -group Ar gname 
 True if the file belongs to the group
 True if the file belongs to the group
-.BR gname .
+.Ar gname  .
 If
 If
-.B gname
+.Ar gname
 is numeric and there is no such group name, then
 is numeric and there is no such group name, then
-.B gname
+.Ar gname
 is treated as a group id.
 is treated as a group id.
-.TP
-.B \-inum n
+.It Ic -inum Ar n 
 True if the file has inode number
 True if the file has inode number
-.BR n .
-.TP
-.B \-links  n
+.Ar n  .
+.It Ic -links Ar n 
 True if the file has
 True if the file has
-.B n
+.Ar n
 links.
 links.
-.TP
-.B \-ls
+.It Ic -ls
 This primary always evaluates to true.
 The following information for the current file is written to standard output:
 its inode number, size in 512\-byte blocks, file permissions, number of hard
 This primary always evaluates to true.
 The following information for the current file is written to standard output:
 its inode number, size in 512\-byte blocks, file permissions, number of hard
@@ -117,230 +195,267 @@ will be displayed instead of the size in bytes.
 If the file is a symbolic link, the pathname of the linked\-to file will be
 displayed preceded by ``\->''.
 The format is identical to that produced by ``ls \-dgils''.
 If the file is a symbolic link, the pathname of the linked\-to file will be
 displayed preceded by ``\->''.
 The format is identical to that produced by ``ls \-dgils''.
-.TP
-.B \-mtime n
+.It Ic -mtime Ar n 
 True if the difference between the file last modification time and the time
 True if the difference between the file last modification time and the time
-.I find
+.Nm find
 was started, rounded up to the next full 24\-hour period, is
 was started, rounded up to the next full 24\-hour period, is
-.B n
+.Ar n
 24\-hour periods.
 24\-hour periods.
-.TP
-.B \-ok  utility  [argument ...]  ;
+.It Ic \&-ok Ar utility Op argument ... ; 
 The
 The
-.B \-ok
+.Ic \&-ok
 primary is identical to the
 primary is identical to the
-.B \-exec
+.Ic -exec
 primary with the exception that
 primary with the exception that
-.I find
+.Nm find
 requests user affirmation for the execution of the utility by printing
 a message to the terminal and reading a response.
 If the response is other than ``y'' the command is not executed and the
 value of the
 requests user affirmation for the execution of the utility by printing
 a message to the terminal and reading a response.
 If the response is other than ``y'' the command is not executed and the
 value of the
-.B \-ok
+.Ar \&ok
 expression is false.
 expression is false.
-.TP
-.B \-name pattern
+.It Ic -name Ar pattern 
 True if the last component of the pathname being examined matches
 True if the last component of the pathname being examined matches
-.BR pattern .
+.Ar pattern  .
 Special shell pattern matching characters (``['', ``]'', ``*'', and ``?'')
 may be used as part of
 Special shell pattern matching characters (``['', ``]'', ``*'', and ``?'')
 may be used as part of
-.BR pattern .
-These characters may be escaped with a backslash (``\e'').
-.TP
-.B \-newer file
+.Ar pattern  .
+These characters may be matched explicitly by escaping them with a
+backslash (``\e'').
+.It Ic -newer Ar file 
 True if the current file has a more recent last modification time than
 True if the current file has a more recent last modification time than
-.BR file .
-.TP
-.B \-nouser
+.Ar file  .
+.It Ic -nouser
 True if the file belongs to an unknown user.
 True if the file belongs to an unknown user.
-.TP
-.B \-nogroup
+.It Ic -nogroup
 True if the file belongs to an unknown group.
 True if the file belongs to an unknown group.
-.TP
-.B \-perm [\-]mode
+.It Ic -path Ar pattern 
+True if the pathname being examined matches
+.Ar pattern  .
+Special shell pattern matching characters (``['', ``]'', ``*'', and ``?'')
+may be used as part of
+.Ar pattern  .
+These characters may be matched explicitly by escaping them with a
+backslash (``\e'').
+Slashes (``/'') are treated as normal characters and do not have to be
+matched explicitly.
+.It Ic -perm Op Fl Ns Ar mode 
 The
 The
-.B mode
+.Ar mode
 may be either symbolic (see
 may be either symbolic (see
-.IR chmod (1))
+.Xr chmod  1  )
 or an octal number.
 If the mode is symbolic, a starting value of zero is assumed and the
 mode sets or clears permissions without regard to the process' file mode
 creation mask.
 or an octal number.
 If the mode is symbolic, a starting value of zero is assumed and the
 mode sets or clears permissions without regard to the process' file mode
 creation mask.
-If the mode is octal, only bits 07777 of the file's mode bits participate
+If the mode is octal, only bits 07777
+.Pf ( Dv S_ISUID
+|
+.Dv S_ISGID
+|
+.Dv S_ISTXT
+|
+.Dv S_IRWXU
+|
+.Dv S_IRWXG
+|
+.Dv S_IRWXO )
+of the file's mode bits participate
 in the comparison.
 If the mode is preceded by a dash (``\-''), this primary evaluates to true
 if at least all of the bits in the mode are set in the file's mode bits.
 If the mode is not preceded by a dash, this primary evaluates to true if
 the bits in the mode exactly match the file's mode bits.
 Note, the first character of a symbolic mode may not be a dash (``\-'').
 in the comparison.
 If the mode is preceded by a dash (``\-''), this primary evaluates to true
 if at least all of the bits in the mode are set in the file's mode bits.
 If the mode is not preceded by a dash, this primary evaluates to true if
 the bits in the mode exactly match the file's mode bits.
 Note, the first character of a symbolic mode may not be a dash (``\-'').
-.TP
-.B \-print
+.It Ic -print
 This primary always evaluates to true.
 It prints the pathname of the current file to standard output.
 This primary always evaluates to true.
 It prints the pathname of the current file to standard output.
-The expression is appended to the user specified expression if neither
-.BR \-exec ,
-.BR \-ls ,
+If none of
+.Ic -exec ,
+.Ic -ls ,
 or
 or
-.B \-ok
-is specified.
-.TP
-.B \-prune
+.Ic \&-ok
+is specified, the given expression shall be effectively replaced by
+.Cm \&( Ns Ar given\& expression Ns Cm \&) 
+.Ic -print .
+.It Ic -prune
 This primary always evaluates to true.
 It causes
 This primary always evaluates to true.
 It causes
-.I find
+.Nm find
 to not descend into the current file.
 to not descend into the current file.
-.TP
-.B \-size n[c]
+Note, the
+.Ic -prune
+primary has no effect if the
+.Fl d
+option was specified.
+.It Ic -size Ar n Ns Op Cm c 
 True if the file's size, rounded up, in 512\-byte blocks is
 True if the file's size, rounded up, in 512\-byte blocks is
-.BR n .
-If 
-.B n
+.Ar n  .
+If
+.Ar n
 is followed by a ``c'', then the primary is true if the
 is followed by a ``c'', then the primary is true if the
-file's size is 
-.I n
+file's size is
+.Ar n
 bytes.
 bytes.
-.TP
-.B \-type t
+.It Ic -type Ar t 
 True if the file is of the specified type.
 Possible file types are as follows:
 True if the file is of the specified type.
 Possible file types are as follows:
-.RS
-.TP
-.B b
+.Pp
+.Bl -tag -width flag -offset indent -compact
+.It Cm b
 block special
 block special
-.br
-.ns
-.TP
-.B c
+.It Cm c
 character special
 character special
-.br
-.ns
-.TP
-.B d
+.It Cm d
 directory
 directory
-.br
-.ns
-.TP
-.B f
+.It Cm f
 regular file
 regular file
-.br
-.ns
-.TP
-.B l
+.It Cm l
 symbolic link
 symbolic link
-.br
-.ns
-.TP
-.B p
+.It Cm p
 FIFO
 FIFO
-.br
-.ns
-.TP
-.B s
+.It Cm s
 socket
 socket
-.RE
-.TP
-.B \-user uname
+.El
+.Pp
+.It Ic -user Ar uname 
 True if the file belongs to the user
 True if the file belongs to the user
-.BR uname .
+.Ar uname  .
 If
 If
-.B uname
+.Ar uname
 is numeric and there is no such user name, then
 is numeric and there is no such user name, then
-.B uname
+.Ar uname
 is treated as a user id.
 is treated as a user id.
-.TP
-.B \-xdev
-This primary always evaluates to true.
-It causes
-.I find
-to not descend into directories that have a different device number
-than the file the descent began from.
-.SH OPERATORS
+.El
+.Pp
+All primaries which take a numeric argument allow the number to be
+preceded by a plus sign (``+'') or a minus sign (``\-'').
+A preceding plus sign means ``more than n'', a preceding minus sign means
+``less than n'' and neither means ``exactly n'' .
+.Sh OPERATORS
 The primaries may be combined using the following operators.
 The operators are listed in order of decreasing precedence.
 The primaries may be combined using the following operators.
 The operators are listed in order of decreasing precedence.
-.TP
-.B "( expression )"
+.Bl -tag -width (expression) 
+.It Cm \&( Ns Ar expression Ns Cm \&) 
 This evaluates to true if the parenthesized expression evaluates to
 true.
 This evaluates to true if the parenthesized expression evaluates to
 true.
-.TP
-.B "! expression"
-This is the unary NOT operator.
+.Pp
+.It Cm \&! Ns Ar expression 
+This is the unary
+.Tn NOT
+operator.
 It evaluates to true if the expression is false.
 It evaluates to true if the expression is false.
-.TP
-.B "expression \-a expression"
-.br
-.ns
-.TP
-.B "expression expression"
+.Pp
+.It Ar expression Cm -and Ar expression 
+.It Ar expression expression 
 The
 The
-.B \-a
-operator is the logical AND operator.
+.Cm -and
+operator is the logical
+.Tn AND
+operator.
 As it is implied by the juxtaposition of two expressions it does not
 have to be specified.
 The expression evaluates to true if both expressions are true.
 The second expression is not evaluated if the first expression is false.
 As it is implied by the juxtaposition of two expressions it does not
 have to be specified.
 The expression evaluates to true if both expressions are true.
 The second expression is not evaluated if the first expression is false.
-.TP
-.B "expression \-o expression"
+.Pp
+.It Ar expression Cm -or Ar expression 
 The
 The
-.B \-o
-operator is the logical OR operator.
+.Cm -or
+operator is the logical
+.Tn OR
+operator.
 The expression evaluates to true if either the first or the second expression
 is true.
 The second expression is not evaluated if the first expression is true.
 The expression evaluates to true if either the first or the second expression
 is true.
 The second expression is not evaluated if the first expression is true.
-.SH EXAMPLES
-.PP
+.El
+.Pp
+All operands and primaries must be separate arguments to
+.Nm find  .
+Primaries which themselves take arguments expect each argument
+to be a separate argument to
+.Nm find  .
+.Sh EXAMPLES
+.Pp
 The following examples are shown as given to the shell:
 The following examples are shown as given to the shell:
-.TP
-find  /  \e!  \-name  "*.c"  \-print
+.Bl -tag -width findx
+.It Li "find  /  \e!  -name  \*q*.c\*q  -print"
 Print out a list of all the files whose names do not end in ``.c''.
 Print out a list of all the files whose names do not end in ``.c''.
-.TP
-find  /  \-newer  ttt  \-user  wnj  \-print
+.It Li "find  /  -newer  ttt  -user  wnj  -print"
 Print out a list of all the files owned by user ``wnj'' that are newer
 than the file ``ttt''.
 Print out a list of all the files owned by user ``wnj'' that are newer
 than the file ``ttt''.
-.TP
-find  /  \e!  \e(  \-newer  ttt  \-user  wnj  \e)  \-print
+.It Li "find  /  \e!  \e(  -newer  ttt  -user  wnj  \e)  -print"
 Print out a list of all the files which are not both newer than ``ttt''
 and owned by ``wnj''.
 Print out a list of all the files which are not both newer than ``ttt''
 and owned by ``wnj''.
-.TP
-find  /  \e(  \-newer  ttt  \-o  \-user wnj  \e)  \-print
+.It Li "find  /  \e(  -newer  ttt  -or  -user wnj  \e)  -print"
 Print out a list of all the files that are either owned by ``wnj'' or
 that are newer than ``ttt''.
 Print out a list of all the files that are either owned by ``wnj'' or
 that are newer than ``ttt''.
-.SH "SEE ALSO"
-chmod(1), sh(1), test(1), stat(2), umask(2), getpwent(3), getgrent(3)
-.SH STANDARDS
+.El
+.Sh SEE ALSO
+.Xr chmod 1 ,
+.Xr locate 1 ,
+.Xr stat 2 ,
+.Xr fts 3 ,
+.Xr getgrent 3 ,
+.Xr getpwent 3 ,
+.Xr strmode 3 ,
+.Xr symlink 7
+.Sh STANDARDS
+The
+.Nm find
+utility syntax is a superset of the syntax specified by the
+.St -p1003.2
+standard.
+.Pp
 The
 The
-.I find
-utility is expected to be POSIX 1003.2 compatible.
-The primaries
-.B \-follow
-.B \-inum
+.Fl s
 and
 and
-.BR \-ls
-are Berkeley extensions.
-.SH BUGS
-The primaries
-.BR \-depth ,
-.BR \-follow ,
+.Fl X
+options and the
+.Ic -inum
 and
 and
-.B \-xdev
-are really global variables that take effect before the traversal begins,
-possibly leading to unexpected results.
-An example would be the expression ``\-print \-o \-depth''.
+.Ic -ls
+primaries are extensions to
+.St -p1003.2 .
+.Pp
+Historically, the
+.Fl d ,
+.Fl h
+and
+.Fl x
+options were implemented using the primaries ``\-depth'', ``\-follow'',
+and ``\-xdev''.
+These primaries always evaluated to true.
+As they were really global variables that took effect before the traversal
+began, some legal expressions could have unexpected results.
+An example is the expression ``\-print \-o \-depth''.
 As \-print always evaluates to true, the standard order of evaluation
 As \-print always evaluates to true, the standard order of evaluation
-would imply that \-depth would never be evaluated.
-These primaries actually behave as multi-letter options which are
-evaluated and replaced with the moral equivalent of \-true when
-.I find
-begins execution.
-.PP
-Any command line argument beginning with a dash (``\-''), exclamation point
-(``!'') or left parenthesis (``('') is assumed to be part of an expression.
-The first such argument is used to delimit the end of the file names and
-the beginning of the expression.
-Traversing file trees with names beginning with one of these characters
-is tough.
-.PP
-Several special characters used by
-.I find
-are also special characters to the shell programs.
+implies that \-depth would never be evaluated.
+This is not the case.
+.Pp
+The operator ``-or'' was implemented as ``\-o'', and the operator ``-and''
+was implemented as ``\-a''.
+.Pp
+Historic implementations of the
+.Ic exec
+and
+.Ic ok
+primaries did not replace the string ``{}'' in the utility name or the
+utility arguments if it had preceding or following non-whitespace characters.
+This version replaces it no matter where in the utility name or arguments
+it appears.
+.Sh BUGS
+The special characters used by
+.Nm find
+are also special characters to many shell programs.
 In particular, the characters ``*'', ``['', ``]'', ``?'', ``('', ``)'',
 ``!'', ``\e'' and ``;'' may have to be escaped from the shell.
 In particular, the characters ``*'', ``['', ``]'', ``?'', ``('', ``)'',
 ``!'', ``\e'' and ``;'' may have to be escaped from the shell.
+.Pp
+As there is no delimiter separating options and file names or file
+names and the
+.Ar expression ,
+it is difficult to specify files named ``-xdev'' or ``!''.
+These problems are handled by the
+.Fl f
+option and the
+.Xr getopt 3
+``--'' construct.