BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / sys / chflags.2

diff --git a/usr/src/lib/libc/sys/chflags.2 b/usr/src/lib/libc/sys/chflags.2
index 54282e6..f3b626d 100644 (file)
--- a/usr/src/lib/libc/sys/chflags.2
+++ b/usr/src/lib/libc/sys/chflags.2
@@ -1,110 +1,124 @@
 .\" Copyright (c) 1989 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1989 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" 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.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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.

 .\"
 .\"

-.\"    @(#)chflags.2   6.3 (Berkeley) 6/23/90
+.\" 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.

 .\"
 .\"

-.TH CHFALGS 2 "June 23, 1990"
-.UC 7
-.SH NAME
-chflags, fchflags \- set file flags
-.SH SYNOPSIS
-.nf
-.ft B
-chflags(path, flags)
-char *path;
-long flags;
-.LP
-.ft B
-fchflags(fd, flags)
-int fd;
-long flags;
-.fi
-.ft R
-.SH DESCRIPTION
+.\"    @(#)chflags.2   6.6 (Berkeley) 7/25/91
+.\"
+.Dd July 25, 1991
+.Dt CHFLAGS 2
+.Os
+.Sh NAME
+.Nm chflags ,
+.Nm fchflags
+.Nd set file flags
+.Sh SYNOPSIS
+.Fd #include <unistd.h>
+.Ft int
+.Fn chflags "const char *path"  "long flags"
+.Ft int
+.Fn fchflags "int fd" "long flags"
+.Sh DESCRIPTION

 The file whose name
 The file whose name

-is given by \fIpath\fP
+is given by
+.Fa path

 or referenced by the descriptor
 or referenced by the descriptor

-.I fd
+.Fa fd

 has its flags changed to
 has its flags changed to

-.IR flags .
-.PP
+.Fa flags .
+.Pp

 Only the owner of a file (or the super-user) may change the flags.
 The owner may only change the lower 16 bits of the flags;
 the super-user may change all 32 bits of the flags.
 Only the owner of a file (or the super-user) may change the flags.
 The owner may only change the lower 16 bits of the flags;
 the super-user may change all 32 bits of the flags.

-.SH RETURN VALUE
+.Sh RETURN VALUES

 Upon successful completion, a value of 0 is returned.
 Upon successful completion, a value of 0 is returned.

-Otherwise, \-1 is returned and the global variable
-.I errno
+Otherwise, -1 is returned and the global variable
+.Va errno

 is set to indicate the error.
 is set to indicate the error.

-.SH ERRORS
-.I Chflags
-fails if one or more of the following are true:
-.TP 15
-[ENOTDIR]
+.Sh ERRORS
+.Fn Chflags
+fails if:
+.Bl -tag -width Er
+.It Bq Er ENOTDIR

 A component of the path prefix is not a directory.
 A component of the path prefix is not a directory.

-.TP 15
-[EINVAL]
+.It Bq Er EINVAL

 The pathname contains a character with the high-order bit set.
 The pathname contains a character with the high-order bit set.

-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG

 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.
 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.

-.TP 15
-[ENOENT]
+.It Bq Er ENOENT

 The named file does not exist.
 The named file does not exist.

-.TP 15
-[EACCES]
+.It Bq Er EACCES

 Search permission is denied for a component of the path prefix.
 Search permission is denied for a component of the path prefix.

-.TP 15
-[ELOOP]
+.It Bq Er ELOOP

 Too many symbolic links were encountered in translating the pathname.
 Too many symbolic links were encountered in translating the pathname.

-.TP 15
-[EPERM]
+.It Bq Er EPERM

 The effective user ID does not match the owner of the file and
 the effective user ID is not the super-user.
 The effective user ID does not match the owner of the file and
 the effective user ID is not the super-user.

-.TP 15
-[EROFS]
+.It Bq Er EROFS

 The named file resides on a read-only file system.
 The named file resides on a read-only file system.

-.TP 15
-[EFAULT]
-.I Path
+.It Bq Er EFAULT
+.Fa Path

 points outside the process's allocated address space.
 points outside the process's allocated address space.

-.TP 15
-[EIO]
-An I/O error occurred while reading from or writing to the file system.
-.PP
-.I Fchflags
+.It Bq Er EIO
+An
+.Tn I/O
+error occurred while reading from or writing to the file system.
+.El
+.Pp
+.Fn Fchflags

 will fail if:
 will fail if:

-.TP 15
-[EBADF]
+.Bl -tag -width Er
+.It Bq Er EBADF

 The descriptor is not valid.
 The descriptor is not valid.

-.TP 15
-[EINVAL]
-.I Fd
+.It Bq Er EINVAL
+.Fa Fd

 refers to a socket, not to a file.
 refers to a socket, not to a file.

-.TP 15
-[EPERM]
+.It Bq Er EPERM

 The effective user ID does not match the owner of the file and
 the effective user ID is not the super-user.
 The effective user ID does not match the owner of the file and
 the effective user ID is not the super-user.

-.TP 15
-[EROFS]
+.It Bq Er EROFS

 The file resides on a read-only file system.
 The file resides on a read-only file system.

-.TP 15
-[EIO]
-An I/O error occurred while reading from or writing to the file system.
-.SH "SEE ALSO"
-chmod(2), open(2), chown(2), stat(2)
+.It Bq Er EIO
+An
+.Tn I/O
+error occurred while reading from or writing to the file system.
+.El
+.Sh SEE ALSO
+.Xr chmod 2 ,
+.Xr open 2 ,
+.Xr chown 2 ,
+.Xr stat 2
+.Sh HISTORY
+The
+.Nm chflags
+and
+.Nm fchflags
+function calls are
+.Ud .