mir/sudo
2
0
Fork 0
mirror of https://github.com/sudo-project/sudo.git synced 2025-08-22 01:49:11 +00:00
Code Issues Releases Wiki Activity

Fix some issues pointed out by mandoc -Tlint

Browse Source
This commit is contained in:
Todd C. Miller 2018-06-13 11:19:35 -06:00
parent 6eadaddc99
commit b67915c6e4
20 changed files with 75 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/sudo.cat
View File

@ -610,8 +610,8 @@ EEXXAAMMPPLLEESS
$ sudo sh -c "cd /home ; du -s * | sort -rn > USAGE"
SSEEEE AALLSSOO
su(1), stat(2), login_cap(3), passwd(4), sudo.conf(4), sudoers(4),
sudo_plugin(4), sudoreplay(1m), visudo(1m)
su(1), stat(2), login_cap(3), passwd(4), sudo.conf(4), sudo_plugin(4),
sudoers(4), sudoreplay(1m), visudo(1m)
HHIISSTTOORRYY
See the HISTORY file in the ssuuddoo distribution
@ -661,4 +661,4 @@ DDIISSCCLLAAIIMMEERR
file distributed with ssuuddoo or https://www.sudo.ws/license.html for
complete details.
Sudo 1.8.23 March 21, 2018 Sudo 1.8.23
Sudo 1.8.24 March 21, 2018 Sudo 1.8.24

10
doc/sudo.conf.cat
View File

@ -154,8 +154,8 @@ DDEESSCCRRIIPPTTIIOONN
without compromising security. To actually get a ssuuddoo core
file you will likely need to enable core dumps for setuid
processes. On BSD and Linux systems this is accomplished in
the sysctl command. On Solaris, the coreadm command is used to
configure core dump behavior.
the sysctl(1m) command. On Solaris, the coreadm(1m) command is
used to configure core dump behavior.
This setting is only available in ssuuddoo version 1.8.4 and
higher.
@ -278,7 +278,7 @@ DDEESSCCRRIIPPTTIIOONN
The priorities _t_r_a_c_e and _d_e_b_u_g also include function call tracing which
logs when a function is entered and when it returns. For example, the
following trace is for the get_user_groups() function located in
following trace is for the ggeett__uusseerr__ggrroouuppss() function located in
src/sudo.c:
sudo[123] -> get_user_groups @ src/sudo.c:385
@ -400,7 +400,7 @@ EEXXAAMMPPLLEESS
#Set group_source static
SSEEEE AALLSSOO
sudoers(4), sudo(1m), sudo_plugin(4)
sudo_plugin(4), sudoers(4), sudo(1m)
HHIISSTTOORRYY
See the HISTORY file in the ssuuddoo distribution
@ -432,4 +432,4 @@ DDIISSCCLLAAIIMMEERR
file distributed with ssuuddoo or https://www.sudo.ws/license.html for
complete details.
Sudo 1.8.23 July 21, 2017 Sudo 1.8.23
Sudo 1.8.24 July 21, 2017 Sudo 1.8.24

11
doc/sudo.conf.man.in
View File

@ -335,10 +335,10 @@ To actually get a
\fBsudo\fR
core file you will likely need to enable core dumps for setuid processes.
On BSD and Linux systems this is accomplished in the
sysctl
sysctl(@mansectsu@)
command.
On Solaris, the
coreadm
coreadm(1m)
command is used to configure core dump behavior.
.sp
This setting is only available in
@ -552,7 +552,8 @@ and
\fIdebug\fR
also include function call tracing which logs when a function is
entered and when it returns.
For example, the following trace is for the get_user_groups()
For example, the following trace is for the
\fBget_user_groups\fR()
function located in src/sudo.c:
.nf
.sp
@ -704,9 +705,9 @@ Plugin sudoers_io sudoers.so
.RE
.fi
.SH "SEE ALSO"
sudo_plugin(@mansectform@),
sudoers(@mansectform@),
sudo(@mansectsu@),
sudo_plugin(@mansectform@)
sudo(@mansectsu@)
.SH "HISTORY"
See the HISTORY file in the
\fBsudo\fR

11
doc/sudo.conf.mdoc.in
View File

