Add the sticky file in the proper section and add a history section for it

explaining what sticky means and meant on plain files.
This commit is contained in:
christos 2004-01-30 15:27:07 +00:00
parent c2f71cffe7
commit a3b53d29e6
2 changed files with 99 additions and 2 deletions

View File

@ -1,10 +1,10 @@
# $NetBSD: Makefile,v 1.15 2003/06/30 18:51:55 wiz Exp $
# $NetBSD: Makefile,v 1.16 2004/01/30 15:27:07 christos Exp $
# @(#)Makefile 8.1 (Berkeley) 6/5/93
# missing: eqnchar.7 man.7 ms.7 term.7
MAN= ascii.7 environ.7 hier.7 hostname.7 intro.7 mailaddr.7 \
nls.7 operator.7 packages.7 release.7 \
setuid.7 signal.7 symlink.7
setuid.7 signal.7 sticky.7 symlink.7
.include <bsd.man.mk>

97
share/man/man7/sticky.7 Normal file
View File

@ -0,0 +1,97 @@
.\" $NetBSD: sticky.7,v 1.1 2004/01/30 15:27:07 christos Exp $
.\"
.\" Copyright (c) 1980, 1991, 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. 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.
.\"
.\" @(#)sticky.8 8.1 (Berkeley) 6/5/93
.\"
.Dd May 25, 1998
.Dt STICKY 8
.Os
.Sh NAME
.Nm sticky
.Nd Description of the `sticky' (S_ISVTX) bit functionality.
.Sh DESCRIPTION
A special file mode, called the
.Em sticky bit
(mode S_ISVTX),
is used to indicate special treatment for directories.
See
.Xr chmod 2
or
the file
.Pa /usr/include/sys/stat.h
.Sh STICKY FILES
The use of mode S_ISVTX is reserved and can be set only by
the super-user.
.Sh STICKY DIRECTORIES
A directory whose `sticky bit' is set
becomes an append-only directory, or, more accurately,
a directory in which the deletion of files is restricted.
A file in a sticky directory may only be removed or renamed
by a user if the user has write permission for the directory and
the user is the owner of the file, the owner of the directory,
or the super-user.
This feature is usefully applied to directories such as
.Pa /tmp
which must be publicly writable but
should deny users the license to arbitrarily
delete or rename each others' files.
.Pp
Any user may create a sticky directory.
See
.Xr chmod 1
for details about modifying file modes.
.Sh BUGS
Neither
.Xr open 2
nor
.Xr mkdir 2
will create a file with the sticky bit set.
.Sh HISTORY
.Pp
The sticky bit first appeared in 4.1BSD.
It's initial use was to mark executables that were frequently used so that
their text would stay in virtual memory after the process exited.
This is where the term `sticky' comes from - the text of the program would
stick around in virtual memory.
Such executables were compiled in a way that they would have
their readonly data loaded in the text segment to minimize the amount of
work needed to load the executable.
.Xr vi 1
was one such executable.
.Pp
Later, on SunOS 4 the sticky bit got an additional meaning for files that
had the bit set and were not executable: read and write operations from and
to those files would go directly to the disk and bypass the buffer cache.
This was typically used on swap files for nfs clients on an nfs server,
so that swap I/O generated by the clients on the servers would not evict
useful data from the server's buffer cache.
.Pp
.Nx
currently does not treat plain files that have the sticky bit specially,
but this behavior might change in the future.