d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4d276cbac6
freebsd-skq/lib/libc/sys/chflags.2

238 lines
6.2 KiB
Groff
Raw Normal View History

BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.\" Copyright (c) 1989, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" 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.
.\"
.\" 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.
.\"
Merge from Lite2 onto mainline - - add undelete() and undelete.2 (requires libc minor bump some time) - man page updates
1997-03-11 11:35:56 +00:00
.\" @(#)chflags.2 8.3 (Berkeley) 5/2/95
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.\"
mdoc(7) police: bump document date on behalf of previous delta.
2002-05-29 15:47:24 +00:00
.Dd May 5, 2002
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Dt CHFLAGS 2
.Os
.Sh NAME
.Nm chflags ,
Document the lchflags(2) syscall.
2002-05-05 23:51:32 +00:00
.Nm lchflags ,
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Nm fchflags
.Nd set file flags
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following.
2000-04-21 09:42:15 +00:00
.Sh LIBRARY
.Lb libc
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In sys/stat.h
.In unistd.h
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Ft int
Eliminate double whitespace.
2004-07-03 22:30:10 +00:00
.Fn chflags "const char *path" "u_long flags"
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Ft int
Document the lchflags(2) syscall.
2002-05-05 23:51:32 +00:00
.Fn lchflags "const char *path" "int flags"
.Ft int
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Fn fchflags "int fd" "u_long flags"
.Sh DESCRIPTION
The file whose name
is given by
.Fa path
or referenced by the descriptor
.Fa fd
has its flags changed to
.Fa flags .
.Pp
Document the lchflags(2) syscall.
2002-05-05 23:51:32 +00:00
The
.Fn lchflags
system call is like
.Fn chflags
except in the case where the named file is a symbolic link,
in which case
.Fn lchflags
will change the flags of the link itself,
rather than the file it points to.
.Pp
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
The flags specified are formed by
.Em or Ns 'ing
the following values
.Pp
.Bl -tag -width "SF_IMMUTABLE" -compact -offset indent
.It UF_NODUMP
Do not dump the file.
.It UF_IMMUTABLE
The file may not be changed.
.It UF_APPEND
The file may only be appended to.
Submitted by: Whistle Communications (archie Cobbs) These changes add the ability to specify that a UFS file/directory cannot be unlinked. This is basically a scaled back version of the IMMUTABLE flag. The reason is to allow an administrator to create a directory hierarchy that a group of users can arbitrarily add/delete files from, but that the hierarchy itself is safe from removal by them. If the NOUNLINK definition is set to 0 then this results in no change to what happens normally. (and results in identical binary (in the kernel)). It can be proven that if this bit is never set by the admin, no new behaviour is introduced.. Several "good idea" comments from reviewers plus one grumble about creeping featurism. This code is in production in 2.2 based systems
1997-06-02 06:24:52 +00:00
.It UF_NOUNLINK
The file may not be renamed or deleted.
Merge from Lite2 onto mainline - - add undelete() and undelete.2 (requires libc minor bump some time) - man page updates
1997-03-11 11:35:56 +00:00
.It UF_OPAQUE
The directory is opaque when viewed through a union stack.
Resurrect documentation of chflags(2)'s SF_ARCHIVED. PR: 21428 Reviewed by: ben
2000-09-22 06:58:22 +00:00
.It SF_ARCHIVED
The file may be archived.
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.It SF_IMMUTABLE
The file may not be changed.
.It SF_APPEND
The file may only be appended to.
Submitted by: Whistle Communications (archie Cobbs) These changes add the ability to specify that a UFS file/directory cannot be unlinked. This is basically a scaled back version of the IMMUTABLE flag. The reason is to allow an administrator to create a directory hierarchy that a group of users can arbitrarily add/delete files from, but that the hierarchy itself is safe from removal by them. If the NOUNLINK definition is set to 0 then this results in no change to what happens normally. (and results in identical binary (in the kernel)). It can be proven that if this bit is never set by the admin, no new behaviour is introduced.. Several "good idea" comments from reviewers plus one grumble about creeping featurism. This code is in production in 2.2 based systems
1997-06-02 06:24:52 +00:00
.It SF_NOUNLINK
The file may not be renamed or deleted.
* Document the fact that non-superusers cannot change file flags for objects with SF_IMMUTABLE, SF_APPEND, or SF_NOUNLINK. * Document that non-superusers cannot set or clear any SF_* flag (setting fails with EPERM, clearing is silently ignored). * Document that superusers cannot change any flag if one of SF_IMMUTABLE, SF_APPEND, SF_NOUNLINK is set and securelevel is greater than 0. * Document SF_SNAPSHOT and note that it is maintained by the system and is, for this reason, impossible to set to clear by any user. PR: docs/33877 Submitted by: harti Help by: George Marsellis <gam9478@njit.edu> MFC after: 1 week
2006-05-16 20:24:41 +00:00
.It SF_SNAPSHOT
The file is a snapshot file.
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.El
.Pp
* Document the fact that non-superusers cannot change file flags for objects with SF_IMMUTABLE, SF_APPEND, or SF_NOUNLINK. * Document that non-superusers cannot set or clear any SF_* flag (setting fails with EPERM, clearing is silently ignored). * Document that superusers cannot change any flag if one of SF_IMMUTABLE, SF_APPEND, SF_NOUNLINK is set and securelevel is greater than 0. * Document SF_SNAPSHOT and note that it is maintained by the system and is, for this reason, impossible to set to clear by any user. PR: docs/33877 Submitted by: harti Help by: George Marsellis <gam9478@njit.edu> MFC after: 1 week
2006-05-16 20:24:41 +00:00
If one of
.Dq SF_IMMUTABLE ,
.Dq SF_APPEND ,
or
.Dq SF_NOUNLINK
is set a non-super-user cannot change any flags and even the super-user
can change flags only if securelevel is greater than 0.
(See
.Xr init 8
for details.)
.Pp
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
The
mdoc style fix. Reviewed by: mpp
1999-09-05 06:39:22 +00:00
.Dq UF_IMMUTABLE ,
Make it clear who can and can't set the UF_NODUMP, UF_OPAQUE, and SF_ARCHIVED file flags. PR: 25227 Approved by: nik
2001-03-19 23:51:09 +00:00
.Dq UF_APPEND ,
.Dq UF_NOUNLINK ,
.Dq UF_NODUMP ,
Submitted by: Whistle Communications (archie Cobbs) These changes add the ability to specify that a UFS file/directory cannot be unlinked. This is basically a scaled back version of the IMMUTABLE flag. The reason is to allow an administrator to create a directory hierarchy that a group of users can arbitrarily add/delete files from, but that the hierarchy itself is safe from removal by them. If the NOUNLINK definition is set to 0 then this results in no change to what happens normally. (and results in identical binary (in the kernel)). It can be proven that if this bit is never set by the admin, no new behaviour is introduced.. Several "good idea" comments from reviewers plus one grumble about creeping featurism. This code is in production in 2.2 based systems
1997-06-02 06:24:52 +00:00
and
Make it clear who can and can't set the UF_NODUMP, UF_OPAQUE, and SF_ARCHIVED file flags. PR: 25227 Approved by: nik
2001-03-19 23:51:09 +00:00
.Dq UF_OPAQUE
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
flags may be set or unset by either the owner of a file or the super-user.
.Pp
The
mdoc style fix. Reviewed by: mpp
1999-09-05 06:39:22 +00:00
.Dq SF_IMMUTABLE ,
Make it clear who can and can't set the UF_NODUMP, UF_OPAQUE, and SF_ARCHIVED file flags. PR: 25227 Approved by: nik
2001-03-19 23:51:09 +00:00
.Dq SF_APPEND ,
.Dq SF_NOUNLINK ,
Submitted by: Whistle Communications (archie Cobbs) These changes add the ability to specify that a UFS file/directory cannot be unlinked. This is basically a scaled back version of the IMMUTABLE flag. The reason is to allow an administrator to create a directory hierarchy that a group of users can arbitrarily add/delete files from, but that the hierarchy itself is safe from removal by them. If the NOUNLINK definition is set to 0 then this results in no change to what happens normally. (and results in identical binary (in the kernel)). It can be proven that if this bit is never set by the admin, no new behaviour is introduced.. Several "good idea" comments from reviewers plus one grumble about creeping featurism. This code is in production in 2.2 based systems
1997-06-02 06:24:52 +00:00
and
Make it clear who can and can't set the UF_NODUMP, UF_OPAQUE, and SF_ARCHIVED file flags. PR: 25227 Approved by: nik
2001-03-19 23:51:09 +00:00
.Dq SF_ARCHIVED
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
flags may only be set or unset by the super-user.
* Document the fact that non-superusers cannot change file flags for objects with SF_IMMUTABLE, SF_APPEND, or SF_NOUNLINK. * Document that non-superusers cannot set or clear any SF_* flag (setting fails with EPERM, clearing is silently ignored). * Document that superusers cannot change any flag if one of SF_IMMUTABLE, SF_APPEND, SF_NOUNLINK is set and securelevel is greater than 0. * Document SF_SNAPSHOT and note that it is maintained by the system and is, for this reason, impossible to set to clear by any user. PR: docs/33877 Submitted by: harti Help by: George Marsellis <gam9478@njit.edu> MFC after: 1 week
2006-05-16 20:24:41 +00:00
Attempts to set these flags by non-super-users are rejected, attempts by
non-superusers to clear flags that are already unset are silently ignored.
Merge from Lite2 onto mainline - - add undelete() and undelete.2 (requires libc minor bump some time) - man page updates
1997-03-11 11:35:56 +00:00
These flags may be set at any time, but normally may only be unset when
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
the system is in single-user mode.
(See
.Xr init 8
for details.)
* Document the fact that non-superusers cannot change file flags for objects with SF_IMMUTABLE, SF_APPEND, or SF_NOUNLINK. * Document that non-superusers cannot set or clear any SF_* flag (setting fails with EPERM, clearing is silently ignored). * Document that superusers cannot change any flag if one of SF_IMMUTABLE, SF_APPEND, SF_NOUNLINK is set and securelevel is greater than 0. * Document SF_SNAPSHOT and note that it is maintained by the system and is, for this reason, impossible to set to clear by any user. PR: docs/33877 Submitted by: harti Help by: George Marsellis <gam9478@njit.edu> MFC after: 1 week
2006-05-16 20:24:41 +00:00
.Pp
The
.Dq SF_SNAPSHOT
flag is maintained by the system and cannot be changed by any user.
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh RETURN VALUES
Use ``.Rv -std'' wherever possible. Submitted by: yar
2001-08-31 09:57:38 +00:00
.Rv -std
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh ERRORS
The .Fn function.
2002-07-15 20:59:12 +00:00
The
.Fn chflags
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe.
2002-12-18 09:22:32 +00:00
system call will fail if:
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG
A component of a pathname exceeded 255 characters,
or an entire path name exceeded 1023 characters.
.It Bq Er ENOENT
The named file does not exist.
.It Bq Er EACCES
Search permission is denied for a component of the path prefix.
.It Bq Er ELOOP
Too many symbolic links were encountered in translating the pathname.
.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.
* Document the fact that non-superusers cannot change file flags for objects with SF_IMMUTABLE, SF_APPEND, or SF_NOUNLINK. * Document that non-superusers cannot set or clear any SF_* flag (setting fails with EPERM, clearing is silently ignored). * Document that superusers cannot change any flag if one of SF_IMMUTABLE, SF_APPEND, SF_NOUNLINK is set and securelevel is greater than 0. * Document SF_SNAPSHOT and note that it is maintained by the system and is, for this reason, impossible to set to clear by any user. PR: docs/33877 Submitted by: harti Help by: George Marsellis <gam9478@njit.edu> MFC after: 1 week
2006-05-16 20:24:41 +00:00
.It Bq Er EPERM
One of
.Dq SF_IMMUTABLE ,
.Dq SF_APPEND ,
or
.Dq SF_NOUNLINK
is set and the user is either not the super-user or
securelevel is greater than 0.
.It Bq Er EPERM
A non-super-user tries to set one of
.Dq SF_IMMUTABLE ,
.Dq SF_APPEND ,
or
.Dq SF_NOUNLINK .
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.It Bq Er EROFS
The named file resides on a read-only file system.
.It Bq Er EFAULT
mdoc(7) police: "The .Fa argument.".
2002-12-19 09:40:28 +00:00
The
.Fa path
argument
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
points outside the process's allocated address space.
.It Bq Er EIO
An
.Tn I/O
error occurred while reading from or writing to the file system.
Mention that chflags can fail with EOPNOTSUPP.
1999-02-14 13:58:18 +00:00
.It Bq Er EOPNOTSUPP
The underlying file system does not support file flags.
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.El
.Pp
The .Fn function.
2002-07-15 20:59:12 +00:00
The
.Fn fchflags
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe.
2002-12-18 09:22:32 +00:00
system call will fail if:
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Bl -tag -width Er
.It Bq Er EBADF
The descriptor is not valid.
.It Bq Er EINVAL
mdoc(7) police: "The .Fa argument.".
2002-12-19 09:40:28 +00:00
The
Prepare for mdoc(7)NG.
2000-12-29 14:08:20 +00:00
.Fa fd
mdoc(7) police: "The .Fa argument.".
2002-12-19 09:40:28 +00:00
argument
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
refers to a socket, not to a file.
.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.
* Document the fact that non-superusers cannot change file flags for objects with SF_IMMUTABLE, SF_APPEND, or SF_NOUNLINK. * Document that non-superusers cannot set or clear any SF_* flag (setting fails with EPERM, clearing is silently ignored). * Document that superusers cannot change any flag if one of SF_IMMUTABLE, SF_APPEND, SF_NOUNLINK is set and securelevel is greater than 0. * Document SF_SNAPSHOT and note that it is maintained by the system and is, for this reason, impossible to set to clear by any user. PR: docs/33877 Submitted by: harti Help by: George Marsellis <gam9478@njit.edu> MFC after: 1 week
2006-05-16 20:24:41 +00:00
.It Bq Er EPERM
One of
.Dq SF_IMMUTABLE ,
.Dq SF_APPEND ,
or
.Dq SF_NOUNLINK
is set and the user is either not the super-user or
securelevel is greater than 0.
.It Bq Er EPERM
A non-super-user tries to set one of
.Dq SF_IMMUTABLE ,
.Dq SF_APPEND ,
or
.Dq SF_NOUNLINK .
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.It Bq Er EROFS
The file resides on a read-only file system.
.It Bq Er EIO
An
.Tn I/O
error occurred while reading from or writing to the file system.
EOPNOTSUPP also applies to fchflags().
1999-02-15 13:16:02 +00:00
.It Bq Er EOPNOTSUPP
The underlying file system does not support file flags.
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.El
.Sh SEE ALSO
".Xr chflags 1," -> ".Xr chflags 1 ,"
1996-09-21 06:28:55 +00:00
.Xr chflags 1 ,
Make a note of fflagstostr and strtofflags in the 'see also' section.
2000-06-17 14:03:34 +00:00
.Xr fflagstostr 3 ,
.Xr strtofflags 3 ,
Merge from Lite2 onto mainline - - add undelete() and undelete.2 (requires libc minor bump some time) - man page updates
1997-03-11 11:35:56 +00:00
.Xr init 8 ,
Rename (after a repo-copy) some mount(8) programs: mount_fdesc -> mount_fdescfs mount_null -> mount_nullfs mount_portal -> mount_portalfs mount_umap -> mount_umapfs mount_union -> mount_unionfs
2001-05-23 14:58:19 +00:00
.Xr mount_unionfs 8
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh HISTORY
The
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe.
2002-12-18 09:22:32 +00:00
.Fn chflags
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
and
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe.
2002-12-18 09:22:32 +00:00
.Fn fchflags
system calls first appeared in
Correctly use .Fn instead of .Nm to reference function names in a bunch of man pages. Use the correct .Bx (BSD UNIX) or .At (AT&T UNIX) macros instead of explicitly specifying the version in the text in a bunch of man pages.
1996-08-22 23:31:07 +00:00
.Bx 4.4 .
Reference in New Issue Copy Permalink