File attribute

File attributes are a type of meta-data that describe and may modify how files and/or directories in a filesystem behave. Typical file attributes may, for example, indicate or specify whether a file is visible, modifiable, compressed, or encrypted. The availability of most file attributes depends on support by the underlying filesystem (such as FAT, NTFS, ext4) where attribute data must be stored along with other control structures. Each attribute can have one of two states: set and cleared. Attributes are considered distinct from other metadata, such as dates and times, filename extensions or file system permissions. In addition to files, folders, volumes and other file system objects may have attributes.

DOS and Windows

Traditionally, in DOS and Microsoft Windows, files and folders accepted four attributes:^[1]^[2]^[3]

Archive (A): When set, it indicates that the hosting file has changed since the last backup operation. Windows' file system sets this attribute on any file that has changed. Backup software then has the duty of clearing it upon a successful full or incremental backup (not a differential one).
Hidden (H): When set, indicates that the hosting file is hidden. MS-DOS commands like dir and Windows apps like File Explorer do not show hidden files by default, unless asked to do so.^[4]
System (S): When set, indicates that the hosting file is a critical system file that is necessary for the computer to operate properly. MS-DOS and Microsoft Windows use it to mark important system files. MS-DOS commands like dir and Windows apps like File Explorer do not show system files by default even when hidden files are shown, unless asked to do so.
Read-only (R): When set, indicates that a file should not be altered. Upon opening the file, file system API usually does not grant write permission to the requesting application, unless the application explicitly requests it. Read-only attributes on folders are usually ignored, being used for another purpose.^[5]^[6]

As new versions of Windows came out, Microsoft has added to the inventory of available attributes on the NTFS file system,^[7] including but not limited to:^[8]

Compressed (C): When set, Windows compresses the hosting file upon storage. For more information, see NTFS § File compression.
Encrypted (E): When set, Windows encrypts the hosting file upon storage to prevent unauthorized access. For more information, see NTFS § Encryption.
Not Content-Indexed (I): When set, Indexing Service or Windows Search do not include the hosting file in their indexing operation.

Other attributes that are displayed in the "Attributes" column of Windows Explorer^[7] include:

Directory (D): The entry is a subdirectory, containing file and directory entries of its own.
Reparse Point (L): The file or directory has an associated re-parse point, or is a symbolic link.
Not Indexed (N): The file is not indexed on the host device.
Offline (O): The file data is physically moved to offline storage (Remote Storage).
Sparse (P): The file is a sparse file, i.e., its contents are partially empty and non-contiguous.
Temporary (T): The file is used for temporary storage.

In DOS, OS/2 and Windows, the attrib command in cmd.exe and command.com can be used to change and display the four traditional file attributes.^[3]^[9] File Explorer in Windows can show the seven mentioned attributes but cannot set or clear the System attribute.^[5]Windows PowerShell, which has become a component of Windows 7 and later, features two commands that can read and write attributes: Get-ItemProperty and Set-ItemProperty.^[10] To change an attribute on a file on Windows NT, the user must have appropriate file system permissions known as Write Attributes and Write Extended Attributes.^[11]

Unix and POSIX

In Unix and Unix-like systems, including POSIX-conforming systems, each file has a 'mode' containing 9 bit flags controlling read, write and execute permission for each of the file's owner, group and all other users (see File-system permissions §Traditional Unix permissions for more details) plus the setuid and setgid bit flags and a 'sticky' bit flag. The mode also specifies the file type (regular file, directory, or some other special kind).

4.4BSD and derivatives

In 4.4BSD and 4.4BSD-Lite, files and directories (folders) accepted four attributes that could be set by the owner of the file or the superuser (the "User" attributes) and two attributes that could only be set by the superuser (the "System" attributes):^[12]

(User) No-dump: When set, it indicates that the file or directory should not be saved during a backup operation.
(User and System) Immutable: When set, indicates that the file or directory should not be altered. Attempts to open the file for writing, create a file within the directory, remove a file from the directory, rename a file within the directory, rename the file or directory, or remove the file or directory will fail with a permissions error.
(User and System) Append-only: When set, indicates that the file should only be appended to.
(User) Opaque: When set on a directory, indicates that the directory is opaque when viewed through a union stack.

FreeBSD added some additional attributes,^[13] also supported by DragonFly BSD:^[14]

(User and System) No-unlink: When set, indicates that the file or directory should not be renamed or removed. Attempts to rename or remove the file or directory will fail with a permissions error.

FreeBSD also supports:^[13]

(System) No-archive: When set, indicates that the file or directory should not be archived.
(System) Snapshot: When set, indicates that the file or directory is a snapshot file. This attribute is maintained by the system, and cannot be set, even by the super-user.

whereas DragonFly BSD supports:^[14]

(User and System) No-history: When set, indicates that history should not be retained for the file or directory.
(User) Swapcache: When set, indicates that clean filesystem data for the file, or for the directory and everything underneath the directory, should be cached in swap space on a solid-state drive.
(System) Swapcache: When set, indicates that clean filesystem data for the file, or for the directory and everything underneath the directory, should not be cached in swap space on a solid-state drive.
(System) Archived: When set, indicates that the file or directory may be archived.

NetBSD added another attribute,^[15] also supported by OpenBSD:^[16]

(System) Archived: When set, indicates that the file or directory is archived.

macOS added three attributes:

(User) Hidden: When set, indicates that the file or directory should not, by default, be displayed in the GUI; ls will display it, however.^[17]
(System) Restricted: When set, indicates that the file or directory will be protected by System Integrity Protection
(User and System) Compressed: Read-only attribute for files compressed using HFS+ Compression