@ -306,10 +306,10 @@ To actually get a
.Nm sudo
core file you will likely need to enable core dumps for setuid processes.
On BSD and Linux systems this is accomplished in the
.Xr sysctl
.Xr sysctl 8
command.
On Solaris, the
.Xr coreadm
.Xr coreadm 1m
command is used to configure core dump behavior.
.Pp
This setting is only available in
@ -504,7 +504,8 @@ and
.Em debug
also include function call tracing which logs when a function is
entered and when it returns.
For example, the following trace is for the get_user_groups()
For example, the following trace is for the
.Fn get_user_groups
function located in src/sudo.c:
.Bd -literal -offset indent
sudo[123] -> get_user_groups @ src/sudo.c:385
@ -640,9 +641,9 @@ Plugin sudoers_io sudoers.so
#Set group_source static
.Ed
.Sh SEE ALSO
.Xr sudo_plugin @mansectform@ ,
.Xr sudoers @mansectform@ ,
.Xr sudo @mansectsu@ ,
.Xr sudo_plugin @mansectform@
.Xr sudo @mansectsu@
.Sh HISTORY
See the HISTORY file in the
.Nm sudo

9
doc/sudo.man.in
View File

@ -1,5 +1,4 @@
.\" DO NOT EDIT THIS FILE, IT IS NOT THE MASTER!
.\" IT IS GENERATED AUTOMATICALLY FROM sudo.mdoc.in
.\" Automatically generated from an mdoc input file. Do not edit.
.\"
.\" Copyright (c) 1994-1996, 1998-2005, 2007-2018
.\" Todd C. Miller <Todd.Miller@sudo.ws>
@ -93,8 +92,8 @@ allows a permitted user to execute a
as the superuser or another user, as specified by the security
policy.
The invoking user's real
(\fInot\fR
effective) user ID is used to determine the user name with which
(\fInot\fR effective)
user ID is used to determine the user name with which
to query the security policy.
.PP
\fBsudo\fR
@ -1211,8 +1210,8 @@ stat(2),
login_cap(3),
passwd(@mansectform@),
sudo.conf(@mansectform@),
sudoers(@mansectform@),
sudo_plugin(@mansectform@),
sudoers(@mansectform@),
sudoreplay(@mansectsu@),
visudo(@mansectsu@)
.SH "HISTORY"

6
doc/sudo.mdoc.in
View File

@ -80,8 +80,8 @@ allows a permitted user to execute a
as the superuser or another user, as specified by the security
policy.
The invoking user's real
.No ( Em not
effective) user ID is used to determine the user name with which
.Pq Em not No effective
user ID is used to determine the user name with which
to query the security policy.
.Pp
.Nm
@ -1102,8 +1102,8 @@ $ sudo sh -c "cd /home ; du -s * | sort -rn > USAGE"
.Xr login_cap 3 ,
.Xr passwd @mansectform@ ,
.Xr sudo.conf @mansectform@ ,
.Xr sudoers @mansectform@ ,
.Xr sudo_plugin @mansectform@ ,
.Xr sudoers @mansectform@ ,
.Xr sudoreplay @mansectsu@ ,
.Xr visudo @mansectsu@
.Sh HISTORY

2
doc/sudo_plugin.man.in
View File

@ -1975,7 +1975,7 @@ deregister_hooks
See the
\fIPolicy plugin API\fR
section for a description of
\fRderegister_hooks.\fR
\fRderegister_hooks\fR.
.TP 6n
change_winsize
.nf

2
doc/sudo_plugin.mdoc.in
View File

@ -1730,7 +1730,7 @@ section for a description of
See the
.Sx Policy plugin API
section for a description of
.Li deregister_hooks.
.Li deregister_hooks .
.It change_winsize
.Bd -literal -compact
int (*change_winsize)(unsigned int lines, unsigned int cols);

8
doc/sudoers.cat
View File

