| 1 |
'\" t |
| 2 |
.\" Title: pam_issue |
| 3 |
.\" Author: [see the "AUTHOR" section] |
| 4 |
.\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/> |
| 5 |
.\" Date: 06/29/2025 |
| 6 |
.\" Manual: Linux-PAM Manual |
| 7 |
.\" Source: Linux-PAM |
| 8 |
.\" Language: English |
| 9 |
.\" |
| 10 |
.TH "PAM_ISSUE" "8" "06/29/2025" "Linux\-PAM" "Linux\-PAM Manual" |
| 11 |
.\" ----------------------------------------------------------------- |
| 12 |
.\" * Define some portability stuff |
| 13 |
.\" ----------------------------------------------------------------- |
| 14 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 15 |
.\" http://bugs.debian.org/507673 |
| 16 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 17 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 18 |
.ie \n(.g .ds Aq \(aq |
| 19 |
.el .ds Aq ' |
| 20 |
.\" ----------------------------------------------------------------- |
| 21 |
.\" * set default formatting |
| 22 |
.\" ----------------------------------------------------------------- |
| 23 |
.\" disable hyphenation |
| 24 |
.nh |
| 25 |
.\" disable justification (adjust text to left margin only) |
| 26 |
.ad l |
| 27 |
.\" ----------------------------------------------------------------- |
| 28 |
.\" * MAIN CONTENT STARTS HERE * |
| 29 |
.\" ----------------------------------------------------------------- |
| 30 |
.SH "NAME" |
| 31 |
pam_issue \- PAM module to add issue file to user prompt |
| 32 |
.SH "SYNOPSIS" |
| 33 |
.HP \w'\fBpam_issue\&.so\fR\ 'u |
| 34 |
\fBpam_issue\&.so\fR [noesc] [issue=\fIissue\-file\-name\fR] |
| 35 |
.SH "DESCRIPTION" |
| 36 |
.PP |
| 37 |
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\*(Aqs (using \ex format)\&. |
| 38 |
.PP |
| 39 |
Recognized escapes: |
| 40 |
.PP |
| 41 |
\ed |
| 42 |
.RS 4 |
| 43 |
current day |
| 44 |
.RE |
| 45 |
.PP |
| 46 |
\el |
| 47 |
.RS 4 |
| 48 |
name of this tty |
| 49 |
.RE |
| 50 |
.PP |
| 51 |
\em |
| 52 |
.RS 4 |
| 53 |
machine architecture (uname \-m) |
| 54 |
.RE |
| 55 |
.PP |
| 56 |
\en |
| 57 |
.RS 4 |
| 58 |
machine\*(Aqs network node hostname (uname \-n) |
| 59 |
.RE |
| 60 |
.PP |
| 61 |
\eo |
| 62 |
.RS 4 |
| 63 |
domain name of this system |
| 64 |
.RE |
| 65 |
.PP |
| 66 |
\er |
| 67 |
.RS 4 |
| 68 |
release number of operating system (uname \-r) |
| 69 |
.RE |
| 70 |
.PP |
| 71 |
\et |
| 72 |
.RS 4 |
| 73 |
current time |
| 74 |
.RE |
| 75 |
.PP |
| 76 |
\es |
| 77 |
.RS 4 |
| 78 |
operating system name (uname \-s) |
| 79 |
.RE |
| 80 |
.PP |
| 81 |
\eu |
| 82 |
.RS 4 |
| 83 |
number of users currently logged in |
| 84 |
.RE |
| 85 |
.PP |
| 86 |
\eU |
| 87 |
.RS 4 |
| 88 |
same as \eu except it is suffixed with "user" or "users" (eg\&. "1 user" or "10 users") |
| 89 |
.RE |
| 90 |
.PP |
| 91 |
\ev |
| 92 |
.RS 4 |
| 93 |
operating system version and build date (uname \-v) |
| 94 |
.RE |
| 95 |
.SH "OPTIONS" |
| 96 |
.PP |
| 97 |
.PP |
| 98 |
noesc |
| 99 |
.RS 4 |
| 100 |
Turns off escape code parsing\&. |
| 101 |
.RE |
| 102 |
.PP |
| 103 |
issue=issue\-file\-name |
| 104 |
.RS 4 |
| 105 |
The file to output if not using the default\&. |
| 106 |
.RE |
| 107 |
.SH "MODULE TYPES PROVIDED" |
| 108 |
.PP |
| 109 |
Only the |
| 110 |
\fBauth\fR |
| 111 |
module type is provided\&. |
| 112 |
.SH "RETURN VALUES" |
| 113 |
.PP |
| 114 |
.PP |
| 115 |
PAM_BUF_ERR |
| 116 |
.RS 4 |
| 117 |
Memory buffer error\&. |
| 118 |
.RE |
| 119 |
.PP |
| 120 |
PAM_IGNORE |
| 121 |
.RS 4 |
| 122 |
The prompt was already changed\&. |
| 123 |
.RE |
| 124 |
.PP |
| 125 |
PAM_SERVICE_ERR |
| 126 |
.RS 4 |
| 127 |
A service module error occurred\&. |
| 128 |
.RE |
| 129 |
.PP |
| 130 |
PAM_SUCCESS |
| 131 |
.RS 4 |
| 132 |
The new prompt was set successfully\&. |
| 133 |
.RE |
| 134 |
.SH "EXAMPLES" |
| 135 |
.PP |
| 136 |
Add the following line to |
| 137 |
/etc/pam\&.d/login |
| 138 |
to set the user specific issue at login: |
| 139 |
.sp |
| 140 |
.if n \{\ |
| 141 |
.RS 4 |
| 142 |
.\} |
| 143 |
.nf |
| 144 |
auth optional pam_issue\&.so issue=/etc/issue |
| 145 |
|
| 146 |
.fi |
| 147 |
.if n \{\ |
| 148 |
.RE |
| 149 |
.\} |
| 150 |
.sp |
| 151 |
.SH "SEE ALSO" |
| 152 |
.PP |
| 153 |
\fBpam.conf\fR(5), |
| 154 |
\fBpam.d\fR(5), |
| 155 |
\fBpam\fR(7) |
| 156 |
.SH "AUTHOR" |
| 157 |
.PP |
| 158 |
pam_issue was written by Ben Collins <bcollins@debian\&.org>\&. |