Index | Thread | Search

From:
Omar Polo <op@omarpolo.com>
Subject:
mark up entries of login.conf(5)
To:
tech@openbsd.org
Date:
Fri, 24 May 2024 15:29:45 +0200

Download raw body.

Thread
  • Omar Polo:

    mark up entries of login.conf(5)

noticed since `apropos -k any=passwordtries` didn't yield anything,
making me assume that it was undocumented.  Properly marking them up
means apropos can find them and it's also easier to navigate the file
via less :t

I'm not sure Dv is the correct macro to use here; I could see how Ic
could also be appropriate.

I'm also not sure that the markup of the "Default" column is correct,
but it is at least inconsistent.  Some number entries are marked with
Dv, some don't.  I'm wondering if some of these, like expire-warn,
should use Ar instead (i.e. ``Ar 2w'' instead of ``Dv 2w''.)


diff /usr/src
commit - 325072a3a66b70a42b21a2955d537c5671c7e831
path + /usr/src
blob - 3d6d92a14c3e4910a7c0ab5d9e7d34ecaf11df88
file + share/man/man5/login.conf.5
--- share/man/man5/login.conf.5
+++ share/man/man5/login.conf.5
@@ -101,55 +101,55 @@ The types are described after the capability table.
 .Bl -column "approve-service" "program" "bcrypt,8" "Description"
 .It Sy Name Ta Sy Type Ta Sy Default Ta Sy Description
 .\"
-.It approve Ta program Ta "" Ta
+.It Dv approve Ta program Ta "" Ta
 Default program to approve login.
 .\"
 .Pp
-.It approve- Ns Ar service Ta program Ta "" Ta
+.It Dv approve- Ns Ar service Ta program Ta "" Ta
 Program to approve login for
 .Ar service .
 .\"
 .Pp
-.It auth Ta list Ta Dv passwd Ta
+.It Dv auth Ta list Ta Dv passwd Ta
 Allowed authentication styles.
 The first value is the default style.
 .\"
 .Pp
-.It auth- Ns Ar type Ta list Ta "" Ta
+.It Dv auth- Ns Ar type Ta list Ta "" Ta
 Allowed authentication styles for the authentication type
 .Ar type .
 .\"
 .Pp
-.It classify Ta program Ta "" Ta
+.It Dv classify Ta program Ta "" Ta
 Classify type of login.
 .\"
 .Pp
-.It copyright Ta file Ta "" Ta
+.It Dv copyright Ta file Ta "" Ta
 File containing additional copyright information.
 .\"
 .Pp
-.It coredumpsize Ta size Ta "" Ta
+.It Dv coredumpsize Ta size Ta "" Ta
 Maximum coredump size limit.
 .\"
 .Pp
-.It cputime Ta time Ta "" Ta
+.It Dv cputime Ta time Ta "" Ta
 CPU usage limit.
 .\"
 .Pp
-.It datasize Ta size Ta "" Ta
+.It Dv datasize Ta size Ta "" Ta
 Maximum data size limit.
 .\"
 .Pp
-.It expire-warn Ta time Ta Dv 2w Ta
+.It Dv expire-warn Ta time Ta Dv 2w Ta
 If the user's account will expire within this length of time then
 warn the user of this.
 .\"
 .Pp
-.It filesize Ta size Ta "" Ta
+.It Dv filesize Ta size Ta "" Ta
 Maximum file size limit.
 .\"
 .Pp
-.It hushlogin Ta bool Ta Dv false Ta
+.It Dv hushlogin Ta bool Ta Dv false Ta
 Same as having a
 .Pa $HOME/.hushlogin
 file.
@@ -157,7 +157,7 @@ See
 .Xr login 1 .
 .\"
 .Pp
-.It ignorenologin Ta bool Ta Dv false Ta
+.It Dv ignorenologin Ta bool Ta Dv false Ta
 Not affected by
 .Pa nologin
 files.
@@ -165,14 +165,14 @@ See
 .Xr login 1 .
 .\"
 .Pp
-.It localcipher Ta string Ta bcrypt,a Ta
+.It Dv localcipher Ta string Ta Dv bcrypt,a Ta
 The cipher to use for encrypting passwords.
 Refer to
 .Xr crypt_newhash 3
 for possible values.
 .\"
 .Pp
-.It login-backoff Ta number Ta 3 Ta
+.It Dv login-backoff Ta number Ta 3 Ta
 After
 .Ar login-backoff
 unsuccessful login attempts during a single session,
@@ -180,7 +180,7 @@ unsuccessful login attempts during a single session,
 will start sleeping a bit in between attempts.
 .\"
 .Pp
-.It login-timeout Ta time Ta 300 Ta
+.It Dv login-timeout Ta time Ta 300 Ta
 Number of seconds before
 .Xr login 1
 times out at the password prompt.
@@ -189,29 +189,29 @@ Note that this setting is only valid for the
 record.
 .\"
 .Pp
-.It login-tries Ta number Ta 10 Ta
+.It Dv login-tries Ta number Ta 10 Ta
 Number of tries a user gets to successfully login before
 .Xr login 1
 closes the connection.
 .\"
 .Pp
-.It stacksize Ta size Ta "" Ta
+.It Dv stacksize Ta size Ta "" Ta
 Maximum stack size limit.
 .\"
 .Pp
