2
0
mirror of https://github.com/sudo-project/sudo.git synced 2025-08-22 09:57:41 +00:00

Fix some style warnings from "mandoc -Tlint"

This commit is contained in:
Todd C. Miller 2025-02-22 15:41:22 -07:00
parent 3ba525a348
commit 4d331e6026
4 changed files with 30 additions and 22 deletions

View File

@ -2,7 +2,7 @@
.\" .\"
.\" SPDX-License-Identifier: ISC .\" SPDX-License-Identifier: ISC
.\" .\"
.\" Copyright (c) 2018, 2021-2023 Todd C. Miller <Todd.Miller@sudo.ws> .\" Copyright (c) 2018, 2021-2025 Todd C. Miller <Todd.Miller@sudo.ws>
.\" .\"
.\" Permission to use, copy, modify, and distribute this software for any .\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above .\" purpose with or without fee is hereby granted, provided that the above
@ -16,7 +16,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\" .\"
.TH "CVTSUDOERS" "1" "April 26, 2024" "Sudo @PACKAGE_VERSION@" "General Commands Manual" .TH "CVTSUDOERS" "1" "February 22, 2025" "Sudo @PACKAGE_VERSION@" "General Commands Manual"
.nh .nh
.if n .ad l .if n .ad l
.SH "NAME" .SH "NAME"
@ -47,7 +47,7 @@ utility accepts one or more security policies in either
or LDIF format as input, and generates a single or LDIF format as input, and generates a single
policy of the specified format as output. policy of the specified format as output.
The default input format is The default input format is
\fIsudoers.\fR \fIsudoers\fR.
The default output format is LDIF. The default output format is LDIF.
It is only possible to convert a policy file that is syntactically correct. It is only possible to convert a policy file that is syntactically correct.
.PP .PP
@ -888,7 +888,8 @@ array, an optional
array, an optional array, an optional
\fIrunasgroups\fR \fIrunasgroups\fR
array, and an optional array, and an optional
\fIOptions array.\fR \fIOptions\fR
array.
.sp .sp
The The
\fICommands\fR \fICommands\fR

View File

@ -1,7 +1,7 @@
.\" .\"
.\" SPDX-License-Identifier: ISC .\" SPDX-License-Identifier: ISC
.\" .\"
.\" Copyright (c) 2018, 2021-2023 Todd C. Miller <Todd.Miller@sudo.ws> .\" Copyright (c) 2018, 2021-2025 Todd C. Miller <Todd.Miller@sudo.ws>
.\" .\"
.\" Permission to use, copy, modify, and distribute this software for any .\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above .\" purpose with or without fee is hereby granted, provided that the above
@ -15,7 +15,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\" .\"
.Dd April 26, 2024 .Dd February 22, 2025
.Dt CVTSUDOERS 1 .Dt CVTSUDOERS 1
.Os Sudo @PACKAGE_VERSION@ .Os Sudo @PACKAGE_VERSION@
.Sh NAME .Sh NAME
@ -45,7 +45,7 @@ utility accepts one or more security policies in either
or LDIF format as input, and generates a single or LDIF format as input, and generates a single
policy of the specified format as output. policy of the specified format as output.
The default input format is The default input format is
.Em sudoers. .Em sudoers .
The default output format is LDIF. The default output format is LDIF.
It is only possible to convert a policy file that is syntactically correct. It is only possible to convert a policy file that is syntactically correct.
.Pp .Pp
@ -775,7 +775,8 @@ array, an optional
array, an optional array, an optional
.Em runasgroups .Em runasgroups
array, and an optional array, and an optional
.Em Options array. .Em Options
array.
.Pp .Pp
The The
.Em Commands .Em Commands

View File

