BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / gen / setmode.3

diff --git a/usr/src/lib/libc/gen/setmode.3 b/usr/src/lib/libc/gen/setmode.3
index 1353155..39cb618 100644 (file)
--- a/usr/src/lib/libc/gen/setmode.3
+++ b/usr/src/lib/libc/gen/setmode.3
@@ -1,77 +1,105 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
+.\" Copyright (c) 1989, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" 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.

 .\"
 .\"

-.\"    @(#)setmode.3   5.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 SETMODE 3 "June 23, 1990"
-.UC 7
-.SH NAME
-getmode, setmode \- modify mode bits
-.SH SYNOPSIS
-.nf
-.ft B
-getmode(set, mode)
-mode_t *set, mode;
-
-set = setmode(mode_str)
-mode_t *set;
-char *mode_str;
-.ft R
-.fi
-.SH DESCRIPTION
-.I Getmode
+.\"     @(#)setmode.3  5.4 (Berkeley) 4/19/91
+.\"
+.Dd April 19, 1991
+.Dt SETMODE 3
+.Os
+.Sh NAME
+.Nm getmode ,
+.Nm setmode
+.Nd modify mode bits
+.Sh SYNOPSIS
+.Ft mode_t
+.Fn getmode "const void *set" "mode_t mode"
+.Ft void
+.Fn setmode "const char *mode_str"
+.Sh DESCRIPTION
+The
+.Fn getmode
+function

 returns a copy of the file permission bits
 returns a copy of the file permission bits

-.I mode
+.Fa mode

 as altered by the values pointed to by
 as altered by the values pointed to by

-.IR set .
+.Fa set .

 While only the mode bits are altered, other parts of the file mode
 may be examined.
 While only the mode bits are altered, other parts of the file mode
 may be examined.

-.PP
-.I Setmode
+.Pp
+The
+.Fn setmode
+function

 takes an absolute (octal) or symbolic value, as described in
 takes an absolute (octal) or symbolic value, as described in

-.IR chmod (1),
+.Xr chmod 1 ,

 as an argument
 and returns a pointer to mode values to be supplied to
 as an argument
 and returns a pointer to mode values to be supplied to

-.IR getmode .
+.Fn getmode .

 Because some of the symbolic values are relative to the file
 creation mask,
 Because some of the symbolic values are relative to the file
 creation mask,

-.I setmode
+.Fn setmode

 may call
 may call

-.IR umask (2).
+.Xr umask 2 .

 If this occurs, the file creation mask will be restored before
 If this occurs, the file creation mask will be restored before

-.I setmode
+.Fn setmode

 returns.
 If the calling program changes the value of its file creation mask
 after calling
 returns.
 If the calling program changes the value of its file creation mask
 after calling

-.IR setmode ,
-.I setmode
+.Fn setmode ,
+.Fn setmode

 must be called again if
 must be called again if

-.I getmode
+.Fn getmode

 is to modify future file modes correctly.
 is to modify future file modes correctly.

-.PP
+.Pp

 If the mode passed to
 If the mode passed to

-.I setmode
+.Fn setmode

 is invalid,
 is invalid,

-.I setmode
-returns NULL.
-.SH ERRORS
-.I Setmode
+.Fn setmode
+returns
+.Dv NULL . 
+.Sh ERRORS
+The
+.Fn setmode
+function

 may fail and set errno for any of the errors specified for the library
 routine
 may fail and set errno for any of the errors specified for the library
 routine

-.IR malloc (3).
-.SH SEE ALSO
-chmod(1), stat(2), umask(2), malloc(3)
+.Xr malloc 3 .
+.Sh SEE ALSO
+.Xr chmod 1 ,
+.Xr stat 2 ,
+.Xr umask 2 ,
+.Xr malloc 3
+.Sh HISTORY
+The
+.Fn getmode
+and
+.Fn setmode
+functions are
+.Ud .