-.It maxproc Ta number Ta "" Ta
+.It Dv maxproc Ta number Ta "" Ta
 Maximum number of processes.
 .\"
 .Pp
-.It memorylocked Ta size Ta "" Ta
+.It Dv memorylocked Ta size Ta "" Ta
 Maximum locked in core memory size limit.
 .\"
 .Pp
-.It memoryuse Ta size Ta "" Ta
+.It Dv memoryuse Ta size Ta "" Ta
 Maximum in core memoryuse size limit.
 .\"
 .Pp
-.It minpasswordlen Ta number Ta 6 Ta
+.It Dv minpasswordlen Ta number Ta 6 Ta
 The minimum length a local password may be.
 If a negative value or zero, no length restrictions are enforced.
 Used by the
@@ -219,16 +219,16 @@ Used by the
 utility.
 .\"
 .Pp
-.It nologin Ta file Ta "" Ta
+.It Dv nologin Ta file Ta "" Ta
 If the file exists, it will be displayed
 and the login session will be terminated.
 .\"
 .Pp
-.It openfiles Ta number Ta "" Ta
+.It Dv openfiles Ta number Ta "" Ta
 Maximum number of open file descriptors per process.
 .\"
 .Pp
-.It password-dead Ta time Ta Dv 0 Ta
+.It Dv password-dead Ta time Ta Dv 0 Ta
 Length of time a password may be expired but not quite dead yet.
 When set (for both the client and remote server machine when doing
 remote authentication), a user is allowed to log in just one more
@@ -236,12 +236,12 @@ time after their password (but not account) has expire
 This allows a grace period for updating their password.
 .\"
 .Pp
-.It password-warn Ta time Ta Dv 2w Ta
+.It Dv password-warn Ta time Ta Dv 2w Ta
 If the user's password will expire within this length of time then
 warn the user of this.
 .\"
 .Pp
-.It passwordcheck Ta program Ta "" Ta
+.It Dv passwordcheck Ta program Ta "" Ta
 An external program that checks the quality of the password.
 The password is passed to the program on
 .Pa stdin .
@@ -249,7 +249,7 @@ An exit code of 0 indicates that the quality of the pa
 sufficient, an exit code of 1 signals that the password failed the check.
 .\"
 .Pp
-.It passwordtime Ta time Ta "" Ta
+.It Dv passwordtime Ta time Ta "" Ta
 The lifetime of a password in seconds, reset every time a user
 changes their password.
 When this value is exceeded, the user will no longer be able to
@@ -261,7 +261,7 @@ Used by the
 utility.
 .\"
 .Pp
-.It passwordtries Ta number Ta 3 Ta
+.It Dv passwordtries Ta number Ta 3 Ta
 The number of times the
 .Xr passwd 1
 utility enforces a check on the password.
@@ -269,48 +269,48 @@ If 0, the new password will only be accepted if it pas
 quality check.
 .\"
 .Pp
-.It path Ta path Ta value of Dv _PATH_DEFPATH Ta
+.It Dv path Ta path Ta value of Dv _PATH_DEFPATH Ta
 .br
 Default search path.
 See
 .Pa /usr/include/paths.h .
 .\"
 .Pp
-.It priority Ta number Ta "" Ta
+.It Dv priority Ta number Ta "" Ta
 Initial priority (nice) level.
 .\"
 .Pp
-.It requirehome Ta bool Ta Dv false Ta
+.It Dv requirehome Ta bool Ta Dv false Ta
 Require home directory to login.
 .\"
 .Pp
-.It rtable Ta number Ta "" Ta
+.It Dv rtable Ta number Ta "" Ta
 Rtable to be set for the class.
 .\"
 .Pp
-.It setenv Ta envlist Ta "" Ta
+.It Dv setenv Ta envlist Ta "" Ta
 A list of environment variables and associated values to be set for the class.
 .\"
 .Pp
-.It shell Ta program Ta "" Ta
+.It Dv shell Ta program Ta "" Ta
 Session shell to execute rather than the shell specified in the password file.
 The
 .Ev SHELL
 environment variable will contain the shell specified in the password file.
 .\"
 .Pp
-.It tc Ta string Ta "" Ta
+.It Dv tc Ta string Ta "" Ta
 Interpolate/expands records from corresponding
 .Pa login.conf .
 See
 .Xr cgetent 3 .
 .\"
 .Pp
-.It term Ta string Ta Dv su Ta
+.It Dv term Ta string Ta Dv su Ta
 Default terminal type if not able to determine from other means.
 .\"
 .Pp
-.It umask Ta number Ta Dv 022 Ta
+.It Dv umask Ta number Ta Dv 022 Ta
 Initial umask.
 Should always have a leading
 .Li 0
@@ -319,11 +319,11 @@ See
 .Xr umask 2 .
 .\"
 .Pp
-.It vmemoryuse Ta size Ta "" Ta
+.It Dv vmemoryuse Ta size Ta "" Ta
 Maximum virtual memoryuse size limit.
 .\"
 .Pp
-.It welcome Ta file Ta Pa /etc/motd Ta
+.It Dv welcome Ta file Ta Pa /etc/motd Ta
 File containing welcome message.
 .El
 .Pp