contrib/libpam/doc/modules/pam_motd.sgml

   1 <!--
   2
   3 Ben Collins <bcollins@debian.org>
   4
   5 -->
   6
   7 <sect1>Output the motd file
   8
   9 <sect2>Synopsis
  10
  11 <p>
  12 <descrip>
  13
  14 <tag><bf>Module Name:</bf></tag>
  15 <tt/pam_motd/
  16
  17 <tag><bf>Author:</bf></tag>
  18 Ben Collins &lt;bcollins@debian.org&gt;
  19
  20 <tag><bf>Maintainer:</bf></tag>
  21 Author
  22
  23 <tag><bf>Management groups provided:</bf></tag>
  24 Session (open)
  25
  26 <tag><bf>Cryptographically sensitive:</bf></tag>
  27
  28 <tag><bf>Security rating:</bf></tag>
  29
  30 <tag><bf>Clean code base:</bf></tag>
  31
  32 <tag><bf>System dependencies:</bf></tag>
  33
  34 <tag><bf>Network aware:</bf></tag>
  35
  36 </descrip>
  37
  38 <sect2>Overview of module
  39
  40 <p>
  41 This module outputs the motd file (<em>/etc/motd</em> by default) upon
  42 successful login.
  43
  44 <sect2>Session component
  45
  46 <p>
  47 <descrip>
  48
  49 <tag><bf>Recognized arguments:</bf></tag>
  50 <tt/debug/; <tt/motd=motd-file-name/;
  51
  52 <tag><bf>Description:</bf></tag>
  53 This module allows you to have arbitrary motd's (message of the day)
  54 output after a succesful login. By default this file is <em>/etc/motd</em>,
  55 but is configurable to any file.
  56
  57 <p>
  58 The behavior of this module can be modified with one of the following
  59 flags:
  60
  61 <p>
  62 <itemize>
  63
  64 <item><tt/motd/
  65 - the file to output if not using the default.
  66
  67 </itemize>
  68
  69 <tag><bf>Examples/suggested usage:</bf></tag>
  70
  71 login  session  pam_motd.so  motd=/etc/motd
  72
  73 </descrip>
  74
  75 <!--
  76 End of sgml insert for this module.
  77 -->