@ -1972,7 +1972,7 @@ SSUUDDOOEERRSS OOPPTTIIOONNSS
initialization function. If arguments are present, the
string must be enclosed in double quotes ("").
For more information see GROUP PROVIDER PLUGINS.
For more information see _G_R_O_U_P _P_R_O_V_I_D_E_R _P_L_U_G_I_N_S.
lecture This option controls when a short lecture will be printed
along with the password prompt. It has the following
@ -2018,7 +2018,7 @@ SSUUDDOOEERRSS OOPPTTIIOONNSS
Setting a path turns on logging to a file; negating this
option turns it off. By default, ssuuddoo logs via syslog.
mailerflags Flags to use when invoking mailer. Defaults to --tt.
mailerflags Flags to use when invoking mailer. Defaults to --tt.
mailerpath Path to mail program used to send warning mail. Defaults
to the path to sendmail found at configure time.
@ -2880,7 +2880,7 @@ DDEEBBUUGGGGIINNGG
SSEEEE AALLSSOO
ssh(1), su(1), fnmatch(3), glob(3), mktemp(3), strftime(3), sudo.conf(4),
sudoers.ldap(4), sudo(1m), sudo_plugin(4), sudoers_timestamp(4), visudo(1m)
sudo_plugin(4), sudoers.ldap(4), sudoers_timestamp(4), sudo(1m), visudo(1m)
AAUUTTHHOORRSS
Many people have worked on ssuuddoo over the years; this version consists of
@ -2919,4 +2919,4 @@ DDIISSCCLLAAIIMMEERR
file distributed with ssuuddoo or https://www.sudo.ws/license.html for
complete details.
Sudo 1.8.23 April 18, 2018 Sudo 1.8.23
Sudo 1.8.24 April 18, 2018 Sudo 1.8.24

4
doc/sudoers.ldap.cat
View File

@ -110,7 +110,7 @@ DDEESSCCRRIIPPTTIIOONN
as. The special value ALL will match any user. If sudoRunAsUser
is specified but empty, it will match the invoking user. If
neither sudoRunAsUser nor sudoRunAsGroup are present, the value of
the runas_default sudoOption is used (defaults to root ).
the _r_u_n_a_s___d_e_f_a_u_l_t sudoOption is used (defaults to root).
The sudoRunAsUser attribute is only available in ssuuddoo versions
1.7.0 and higher. Older versions of ssuuddoo use the sudoRunAs
@ -985,4 +985,4 @@ DDIISSCCLLAAIIMMEERR
file distributed with ssuuddoo or https://www.sudo.ws/license.html for
complete details.
Sudo 1.8.23 March 29, 2018 Sudo 1.8.23
Sudo 1.8.24 March 29, 2018 Sudo 1.8.24

4
doc/sudoers.ldap.man.in
View File

@ -227,10 +227,10 @@ If neither
nor
\fRsudoRunAsGroup\fR
are present, the value of the
runas_default
\fIrunas_default\fR
\fRsudoOption\fR
is used (defaults to
\fR@runas_default@ ).\fR
\fR@runas_default@\fR).
.sp
The
\fRsudoRunAsUser\fR

4
doc/sudoers.ldap.mdoc.in
View File

@ -212,10 +212,10 @@ If neither
nor
.Li sudoRunAsGroup
are present, the value of the
.En runas_default
.Em runas_default
.Li sudoOption
is used (defaults to
.Li @runas_default@ ).
.Li @runas_default@ ) .
.Pp
The
.Li sudoRunAsUser

32
doc/sudoers.man.in
View File

@ -1,26 +1,3 @@
.\" DO NOT EDIT THIS FILE, IT IS NOT THE MASTER!
.\" IT IS GENERATED AUTOMATICALLY FROM sudoers.mdoc.in
.\"
.\" Copyright (c) 1994-1996, 1998-2005, 2007-2018
.\" Todd C. Miller <Todd.Miller@sudo.ws>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" Sponsored in part by the Defense Advanced Research Projects
.\" Agency (DARPA) and Air Force Research Laboratory, Air Force
.\" Materiel Command, USAF, under agreement number F39502-99-1-0512.
.\"
.\" Automatically generated from an mdoc input file. Do not edit.
.\"
.\" Copyright (c) 1994-1996, 1998-2005, 2007-2018
@ -3919,7 +3896,7 @@ If arguments are present, the string must be enclosed in double quotes
(\&"").
.sp
For more information see
GROUP PROVIDER PLUGINS.
\fIGROUP PROVIDER PLUGINS\fR.
.TP 14n
lecture
This option controls when a short lecture will be printed along with
@ -4018,7 +3995,8 @@ By default,
logs via syslog.
.TP 14n
mailerflags
Flags to use when invoking mailer. Defaults to
Flags to use when invoking mailer.
Defaults to
\fB\-t\fR.
.TP 14n
mailerpath
@ -5735,10 +5713,10 @@ glob(3),
mktemp(3),
strftime(3),
sudo.conf(@mansectform@),
sudoers.ldap(@mansectform@),
sudo(@mansectsu@),
sudo_plugin(@mansectform@),
sudoers.ldap(@mansectform@),
sudoers_timestamp(@mansectform@),
sudo(@mansectsu@),
visudo(@mansectsu@)
.SH "AUTHORS"
Many people have worked on

