man-pages/man8/pam_motd.8.html
2021-03-31 01:06:50 +01:00

230 lines
3.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PAM_MOTD</TITLE>
</HEAD><BODY>
<H1>PAM_MOTD</H1>
Section: Linux-PAM Manual (8)<BR>Updated: 07/21/2020<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
pam_motd - Display the motd file
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<DL COMPACT>
<DT id="1">
<B>pam_motd.so</B> [motd=<I>/path/filename</I>]
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<DD>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.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
<B>motd=</B><B></B><I>/path/filename</I>
<DL COMPACT><DT id="2"><DD>
The
/path/filename
file is displayed as message of the day.
</DL>
<P>
<B>motd_dir=</B><B></B><I>/path/dirname.d</I>
<DL COMPACT><DT id="3"><DD>
The
/path/dirname.d
directory is scanned and each file contained inside of it is displayed.
</DL>
<P>
<B>noupdate</B>
<DL COMPACT><DT id="4"><DD>
Don't run the scripts in
/etc/update-motd.d
to refresh the motd file.
</DL>
<P>
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.
<P>
The
<B>MOTD_SHOWN=pam</B>
environment variable is set after showing the motd files, even when all of them were silenced using symbolic links.
<A NAME="lbAF">&nbsp;</A>
<H2>MODULE TYPES PROVIDED</H2>
<P>
Only the
<B>session</B>
module type is provided.
<A NAME="lbAG">&nbsp;</A>
<H2>RETURN VALUES</H2>
<P>
PAM_ABORT
<DL COMPACT><DT id="5"><DD>
Not all relevant data or options could be obtained.
</DL>
<P>
PAM_BUF_ERR
<DL COMPACT><DT id="6"><DD>
Memory buffer error.
</DL>
<P>
PAM_IGNORE
<DL COMPACT><DT id="7"><DD>
This is the default return value of this module.
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>EXAMPLES</H2>
<P>
The suggested usage for
/etc/pam.d/login
is:
<P>
<DL COMPACT><DT id="8"><DD>
<PRE>
session optional pam_motd.so
</PRE>
</DL>
<P>
To use a
motd
file from a different location:
<P>
<DL COMPACT><DT id="9"><DD>
<PRE>
session optional pam_motd.so motd=/elsewhere/motd
</PRE>
</DL>
<P>
To use a
motd
file from elsewhere, along with a corresponding
.d
directory:
<P>
<DL COMPACT><DT id="10"><DD>
<PRE>
session optional pam_motd.so motd=/elsewhere/motd motd_dir=/elsewhere/motd.d
</PRE>
</DL>
<P>
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?5+motd">motd</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?5+pam.conf">pam.conf</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?5+pam.d">pam.d</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?7+pam">pam</A></B>(7),
<B><A HREF="/cgi-bin/man/man2html?5+update-motd">update-motd</A></B>(5)
<A NAME="lbAJ">&nbsp;</A>
<H2>AUTHOR</H2>
<P>
pam_motd was written by Ben Collins &lt;<A HREF="mailto:bcollins@debian.org">bcollins@debian.org</A>&gt;.
<P>
The
<B>motd_dir=</B>
option was added by Allison Karlitskaya &lt;<A HREF="mailto:allison.karlitskaya@redhat.com">allison.karlitskaya@redhat.com</A>&gt;.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="11"><A HREF="#lbAB">NAME</A><DD>
<DT id="12"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="13"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="14"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="15"><A HREF="#lbAF">MODULE TYPES PROVIDED</A><DD>
<DT id="16"><A HREF="#lbAG">RETURN VALUES</A><DD>
<DT id="17"><A HREF="#lbAH">EXAMPLES</A><DD>
<DT id="18"><A HREF="#lbAI">SEE ALSO</A><DD>
<DT id="19"><A HREF="#lbAJ">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:14 GMT, March 31, 2021
</BODY>
</HTML>