Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

setmode(3) [netbsd man page]

SETMODE(3)						   BSD Library Functions Manual 						SETMODE(3)

NAME
getmode, setmode -- modify mode bits LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <unistd.h> void * setmode(const char *mode_str); mode_t getmode(const void *set, mode_t mode); DESCRIPTION
The setmode() function accepts a string representation of a file mode change, compiles it to binary form, and returns an abstract representa- tion that may be passed to getmode(). The string may be an numeric (octal) or symbolic string of the form accepted by chmod(1), and may rep- resent either an exact mode to set or a change to make to the existing mode. The getmode() function adjusts the file permission bits given by mode according to the compiled change representation set, and returns the adjusted mode. While only the permission bits are altered, other parts of the file mode, particularly the type, may be examined. Because some of the possible symbolic values are defined relative to the file creation mask, setmode() may call umask(2), temporarily chang- ing the mask. If this occurs, the file creation mask will be restored before setmode() returns. If the calling program changes the value of its file creation mask after calling setmode(), setmode() must be called again to recompile the mode string if getmode() is to modify future file modes correctly. If the mode passed to setmode() is invalid, setmode() returns NULL. EXAMPLES
The effects of the shell command 'chmod a+x myscript.sh' can be duplicated as follows: const char *file = "myscript.sh"; struct stat st; mode_t newmode; stat(file, &st); newmode = getmode(setmode("a+x"), st.st_mode); chmod(file, newmode); ERRORS
The setmode() function may fail and set errno for any of the errors specified for the library routines malloc(3) or strtol(3). In addition, setmode() will fail and set errno to: [EINVAL] The mode argument does not represent a valid mode. SEE ALSO
chmod(1), stat(2), umask(2), malloc(3) HISTORY
The getmode() and setmode() functions first appeared in 4.4BSD. BUGS
Each call to setmode allocates a small amount of memory that there is no correct way to free. The type of set should really be some opaque struct type used only by these functions rather than void *. BSD
January 4, 2009 BSD

Check Out this Related Man Page

CHMOD(2)						      BSD System Calls Manual							  CHMOD(2)

NAME
chmod, lchmod, fchmod -- change mode of file LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <sys/stat.h> int chmod(const char *path, mode_t mode); int lchmod(const char *path, mode_t mode); int fchmod(int fd, mode_t mode); DESCRIPTION
The function chmod() sets the file permission bits of the file specified by the pathname path to mode. fchmod() sets the permission bits of the specified file descriptor fd. lchmod() is like chmod() except in the case where the named file is a symbolic link, in which case lchmod() sets the permission bits of the link, while chmod() sets the bits of the file the link references. chmod() verifies that the process owner (user) either owns the file specified by path (or fd), or is the super-user. A mode is created from or'd permission bit masks defined in <sys/stat.h>: #define S_IRWXU 0000700 /* RWX mask for owner */ #define S_IRUSR 0000400 /* R for owner */ #define S_IWUSR 0000200 /* W for owner */ #define S_IXUSR 0000100 /* X for owner */ #define S_IRWXG 0000070 /* RWX mask for group */ #define S_IRGRP 0000040 /* R for group */ #define S_IWGRP 0000020 /* W for group */ #define S_IXGRP 0000010 /* X for group */ #define S_IRWXO 0000007 /* RWX mask for other */ #define S_IROTH 0000004 /* R for other */ #define S_IWOTH 0000002 /* W for other */ #define S_IXOTH 0000001 /* X for other */ #define S_ISUID 0004000 /* set user id on execution */ #define S_ISGID 0002000 /* set group id on execution */ #define S_ISVTX 0001000 /* sticky bit */ The mode ISVTX (the 'sticky bit') can be set on a regular file by the super-user, but has no effect. If mode ISVTX (the 'sticky bit') is set on a directory, an unprivileged user may not delete or rename files of other users in that directory. The sticky bit may be set by any user on a directory which the user owns or has appropriate permissions. For more information about the history and properties of the sticky bit, see sticky(7). Changing the owner of a file turns off the set-user-id and set-group-id bits; writing to a file turns off the set-user-id and set-group-id bits unless the user is the super-user. This makes the system somewhat more secure by protecting set-user-id (set-group-id) files from remaining set-user-id (set-group-id) if they are modified, at the expense of a degree of compatibility. RETURN VALUES
Upon successful completion, a value of 0 is returned. Otherwise, a value of -1 is returned and errno is set to indicate the error. ERRORS
chmod() and lchmod() will fail and the file mode will be unchanged if: [ENOTDIR] A component of the path prefix is not a directory. [ENAMETOOLONG] A component of a pathname exceeded {NAME_MAX} characters, or an entire path name exceeded {PATH_MAX} characters. [ENOENT] The named file does not exist. [EACCES] Search permission is denied for a component of the path prefix. [ELOOP] Too many symbolic links were encountered in translating the pathname. [EPERM] The effective user ID does not match the owner of the file and the effective user ID is not the super-user. [EPERM] The mode includes the setgid bit (S_ISGID) but the file's group is neither the effective group ID nor is it in the group access list. [EROFS] The named file resides on a read-only file system. [EFAULT] path points outside the process's allocated address space. [EIO] An I/O error occurred while reading from or writing to the file system. [EFTYPE] The effective user ID is not the super-user, the mode includes the sticky bit (S_ISVTX), and path does not refer to a directory. fchmod() will fail if: [EBADF] The descriptor is not valid. [EINVAL] fd refers to a socket, not to a file. [EPERM] The effective user ID does not match the owner of the file and the effective user ID is not the super-user. [EPERM] The mode includes the setgid bit (S_ISGID) but the file's group is neither the effective group ID nor is it in the group access list. [EROFS] The file resides on a read-only file system. [EIO] An I/O error occurred while reading from or writing to the file system. [EFTYPE] The effective user ID is not the super-user, the mode includes the sticky bit (S_ISVTX), and fd does not refer to a direc- tory. SEE ALSO
chmod(1), chflags(2), chown(2), open(2), stat(2), getmode(3), setmode(3), sticky(7), symlink(7) STANDARDS
The chmod() function conforms to ISO/IEC 9945-1:1990 (``POSIX.1''). HISTORY
The fchmod() function call appeared in 4.2BSD. The lchmod() function call appeared in NetBSD 1.3. BSD
October 11, 2011 BSD
Man Page