login: add support for directories in MOTD_FILE=

[thirdparty/util-linux.git] / login-utils / login.1

diff --git a/login-utils/login.1 b/login-utils/login.1
index d74e96220cb974046e98d01482a9bdfd15bbbc9e..1e2d3cb28990c60b080449e31eb111d9deb1feb1 100644 (file)
--- a/login-utils/login.1
+++ b/login-utils/login.1
@@ -6,17 +6,17 @@ login \- begin session on the system
 .SH SYNOPSIS
 .B login
 [
-.BR \-p
+.B \-p
 ] [
-.BR \-h
-.IR host
+.B \-h
+.I host
 ] [
-.BR \-H
+.B \-H
 ] [
-.BR \-f
-.IR username
+.B \-f
+.I username
 |
-.IR username
+.I username
 ]
 .SH DESCRIPTION
 .B login
@@ -67,9 +67,9 @@ option is given), else it will be initialized to the terminal type on your tty.
 .PP
 Then the user's shell is started.  If no shell is specified for the
 user in
-.BR /etc\:/passwd ,
+.IR /etc\:/passwd ,
 then
-.B /bin\:/sh
+.I /bin\:/sh
 is used.  If there is no directory specified in
 .IR /etc\:/passwd ,
 then
@@ -119,7 +119,7 @@ with the
 .B \-h
 option the name is
 .IR remote .
-It is necessary to create proper PAM config files (e.g.
+It is necessary to create proper PAM config files (e.g.,
 .I /etc\:/pam.d\:/login
 and
 .IR /etc\:/pam.d\:/remote ).
@@ -130,24 +130,33 @@ Used by other servers (i.e.,
 to tell
 .B login
 that printing the hostname should be suppressed in the login: prompt.
+See also LOGIN_PLAIN_PROMPT below if your server does not allow to configure
+.B login
+command line.
+.TP
+\fB\-\-help\fR
+Display help text and exit.
 .TP
-.B \-V
+\fB\-V\fR, \fB\-\-version\fR
 Display version information and exit.
 .SH CONFIG FILE ITEMS
 .B login
 reads the
-.BR /etc\:/login.defs (5)
+.IR /etc\:/login.defs (5)
 configuration file.  Note that the configuration file could be
-distributed with another package (e.g. shadow-utils).  The following
+distributed with another package (e.g., shadow-utils).  The following
 configuration items are relevant for
 .BR login (1):
 .PP
 .B MOTD_FILE
 (string)
 .RS 4
-If defined, a ":" delimited list of "message of the day" files to be
-displayed upon login.  The default value is
-.IR /etc\:/motd .
+Sepecifies a ":" delimited list of "message of the day" files and directories
+to be displayed upon login.  If the specified path is a directory then displays
+all files with .motd file extension in version-sort order from the directory.
+.PP
+The default value is
+.IR "/usr/share/misc/motd:/run/motd:/run/motd.d:/etc/motd:/etc/motd.d" .
 If the
 .B MOTD_FILE
 item is empty or a quiet login is enabled, then the message of the day
@@ -155,6 +164,19 @@ is not displayed.  Note that the same functionality is also provided
 by
 .BR pam_motd (8)
 PAM module.
+.PP
+The directories in the
+.B MOTD_FILE
+are supported since version 2.36.
+.RE
+.PP
+.B LOGIN_PLAIN_PROMPT
+(boolean)
+.RS 4
+Tell login that printing the hostname should be suppressed in the login:
+prompt.  This is alternative to the \fB\-H\fR command line option.  The default
+value is
+.IR no .
 .RE
 .PP
 .B LOGIN_TIMEOUT
@@ -184,9 +206,9 @@ login failure.  The default value is
 (string)
 .RS 4
 The terminal permissions.  The default value is
-.IR 0600
+.I 0600
 or
-.IR 0620
+.I 0620
 if tty group is used.
 .RE
 .PP
@@ -211,7 +233,7 @@ can be either the name of a group or a numeric group identifier.
 (string)
 .RS 4
 If defined, this file can inhibit all the usual chatter during the
-login sequence.  If a full pathname (e.g.
+login sequence.  If a full pathname (e.g.,
 .IR /etc\:/hushlogins )
 is specified, then hushed mode will be enabled if the user\'s name or
 shell are found in the file.  If this global hush login file is empty
@@ -241,6 +263,17 @@ to change directory to her home.  The default value is
 .IR yes .
 .RE
 .PP
+.B LASTLOG_UID_MAX
+(unsigned number)
+.RS 4
+Highest user ID number for which the lastlog entries should be
+updated.  As higher user IDs are usually tracked by remote user
+identity and authentication services there is no need to create
+a huge sparse lastlog file for them.  No LASTLOG_UID_MAX option
+present in the configuration means that there is no user ID limit
+for writing lastlog entries.
+.RE
+.PP
 .B LOG_UNKFAIL_ENAB
 (boolean)
 .RS 4
@@ -267,7 +300,7 @@ a regular user logs in.  The default value is
 (string)
 .RS 4
 If set, it will be used to define the PATH environment variable when
-the superuser logs in.  The default value is
+the superuser logs in.  ENV_ROOTPATH takes precedence.  The default value is
 .I /usr\:/local\:/sbin:\:/usr\:/local\:/bin:\:/sbin:\:/bin:\:/usr\:/sbin:\:/usr\:/bin
 .RE
 .SH FILES
@@ -330,6 +363,6 @@ Karel Zak
 .SH AVAILABILITY
 The login command is part of the util-linux package and is
 available from
-.UR ftp:\://ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
+.UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
 Linux Kernel Archive
 .UE .