1 .\" $NetBSD: setmode.3,v 1.21 2009/01/11 02:46:27 christos Exp $
3 .\" Copyright (c) 1989, 1991, 1993
4 .\" The Regents of the University of California. All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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.
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
30 .\" @(#)setmode.3 8.2 (Berkeley) 4/28/95
44 .Fn setmode "const char *mode_str"
46 .Fn getmode "const void *set" "mode_t mode"
50 function accepts a string representation of a file mode change,
51 compiles it to binary form, and returns an abstract representation
54 The string may be an numeric (octal) or symbolic string of the form
57 and may represent either an exact mode to set or a change to make to
63 adjusts the file permission bits given by
65 according to the compiled change representation
67 and returns the adjusted mode.
68 While only the permission bits are altered, other parts of the file
69 mode, particularly the type, may be examined.
71 Because some of the possible symbolic values are defined relative to
72 the file creation mask,
76 temporarily changing the mask.
77 If this occurs, the file creation mask will be restored before
80 If the calling program changes the value of its file creation mask
84 must be called again to recompile the mode string if
86 is to modify future file modes correctly.
95 The effects of the shell command
96 .Ql "chmod a+x myscript.sh"
97 can be duplicated as follows:
98 .Bd -literal -offset indent
99 const char *file = "myscript.sh";
103 stat(file, \*[Am]st);
104 newmode = getmode(setmode("a+x"), st.st_mode);
105 chmod(file, newmode);
113 for any of the errors specified for the library routines
126 argument does not represent a valid mode.
138 functions first appeared in
143 allocates a small amount of memory that there is no correct way to
148 should really be some opaque struct type used only by these functions