modules/pam_motd/pam_motd.8.xml

   1 <?xml version="1.0" encoding='UTF-8'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
   4
   5 <refentry id="pam_motd">
   6
   7   <refmeta>
   8     <refentrytitle>pam_motd</refentrytitle>
   9     <manvolnum>8</manvolnum>
  10     <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="pam_motd-name">
  14     <refname>pam_motd</refname>
  15     <refpurpose>Display the motd file</refpurpose>
  16   </refnamediv>
  17
  18   <refsynopsisdiv>
  19     <cmdsynopsis id="pam_motd-cmdsynopsis">
  20       <command>pam_motd.so</command>
  21       <arg choice="opt">
  22         motd=<replaceable>/path/filename</replaceable>
  23       </arg>
  24     </cmdsynopsis>
  25   </refsynopsisdiv>
  26
  27   <refsect1 id="pam_motd-description">
  28
  29     <title>DESCRIPTION</title>
  30
  31     <para>
  32       pam_motd is a PAM module that can be used to display
  33       arbitrary motd (message of the day) files after a successful
  34       login. By default the <filename>/etc/motd</filename> file is
  35       shown. The message size is limited to 64KB.
  36     </para>
  37
  38   </refsect1>
  39
  40   <refsect1 id="pam_motd-options">
  41
  42     <title>OPTIONS</title>
  43     <variablelist>
  44       <varlistentry>
  45         <term>
  46           <option>motd=<replaceable>/path/filename</replaceable></option>
  47         </term>
  48         <listitem>
  49           <para>
  50             The <filename>/path/filename</filename> file is displayed
  51             as message of the day.
  52           </para>
  53         </listitem>
  54       </varlistentry>
  55     </variablelist>
  56   </refsect1>
  57
  58   <refsect1 id="pam_motd-types">
  59     <title>MODULE TYPES PROVIDED</title>
  60     <para>
  61       Only the <option>session</option> module type is provided.
  62     </para>
  63   </refsect1>
  64
  65   <refsect1 id='pam_motd-return_values'>
  66     <title>RETURN VALUES</title>
  67     <variablelist>
  68       <varlistentry>
  69         <term>PAM_IGNORE</term>
  70         <listitem>
  71           <para>
  72             This is the only return value of this module.
  73           </para>
  74         </listitem>
  75       </varlistentry>
  76     </variablelist>
  77      </refsect1>
  78
  79   <refsect1 id='pam_motd-examples'>
  80     <title>EXAMPLES</title>
  81     <para>
  82       The suggested usage for <filename>/etc/pam.d/login</filename> is:
  83       <programlisting>
  84 session  optional  pam_motd.so  motd=/etc/motd
  85       </programlisting>
  86     </para>
  87   </refsect1>
  88
  89   <refsect1 id='pam_motd-see_also'>
  90     <title>SEE ALSO</title>
  91     <para>
  92       <citerefentry>
  93         <refentrytitle>motd</refentrytitle><manvolnum>5</manvolnum>
  94       </citerefentry>,
  95       <citerefentry>
  96         <refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
  97       </citerefentry>,
  98       <citerefentry>
  99         <refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
 100       </citerefentry>,
 101       <citerefentry>
 102         <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
 103       </citerefentry>
 104     </para>
 105   </refsect1>
 106
 107   <refsect1 id='pam_motd-author'>
 108     <title>AUTHOR</title>
 109       <para>
 110         pam_motd was written by Ben Collins &lt;bcollins@debian.org&gt;.
 111       </para>
 112   </refsect1>
 113
 114 </refentry>