sbin/hammer2: Fix usage()
[dragonfly.git] / usr.sbin / chown / chown.8
blobad6125546a5a698130761bd437ebd0fbf0ecfce7
1 .\" Copyright (c) 1990, 1991, 1993, 1994
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)chown.8     8.3 (Berkeley) 3/31/94
29 .\" $FreeBSD: head/usr.sbin/chown/chown.8 282208 2015-04-29 00:49:00Z smh $
30 .\"
31 .Dd May 12, 2016
32 .Dt CHOWN 8
33 .Os
34 .Sh NAME
35 .Nm chown
36 .Nd change file owner and group
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl fhvx
40 .Oo
41 .Fl R
42 .Op Fl H | Fl L | Fl P
43 .Oc
44 .Ar owner Ns Op : Ns Ar group
45 .Ar
46 .Nm
47 .Op Fl fhvx
48 .Oo
49 .Fl R
50 .Op Fl H | Fl L | Fl P
51 .Oc
52 .No : Ns Ar group
53 .Ar
54 .Sh DESCRIPTION
55 The
56 .Nm
57 utility changes the user ID and/or the group ID of the specified files.
58 Symbolic links named by arguments are silently left unchanged unless
59 .Fl h
60 is used.
61 .Pp
62 The options are as follows:
63 .Bl -tag -width Ds
64 .It Fl H
65 If the
66 .Fl R
67 option is specified, symbolic links on the command line are followed
68 and hence unaffected by the command.
69 (Symbolic links encountered during traversal are not followed.)
70 .It Fl L
71 If the
72 .Fl R
73 option is specified, all symbolic links are followed.
74 .It Fl P
75 If the
76 .Fl R
77 option is specified, no symbolic links are followed.
78 This is the default.
79 .It Fl R
80 Change the user ID and/or the group ID of the file hierarchies rooted
81 in the files, instead of just the files themselves.
82 Beware of unintentionally matching the
83 .Dq Pa ".."
84 hard link to the parent directory when using wildcards like
85 .Dq Li ".*" .
86 .It Fl f
87 Do not report any failure to change file owner or group, nor modify
88 the exit status to reflect such failures.
89 .It Fl h
90 If the file is a symbolic link, change the user ID and/or the
91 group ID of the link itself.
92 .It Fl v
93 Cause
94 .Nm
95 to be verbose, showing files as the owner is modified.
96 If the
97 .Fl v
98 flag is specified more than once,
99 .Nm
100 will print the filename, followed by the old and new numeric user/group ID.
101 .It Fl x
102 File system mount points are not traversed.
106 .Fl H ,
107 .Fl L
109 .Fl P
110 options are ignored unless the
111 .Fl R
112 option is specified.
113 In addition, these options override each other and the
114 command's actions are determined by the last one specified.
117 .Ar owner
119 .Ar group
120 operands are both optional, however, one must be specified.
121 If the
122 .Ar group
123 operand is specified, it must be preceded by a colon (``:'') character.
126 .Ar owner
127 may be either a numeric user ID or a user name.
128 If a user name is also a numeric user ID, the operand is used as a
129 user name.
131 .Ar group
132 may be either a numeric group ID or a group name.
133 If a group name is also a numeric group ID, the operand is used as a
134 group name.
136 The ownership of a file may only be altered by a super-user for
137 obvious security reasons.
138 .Sh EXIT STATUS
139 .Ex -std
140 .Sh COMPATIBILITY
141 Previous versions of the
143 utility used the dot (``.'') character to distinguish the group name.
144 This has been changed to be a colon (``:'') character so that user and
145 group names may contain the dot character.
147 On previous versions of this system, symbolic links did not have
148 owners.
151 .Fl v
153 .Fl x
154 options are non-standard and their use in scripts is not recommended.
155 .Sh SEE ALSO
156 .Xr chgrp 1 ,
157 .Xr find 1 ,
158 .Xr chown 2 ,
159 .Xr fts 3 ,
160 .Xr symlink 7
161 .Sh STANDARDS
164 utility is expected to be
165 .St -p1003.2
166 compliant.
167 .Sh HISTORY
170 utility appeared in
171 .At v1 .