fbt/sbase
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
1466021305
sbase/chmod.1

70 lines
980 B
Groff
Raw Normal View History

Add mandoc-manpage for chmod(1) and mark it as finished in README. One small rationale on the way the manpage is set up: Looking at the coreutils manpage, it does not invite to be a quick reference guide, whereas I wrote this manpage to be short and concise in regard to the information the advanced user needs. No one needs to explain what an octal number is. That's not part of the scope of this manpage. Also, nobody wants to read a block of text just to find out how to build an octal mode string.
2015-01-17 21:33:19 +00:00
.Dd January 17, 2015
.Dt CHMOD 1 sbase\-VERSION
add some mandoc pages and fix some warnings - add .Os, it is mandatory. - don't redeclare .Nm when it's not needed. - fix some warnings (checked with mandoc -Tlint). - remove some leftover old stuff.
2015-01-30 20:17:58 +00:00
.Os
Add mandoc-manpage for chmod(1) and mark it as finished in README. One small rationale on the way the manpage is set up: Looking at the coreutils manpage, it does not invite to be a quick reference guide, whereas I wrote this manpage to be short and concise in regard to the information the advanced user needs. No one needs to explain what an octal number is. That's not part of the scope of this manpage. Also, nobody wants to read a block of text just to find out how to build an octal mode string.
2015-01-17 21:33:19 +00:00
.Sh NAME
.Nm chmod
.Nd change file mode
.Sh SYNOPSIS
add some mandoc pages and fix some warnings - add .Os, it is mandatory. - don't redeclare .Nm when it's not needed. - fix some warnings (checked with mandoc -Tlint). - remove some leftover old stuff.
2015-01-30 20:17:58 +00:00
.Nm
Add mandoc-manpage for chmod(1) and mark it as finished in README. One small rationale on the way the manpage is set up: Looking at the coreutils manpage, it does not invite to be a quick reference guide, whereas I wrote this manpage to be short and concise in regard to the information the advanced user needs. No one needs to explain what an octal number is. That's not part of the scope of this manpage. Also, nobody wants to read a block of text just to find out how to build an octal mode string.
2015-01-17 21:33:19 +00:00
.Op Fl R
.Ar mode
.Op Ar file ...
.Sh DESCRIPTION
.Nm
changes the file mode of the given files.
.Pp
If
.Ar mode
is
.Em octal
"[sog]e"
.Bl -tag -width Ds
.It s
.Xr sticky 1 => s += 1
.Pp
.Xr setgid 2 => s += 2
.Pp
.Xr setuid 4 => s += 4
.It o|g|e
owner | group | everyone
.Pp
.Xr execute 1 => o|g|e += 1
.Pp
.Xr write 2 => o|g|e += 2
.Pp
.Xr read 4 => o|g|e += 4
.El
.Pp
Leading zeroes may be omitted.
.Pp
If
.Ar mode
is
.Em symbolic
"[ugoa]*[+-=][rwxst]*"
.Bl -tag -width Ds
.It u|g|o|a
owner | group | other (non-group) | everyone
.It +|-|=
add | remove | set
.It r|w|x|s|t
read | write | execute | setuid and setgid | sticky
.El
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl R
Change modes recursively
.El
Add additional info to mkdir(1), mkfifo(1) and chmod(1)-manpages
2015-01-28 20:15:55 +00:00
.Sh SEE ALSO
.Xr umask 1
Add mandoc-manpage for chmod(1) and mark it as finished in README. One small rationale on the way the manpage is set up: Looking at the coreutils manpage, it does not invite to be a quick reference guide, whereas I wrote this manpage to be short and concise in regard to the information the advanced user needs. No one needs to explain what an octal number is. That's not part of the scope of this manpage. Also, nobody wants to read a block of text just to find out how to build an octal mode string.
2015-01-17 21:33:19 +00:00
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2008
specification.
.Pp
The
.Op Fl R
flag is an extension to that specification.
Reference in New Issue Copy Permalink