summaryrefslogtreecommitdiff
path: root/modules/pam_motd/pam_motd.8.xml
blob: ff92154e9af74af45d7056c0960f7bf9c8747795 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<?xml version="1.0" encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">

<refentry id="pam_motd">

  <refmeta>
    <refentrytitle>pam_motd</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
  </refmeta>

  <refnamediv id="pam_motd-name">
    <refname>pam_motd</refname>
    <refpurpose>Display the motd file</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="pam_motd-cmdsynopsis">
      <command>pam_motd.so</command>
      <arg choice="opt">
        motd=<replaceable>/path/filename</replaceable>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="pam_motd-description">

    <title>DESCRIPTION</title>

    <para>
      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 <filename>/etc/motd</filename> file is
      shown. The message size is limited to 64KB.
    </para>

  </refsect1>

  <refsect1 id="pam_motd-options">

    <title>OPTIONS</title>
    <variablelist>
      <varlistentry>
        <term>
          <option>motd=<replaceable>/path/filename</replaceable></option>
        </term>
        <listitem>
          <para>
	    The <filename>/path/filename</filename> file is displayed
            as message of the day.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id="pam_motd-types">
    <title>MODULE TYPES PROVIDED</title>
    <para>
      Only the <option>session</option> module type is provided.
    </para>
  </refsect1>

  <refsect1 id='pam_motd-return_values'>
    <title>RETURN VALUES</title>
    <variablelist>
      <varlistentry>
        <term>PAM_IGNORE</term>
        <listitem>
          <para>
            This is the only return value of this module.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
     </refsect1>

  <refsect1 id='pam_motd-examples'>
    <title>EXAMPLES</title>
    <para>
      The suggested usage for <filename>/etc/pam.d/login</filename> is:
      <programlisting>
session  optional  pam_motd.so  motd=/etc/motd
      </programlisting>
    </para>
  </refsect1>

  <refsect1 id='pam_motd-see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
	<refentrytitle>motd</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>

  <refsect1 id='pam_motd-author'>
    <title>AUTHOR</title>
      <para>
        pam_motd was written by Ben Collins &lt;bcollins@debian.org&gt;.
      </para>
  </refsect1>

</refentry>