Skip to content

Commit 7735593

Browse files
committed
docs: fix sudoers(5)
- iolog_flush: boolean - iolog_mode: integer - passwd_timeout: decimal or boolean - timestamp_timeout: decimal or boolean
1 parent 38d909a commit 7735593

2 files changed

Lines changed: 103 additions & 97 deletions

File tree

docs/sudoers.man.in

Lines changed: 53 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -3195,6 +3195,19 @@ This flag is
31953195
\fI@insults@\fR
31963196
by default.
31973197
.TP 18n
3198+
iolog_flush
3199+
If set,
3200+
\fBsudo\fR
3201+
will flush I/O log data to disk after each write instead of buffering it.
3202+
This makes it possible to view the logs in real-time as the program
3203+
is executing but may significantly reduce the effectiveness of I/O
3204+
log compression.
3205+
This flag is
3206+
\fIoff\fR
3207+
by default.
3208+
.sp
3209+
This setting is only supported by version 1.8.20 or higher.
3210+
.TP 18n
31983211
log_allowed
31993212
If set,
32003213
\fBsudoers\fR
@@ -4481,31 +4494,6 @@ This value is used to decide when to wrap lines for nicer log files.
44814494
This has no effect on the syslog log file, only the file log.
44824495
The default is @loglen@ (use 0 or negate the option to disable word wrap).
44834496
.TP 18n
4484-
passwd_timeout
4485-
Number of minutes before the
4486-
\fBsudo\fR
4487-
password prompt times out, or 0 for no timeout.
4488-
The timeout may include a fractional component
4489-
if minute granularity is insufficient, for example 2.5.
4490-
The default is @password_timeout@.
4491-
.TP 18n
4492-
timestamp_timeout
4493-
.br
4494-
Number of minutes that can elapse before
4495-
\fBsudo\fR
4496-
will ask for a password again.
4497-
The timeout may include a fractional component if
4498-
minute granularity is insufficient, for example 2.5.
4499-
The default is @timeout@.
4500-
Set this to 0 to always prompt for a password.
4501-
If set to a value less than 0 the user's time stamp will not expire
4502-
until the system is rebooted.
4503-
This can be used to allow users to create or delete their own time stamps via
4504-
\(oqsudo \-v\(cq
4505-
and
4506-
\(oqsudo \-k\(cq
4507-
respectively.
4508-
.TP 18n
45094497
umask
45104498
File mode creation mask to use when running the command.
45114499
Negate this option or set it to 0777 to prevent
@@ -4534,6 +4522,46 @@ the umask specified by PAM or login.conf will take precedence.
45344522
The umask setting in PAM is not used for
45354523
\fBsudoedit\fR,
45364524
which does not create a new PAM session.
4525+
.TP 18n
4526+
iolog_mode
4527+
The file mode to use when creating I/O log files.
4528+
Mode bits for read and write permissions for owner, group, or other
4529+
are honored, everything else is ignored.
4530+
The file permissions will always include the owner read and
4531+
write bits, even if they are not present in the specified mode.
4532+
When creating I/O log directories, search (execute) bits are added
4533+
to match the read and write bits specified by
4534+
\fIiolog_mode\fR.
4535+
Defaults to 0600 (read and write by user only).
4536+
.sp
4537+
This setting is only supported by version 1.8.19 or higher.
4538+
.PP
4539+
\fBDecimals that can be used in a boolean context\fR:
4540+
.TP 18n
4541+
passwd_timeout
4542+
Number of minutes before the
4543+
\fBsudo\fR
4544+
password prompt times out, or 0 for no timeout.
4545+
The timeout may include a fractional component
4546+
if minute granularity is insufficient, for example 2.5.
4547+
The default is @password_timeout@.
4548+
.TP 18n
4549+
timestamp_timeout
4550+
.br
4551+
Number of minutes that can elapse before
4552+
\fBsudo\fR
4553+
will ask for a password again.
4554+
The timeout may include a fractional component if
4555+
minute granularity is insufficient, for example 2.5.
4556+
The default is @timeout@.
4557+
Set this to 0 to always prompt for a password.
4558+
If set to a value less than 0 the user's time stamp will not expire
4559+
until the system is rebooted.
4560+
This can be used to allow users to create or delete their own time stamps via
4561+
\(oqsudo \-v\(cq
4562+
and
4563+
\(oqsudo \-k\(cq
4564+
respectively.
45374565
.PP
45384566
\fBStrings\fR:
45394567
.if \n(AA \{\
@@ -4790,19 +4818,6 @@ ends in six or
47904818
more
47914819
\fIX\fRs.
47924820
.TP 18n
4793-
iolog_flush
4794-
If set,
4795-
\fBsudo\fR
4796-
will flush I/O log data to disk after each write instead of buffering it.
4797-
This makes it possible to view the logs in real-time as the program
4798-
is executing but may significantly reduce the effectiveness of I/O
4799-
log compression.
4800-
This flag is
4801-
\fIoff\fR
4802-
by default.
4803-
.sp
4804-
This setting is only supported by version 1.8.20 or higher.
4805-
.TP 18n
48064821
iolog_group
48074822
The group name to look up when setting the group-ID on new I/O log
48084823
files and directories.
@@ -4820,19 +4835,6 @@ are set, I/O log files and directories are created with group-ID 0.
48204835
.sp
48214836
This setting is only supported by version 1.8.19 or higher.
48224837
.TP 18n
4823-
iolog_mode
4824-
The file mode to use when creating I/O log files.
4825-
Mode bits for read and write permissions for owner, group, or other
4826-
are honored, everything else is ignored.
4827-
The file permissions will always include the owner read and
4828-
write bits, even if they are not present in the specified mode.
4829-
When creating I/O log directories, search (execute) bits are added
4830-
to match the read and write bits specified by
4831-
\fIiolog_mode\fR.
4832-
Defaults to 0600 (read and write by user only).
4833-
.sp
4834-
This setting is only supported by version 1.8.19 or higher.
4835-
.TP 18n
48364838
iolog_user
48374839
The user name to look up when setting the user and group-IDs on new
48384840
I/O log files and directories.

docs/sudoers.mdoc.in

Lines changed: 50 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -3017,6 +3017,18 @@ will insult users when they enter an incorrect password.
30173017
This flag is
30183018
.Em @insults@
30193019
by default.
3020+
.It iolog_flush
3021+
If set,
3022+
.Nm sudo
3023+
will flush I/O log data to disk after each write instead of buffering it.
3024+
This makes it possible to view the logs in real-time as the program
3025+
is executing but may significantly reduce the effectiveness of I/O
3026+
log compression.
3027+
This flag is
3028+
.Em off
3029+
by default.
3030+
.Pp
3031+
This setting is only supported by version 1.8.20 or higher.
30203032
.It log_allowed
30213033
If set,
30223034
.Nm
@@ -4232,28 +4244,6 @@ Number of characters per line for the file log.
42324244
This value is used to decide when to wrap lines for nicer log files.
42334245
This has no effect on the syslog log file, only the file log.
42344246
The default is @loglen@ (use 0 or negate the option to disable word wrap).
4235-
.It passwd_timeout
4236-
Number of minutes before the
4237-
.Nm sudo
4238-
password prompt times out, or 0 for no timeout.
4239-
The timeout may include a fractional component
4240-
if minute granularity is insufficient, for example 2.5.
4241-
The default is @password_timeout@.
4242-
.It timestamp_timeout
4243-
Number of minutes that can elapse before
4244-
.Nm sudo
4245-
will ask for a password again.
4246-
The timeout may include a fractional component if
4247-
minute granularity is insufficient, for example 2.5.
4248-
The default is @timeout@.
4249-
Set this to 0 to always prompt for a password.
4250-
If set to a value less than 0 the user's time stamp will not expire
4251-
until the system is rebooted.
4252-
This can be used to allow users to create or delete their own time stamps via
4253-
.Ql sudo \-v
4254-
and
4255-
.Ql sudo \-k
4256-
respectively.
42574247
.It umask
42584248
File mode creation mask to use when running the command.
42594249
Negate this option or set it to 0777 to prevent
@@ -4282,6 +4272,44 @@ the umask specified by PAM or login.conf will take precedence.
42824272
The umask setting in PAM is not used for
42834273
.Nm sudoedit ,
42844274
which does not create a new PAM session.
4275+
.It iolog_mode
4276+
The file mode to use when creating I/O log files.
4277+
Mode bits for read and write permissions for owner, group, or other
4278+
are honored, everything else is ignored.
4279+
The file permissions will always include the owner read and
4280+
write bits, even if they are not present in the specified mode.
4281+
When creating I/O log directories, search (execute) bits are added
4282+
to match the read and write bits specified by
4283+
.Em iolog_mode .
4284+
Defaults to 0600 (read and write by user only).
4285+
.Pp
4286+
This setting is only supported by version 1.8.19 or higher.
4287+
.El
4288+
.Pp
4289+
.Sy Decimals that can be used in a boolean context :
4290+
.Bl -tag -width 16n
4291+
.It passwd_timeout
4292+
Number of minutes before the
4293+
.Nm sudo
4294+
password prompt times out, or 0 for no timeout.
4295+
The timeout may include a fractional component
4296+
if minute granularity is insufficient, for example 2.5.
4297+
The default is @password_timeout@.
4298+
.It timestamp_timeout
4299+
Number of minutes that can elapse before
4300+
.Nm sudo
4301+
will ask for a password again.
4302+
The timeout may include a fractional component if
4303+
minute granularity is insufficient, for example 2.5.
4304+
The default is @timeout@.
4305+
Set this to 0 to always prompt for a password.
4306+
If set to a value less than 0 the user's time stamp will not expire
4307+
until the system is rebooted.
4308+
This can be used to allow users to create or delete their own time stamps via
4309+
.Ql sudo \-v
4310+
and
4311+
.Ql sudo \-k
4312+
respectively.
42854313
.El
42864314
.Pp
42874315
.Sy Strings :
@@ -4515,18 +4543,6 @@ overwritten unless
45154543
ends in six or
45164544
more
45174545
.Em X Ns s .
4518-
.It iolog_flush
4519-
If set,
4520-
.Nm sudo
4521-
will flush I/O log data to disk after each write instead of buffering it.
4522-
This makes it possible to view the logs in real-time as the program
4523-
is executing but may significantly reduce the effectiveness of I/O
4524-
log compression.
4525-
This flag is
4526-
.Em off
4527-
by default.
4528-
.Pp
4529-
This setting is only supported by version 1.8.20 or higher.
45304546
.It iolog_group
45314547
The group name to look up when setting the group-ID on new I/O log
45324548
files and directories.
@@ -4543,18 +4559,6 @@ nor
45434559
are set, I/O log files and directories are created with group-ID 0.
45444560
.Pp
45454561
This setting is only supported by version 1.8.19 or higher.
4546-
.It iolog_mode
4547-
The file mode to use when creating I/O log files.
4548-
Mode bits for read and write permissions for owner, group, or other
4549-
are honored, everything else is ignored.
4550-
The file permissions will always include the owner read and
4551-
write bits, even if they are not present in the specified mode.
4552-
When creating I/O log directories, search (execute) bits are added
4553-
to match the read and write bits specified by
4554-
.Em iolog_mode .
4555-
Defaults to 0600 (read and write by user only).
4556-
.Pp
4557-
This setting is only supported by version 1.8.19 or higher.
45584562
.It iolog_user
45594563
The user name to look up when setting the user and group-IDs on new
45604564
I/O log files and directories.

0 commit comments

Comments
 (0)