stat_flags(3) [netbsd man page]
STAT_FLAGS(3) BSD Library Functions Manual STAT_FLAGS(3) NAME
string_to_flags, flags_to_string -- Stat flags parsing and printing functions LIBRARY
System Utilities Library (libutil, -lutil) SYNOPSIS
#include <util.h> char * flags_to_string(u_long flags, const char *def); int string_to_flags(char **stringp, u_long *setp, u_long clrp); DESCRIPTION
The flags_to_string() and string_to_flags() functions are used by programs such as ls(1), mtree(8), makefs(8), etc., to parse and/or print the st_flags field in the stat(2) structure. They recognize the following flags: String Flag Description arch SF_ARCHIVED file is archived nodump UF_NODUMP do not dump file opaque UF_OPAQUE directory is opaque in union filesystems sappnd SF_APPEND writes to the file may only append schg SF_IMMUTABLE file cannot be changed; it is immutable snap SF_SNAPSHOT file is a snapshot inode uappnd UF_APPEND writes to the file may only append uchg UF_IMMUTABLE file cannot be changed; it is immutable The SF_APPEND and SF_IMMUTABLE flags are for the superuser only, whereas UF_APPEND and UF_IMMUTABLE are for the user only. The flags_to_string() function converts the bits set in the flags argument to a comma-separated string and returns it. If no flags are set, then the def string is returned. The returned string is allocated via malloc(3) and it is the responsibility of the caller to free(3) it. The string_to_flags() function takes a stringp of space, comma, or tab separated flag names and places their bit value on the setp argument. If the flag name is prefixed by: ``no'', then the bit value is placed on the clrp argument. RETURN VALUES
flags_to_string() returns the symbolic representation of flags, the default string, or NULL if allocation failed. string_to_flags() returns 0 on success and 1 if it fails to parse the string, setting stringp to point to the first string that it failed to parse. SEE ALSO
chflags(2), stat(2) BSD
August 6, 2011 BSD
Check Out this Related Man Page
CHFLAGS(2) BSD System Calls Manual CHFLAGS(2) NAME
chflags, lchflags, fchflags -- set file flags LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <sys/stat.h> #include <unistd.h> int chflags(const char *path, u_long flags); int lchflags(const char *path, int flags); int fchflags(int fd, u_long flags); DESCRIPTION
The file whose name is given by path or referenced by the descriptor fd has its flags changed to flags. The lchflags() system call is like chflags() except in the case where the named file is a symbolic link, in which case lchflags() will change the flags of the link itself, rather than the file it points to. The flags specified are formed by or'ing the following values UF_NODUMP Do not dump the file. UF_IMMUTABLE The file may not be changed. UF_APPEND The file may only be appended to. UF_NOUNLINK The file may not be renamed or deleted. UF_OPAQUE The directory is opaque when viewed through a union stack. SF_ARCHIVED The file may be archived. SF_IMMUTABLE The file may not be changed. SF_APPEND The file may only be appended to. SF_NOUNLINK The file may not be renamed or deleted. SF_SNAPSHOT The file is a snapshot file. If one of SF_IMMUTABLE, SF_APPEND, or SF_NOUNLINK is set a non-super-user cannot change any flags and even the super-user can change flags only if securelevel is greater than 0. (See init(8) for details.) The UF_IMMUTABLE, UF_APPEND, UF_NOUNLINK, UF_NODUMP, and UF_OPAQUE flags may be set or unset by either the owner of a file or the super-user. The SF_IMMUTABLE, SF_APPEND, SF_NOUNLINK, and SF_ARCHIVED flags may only be set or unset by the super-user. Attempts to set these flags by non-super-users are rejected, attempts by non-superusers to clear flags that are already unset are silently ignored. These flags may be set at any time, but normally may only be unset when the system is in single-user mode. (See init(8) for details.) The SF_SNAPSHOT flag is maintained by the system and cannot be changed by any user. RETURN VALUES
Upon successful completion, the value 0 is returned; otherwise the value -1 is returned and the global variable errno is set to indicate the error. ERRORS
The chflags() system call will fail if: [ENOTDIR] A component of the path prefix is not a directory. [ENAMETOOLONG] A component of a pathname exceeded 255 characters, or an entire path name exceeded 1023 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] One of SF_IMMUTABLE, SF_APPEND, or SF_NOUNLINK is set and the user is either not the super-user or securelevel is greater than 0. [EPERM] A non-super-user tries to set one of SF_IMMUTABLE, SF_APPEND, or SF_NOUNLINK. [EPERM] User tries to set or remove the SF_SNAPSHOT flag. [EROFS] The named file resides on a read-only file system. [EFAULT] The path argument points outside the process's allocated address space. [EIO] An I/O error occurred while reading from or writing to the file system. [EOPNOTSUPP] The underlying file system does not support file flags. The fchflags() system call will fail if: [EBADF] The descriptor is not valid. [EINVAL] The fd argument 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] One of SF_IMMUTABLE, SF_APPEND, or SF_NOUNLINK is set and the user is either not the super-user or securelevel is greater than 0. [EPERM] A non-super-user tries to set one of SF_IMMUTABLE, SF_APPEND, or SF_NOUNLINK. [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. [EOPNOTSUPP] The underlying file system does not support file flags. SEE ALSO
chflags(1), fflagstostr(3), strtofflags(3), init(8), mount_unionfs(8) HISTORY
The chflags() and fchflags() system calls first appeared in 4.4BSD. BSD May 16, 2006 BSD