1PAM_ISSUE(8)                   Linux-PAM Manual                   PAM_ISSUE(8)
2
3
4

NAME

6       pam_issue - PAM module to add issue file to user prompt
7

SYNOPSIS

9       pam_issue.so [noesc] [issue=issue-file-name]
10

DESCRIPTION

12       pam_issue is a PAM module to prepend an issue file to the username
13       prompt. It also by default parses escape codes in the issue file
14       similar to some common getty's (using \x format).
15
16       Recognized escapes:
17
18       \d
19           current day
20
21       \l
22           name of this tty
23
24       \m
25           machine architecture (uname -m)
26
27       \n
28           machine's network node hostname (uname -n)
29
30       \o
31           domain name of this system
32
33       \r
34           release number of operating system (uname -r)
35
36       \t
37           current time
38
39       \s
40           operating system name (uname -s)
41
42       \u
43           number of users currently logged in
44
45       \U
46           same as \u except it is suffixed with "user" or "users" (eg. "1
47           user" or "10 users")
48
49       \v
50           operating system version and build date (uname -v)
51

OPTIONS

53       noesc
54           Turns off escape code parsing.
55
56       issue=issue-file-name
57           The file to output if not using the default.
58

MODULE TYPES PROVIDED

60       Only the auth module type is provided.
61

RETURN VALUES

63       PAM_BUF_ERR
64           Memory buffer error.
65
66       PAM_IGNORE
67           The prompt was already changed.
68
69       PAM_SERVICE_ERR
70           A service module error occurred.
71
72       PAM_SUCCESS
73           The new prompt was set successfully.
74

EXAMPLES

76       Add the following line to /etc/pam.d/login to set the user specific
77       issue at login:
78
79                   auth optional pam_issue.so issue=/etc/issue
80
81
82

SEE ALSO

84       pam.conf(5), pam.d(5), pam(8)
85

AUTHOR

87       pam_issue was written by Ben Collins <bcollins@debian.org>.
88
89
90
91Linux-PAM                         05/07/2023                      PAM_ISSUE(8)
Impressum