diff options
Diffstat (limited to 'modules/pam_issue/pam_issue.8')
-rw-r--r-- | modules/pam_issue/pam_issue.8 | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/modules/pam_issue/pam_issue.8 b/modules/pam_issue/pam_issue.8 new file mode 100644 index 00000000..467ae26b --- /dev/null +++ b/modules/pam_issue/pam_issue.8 @@ -0,0 +1,98 @@ +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "PAM_ISSUE" "8" "06/01/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +pam_issue \- PAM module to add issue file to user prompt +.SH "SYNOPSIS" +.HP 13 +\fBpam_issue.so\fR [noesc] [issue=\fIissue\-file\-name\fR] +.SH "DESCRIPTION" +.PP +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's (using \\x format). +.PP +Recognized escapes: +.TP +\fI\\d\fR +current day +.TP +\fI\\l\fR +name of this tty +.TP +\fI\\m\fR +machine architecture (uname \-m) +.TP +\fI\\n\fR +machine's network node hostname (uname \-n) +.TP +\fI\\o\fR +domain name of this system +.TP +\fI\\r\fR +release number of operating system (uname \-r) +.TP +\fI\\t\fR +current time +.TP +\fI\\s\fR +operating system name (uname \-s) +.TP +\fI\\u\fR +number of users currently logged in +.TP +\fI\\U\fR +same as \\u except it is suffixed with "user" or "users" (eg. "1 user" or "10 users") +.TP +\fI\\v\fR +operating system version and build date (uname \-v) +.SH "OPTIONS" +.PP +.TP +\fBnoesc\fR +Turns off escape code parsing. +.TP +\fBissue=\fR\fB\fIissue\-file\-name\fR\fR +The file to output if not using the default. +.SH "MODULE SERVICES PROVIDED" +.PP +Only the +\fBauth\fR +service is supported. +.SH "RETURN VALUES" +.PP +.TP +PAM_BUF_ERR +Memory buffer error. +.TP +PAM_IGNORE +The prompt was already changed. +.TP +PAM_SERVICE_ERR +A service module error occured. +.TP +PAM_SUCCESS +The new prompt was set successfull. +.SH "EXAMPLES" +.PP +Add the following line to +\fI/etc/pam.d/login\fR +to set the user specific issue at login: +.sp +.nf + auth optional pam_issue.so issue=/etc/issue + +.fi +.sp +.SH "SEE ALSO" +.PP +\fBpam.conf\fR(5), +\fBpam.d\fR(8), +\fBpam\fR(8) +.SH "AUTHOR" +.PP +pam_issue was written by Ben Collins <bcollins@debian.org>. |