diff options
Diffstat (limited to 'modules/pam_motd/pam_motd.8')
-rw-r--r-- | modules/pam_motd/pam_motd.8 | 132 |
1 files changed, 132 insertions, 0 deletions
diff --git a/modules/pam_motd/pam_motd.8 b/modules/pam_motd/pam_motd.8 new file mode 100644 index 0000000..21c2ed7 --- /dev/null +++ b/modules/pam_motd/pam_motd.8 @@ -0,0 +1,132 @@ +'\" t +.\" Title: pam_motd +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 05/18/2018 +.\" Manual: Linux-PAM Manual +.\" Source: Linux-PAM Manual +.\" Language: English +.\" +.TH "PAM_MOTD" "8" "05/18/2018" "Linux-PAM Manual" "Linux\-PAM Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +pam_motd \- Display the motd file +.SH "SYNOPSIS" +.HP \w'\fBpam_motd\&.so\fR\ 'u +\fBpam_motd\&.so\fR [motd=\fI/path/filename\fR] +.SH "DESCRIPTION" +.PP +pam_motd is a PAM module that can be used to display arbitrary motd (message of the day) files after a successful login\&. By default the +/etc/motd +file is shown\&. The message size is limited to 64KB\&. +.SH "OPTIONS" +.PP +\fBmotd=\fR\fB\fI/path/filename\fR\fR +.RS 4 +The +/path/filename +file is displayed as message of the day\&. +.RE +.PP +\fBmotd_dir=\fR\fB\fI/path/dirname\&.d\fR\fR +.RS 4 +The +/path/dirname\&.d +directory is scanned and each file contained inside of it is displayed\&. +.RE +.PP +When no options are given, the default is to display both +/etc/motd +and the contents of +/etc/motd\&.d\&. Specifying either option (or both) will disable this default behavior\&. +.SH "MODULE TYPES PROVIDED" +.PP +Only the +\fBsession\fR +module type is provided\&. +.SH "RETURN VALUES" +.PP +PAM_IGNORE +.RS 4 +This is the only return value of this module\&. +.RE +.SH "EXAMPLES" +.PP +The suggested usage for +/etc/pam\&.d/login +is: +.sp +.if n \{\ +.RS 4 +.\} +.nf +session optional pam_motd\&.so + +.fi +.if n \{\ +.RE +.\} +.PP +To use a +motd +file from a different location: +.sp +.if n \{\ +.RS 4 +.\} +.nf +session optional pam_motd\&.so motd=/elsewhere/motd + +.fi +.if n \{\ +.RE +.\} +.PP +To use a +motd +file from elsewhere, along with a corresponding +\&.d +directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +session optional pam_motd\&.so motd=/elsewhere/motd motd_dir=/elsewhere/motd\&.d + +.fi +.if n \{\ +.RE +.\} +.sp +.SH "SEE ALSO" +.PP +\fBmotd\fR(5), +\fBpam.conf\fR(5), +\fBpam.d\fR(5), +\fBpam\fR(8) +.SH "AUTHOR" +.PP +pam_motd was written by Ben Collins <bcollins@debian\&.org>\&. +.PP +The +\fBmotd_dir=\fR +option was added by Allison Karlitskaya <allison\&.karlitskaya@redhat\&.com>\&. |