Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   9087 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

STAT_FLAGS(3)		 BSD Library Functions Manual		 STAT_FLAGS(3)

NAME
     string_to_flags, flags_to_string — Stat flags parsing and printing func‐
     tions

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 pro‐
     grams 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 argu‐
     ment 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

                             _         _         _ 
                            | |       | |       | |     
                            | |       | |       | |     
                         __ | | __ __ | | __ __ | | __  
                         \ \| |/ / \ \| |/ / \ \| |/ /  
                          \ \ / /   \ \ / /   \ \ / /   
                           \   /     \   /     \   /    
                            \_/       \_/       \_/ 

Vote for polarhome