@ -479,7 +479,8 @@ validate(self)
.fi .fi
.RS 6n .RS 6n
.sp .sp
For policy plugins that cache authentication credentials, this function is used to validate and cache the credentials (optional). For policy plugins that cache authentication credentials,
this function is used to validate and cache the credentials (optional).
.RE .RE
.TP 6n .TP 6n
\fIinvalidate\fR \fIinvalidate\fR
@ -490,7 +491,8 @@ invalidate(self, remove: int)
.fi .fi
.RS 6n .RS 6n
.sp .sp
For policy plugins that cache authentication credentials, this function is used to invalidate the credentials (optional). For policy plugins that cache authentication credentials,
this function is used to invalidate the credentials (optional).
.sp .sp
The function arguments are as follows: The function arguments are as follows:
.TP 6n .TP 6n
@ -553,8 +555,8 @@ The exit status of the command if was executed, otherwise \-1.
.TP 6n .TP 6n
\fIerror\fR \fIerror\fR
.br .br
If the command could not be executed, this is set to the value of If the command could not be executed,
errno set by the this is set to the value of errno set by the
execve(2) execve(2)
system call, otherwise 0. system call, otherwise 0.
.PD 0 .PD 0
@ -853,8 +855,8 @@ The exit status of the command if was executed, otherwise \-1.
.TP 6n .TP 6n
\fIerror\fR \fIerror\fR
.br .br
If the command could not be executed, this is set to the value of If the command could not be executed,
errno set by the this is set to the value of errno set by the
execve(2) execve(2)
system call, otherwise 0. system call, otherwise 0.
.PD 0 .PD 0
@ -887,7 +889,8 @@ Plugin python_audit @python_plugin@ ModulePath=<path> ClassName=<class>
Sudo supports loading multiple audit plugins. Sudo supports loading multiple audit plugins.
Currently only 8 python audit plugins can be loaded at once. Currently only 8 python audit plugins can be loaded at once.
.PP .PP
An audit plugin may have the following member functions (all of which are optional): An audit plugin may have the following member functions
(all of which are optional):
.TP 6n .TP 6n
\fIconstructor\fR \fIconstructor\fR
.nf .nf

View File

@ -401,13 +401,15 @@ the plugin should list the privileges of the invoking user.
validate(self) validate(self)
.Ed .Ed
.Pp .Pp
For policy plugins that cache authentication credentials, this function is used to validate and cache the credentials (optional). For policy plugins that cache authentication credentials,
this function is used to validate and cache the credentials (optional).
.It Fa invalidate .It Fa invalidate
.Bd -literal -compact .Bd -literal -compact
invalidate(self, remove: int) invalidate(self, remove: int)
.Ed .Ed
.Pp .Pp
For policy plugins that cache authentication credentials, this function is used to invalidate the credentials (optional). For policy plugins that cache authentication credentials,
this function is used to invalidate the credentials (optional).
.Pp .Pp
The function arguments are as follows: The function arguments are as follows:
.Bl -tag -width 4n .Bl -tag -width 4n
@ -453,8 +455,8 @@ The function arguments are as follows:
.It Fa exit_status .It Fa exit_status
The exit status of the command if was executed, otherwise \-1. The exit status of the command if was executed, otherwise \-1.
.It Fa error .It Fa error
If the command could not be executed, this is set to the value of If the command could not be executed,
errno set by the this is set to the value of errno set by the
.Xr execve 2 .Xr execve 2
system call, otherwise 0. system call, otherwise 0.
.El .El
@ -695,8 +697,8 @@ The function arguments are as follows:
.It Fa exit_status .It Fa exit_status
The exit status of the command if was executed, otherwise \-1. The exit status of the command if was executed, otherwise \-1.
.It Fa error .It Fa error
If the command could not be executed, this is set to the value of If the command could not be executed,
errno set by the this is set to the value of errno set by the
.Xr execve 2 .Xr execve 2
system call, otherwise 0. system call, otherwise 0.
.El .El
@ -721,7 +723,8 @@ Plugin python_audit @python_plugin@ ModulePath=<path> ClassName=<class>
Sudo supports loading multiple audit plugins. Sudo supports loading multiple audit plugins.
Currently only 8 python audit plugins can be loaded at once. Currently only 8 python audit plugins can be loaded at once.
.Pp .Pp
An audit plugin may have the following member functions (all of which are optional): An audit plugin may have the following member functions
(all of which are optional):
.Bl -tag -width 4n .Bl -tag -width 4n
.It Fa constructor .It Fa constructor
.Bd -literal -compact .Bd -literal -compact