man.bsd.lv manual page server

Manual Page Search Parameters

STAT_FLAGS(3) Library Functions Manual STAT_FLAGS(3)

string_to_flags, flags_to_stringStat flags parsing and printing functions

library “libutil”

#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);

The () 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:

arch file is archived
nodump do not dump file
opaque directory is opaque in union filesystems
sappnd writes to the file may only append
schg file cannot be changed; it is immutable
snap file is a snapshot inode
uappnd writes to the file may only append
uchg 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 () 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 () 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.

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.

chflags(2), stat(2)

September 20, 2012 NetBSD-9.2