6/lib/libc/sys/chown.2

   1 .\" Copyright (c) 1980, 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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)chown.2     8.4 (Berkeley) 4/19/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd April 19, 1994
  36 .Dt CHOWN 2
  37 .Os
  38 .Sh NAME
  39 .Nm chown ,
  40 .Nm fchown ,
  41 .Nm lchown
  42 .Nd change owner and group of a file
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In unistd.h
  47 .Ft int
  48 .Fn chown "const char *path" "uid_t owner" "gid_t group"
  49 .Ft int
  50 .Fn fchown "int fd" "uid_t owner" "gid_t group"
  51 .Ft int
  52 .Fn lchown "const char *path" "uid_t owner" "gid_t group"
  53 .Sh DESCRIPTION
  54 The owner ID and group ID of the file
  55 named by
  56 .Fa path
  57 or referenced by
  58 .Fa fd
  59 is changed as specified by the arguments
  60 .Fa owner
  61 and
  62 .Fa group .
  63 The owner of a file may change the
  64 .Fa group
  65 to a group of which
  66 he or she is a member,
  67 but the change
  68 .Fa owner
  69 capability is restricted to the super-user.
  70 .Pp
  71 The
  72 .Fn chown
  73 system call
  74 clears the set-user-id and set-group-id bits
  75 on the file
  76 to prevent accidental or mischievous creation of
  77 set-user-id and set-group-id programs if not executed
  78 by the super-user.
  79 The
  80 .Fn chown
  81 system call
  82 follows symbolic links to operate on the target of the link
  83 rather than the link itself.
  84 .Pp
  85 The
  86 .Fn fchown
  87 system call
  88 is particularly useful when used in conjunction
  89 with the file locking primitives (see
  90 .Xr flock 2 ) .
  91 .Pp
  92 The
  93 .Fn lchown
  94 system call is similar to
  95 .Fn chown
  96 but does not follow symbolic links.
  97 .Pp
  98 One of the owner or group id's
  99 may be left unchanged by specifying it as -1.
 100 .Sh RETURN VALUES
 101 .Rv -std
 102 .Sh ERRORS
 103 The
 104 .Fn chown
 105 and
 106 .Fn lchown
 107 will fail and the file will be unchanged if:
 108 .Bl -tag -width Er
 109 .It Bq Er ENOTDIR
 110 A component of the path prefix is not a directory.
 111 .It Bq Er ENAMETOOLONG
 112 A component of a pathname exceeded 255 characters,
 113 or an entire path name exceeded 1023 characters.
 114 .It Bq Er ENOENT
 115 The named file does not exist.
 116 .It Bq Er EACCES
 117 Search permission is denied for a component of the path prefix.
 118 .It Bq Er ELOOP
 119 Too many symbolic links were encountered in translating the pathname.
 120 .It Bq Er EPERM
 121 The effective user ID is not the super-user.
 122 .It Bq Er EROFS
 123 The named file resides on a read-only file system.
 124 .It Bq Er EFAULT
 125 The
 126 .Fa path
 127 argument
 128 points outside the process's allocated address space.
 129 .It Bq Er EIO
 130 An I/O error occurred while reading from or writing to the file system.
 131 .El
 132 .Pp
 133 The
 134 .Fn fchown
 135 system call will fail if:
 136 .Bl -tag -width Er
 137 .It Bq Er EBADF
 138 The
 139 .Fa fd
 140 argument
 141 does not refer to a valid descriptor.
 142 .It Bq Er EINVAL
 143 The
 144 .Fa fd
 145 argument
 146 refers to a socket, not a file.
 147 .It Bq Er EPERM
 148 The effective user ID is not the super-user.
 149 .It Bq Er EROFS
 150 The named file resides on a read-only file system.
 151 .It Bq Er EIO
 152 An I/O error occurred while reading from or writing to the file system.
 153 .El
 154 .Sh SEE ALSO
 155 .Xr chgrp 1 ,
 156 .Xr chmod 2 ,
 157 .Xr flock 2 ,
 158 .Xr chown 8
 159 .Sh STANDARDS
 160 The
 161 .Fn chown
 162 system call is expected to conform to
 163 .St -p1003.1-90 .
 164 .Sh HISTORY
 165 The
 166 .Fn chown
 167 function appeared in
 168 .At v7 .
 169 The
 170 .Fn fchown
 171 system call appeared in
 172 .Bx 4.2 .
 173 .Pp
 174 The
 175 .Fn chown
 176 system call was changed to follow symbolic links in
 177 .Bx 4.4 .
 178 The
 179 .Fn lchown
 180 system call was added in
 181 .Fx 3.0
 182 to compensate for the loss of functionality.