From: Todd C. Miller Date: Sun, 7 Oct 2018 13:34:22 +0000 (-0600) Subject: Use mdoc macros for BSD systems. X-Git-Tag: SUDO_1_8_26^2~63 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=675802b71c0473e02acff5eb3659596c4d8305cb;p=sudo Use mdoc macros for BSD systems. All manuals now pass "make lint" --- diff --git a/doc/sudo.cat b/doc/sudo.cat index 6a7c148a5..8fdeb0ae3 100644 --- a/doc/sudo.cat +++ b/doc/sudo.cat @@ -659,4 +659,4 @@ DDIISSCCLLAAIIMMEERR file distributed with ssuuddoo or https://www.sudo.ws/license.html for complete details. -Sudo 1.8.26 October 6, 2018 Sudo 1.8.26 +Sudo 1.8.26 October 7, 2018 Sudo 1.8.26 diff --git a/doc/sudo.conf.cat b/doc/sudo.conf.cat index 918f13edc..b43217b15 100644 --- a/doc/sudo.conf.cat +++ b/doc/sudo.conf.cat @@ -431,4 +431,4 @@ DDIISSCCLLAAIIMMEERR file distributed with ssuuddoo or https://www.sudo.ws/license.html for complete details. -Sudo 1.8.25 June 16, 2018 Sudo 1.8.25 +Sudo 1.8.26 October 7, 2018 Sudo 1.8.26 diff --git a/doc/sudo.conf.man.in b/doc/sudo.conf.man.in index addaa9785..978259d33 100644 --- a/doc/sudo.conf.man.in +++ b/doc/sudo.conf.man.in @@ -15,7 +15,7 @@ .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.TH "SUDO.CONF" "5" "June 16, 2018" "Sudo @PACKAGE_VERSION@" "File Formats Manual" +.TH "SUDO.CONF" "5" "October 7, 2018" "Sudo @PACKAGE_VERSION@" "File Formats Manual" .nh .if n .ad l .SH "NAME" @@ -257,7 +257,9 @@ This option is ignored on systems that support either the \fBdevname\fR() or \fB_ttyname_dev\fR() -functions, for example BSD, macOS and Solaris. +functions, for example +BSD, +macOS and Solaris. .TP 10n noexec The fully-qualified path to a shared library containing wrappers @@ -334,7 +336,9 @@ so this option can be enabled without compromising security. 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 +On +BSD +and Linux systems this is accomplished in the sysctl(@mansectsu@) command. On Solaris, the @@ -405,8 +409,9 @@ Most operating systems provide an efficient method of performing such queries. Currently, \fBsudo\fR -supports efficient group queries on AIX, BSD, HP-UX, Linux and -Solaris. +supports efficient group queries on AIX, +BSD, +HP-UX, Linux and Solaris. .TP 10n adaptive Only query the group database if the static group list returned diff --git a/doc/sudo.conf.mdoc.in b/doc/sudo.conf.mdoc.in index e576271a3..cb4e23931 100644 --- a/doc/sudo.conf.mdoc.in +++ b/doc/sudo.conf.mdoc.in @@ -14,7 +14,7 @@ .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd June 16, 2018 +.Dd October 7, 2018 .Dt SUDO.CONF @mansectform@ .Os Sudo @PACKAGE_VERSION@ .Sh NAME @@ -234,7 +234,9 @@ This option is ignored on systems that support either the .Fn devname or .Fn _ttyname_dev -functions, for example BSD, macOS and Solaris. +functions, for example +.Bx , +macOS and Solaris. .It noexec The fully-qualified path to a shared library containing wrappers for the @@ -305,7 +307,9 @@ so this option can be enabled without compromising security. 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 +On +.Bx +and Linux systems this is accomplished in the .Xr sysctl 8 command. On Solaris, the @@ -370,8 +374,9 @@ Most operating systems provide an efficient method of performing such queries. Currently, .Nm sudo -supports efficient group queries on AIX, BSD, HP-UX, Linux and -Solaris. +supports efficient group queries on AIX, +.Bx , +HP-UX, Linux and Solaris. .It adaptive Only query the group database if the static group list returned by the kernel has the maximum number of entries. diff --git a/doc/sudo.man.in b/doc/sudo.man.in index 042cf8099..360d02590 100644 --- a/doc/sudo.man.in +++ b/doc/sudo.man.in @@ -20,7 +20,7 @@ .\" Agency (DARPA) and Air Force Research Laboratory, Air Force .\" Materiel Command, USAF, under agreement number F39502-99-1-0512. .\" -.TH "SUDO" "8" "October 6, 2018" "Sudo @PACKAGE_VERSION@" "System Manager's Manual" +.TH "SUDO" "8" "October 7, 2018" "Sudo @PACKAGE_VERSION@" "System Manager's Manual" .nh .if n .ad l .SH "NAME" @@ -191,7 +191,9 @@ will exit with an error. .RE .TP 12n \fB\-a\fR \fItype\fR, \fB\--auth-type\fR=\fItype\fR -Use the specified BSD authentication +Use the specified +BSD +authentication \fItype\fR when validating the user, if allowed by \fI/etc/login.conf\fR. @@ -200,7 +202,9 @@ authentication methods by adding an \(lqauth-sudo\(rq entry in \fI/etc/login.conf\fR. -This option is only available on systems that support BSD authentication. +This option is only available on systems that support +BSD +authentication. .TP 12n \fB\-b\fR, \fB\--background\fR Run the given command in the background. @@ -251,7 +255,9 @@ If the command is being run as a login shell, additional \fI/etc/login.conf\fR settings, such as the umask and environment variables, will be applied, if present. -This option is only available on systems with BSD login classes. +This option is only available on systems with +BSD +login classes. .TP 12n \fB\-E\fR, \fB\--preserve-env\fR Indicates to the security policy that the user wishes to diff --git a/doc/sudo.mdoc.in b/doc/sudo.mdoc.in index 752d48d6b..541e669ea 100644 --- a/doc/sudo.mdoc.in +++ b/doc/sudo.mdoc.in @@ -19,7 +19,7 @@ .\" Agency (DARPA) and Air Force Research Laboratory, Air Force .\" Materiel Command, USAF, under agreement number F39502-99-1-0512. .\" -.Dd October 6, 2018 +.Dd October 7, 2018 .Dt SUDO @mansectsu@ .Os Sudo @PACKAGE_VERSION@ .Sh NAME @@ -173,7 +173,9 @@ If no askpass program is available, .Nm will exit with an error. .It Fl a Ar type , Fl -auth-type Ns = Ns Ar type -Use the specified BSD authentication +Use the specified +.Bx +authentication .Ar type when validating the user, if allowed by .Pa /etc/login.conf . @@ -182,7 +184,9 @@ authentication methods by adding an .Dq auth-sudo entry in .Pa /etc/login.conf . -This option is only available on systems that support BSD authentication. +This option is only available on systems that support +.Bx +authentication. .It Fl b , -background Run the given command in the background. Note that it is not possible to use shell job control to manipulate @@ -230,7 +234,9 @@ If the command is being run as a login shell, additional .Pa /etc/login.conf settings, such as the umask and environment variables, will be applied, if present. -This option is only available on systems with BSD login classes. +This option is only available on systems with +.Bx +login classes. .It Fl E , -preserve-env Indicates to the security policy that the user wishes to preserve their existing environment variables. @@ -646,7 +652,7 @@ Solaris project .It Solaris privileges .It -BSD login class +.Bx No login class .It scheduling priority (aka nice value) .El diff --git a/doc/sudo_plugin.man.in b/doc/sudo_plugin.man.in index 7428cc3de..bf0786746 100644 --- a/doc/sudo_plugin.man.in +++ b/doc/sudo_plugin.man.in @@ -189,7 +189,9 @@ bsdauth_type=string Authentication type, if specified by the \fB\-a\fR flag, to use on -systems where BSD authentication is supported. +systems where +BSD +authentication is supported. .PD .TP 6n closefrom=number @@ -270,7 +272,8 @@ If the user does not specify a program on the command line, will pass the plugin the path to the user's shell and set .TP 6n login_class=string -BSD login class to use when setting resource limits and nice value, +BSD +login class to use when setting resource limits and nice value, if specified by the \fB\-c\fR flag. @@ -953,15 +956,17 @@ This only includes output to the screen, not output to a pipe or file. This is a hint to the I/O logging plugin which may choose to ignore it. .TP 6n login_class=string -BSD login class to use when setting resource limits and nice value -(optional). +BSD +login class to use when setting resource limits and nice value (optional). This option is only set on systems that support login classes. .TP 6n nice=int Nice value (priority) to use when executing the command. The nice value, if specified, overrides the priority associated with the \fIlogin_class\fR -on BSD systems. +on +BSD +systems. .TP 6n noexec=bool If set, prevent the command from executing other programs. diff --git a/doc/sudo_plugin.mdoc.in b/doc/sudo_plugin.mdoc.in index c518fe196..4447dd939 100644 --- a/doc/sudo_plugin.mdoc.in +++ b/doc/sudo_plugin.mdoc.in @@ -174,7 +174,9 @@ might. Authentication type, if specified by the .Fl a flag, to use on -systems where BSD authentication is supported. +systems where +.Bx +authentication is supported. .It closefrom=number If specified, the user has requested via the .Fl C @@ -248,7 +250,8 @@ If the user does not specify a program on the command line, .Nm sudo will pass the plugin the path to the user's shell and set .It login_class=string -BSD login class to use when setting resource limits and nice value, +.Bx +login class to use when setting resource limits and nice value, if specified by the .Fl c flag. @@ -844,14 +847,16 @@ terminal output. This only includes output to the screen, not output to a pipe or file. This is a hint to the I/O logging plugin which may choose to ignore it. .It login_class=string -BSD login class to use when setting resource limits and nice value -(optional). +.Bx +login class to use when setting resource limits and nice value (optional). This option is only set on systems that support login classes. .It nice=int Nice value (priority) to use when executing the command. The nice value, if specified, overrides the priority associated with the .Em login_class -on BSD systems. +on +.Bx +systems. .It noexec=bool If set, prevent the command from executing other programs. .It preserve_fds=list diff --git a/doc/sudoers.cat b/doc/sudoers.cat index ed632e977..6d6ae2d4a 100644 --- a/doc/sudoers.cat +++ b/doc/sudoers.cat @@ -2927,4 +2927,4 @@ DDIISSCCLLAAIIMMEERR file distributed with ssuuddoo or https://www.sudo.ws/license.html for complete details. -Sudo 1.8.26 October 6, 2018 Sudo 1.8.26 +Sudo 1.8.26 October 7, 2018 Sudo 1.8.26 diff --git a/doc/sudoers.ldap.cat b/doc/sudoers.ldap.cat index a0f862253..94166ecfd 100644 --- a/doc/sudoers.ldap.cat +++ b/doc/sudoers.ldap.cat @@ -1011,4 +1011,4 @@ DDIISSCCLLAAIIMMEERR file distributed with ssuuddoo or https://www.sudo.ws/license.html for complete details. -Sudo 1.8.26 September 27, 2018 Sudo 1.8.26 +Sudo 1.8.26 October 7, 2018 Sudo 1.8.26 diff --git a/doc/sudoers.ldap.man.in b/doc/sudoers.ldap.man.in index cba93b918..105135af3 100644 --- a/doc/sudoers.ldap.man.in +++ b/doc/sudoers.ldap.man.in @@ -15,7 +15,7 @@ .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.TH "SUDOERS.LDAP" "5" "September 27, 2018" "Sudo @PACKAGE_VERSION@" "File Formats Manual" +.TH "SUDOERS.LDAP" "5" "October 7, 2018" "Sudo @PACKAGE_VERSION@" "File Formats Manual" .nh .if n .ad l .SH "NAME" diff --git a/doc/sudoers.ldap.mdoc.in b/doc/sudoers.ldap.mdoc.in index 06dd833f5..dc2e8a7c5 100644 --- a/doc/sudoers.ldap.mdoc.in +++ b/doc/sudoers.ldap.mdoc.in @@ -14,7 +14,7 @@ .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd September 27, 2018 +.Dd October 7, 2018 .Dt SUDOERS.LDAP @mansectform@ .Os Sudo @PACKAGE_VERSION@ .Sh NAME @@ -1085,7 +1085,7 @@ A missing or invalid certificate is ignored and not considered an error. The server certificate will be requested. A missing certificate is ignored but an invalid certificate will result in a connection error. -.It demand No | Ar hard +.It demand | Ar hard The server certificate will be requested. A missing or invalid certificate will result in a connection error. This is the default behavior. diff --git a/doc/sudoers.man.in b/doc/sudoers.man.in index 8f77bff4d..3a54b135e 100644 --- a/doc/sudoers.man.in +++ b/doc/sudoers.man.in @@ -20,7 +20,7 @@ .\" Agency (DARPA) and Air Force Research Laboratory, Air Force .\" Materiel Command, USAF, under agreement number F39502-99-1-0512. .\" -.TH "SUDOERS" "5" "October 6, 2018" "Sudo @PACKAGE_VERSION@" "File Formats Manual" +.TH "SUDOERS" "5" "October 7, 2018" "Sudo @PACKAGE_VERSION@" "File Formats Manual" .nh .if n .ad l .SH "NAME" @@ -293,7 +293,9 @@ systems without PAM), the environment is initialized with the contents of the \fI/etc/environment\fR file. -On BSD systems, if the +On +BSD +systems, if the \fIuse_loginclass\fR option is enabled, the environment is initialized based on the @@ -484,7 +486,9 @@ systems without PAM), the contents of \fI/etc/environment\fR are also included. -On BSD systems, if the +On +BSD +systems, if the \fIuse_loginclass\fR flag is enabled, the @@ -2373,7 +2377,9 @@ If disabled, a command may only be run after the audit event is successfully written. This flag is only effective on systems for which \fBsudoers\fR -supports audit logging, including FreeBSD, Linux, macOS and Solaris. +supports audit logging, including +FreeBSD, +Linux, macOS and Solaris. This flag is \fIon\fR by default. @@ -3252,7 +3258,9 @@ at least 480 bytes and should support messages up to 2048 bytes. By default, \fBsudoers\fR creates log messages up to 980 bytes which corresponds to the -historic BSD syslog implementation which used a 1024 byte buffer +historic +BSD +syslog implementation which used a 1024 byte buffer to store the message, date, hostname and program name. To prevent syslog messages from being truncated, \fBsudoers\fR @@ -3775,7 +3783,8 @@ Negative \fItimestamp_timeout\fR values are not supported and positive values are limited to a maximum of 60 minutes. -This is currently only supported on OpenBSD. +This is currently only supported on +OpenBSD. .PP The default value is \fI@timestamp_type@\fR. diff --git a/doc/sudoers.mdoc.in b/doc/sudoers.mdoc.in index b712e804b..62b884d23 100644 --- a/doc/sudoers.mdoc.in +++ b/doc/sudoers.mdoc.in @@ -19,7 +19,7 @@ .\" Agency (DARPA) and Air Force Research Laboratory, Air Force .\" Materiel Command, USAF, under agreement number F39502-99-1-0512. .\" -.Dd October 6, 2018 +.Dd October 7, 2018 .Dt SUDOERS @mansectform@ .Os Sudo @PACKAGE_VERSION@ .Sh NAME @@ -283,7 +283,9 @@ systems without PAM), the environment is initialized with the contents of the .Pa /etc/environment file. -On BSD systems, if the +On +.Bx +systems, if the .Em use_loginclass option is enabled, the environment is initialized based on the @@ -471,7 +473,9 @@ systems without PAM), the contents of .Pa /etc/environment are also included. -On BSD systems, if the +On +.Bx +systems, if the .Em use_loginclass flag is enabled, the @@ -2232,7 +2236,9 @@ If disabled, a command may only be run after the audit event is successfully written. This flag is only effective on systems for which .Nm -supports audit logging, including FreeBSD, Linux, macOS and Solaris. +supports audit logging, including +.Fx , +Linux, macOS and Solaris. This flag is .Em on by default. @@ -3059,7 +3065,9 @@ at least 480 bytes and should support messages up to 2048 bytes. By default, .Nm creates log messages up to 980 bytes which corresponds to the -historic BSD syslog implementation which used a 1024 byte buffer +historic +.Bx +syslog implementation which used a 1024 byte buffer to store the message, date, hostname and program name. To prevent syslog messages from being truncated, .Nm @@ -3535,7 +3543,8 @@ Negative .Em timestamp_timeout values are not supported and positive values are limited to a maximum of 60 minutes. -This is currently only supported on OpenBSD. +This is currently only supported on +.Ox . .El .Pp The default value is diff --git a/doc/sudoers_timestamp.cat b/doc/sudoers_timestamp.cat index c6cb63b99..cf87d7077 100644 --- a/doc/sudoers_timestamp.cat +++ b/doc/sudoers_timestamp.cat @@ -198,4 +198,4 @@ DDIISSCCLLAAIIMMEERR file distributed with ssuuddoo or https://www.sudo.ws/license.html for complete details. -Sudo 1.8.26 October 6, 2018 Sudo 1.8.26 +Sudo 1.8.26 October 7, 2018 Sudo 1.8.26 diff --git a/doc/sudoers_timestamp.man.in b/doc/sudoers_timestamp.man.in index 837f9a4bb..5d32d4699 100644 --- a/doc/sudoers_timestamp.man.in +++ b/doc/sudoers_timestamp.man.in @@ -15,7 +15,7 @@ .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.TH "SUDOERS_TIMESTAMP" "5" "October 6, 2018" "Sudo @PACKAGE_VERSION@" "File Formats Manual" +.TH "SUDOERS_TIMESTAMP" "5" "October 7, 2018" "Sudo @PACKAGE_VERSION@" "File Formats Manual" .nh .if n .ad l .SH "NAME" @@ -275,7 +275,8 @@ now stored in non-global time stamp records. 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. +OpenBSD +which do not use an on-disk time stamp file. .SH "AUTHORS" Many people have worked on \fBsudo\fR diff --git a/doc/sudoers_timestamp.mdoc.in b/doc/sudoers_timestamp.mdoc.in index 1b57053a1..d15922001 100644 --- a/doc/sudoers_timestamp.mdoc.in +++ b/doc/sudoers_timestamp.mdoc.in @@ -14,7 +14,7 @@ .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd October 6, 2018 +.Dd October 7, 2018 .Dt SUDOERS_TIMESTAMP @mansectform@ .Os Sudo @PACKAGE_VERSION@ .Sh NAME @@ -253,7 +253,8 @@ now stored in non-global time stamp records. This prevents re-use of the time stamp file after logout in most cases. .Pp Support was added for the kernel-based tty time stamps available in -OpenBSD which do not use an on-disk time stamp file. +.Ox +which do not use an on-disk time stamp file. .El .Sh AUTHORS Many people have worked on