contrib/libpam/doc/modules/pam_issue.sgml

   1 <!--
   2
   3 Ben Collins <bcollins@debian.org>
   4
   5 -->
   6
   7 <sect1>Add issue file to user prompt
   8
   9 <sect2>Synopsis
  10
  11 <p>
  12 <descrip>
  13
  14 <tag><bf>Module Name:</bf></tag>
  15 <tt/pam_issue/
  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 Authentication (pam_sm_authenticate)
  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 prepends the issue file (<em>/etc/issue</em> by default) when
  42 prompting for a username.
  43
  44 <sect2>Authentication component
  45
  46 <p>
  47 <descrip>
  48
  49 <tag><bf>Recognized arguments:</bf></tag>
  50 <tt/issue=issue-file-name/; <tt/noesc/;
  51
  52 <tag><bf>Description:</bf></tag>
  53 This module allows you to prepend an issue file to the username prompt. It
  54 also by default parses escape codes in the issue file similar to some
  55 common getty's (using &bsol;x format).
  56 <p>
  57 Recognized escapes:
  58 <itemize>
  59
  60 <item><tt/d/
  61 - current date
  62
  63 <item><tt/s/
  64 - operating system name
  65
  66 <item><tt/l/
  67 - name of this tty
  68
  69 <item><tt/m/
  70 - architecture of this system (i686, sparc, powerpc, ...)
  71
  72 <item><tt/n/
  73 - hostname of this system
  74
  75 <item><tt/o/
  76 - domainname of this system
  77
  78 <item><tt/r/
  79 - release number of the operation system (eg. 2.2.12)
  80
  81 <item><tt/t/
  82 - current time
  83
  84 <item><tt/u/
  85 - number of users currently logged in
  86
  87 <item><tt/U/
  88 - same as <tt/u/, except it is suffixed with "user" or "users" (eg. "1
  89 user" or "10 users"
  90
  91 <item><tt/v/
  92 - version/build-date of the operating system (eg. "&num;3 Mon Aug 23 14:38:16
  93 EDT 1999" on Linux).
  94
  95 </itemize>
  96
  97 <p>
  98 The behavior of this module can be modified with one of the following
  99 flags:
 100
 101 <p>
 102 <itemize>
 103
 104 <item><tt/issue/
 105 - the file to output if not using the default
 106
 107 <item><tt/noesc/
 108 - turns off escape code parsing
 109
 110 </itemize>
 111
 112 <tag><bf>Examples/suggested usage:</bf></tag>
 113
 114 login  auth  pam_issue.so  issue=/etc/issue
 115
 116 </descrip>
 117
 118 <!--
 119 End of sgml insert for this module.
 120 -->