17
doc/sudoers.mdoc.in
View File

@ -683,7 +683,7 @@ and
syntax depends on
the underlying group provider plugin.
For instance, the QAS AD plugin supports the following formats:
.Bl -bullet -width 4n -width 1n
.Bl -bullet -width 1n
.It
Group in the same domain: "%:Group Name"
.It
@ -2047,7 +2047,7 @@ if they match a value specified in
.Em editor .
If the
.Em env_reset
flag is enabled, the
flag is enabled, the
.Ev SUDO_EDITOR ,
.Ev VISUAL
and/or
@ -3286,7 +3286,7 @@ The group name to look up when setting the group ID on new I/O log
files and directories.
If
.Em iolog_group
is not set,
is not set,
the primary group ID of the user specified by
.Em iolog_user
is used.
@ -3645,7 +3645,7 @@ If arguments are present, the string must be enclosed in double quotes
.Pq \&"" .
.Pp
For more information see
.Xr "GROUP PROVIDER PLUGINS" .
.Sx "GROUP PROVIDER PLUGINS" .
.It lecture
This option controls when a short lecture will be printed along with
the password prompt.
@ -3726,7 +3726,8 @@ By default,
.Nm sudo
logs via syslog.
.It mailerflags
Flags to use when invoking mailer. Defaults to
Flags to use when invoking mailer.
Defaults to
.Fl t .
.It mailerpath
Path to mail program used to send warning mail.
@ -3779,7 +3780,7 @@ matched by either the
or
.Em env_keep
list.
If
If
.Em env_reset
is disabled, variables in the file are added as long as they
are not matched by the
@ -5280,10 +5281,10 @@ manual.
.Xr mktemp 3 ,
.Xr strftime 3 ,
.Xr sudo.conf @mansectform@ ,
.Xr sudoers.ldap @mansectform@ ,
.Xr sudo @mansectsu@ ,
.Xr sudo_plugin @mansectform@ ,
.Xr sudoers.ldap @mansectform@ ,
.Xr sudoers_timestamp @mansectform@ ,
.Xr sudo @mansectsu@ ,
.Xr visudo @mansectsu@
.Sh AUTHORS
Many people have worked on

8
doc/sudoers_timestamp.cat
View File

@ -118,6 +118,9 @@ LLOOCCKKIINNGG
same terminal (or parent process ID) from from prompting for a password
as the same time.
SSEEEE AALLSSOO
sudoers(4), sudo(1m)
HHIISSTTOORRYY
Originally, ssuuddoo used a single zero-length file per user and the file's
modification time was used as the time stamp. Later versions of ssuuddoo
@ -169,9 +172,6 @@ HHIISSTTOORRYY
Support was added for the kernel-based tty time stamps available in
OpenBSD which do not use an on-disk time stamp file.
SSEEEE AALLSSOO
sudoers(4), sudo(1m)
AAUUTTHHOORRSS
Many people have worked on ssuuddoo over the years; this version consists of
code written primarily by:
@ -198,4 +198,4 @@ DDIISSCCLLAAIIMMEERR
file distributed with ssuuddoo or https://www.sudo.ws/license.html for
complete details.
Sudo 1.8.23 December 21, 2017 Sudo 1.8.23
Sudo 1.8.24 December 21, 2017 Sudo 1.8.24

15
doc/sudoers_timestamp.man.in
View File

