shell_cmds-162.tar.gz

[apple/shell_cmds.git] / find / find.1

diff --git a/find/find.1 b/find/find.1
index a20f4504b8faf78545de607eea4a5d7cb742dc82..21734f18026c923778869cf8ac579d9f09c3d0c2 100644 (file)
--- a/find/find.1
+++ b/find/find.1
@@ -33,9 +33,9 @@
 .\" SUCH DAMAGE.
 .\"
 .\"    @(#)find.1      8.7 (Berkeley) 5/9/95
 .\" SUCH DAMAGE.
 .\"
 .\"    @(#)find.1      8.7 (Berkeley) 5/9/95

-.\" $FreeBSD: src/usr.bin/find/find.1,v 1.81 2006/12/13 17:02:50 ru Exp $
+.\" $FreeBSD: src/usr.bin/find/find.1,v 1.87 2009/09/20 16:47:56 jilles Exp $

 .\"
 .\"

-.Dd December 13, 2006
+.Dd February 24, 2008

 .Dt FIND 1
 .Os
 .Sh NAME
 .Dt FIND 1
 .Os
 .Sh NAME


@@ -45,20 +45,20 @@
 .Nm
 .Op Fl H | Fl L | Fl P
 .Op Fl EXdsx
 .Nm
 .Op Fl H | Fl L | Fl P
 .Op Fl EXdsx

-.Op Fl f Ar pathname
-.Ar pathname ...
-.Ar expression
+.Op Fl f Ar path
+.Ar path ...
+.Op Ar expression

 .Nm
 .Op Fl H | Fl L | Fl P
 .Op Fl EXdsx
 .Nm
 .Op Fl H | Fl L | Fl P
 .Op Fl EXdsx

-.Fl f Ar pathname
-.Op Ar pathname ...
-.Ar expression
+.Fl f Ar path
+.Op Ar path ...
+.Op Ar expression

 .Sh DESCRIPTION
 The
 .Nm
 utility recursively descends the directory tree for each
 .Sh DESCRIPTION
 The
 .Nm
 utility recursively descends the directory tree for each

