fish-shell/doc_src/umask.txt

\section umask umask - set or get the file creation mode mask

\subsection umask-synopsis Synopsis
\fish{synopsis}
umask [OPTIONS] [MASK]
\endfish

\subsection umask-description Description

`umask` displays and manipulates the "umask", or file creation mode mask, which is used to restrict the default access to files.

The umask may be expressed either as an octal number, which represents the rights that will be removed by default, or symbolically, which represents the only rights that will be granted by default.

Access rights are explained in the manual page for the `chmod`(1) program.

With no parameters, the current file creation mode mask is printed as an octal number.

- `-h` or `--help` prints this message.

- `-S` or `--symbolic` prints the umask in symbolic form instead of octal form.

- `-p` or `--as-command` outputs the umask in a form that may be reused as input

If a numeric mask is specified as a parameter, the current shell's umask will be set to that value, and the rights specified by that mask will be removed from new files and directories by default.

If a symbolic mask is specified, the desired permission bits, and not the inverse, should be specified. A symbolic mask is a comma separated list of rights. Each right consists of three parts:

- The first part specifies to whom this set of right applies, and can be one of `u`, `g`, `o` or `a`, where `u` specifies the user who owns the file, `g` specifies the group owner of the file, `o` specific other users rights and `a` specifies all three should be changed.

- The second part of a right specifies the mode, and can be one of `=`, `+` or `-`, where `=` specifies that the rights should be set to the new value, `+` specifies that the specified right should be added to those previously specified and `-` specifies that the specified rights should be removed from those previously specified.

- The third part of a right specifies what rights should be changed and can be any combination of `r`, `w` and `x`, representing read, write and execute rights.

If the first and second parts are skipped, they are assumed to be `a` and `=`, respectively. As an example, `r,u+w` means all users should have read access and the file owner should also have write access.

Note that symbolic masks currently do not work as intended.


\subsection umask-example Example

`umask 177` or `umask u=rw` sets the file creation mask to read and write for the owner and no permissions at all for any other users.
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 07:56:01 +00:00			`\section umask umask - set or get the file creation mode mask`
Add documentation for umask darcs-hash:20051017143050-ac50b-0943033514159966b93adcb4073fa52cc8925597.gz 2005-10-17 14:30:50 +00:00
			`\subsection umask-synopsis Synopsis`
Simplify styling 2014-08-01 12:25:41 +00:00			`\fish{synopsis}`
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 02:37:32 +00:00			`umask [OPTIONS] [MASK]`
			`\endfish`
Add documentation for umask darcs-hash:20051017143050-ac50b-0943033514159966b93adcb4073fa52cc8925597.gz 2005-10-17 14:30:50 +00:00
			`\subsection umask-description Description`

Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00			`umask` displays and manipulates the "umask", or file creation mode mask, which is used to restrict the default access to files.
Code cleanups and API documentation updates darcs-hash:20051023121429-ac50b-6ff72171b5a90b6e398bd84e748388c1dba831d9.gz 2005-10-23 12:14:29 +00:00
Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00			`The umask may be expressed either as an octal number, which represents the rights that will be removed by default, or symbolically, which represents the only rights that will be granted by default.`
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 07:56:01 +00:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 02:37:32 +00:00			Access rights are explained in the manual page for the `chmod`(1) program.
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 07:56:01 +00:00
Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00			`With no parameters, the current file creation mode mask is printed as an octal number.`
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 07:56:01 +00:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 02:37:32 +00:00			- `-h` or `--help` prints this message.
Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 02:37:32 +00:00			- `-S` or `--symbolic` prints the umask in symbolic form instead of octal form.
Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 02:37:32 +00:00			- `-p` or `--as-command` outputs the umask in a form that may be reused as input
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 07:56:01 +00:00
Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00			`If a numeric mask is specified as a parameter, the current shell's umask will be set to that value, and the rights specified by that mask will be removed from new files and directories by default.`

			`If a symbolic mask is specified, the desired permission bits, and not the inverse, should be specified. A symbolic mask is a comma separated list of rights. Each right consists of three parts:`

			- The first part specifies to whom this set of right applies, and can be one of `u`, `g`, `o` or `a`, where `u` specifies the user who owns the file, `g` specifies the group owner of the file, `o` specific other users rights and `a` specifies all three should be changed.

			- The second part of a right specifies the mode, and can be one of `=`, `+` or `-`, where `=` specifies that the rights should be set to the new value, `+` specifies that the specified right should be added to those previously specified and `-` specifies that the specified rights should be removed from those previously specified.

			- The third part of a right specifies what rights should be changed and can be any combination of `r`, `w` and `x`, representing read, write and execute rights.

			If the first and second parts are skipped, they are assumed to be `a` and `=`, respectively. As an example, `r,u+w` means all users should have read access and the file owner should also have write access.
Add documentation for umask darcs-hash:20051017143050-ac50b-0943033514159966b93adcb4073fa52cc8925597.gz 2005-10-17 14:30:50 +00:00
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 07:56:01 +00:00			`Note that symbolic masks currently do not work as intended.`
Add documentation for umask darcs-hash:20051017143050-ac50b-0943033514159966b93adcb4073fa52cc8925597.gz 2005-10-17 14:30:50 +00:00

Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00			`\subsection umask-example Example`
Add documentation for umask darcs-hash:20051017143050-ac50b-0943033514159966b93adcb4073fa52cc8925597.gz 2005-10-17 14:30:50 +00:00
Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00			`umask 177` or `umask u=rw` sets the file creation mask to read and write for the owner and no permissions at all for any other users.