@ -1,5 +1,4 @@
.\" DO NOT EDIT THIS FILE, IT IS NOT THE MASTER!
.\" IT IS GENERATED AUTOMATICALLY FROM sudoers_timestamp.mdoc.in
.\" Automatically generated from an mdoc input file. Do not edit.
.\"
.\" Copyright (c) 2017 Todd C. Miller <Todd.Miller@sudo.ws>
.\"
@ -48,9 +47,9 @@ A multi-record time stamp file format was introduced in
\fBsudo\fR
1.8.10 that uses a single file per user.
Previously, a separate file was used for each user and terminal
combination unless tty-based time stamps were disabled. The new
format is extensible and records of multiple types and versions may
coexist within the same file.
combination unless tty-based time stamps were disabled.
The new format is extensible and records of multiple types and versions
may coexist within the same file.
.PP
All records, regardless of type or version, begin with a 16-bit version
number and a 16-bit record size.
@ -213,6 +212,9 @@ Instead, a separate lock record is used to prevent multiple
\fBsudo\fR
processes using the same terminal (or parent process ID) from
from prompting for a password as the same time.
.SH "SEE ALSO"
sudoers(@mansectform@),
sudo(@mansectsu@)
.SH "HISTORY"
Originally,
\fBsudo\fR
@ -274,9 +276,6 @@ This prevents re-use of the time stamp file after logout in most cases.
.sp
Support was added for the kernel-based tty time stamps available in
OpenBSD which do not use an on-disk time stamp file.
.SH "SEE ALSO"
sudoers(@mansectform@),
sudo(@mansectsu@)
.SH "AUTHORS"
Many people have worked on
\fBsudo\fR

12
doc/sudoers_timestamp.mdoc.in
View File

@ -47,9 +47,9 @@ A multi-record time stamp file format was introduced in
.Nm sudo
1.8.10 that uses a single file per user.
Previously, a separate file was used for each user and terminal
combination unless tty-based time stamps were disabled. The new
format is extensible and records of multiple types and versions may
coexist within the same file.
combination unless tty-based time stamps were disabled.
The new format is extensible and records of multiple types and versions
may coexist within the same file.
.Pp
All records, regardless of type or version, begin with a 16-bit version
number and a 16-bit record size.
@ -200,6 +200,9 @@ Instead, a separate lock record is used to prevent multiple
.Nm sudo
processes using the same terminal (or parent process ID) from
from prompting for a password as the same time.
.Sh SEE ALSO
.Xr sudoers @mansectform@ ,
.Xr sudo @mansectsu@
.Sh HISTORY
Originally,
.Nm sudo
@ -252,9 +255,6 @@ This prevents re-use of the time stamp file after logout in most cases.
Support was added for the kernel-based tty time stamps available in
OpenBSD which do not use an on-disk time stamp file.
.El
.Sh SEE ALSO
.Xr sudoers @mansectform@ ,
.Xr sudo @mansectsu@
.Sh AUTHORS
Many people have worked on
.Nm sudo

2
doc/visudo.cat
View File

@ -222,4 +222,4 @@ DDIISSCCLLAAIIMMEERR
file distributed with ssuuddoo or https://www.sudo.ws/license.html for
complete details.
Sudo 1.8.23 January 26, 2018 Sudo 1.8.23
Sudo 1.8.24 January 26, 2018 Sudo 1.8.24

3
doc/visudo.man.in
View File

@ -1,5 +1,4 @@
.\" DO NOT EDIT THIS FILE, IT IS NOT THE MASTER!
.\" IT IS GENERATED AUTOMATICALLY FROM visudo.mdoc.in
.\" Automatically generated from an mdoc input file. Do not edit.
.\"
.\" Copyright (c) 1996,1998-2005, 2007-2018
.\" Todd C. Miller <Todd.Miller@sudo.ws>

6
doc/visudo.mdoc.in
View File

@ -110,7 +110,7 @@ environment variables are not preserved by default when the
option is enabled.
The default editor path is
.Pa @editor@
which can be set at compile time via the
which can be set at compile time via the
.Li --with-editor
configure option.
.It env_editor
@ -138,7 +138,7 @@ if they match a value specified in
.Em editor .
If the
.Em env_reset
flag is enabled, the
flag is enabled, the
.Ev SUDO_EDITOR ,
.Ev VISUAL
and/or
@ -153,7 +153,7 @@ is invoked via
.Nm sudo .
The default value is
.Em @env_editor@ ,
which can be set at compile time via the
which can be set at compile time via the
.Li --with-env-editor
configure option.
.El