In these systems, the chflags and ls commands can be used to change and display file attributes. To change a "user" attribute on a file in 4.4BSD-derived operating systems, the user must be the owner of the file or the superuser; to change a "system" attribute, the user must be the superuser.

Linux

The Linux operating system can support a wide range of file attributes that can be listed by the lsattr command and modified, where possible, by the chattr command. Programs can examine and alter attributes using ioctl operations.^[18]

Many Linux file systems support only a limited set of attributes, and none of them support every attribute that chattr can change. File systems that support at least some attributes include ext4, XFS and btrfs.

Common file attributes supported by many common Linux file systems
Attribute	lsattr flag	chattr option	Semantics and rationale
No `atime` updates	`A`	`+A,-A`	atime record is not modified when file is read/accessed.
Append-only	`a`	`+a,-a`	Writing to file only allowed in append mode.
Immutable	`i`	`+i,-i`	Prevents any change to file's contents or metadata: file/directory cannot be written to, deleted, renamed, or hard-linked.
No dump	`d`	`+d,-d`	File is skipped by the dump program
Secure deletion	`s`	`+s,-s`	Requests that, when deleted, all file data blocks are filled with zeroes.
Synchronous updates	`S`	`+S,-S`	Changes are written synchronously to the underlying filesystem storage medium; equivalent to 'sync' mount option for affected files.

References

^ "Definition of: file attribute". PC Magazine. Ziff Davis. Retrieved 14 October 2020.
^ "File attributes". Computer Hope. Retrieved 2 December 2012.
^ ^a ^b "In Windows, what are file attributes, and how can I change them?". Knowledge Base. Indiana University. 11 October 2011. Retrieved 2 December 2012.
^ "What is a hidden file?". Windows 7 Help. Microsoft. Retrieved 2 December 2012.
^ ^a ^b "You cannot view or change the Read-only or the System attributes of folders in Windows Server 2003, in Windows XP, in Windows Vista or in Windows 7". Microsoft Support. Microsoft. 31 May 2012. Retrieved 2 December 2012.
^ "Why is the readonly property on folders so strange?".
^ ^a ^b "File Attribute Constants". MSDN. Microsoft. Retrieved 17 July 2018.
^ "HOW TO: Use the File Attribute Management Script (Fileattributes.pl) in Windows 2000". Microsoft support. Microsoft. Retrieved 2 December 2012.
^ "Definition of: DOS Attrib". PC Magazine. Ziff Davis. Retrieved 2 December 2012.
^ "Use a PowerShell Cmdlet to Work with File Attributes". Hey, Scripting Guy! Blog. Microsoft. 26 January 2011. Retrieved 3 December 2012.
^ "How to set, view, change, or remove special permissions for files and folders in Windows XP". Microsoft Support. Microsoft. 7 May 2007. Retrieved 2 December 2012.
^ chflags(2) – BSD System Calls Manual
^ ^a ^b chflags(2) – FreeBSD System Calls Manual
^ ^a ^b chflags(2) – DragonFly BSD System Calls and Error Numbers Manual
^ chflags(2) – NetBSD System Calls Manual
^ chflags(2) – OpenBSD System Calls Manual
^ chflags(2) – Darwin and macOS System Calls Manual
^ ioctl_iflags(2) – Linux Programmer's Manual – System Calls

External links

Definition of: DOS Attrib on PC Magazine
Hidden files in Unix-like operating systems at the Wayback Machine (archived October 17, 2007)
Microsoft File Attribute Constants
Win32 File Attributes

[pcmag-t-1] "Definition of: file attribute". PC Magazine. Ziff Davis. Retrieved 14 October 2020.

[computerhope-t-2] "File attributes". Computer Hope. Retrieved 2 December 2012.

[IndianaUni-t-3] "In Windows, what are file attributes, and how can I change them?". Knowledge Base. Indiana University. 11 October 2011. Retrieved 2 December 2012.

[4] "What is a hidden file?". Windows 7 Help. Microsoft. Retrieved 2 December 2012.

[hidden_and_readonly-5] "You cannot view or change the Read-only or the System attributes of folders in Windows Server 2003, in Windows XP, in Windows Vista or in Windows 7". Microsoft Support. Microsoft. 31 May 2012. Retrieved 2 December 2012.

[6] "Why is the readonly property on folders so strange?".

[microsoft-full-7] "File Attribute Constants". MSDN. Microsoft. Retrieved 17 July 2018.

[8] "HOW TO: Use the File Attribute Management Script (Fileattributes.pl) in Windows 2000". Microsoft support. Microsoft. Retrieved 2 December 2012.

[pcmag-attrib.exe-9] "Definition of: DOS Attrib". PC Magazine. Ziff Davis. Retrieved 2 December 2012.

[10] "Use a PowerShell Cmdlet to Work with File Attributes". Hey, Scripting Guy! Blog. Microsoft. 26 January 2011. Retrieved 3 December 2012.

[11] "How to set, view, change, or remove special permissions for files and folders in Windows XP". Microsoft Support. Microsoft. 7 May 2007. Retrieved 2 December 2012.

[12] chflags(2) – BSD System Calls Manual

[freebsd-flags-13] chflags(2) – FreeBSD System Calls Manual

[dragonflybsd-flags-14] chflags(2) – DragonFly BSD System Calls and Error Numbers Manual

[15] chflags(2) – NetBSD System Calls Manual

[16] chflags(2) – OpenBSD System Calls Manual

[17] chflags(2) – Darwin and macOS System Calls Manual

[18] ioctl_iflags(2) – Linux Programmer's Manual – System Calls

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

[9]

[10]

[11]

[12]

[13]

[14]

[15]

[16]

[17]

[18]

Contents