1.\" $OpenBSD: setmode.3,v 1.13 2007/05/31 19:19:28 jmc 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. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.Dd $Mdocdate: May 31 2007 $ 31.Dt SETMODE 3 32.Os 33.Sh NAME 34.Nm getmode , 35.Nm setmode 36.Nd modify mode bits 37.Sh SYNOPSIS 38.Fd #include <unistd.h> 39.Ft mode_t 40.Fn getmode "const void *set" "mode_t mode" 41.Ft void * 42.Fn setmode "const char *mode_str" 43.Sh DESCRIPTION 44The 45.Fn getmode 46function returns a copy of the file permission bits 47.Fa mode 48as altered by the values pointed to by 49.Fa set . 50While only the mode bits are altered, other parts of the file mode 51may be examined. 52.Pp 53The 54.Fn setmode 55function takes an absolute (octal) or symbolic value, as described in 56.Xr chmod 1 , 57as an argument 58and returns a pointer to mode values to be supplied to 59.Fn getmode . 60Because some of the symbolic values are relative to the file 61creation mask, 62.Fn setmode 63may call 64.Xr umask 2 . 65If this occurs, the file creation mask will be restored before 66.Fn setmode 67returns. 68If the calling program changes the value of its file creation mask 69after calling 70.Fn setmode , 71.Fn setmode 72must be called again if 73.Fn getmode 74is to modify future file modes correctly. 75.Pp 76If the mode passed to 77.Fn setmode 78is invalid, 79.Fn setmode 80returns 81.Dv NULL . 82The caller is responsible for freeing the pointer that 83.Fn setmode 84returns. 85.Sh ERRORS 86The 87.Fn setmode 88function may fail and set 89.Va errno 90for any of the errors specified for the library routine 91.Xr malloc 3 92or to 93.Er ERANGE 94if an invalid octal value was specified, or 95.Er EINVAL 96if an invalid symbolic value was specified. 97.Sh SEE ALSO 98.Xr chmod 1 , 99.Xr stat 2 , 100.Xr umask 2 , 101.Xr malloc 3 102.Sh HISTORY 103The 104.Fn getmode 105and 106.Fn setmode 107functions first appeared in 108.Bx 4.4 . 109