midfavila/sbase
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
4fcb31c6e0
sbase/chmod.1

88 lines
1.2 KiB
Groff
Raw Normal View History

Use ISO-date-format in manpages The one specified by mdoc is hard to read for non-native speakers from countries which read the date day-first (like Germany, Greece, North-Korea, Swamp,...). This is also consistent with how we generally specify dates at suckless.org.
2015-10-08 11:15:08 -04:00
.Dd 2015-10-08
remove sbase-VERSION from man page, fix sponge.1 date
2015-01-31 08:20:02 -05:00
.Dt CHMOD 1
Add .Os sbase and sed replace to .Os sbase $(VERSION) in make install
2015-01-31 14:37:03 -05:00
.Os sbase
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 16:33:19 -05:00
.Sh NAME
.Nm chmod
Audit chmod(1) 1) Update manpage, refactor the HLP-section and other wordings. 2) BUGFIX: If chmod() fails, don't recurse. 3) Rewrite the arg-loop, fixing several issues: BUGFIX: Handle multi-flags (e.g. -RH) BUGFIX: Properly handle the termination flag --, error on e.g. --x BUGFIX: Error out on an empty flag -. 4) Refactor logic after the arg-loop, which is now simpler thanks to argv-incremention.
2015-03-05 13:08:28 -05:00
.Nd change file modes
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 16:33:19 -05:00
.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 15:17:58 -05:00
.Nm
chmod: Add -HLP flags and update manpage
2015-02-16 11:47:07 -05:00
.Oo
.Fl R
.Op Fl H | L | P
.Oc
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 16:33:19 -05:00
.Ar mode
chmod: Add -HLP flags and update manpage
2015-02-16 11:47:07 -05:00
.Ar file ...
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 16:33:19 -05:00
.Sh DESCRIPTION
.Nm
Audit chmod(1) 1) Update manpage, refactor the HLP-section and other wordings. 2) BUGFIX: If chmod() fails, don't recurse. 3) Rewrite the arg-loop, fixing several issues: BUGFIX: Handle multi-flags (e.g. -RH) BUGFIX: Properly handle the termination flag --, error on e.g. --x BUGFIX: Error out on an empty flag -. 4) Refactor logic after the arg-loop, which is now simpler thanks to argv-incremention.
2015-03-05 13:08:28 -05:00
changes the file mode of each
.Ar file
to
.Ar mode .
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 16:33:19 -05:00
.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
chmod: Implement X perm symbol Instead of clearing the format bits before calling parsemode, leave them in so we can differentiate between directories and other files, then clear the format bits in the result.
2020-01-06 16:08:38 -05:00
"[ugoa]*[+-=][rwxXst]*"
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 16:33:19 -05:00
.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
chmod: Implement X perm symbol Instead of clearing the format bits before calling parsemode, leave them in so we can differentiate between directories and other files, then clear the format bits in the result.
2020-01-06 16:08:38 -05:00
.It X
execute, if directory or at least one execute bit is already set
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 16:33:19 -05:00
.El
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl R
chmod: Add -HLP flags and update manpage
2015-02-16 11:47:07 -05:00
Change modes recursively.
.It Fl H
Audit chmod(1) 1) Update manpage, refactor the HLP-section and other wordings. 2) BUGFIX: If chmod() fails, don't recurse. 3) Rewrite the arg-loop, fixing several issues: BUGFIX: Handle multi-flags (e.g. -RH) BUGFIX: Properly handle the termination flag --, error on e.g. --x BUGFIX: Error out on an empty flag -. 4) Refactor logic after the arg-loop, which is now simpler thanks to argv-incremention.
2015-03-05 13:08:28 -05:00
Dereference
.Ar file
if it is a symbolic link.
chmod: Add -HLP flags and update manpage
2015-02-16 11:47:07 -05:00
.It Fl L
Audit chmod(1) 1) Update manpage, refactor the HLP-section and other wordings. 2) BUGFIX: If chmod() fails, don't recurse. 3) Rewrite the arg-loop, fixing several issues: BUGFIX: Handle multi-flags (e.g. -RH) BUGFIX: Properly handle the termination flag --, error on e.g. --x BUGFIX: Error out on an empty flag -. 4) Refactor logic after the arg-loop, which is now simpler thanks to argv-incremention.
2015-03-05 13:08:28 -05:00
Dereference all symbolic links.
chmod: Add -HLP flags and update manpage
2015-02-16 11:47:07 -05:00
.It Fl P
Fix various lint warnings in manuals Fix "new sentence, new line" warnings throughout so that formatters can produce correct spacing between sentences. join.1 Remove unnecessary Ns macros. These are not necessary for delimeters, which get special treatment. xinstall.1 Fix date in manual. The contents were last modified on 2016-12-03, so use that instead of the invalid date. grep.1 Fix escape sequence for `\<` and `\>`. ed.1 Remove spurious `\\n` escape for the null-command.
2020-03-01 17:37:31 -05:00
Preserve symbolic links.
This is the default.
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 16:33:19 -05:00
.El
Add additional info to mkdir(1), mkfifo(1) and chmod(1)-manpages
2015-01-28 15:15:55 -05:00
.Sh SEE ALSO
chmod: Add -HLP flags and update manpage
2015-02-16 11:47:07 -05:00
.Xr chgrp 1 ,
Add additional info to mkdir(1), mkfifo(1) and chmod(1)-manpages
2015-01-28 15:15:55 -05:00
.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 16:33:19 -05:00
.Sh STANDARDS
The
.Nm
utility is compliant with the
POSIX 2013 audit Mostly manpage-shuffling according to the changes in the corrigendum, wording changes and more idiomatic expressions. All this is finished up by marking the POSIX 2013 conformant tools with .St -p1003.1-2013 which is not available in older mandoc builds or nroff, but which reflects what we actually did, so who cares? This is a huge step and it's not far until we can release sbase 0.1.
2015-03-27 12:22:48 -04:00
.St -p1003.1-2013
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 16:33:19 -05:00
specification.
.Pp
The
chmod: Add -HLP flags and update manpage
2015-02-16 11:47:07 -05:00
.Op Fl HLP
flags are an extension to that specification.
Reference in New Issue Copy Permalink