1.\" $NetBSD: setmode.3,v 1.13 2002/02/07 07:00:16 ross Exp $ 2.\" 3.\" Copyright (c) 1989, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)setmode.3 8.2 (Berkeley) 4/28/95 35.\" 36.Dd April 28, 1995 37.Dt SETMODE 3 38.Os 39.Sh NAME 40.Nm getmode , 41.Nm setmode 42.Nd modify mode bits 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.Fd #include \*[Lt]unistd.h\*[Gt] 47.Ft mode_t 48.Fn getmode "const void *set" "mode_t mode" 49.Ft void * 50.Fn setmode "const char *mode_str" 51.Sh DESCRIPTION 52The 53.Fn getmode 54function 55returns a copy of the file permission bits 56.Fa mode 57as altered by the values pointed to by 58.Fa set . 59While only the mode bits are altered, other parts of the file mode 60may be examined. 61.Pp 62The 63.Fn setmode 64function 65takes an absolute (octal) or symbolic value, as described in 66.Xr chmod 1 , 67as an argument 68and returns a pointer to mode values to be supplied to 69.Fn getmode . 70Because some of the symbolic values are relative to the file 71creation mask, 72.Fn setmode 73may call 74.Xr umask 2 . 75If this occurs, the file creation mask will be restored before 76.Fn setmode 77returns. 78If the calling program changes the value of its file creation mask 79after calling 80.Fn setmode , 81.Fn setmode 82must be called again if 83.Fn getmode 84is to modify future file modes correctly. 85.Pp 86If the mode passed to 87.Fn setmode 88is invalid, 89.Fn setmode 90returns 91.Dv NULL . 92.Sh ERRORS 93The 94.Fn setmode 95function 96may fail and set errno for any of the errors specified for the library 97routine 98.Xr malloc 3 . 99.Sh SEE ALSO 100.Xr chmod 1 , 101.Xr stat 2 , 102.Xr umask 2 , 103.Xr malloc 3 104.Sh HISTORY 105The 106.Fn getmode 107and 108.Fn setmode 109functions first appeared in 110.Bx 4.4 . 111