chmod - Man Page

change file mode bits

Examples (TL;DR)

Synopsis

chmod [OPTION]... MODE[,MODE]... FILE...
chmod [OPTION]... OCTAL-MODE FILE...
chmod [OPTION]... --reference=RFILE FILE...

Description

This manual page documents the GNU version of chmod. chmod changes the file mode bits of each given file according to mode, which can be either a symbolic representation of changes to make, or an octal number representing the bit pattern for the new mode bits.

The format of a symbolic mode is [ugoa...][[-+=][perms...]...], where perms is either zero or more letters from the set rwxXst, or a single letter from the set ugo. Multiple symbolic modes can be given, separated by commas.

A combination of the letters ugoa controls which users' access to the file will be changed: the user who owns it (u), other users in the file's group (g), other users not in the file's group (o), or all users (a).  If none of these are given, the effect is as if (a) were given, but bits that are set in the umask are not affected.

The operator + causes the selected file mode bits to be added to the existing file mode bits of each file; - causes them to be removed; and = causes them to be added and causes unmentioned bits to be removed except that a directory's unmentioned set user and group ID bits are not affected.

The letters rwxXst select file mode bits for the affected users: read (r), write (w), execute (or search for directories) (x), execute/search only if the file is a directory or already has execute permission for some user (X), set user or group ID on execution (s), restricted deletion flag or sticky bit (t).  Instead of one or more of these letters, you can specify exactly one of the letters ugo: the permissions granted to the user who owns the file (u), the permissions granted to other users who are members of the file's group (g), and the permissions granted to users that are in neither of the two preceding categories (o).

A numeric mode is from one to four octal digits (0-7), derived by adding up the bits with values 4, 2, and 1.  Omitted digits are assumed to be leading zeros. The first digit selects the set user ID (4) and set group ID (2) and restricted deletion or sticky (1) attributes.  The second digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the third selects permissions for other users in the file's group, with the same values; and the fourth for other users not in the file's group, with the same values.

chmod doesn't change the permissions of symbolic links; the chmod system call cannot change their permissions on most systems, and most systems ignore permissions of symbolic links. However, for each symbolic link listed on the command line, chmod changes the permissions of the pointed-to file. In contrast, chmod ignores symbolic links encountered during recursive directory traversals. Options that modify this behavior are described in the Options section.

Setuid and Setgid Bits

chmod clears the set-group-ID bit of a regular file if the file's group ID does not match the user's effective group ID or one of the user's supplementary group IDs, unless the user has appropriate privileges.  Additional restrictions may cause the set-user-ID and set-group-ID bits of MODE or RFILE to be ignored.  This behavior depends on the policy and functionality of the underlying chmod system call.  When in doubt, check the underlying system behavior.

For directories chmod preserves set-user-ID and set-group-ID bits unless you explicitly specify otherwise.  You can set or clear the bits with symbolic modes like u+s and g-s. To clear these bits for directories with a numeric mode requires an additional leading zero like 00755, leading minus like -6000, or leading equals like =755.

Restricted Deletion Flag or Sticky Bit

The restricted deletion flag or sticky bit is a single bit, whose interpretation depends on the file type.  For directories, it prevents unprivileged users from removing or renaming a file in the directory unless they own the file or the directory; this is called the restricted deletion flag for the directory, and is commonly found on world-writable directories like /tmp.  For regular files on some older systems, the bit saves the program's text image on the swap device so it will load more quickly when run; this is called the sticky bit.

Options

Change the mode of each FILE to MODE. With --reference, change the mode of each FILE to that of RFILE.

-c,  --changes

like verbose but report only when a change is made

-f,  --silent,  --quiet

suppress most error messages

-v,  --verbose

output a diagnostic for every file processed

--dereference

affect the referent of each symbolic link, rather than the symbolic link itself

-h,  --no-dereference

affect each symbolic link, rather than the referent

--no-preserve-root

do not treat '/' specially (the default)

--preserve-root

fail to operate recursively on '/'

--reference=RFILE

use RFILE's mode instead of specifying MODE values. RFILE is always dereferenced if a symbolic link.

-R,  --recursive

change files and directories recursively

The following options modify how a hierarchy is traversed when the -R option is also specified.  If more than one is specified, only the final one takes effect. '-H' is the default.

-H

if a command line argument is a symbolic link to a directory, traverse it

-L

traverse every symbolic link to a directory encountered

-P

do not traverse any symbolic links

--help

display this help and exit

--version

output version information and exit

Each MODE is of the form '[ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+'.

Author

Written by David MacKenzie and Jim Meyering.

Reporting Bugs

GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
Report any translation bugs to <https://translationproject.org/team/>

See Also

chmod(2)

Full documentation <https://www.gnu.org/software/coreutils/chmod>
or available locally via: info '(coreutils) chmod invocation'

Referenced By

acl(5), bash(1), basic_getpwnam_auth(8), basic_pam_auth(8), basic_sasl_auth(8), bindfs(1), calc(1), chacl(1), chmod(2), clifm(1), cloginrc(5), collectd.conf(5), cpmchmod(1), debuild(1), dhcpd-pools(1), dirvish.conf(5), eperl(1), faxcron.8c(8), fcntl(2), find(1), finger(1), fnts2fon(1), g.access.1grass(1), genisoimage(1), gfs2(5), guestfish(1), inc(1), indomcachectl(1), kpsestat(1), ksh93(1), lftp(1), lircd(8), lp(4), mh-profile(5), mkc_install(1), mkfs.xfs(8), mksh(1), mu-mkdir(1), nfs4_setfacl(1), oksh(1), path_resolution(7), public-inbox-fetch(1), pycdlib-genisoimage(1), rcvstore(1), rrdcached(1), rsync(1), rsyncd.conf(5), sane-umax_pp(5), sane-usb(5), setfacl(1), setmode.3bsd(3), shellinaboxd(1), shtool-fixperm(1), shtool-install(1), shtool-mkdir(1), shtool-rotate(1), slapd(8), snmpd.conf(5), star(1), strmode.3bsd(3), symlink(7), TclX(n), uuencode(n), xattr(7), znew(1), zpaq(1), zshbuiltins(1).

November 2024 GNU coreutils 9.5