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

246 lines
3.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PAM_ISSUE</TITLE>
</HEAD><BODY>
<H1>PAM_ISSUE</H1>
Section: Linux-PAM Manual (8)<BR>Updated: 05/18/2017<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_issue - PAM module to add issue file to user prompt
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<DL COMPACT>
<DT id="1">
<B>pam_issue.so</B> [noesc] [issue=<I>issue-file-name</I>]
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<DD>pam_issue is a PAM module to prepend an issue file to the username prompt. It also by default parses escape codes in the issue file similar to some common getty's (using \x format).
<P>
Recognized escapes:
<P>
<B>\d</B>
<DL COMPACT><DT id="2"><DD>
current day
</DL>
<P>
<B>\l</B>
<DL COMPACT><DT id="3"><DD>
name of this tty
</DL>
<P>
<B>\m</B>
<DL COMPACT><DT id="4"><DD>
machine architecture (uname -m)
</DL>
<P>
<B>\n</B>
<DL COMPACT><DT id="5"><DD>
machine's network node hostname (uname -n)
</DL>
<P>
<B>\o</B>
<DL COMPACT><DT id="6"><DD>
domain name of this system
</DL>
<P>
<B>\r</B>
<DL COMPACT><DT id="7"><DD>
release number of operating system (uname -r)
</DL>
<P>
<B>\t</B>
<DL COMPACT><DT id="8"><DD>
current time
</DL>
<P>
<B>\s</B>
<DL COMPACT><DT id="9"><DD>
operating system name (uname -s)
</DL>
<P>
<B>\u</B>
<DL COMPACT><DT id="10"><DD>
number of users currently logged in
</DL>
<P>
<B>\U</B>
<DL COMPACT><DT id="11"><DD>
same as \u except it is suffixed with &quot;user&quot; or &quot;users&quot; (eg. &quot;1 user&quot; or &quot;10 users&quot;)
</DL>
<P>
<B>\v</B>
<DL COMPACT><DT id="12"><DD>
operating system version and build date (uname -v)
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
<P>
<B>noesc</B>
<DL COMPACT><DT id="13"><DD>
Turns off escape code parsing.
</DL>
<P>
<B>issue=</B><B></B><I>issue-file-name</I>
<DL COMPACT><DT id="14"><DD>
The file to output if not using the default.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>MODULE TYPES PROVIDED</H2>
<P>
Only the
<B>auth</B>
module type is provided.
<A NAME="lbAG">&nbsp;</A>
<H2>RETURN VALUES</H2>
<P>
<P>
PAM_BUF_ERR
<DL COMPACT><DT id="15"><DD>
Memory buffer error.
</DL>
<P>
PAM_IGNORE
<DL COMPACT><DT id="16"><DD>
The prompt was already changed.
</DL>
<P>
PAM_SERVICE_ERR
<DL COMPACT><DT id="17"><DD>
A service module error occurred.
</DL>
<P>
PAM_SUCCESS
<DL COMPACT><DT id="18"><DD>
The new prompt was set successfully.
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>EXAMPLES</H2>
<P>
Add the following line to
/etc/pam.d/login
to set the user specific issue at login:
<P>
<DL COMPACT><DT id="19"><DD>
<PRE>
auth optional pam_issue.so issue=/etc/issue
</PRE>
</DL>
<P>
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<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)
<A NAME="lbAJ">&nbsp;</A>
<H2>AUTHOR</H2>
<P>
pam_issue was written by Ben Collins &lt;<A HREF="mailto:bcollins@debian.org">bcollins@debian.org</A>&gt;.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="20"><A HREF="#lbAB">NAME</A><DD>
<DT id="21"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="22"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="23"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="24"><A HREF="#lbAF">MODULE TYPES PROVIDED</A><DD>
<DT id="25"><A HREF="#lbAG">RETURN VALUES</A><DD>
<DT id="26"><A HREF="#lbAH">EXAMPLES</A><DD>
<DT id="27"><A HREF="#lbAI">SEE ALSO</A><DD>
<DT id="28"><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>