-.Ar pathname
+.Ar path

 listed, evaluating an
 .Ar expression
 (composed of the
 listed, evaluating an
 .Ar expression
 (composed of the


@@ -75,7 +75,7 @@ Interpret regular expressions followed by
 .Ic -regex
 and
 .Ic -iregex
 .Ic -regex
 and
 .Ic -iregex

-options as extended (modern) regular expressions rather than basic
+primaries as extended (modern) regular expressions rather than basic

 regular expressions (BRE's).
 The
 .Xr re_format 7
 regular expressions (BRE's).
 The
 .Xr re_format 7


@@ -144,7 +144,9 @@ This option is equivalent to the
 .Ic -depth
 primary of
 .St -p1003.1-2001 .
 .Ic -depth
 primary of
 .St -p1003.1-2001 .

+The

 .Fl d
 .Fl d

+option

 can be useful when
 .Nm
 is used with
 can be useful when
 .Nm
 is used with


@@ -209,12 +211,12 @@ units.
 Please refer to the
 .Ic -atime
 primary description for information on supported time units.
 Please refer to the
 .Ic -atime
 primary description for information on supported time units.

-.\" .It Ic -acl
-.\" May be used in conjunction with other options to locate
-.\" files with extended ACLs.
-.\" See
-.\" .Xr acl 3
-.\" for more information.
+.It Ic -acl
+May be used in conjunction with other primaries to locate
+files with extended ACLs.
+See
+.Xr acl 3
+for more information.

 .It Ic -amin Ar n
 True if the difference between the file last access time and the time
 .Nm
 .It Ic -amin Ar n
 True if the difference between the file last access time and the time
 .Nm


@@ -291,6 +293,12 @@ units.
 Please refer to the
 .Ic -atime
 primary description for information on supported time units.
 Please refer to the
 .Ic -atime
 primary description for information on supported time units.

+.It Ic -d
+Same as 
+.Ic depth .
+GNU find implements this as a primary in mistaken emulation of
+.Fx
+.Xr find 1 .

 .It Ic -delete
 Delete found files and/or directories.
 Always returns true.
 .It Ic -delete
 Delete found files and/or directories.
 Always returns true.


@@ -304,6 +312,7 @@ character in its pathname relative to
 .Dq Pa \&.
 for security reasons.
 Depth-first traversal processing is implied by this option.
 .Dq Pa \&.
 for security reasons.
 Depth-first traversal processing is implied by this option.

+Following symlinks is incompatible with this option.

 .It Ic -depth
 Always true;
 same as the
 .It Ic -depth
 Always true;
 same as the


@@ -363,6 +372,15 @@ The filename substituted for
 the string
 .Dq Li {}
 is not qualified.
 the string
 .Dq Li {}
 is not qualified.

+.It Ic -execdir Ar utility Oo Ar argument ... Oc Li {} +
+Same as
+.Ic -execdir ,
+except that
+.Dq Li {}
+is replaced with as many pathnames as possible for each invocation of
+.Ar utility .
+This behaviour is similar to that of
+.Xr xargs 1 .

 .It Ic -flags Oo Cm - Ns | Ns Cm + Oc Ns Ar flags , Ns Ar notflags
 The flags are specified using symbolic names (see
 .Xr chflags 1 ) .
 .It Ic -flags Oo Cm - Ns | Ns Cm + Oc Ns Ar flags , Ns Ar notflags
 The flags are specified using symbolic names (see
 .Xr chflags 1 ) .


@@ -426,6 +444,15 @@ the
 .Nm
 is being executed and the latter matches any file system which is
 mounted read-only.
 .Nm
 is being executed and the latter matches any file system which is
 mounted read-only.

+.It Ic -gid Ar gname
+The same thing as
+.Ar -group Ar gname 
+for compatibility with GNU find.
+GNU find imposes a restriction that
+.Ar gname 
+is numeric, while
+.Xr find 1 
+does not.

 .It Ic -group Ar gname
 True if the file belongs to the group
 .Ar gname .
 .It Ic -group Ar gname
 True if the file belongs to the group
 .Ar gname .


@@ -434,6 +461,13 @@ If
 is numeric and there is no such group name, then
 .Ar gname
 is treated as a group ID.
 is numeric and there is no such group name, then
 .Ar gname
 is treated as a group ID.

+.It Ic -ignore_readdir_race
+This option is for GNU find compatibility and is ignored.
+.It Ic -ilname Ar pattern
+Like
+.Ic -lname ,
+but the match is case insensitive.
+This is a GNU find extension.

 .It Ic -iname Ar pattern
 Like
 .Ic -name ,
 .It Ic -iname Ar pattern
 Like
 .Ic -name ,


@@ -449,10 +483,20 @@ but the match is case insensitive.
 Like
 .Ic -regex ,
 but the match is case insensitive.
 Like
 .Ic -regex ,
 but the match is case insensitive.

+.It Ic -iwholename Ar pattern
+The same thing as 
+.Ic -ipath ,
+for GNU find compatibility.

 .It Ic -links Ar n
 True if the file has
 .Ar n
 links.
 .It Ic -links Ar n
 True if the file has
 .Ar n
 links.

+.It Ic -lname Ar pattern
+Like
+.Ic -name ,
+but the contents of the symbolic link are matched instead of the file
+name.
+This is a GNU find extension.

 .It Ic -ls
 This primary always evaluates to true.
 The following information for the current file is written to standard output:
 .It Ic -ls
 This primary always evaluates to true.
 The following information for the current file is written to standard output:


@@ -465,7 +509,7 @@ displayed preceded by
 .Dq Li -> .
 The format is identical to that produced by
 .Bk -words
 .Dq Li -> .
 The format is identical to that produced by
 .Bk -words

-.Nm ls Fl dgils .
+.Dq Nm ls Fl dgils .

 .Ek
 .It Ic -maxdepth Ar n
 Always true; descend at most
 .Ek
 .It Ic -maxdepth Ar n
 Always true; descend at most


@@ -475,7 +519,7 @@ If any
 .Ic -maxdepth
 primary is specified, it applies to the entire expression even if it would
 not normally be evaluated.
 .Ic -maxdepth
 primary is specified, it applies to the entire expression even if it would
 not normally be evaluated.

-.Ic -maxdepth Li 0
+.Dq Ic -maxdepth Li 0

 limits the whole search to the command line arguments.
 .It Ic -mindepth Ar n
 Always true; do not apply any tests or actions at levels less than
 limits the whole search to the command line arguments.
 .It Ic -mindepth Ar n
 Always true; do not apply any tests or actions at levels less than


@@ -484,7 +528,7 @@ If any
 .Ic -mindepth
 primary is specified, it applies to the entire expression even if it would
 not normally be evaluated.
 .Ic -mindepth
 primary is specified, it applies to the entire expression even if it would
 not normally be evaluated.

-.Ic -mindepth Li 1
+.Dq Ic -mindepth Li 1

 processes all but the command line arguments.
 .It Ic -mmin Ar n
 True if the difference between the file last modification time and the time
 processes all but the command line arguments.
 .It Ic -mmin Ar n
 True if the difference between the file last modification time and the time


@@ -495,6 +539,10 @@ minutes.
 .It Ic -mnewer Ar file
 Same as
 .Ic -newer .
 .It Ic -mnewer Ar file
 Same as
 .Ic -newer .

+.It Ic -mount
+The same thing as 
+.Ic -xdev ,
+for GNU find compatibility.

 .It Ic -mtime Ar n Ns Op Cm smhdw
 If no units are specified, this primary evaluates to
 true if the difference between the file last modification time and the time
 .It Ic -mtime Ar n Ns Op Cm smhdw
 If no units are specified, this primary evaluates to
 true if the difference between the file last modification time and the time


@@ -531,21 +579,21 @@ True if the current file has a more recent last modification time than
 .Ar file .
 .It Ic -newer Ns Ar X Ns Ar Y Ar file
 True if the current file has a more recent last access time
 .Ar file .
 .It Ic -newer Ns Ar X Ns Ar Y Ar file
 True if the current file has a more recent last access time

-.Ar ( X Ns = Ns Cm a ) ,
+.Pq Ar X Ns = Ns Cm a ,

 inode creation time
 inode creation time

-.Ar ( X Ns = Ns Cm B ) ,
+.Pq Ar X Ns = Ns Cm B ,

 change time
 change time

-.Ar ( X Ns = Ns Cm c ) ,
+.Pq Ar X Ns = Ns Cm c ,

 or modification time
 or modification time

-.Ar ( X Ns = Ns Cm m )
+.Pq Ar X Ns = Ns Cm m

 than the last access time
 than the last access time

-.Ar ( Y Ns = Ns Cm a ) ,
+.Pq Ar Y Ns = Ns Cm a ,

 inode creation time
 inode creation time

-.Ar ( Y Ns = Ns Cm B ) ,
+.Pq Ar Y Ns = Ns Cm B ,

 change time
 change time

-.Ar ( Y Ns = Ns Cm c ) ,
+.Pq Ar Y Ns = Ns Cm c ,

 or modification time
 or modification time

-.Ar ( Y Ns = Ns Cm m )
+.Pq Ar Y Ns = Ns Cm m

 of
 .Ar file .
 In addition, if
 of
 .Ar file .
 In addition, if


@@ -561,6 +609,13 @@ is equivalent to
 .Ic -newer .
 .It Ic -nogroup
 True if the file belongs to an unknown group.
 .Ic -newer .
 .It Ic -nogroup
 True if the file belongs to an unknown group.

+.It Ic -noignore_readdir_race
+This option is for GNU find compatibility and is ignored.
+.It Ic -noleaf
+This option is for GNU find compatibility.
+In GNU find it disables an optimization not relevant to 
+.Xr find 1 ,
+so it is ignored.

 .It Ic -nouser
 True if the file belongs to an unknown user.
 .It Ic -ok Ar utility Oo Ar argument ... Oc Li \&;
 .It Ic -nouser
 True if the file belongs to an unknown user.
 .It Ic -ok Ar utility Oo Ar argument ... Oc Li \&;


@@ -689,6 +744,14 @@ but not
 .Dq Li xyzzy
 or
 .Dq Li /foo/ .
 .Dq Li xyzzy
 or
 .Dq Li /foo/ .

+.It Ic -samefile Ar name
+True if the file is a hard link to
+.Ar name .
+If the command option
+.Ic -L
+is specified, it is also true if the file is a symbolic link and
+points to 
+.Ar name .

 .It Ic -size Ar n Ns Op Cm ckMGTP
 True if the file's size, rounded up, in 512-byte blocks is
 .Ar n .
 .It Ic -size Ar n Ns Op Cm ckMGTP
 True if the file's size, rounded up, in 512-byte blocks is
 .Ar n .


@@ -718,7 +781,6 @@ terabytes (1024 gigabytes)
 .It Cm P
 petabytes (1024 terabytes)
 .El
 .It Cm P
 petabytes (1024 terabytes)
 .El

-.Pp

 .It Ic -type Ar t
 True if the file is of the specified type.
 Possible file types are as follows:
 .It Ic -type Ar t
 True if the file is of the specified type.
 Possible file types are as follows:


@@ -739,6 +801,15 @@ FIFO
 .It Cm s
 socket
 .El
 .It Cm s
 socket
 .El

+.It Ic -uid Ar uname
+The same thing as
+.Ar -user Ar uname 
+for compatibility with GNU find.
+GNU find imposes a restriction that
+.Ar uname 
+is numeric, while
+.Xr find 1 
+does not.

 .It Ic -user Ar uname
 True if the file belongs to the user
 .Ar uname .
 .It Ic -user Ar uname
 True if the file belongs to the user
 .Ar uname .


@@ -747,6 +818,15 @@ If
 is numeric and there is no such user name, then
 .Ar uname
 is treated as a user ID.
 is numeric and there is no such user name, then
 .Ar uname
 is treated as a user ID.

+.It Ic -wholename Ar pattern
+The same thing as 
+.Ic -path ,
+for GNU find compatibility.
+.It Ic -xattr
+True if the file has any extended attributes.
+.It Ic -xattrname Ar name
+True if the file has an extended attribute with the specified
+.Ar name .

 .El
 .Pp
 All primaries which take a numeric argument allow the number to be
 .El
 .Pp
 All primaries which take a numeric argument allow the number to be


@@ -764,19 +844,23 @@ and neither means
 The primaries may be combined using the following operators.
 The operators are listed in order of decreasing precedence.
 .Pp
 The primaries may be combined using the following operators.
 The operators are listed in order of decreasing precedence.
 .Pp

-.Bl -tag -width "( expression )" -compact
+.Bl -tag -width indent -compact

 .It Cm \&( Ar expression Cm \&)
 This evaluates to true if the parenthesized expression evaluates to
 true.
 .Pp
 .It Cm \&! Ar expression
 .It Cm \&( Ar expression Cm \&)
 This evaluates to true if the parenthesized expression evaluates to
 true.
 .Pp
 .It Cm \&! Ar expression

-.It Cm -false Ar expression

 .It Cm -not Ar expression
 This is the unary
 .Tn NOT
 operator.
 It evaluates to true if the expression is false.
 .Pp
 .It Cm -not Ar expression
 This is the unary
 .Tn NOT
 operator.
 It evaluates to true if the expression is false.
 .Pp

+.It Cm -false
+Always false.
+.It Cm -true
+Always true.
+.Pp

 .It Ar expression Cm -and Ar expression
 .It Ar expression expression
 The
 .It Ar expression Cm -and Ar expression
 .It Ar expression expression
 The


@@ -843,7 +927,7 @@ recent than the current time minus one minute.
 Use the
 .Xr echo 1
 command to print out a list of all the files.
 Use the
 .Xr echo 1
 command to print out a list of all the files.

-.It Li "find -L /usr/ports/packages -type l -delete"
+.It Li "find -L /usr/ports/packages -type l -exec rm -- {} +"

 Delete all broken symbolic links in
 .Pa /usr/ports/packages .
 .It Li "find /usr/src -name CVS -prune -o -depth +6 -print"
 Delete all broken symbolic links in
 .Pa /usr/ports/packages .
 .It Li "find /usr/src -name CVS -prune -o -depth +6 -print"


@@ -873,7 +957,7 @@ section below for details.
 .Xr which 1 ,
 .Xr xargs 1 ,
 .Xr stat 2 ,
 .Xr which 1 ,
 .Xr xargs 1 ,
 .Xr stat 2 ,

-.\" .Xr acl 3 ,
+.Xr acl 3 ,

 .Xr fts 3 ,
 .Xr getgrent 3 ,
 .Xr getpwent 3 ,
 .Xr fts 3 ,
 .Xr getgrent 3 ,
 .Xr getpwent 3 ,


@@ -888,15 +972,15 @@ utility syntax is a superset of the syntax specified by the
 standard.
 .Pp
 All the single character options except
 standard.
 .Pp
 All the single character options except

-.Ic -H
+.Fl H

 and
 and

-.Ic -L
+.Fl L

 as well as
 .Ic -amin , -anewer , -cmin , -cnewer , -delete , -empty , -fstype ,
 .Ic -iname , -inum , -iregex , -ls , -maxdepth , -mindepth , -mmin ,
 .Ic -path , -print0 , -regex
 and all of the
 as well as
 .Ic -amin , -anewer , -cmin , -cnewer , -delete , -empty , -fstype ,
 .Ic -iname , -inum , -iregex , -ls , -maxdepth , -mindepth , -mmin ,
 .Ic -path , -print0 , -regex
 and all of the

-.Ic -B
+.Ic -B*

 birthtime related primaries are extensions to
 .St -p1003.1-2001 .
 .Pp
 birthtime related primaries are extensions to
 .St -p1003.1-2001 .
 .Pp