PAM_ISSUE(8)

  .SH "NAME" pam_issue - PAM module to add issue file to user prompt
  .SH "SYNOPSIS"
    .HP u
      pam_issue.so
       [noesc]
       [issue=issue-file-name]

  .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:

      .PP \d

              current day

          .RE
          .PP \l

                  name of this tty

              .RE
              .PP \m

                      machine architecture (uname -m)

                  .RE
                  .PP \n

                          machine's network node hostname (uname -n)

                      .RE
                      .PP \o

                              domain name of this system

                          .RE
                          .PP \r

                                  release number of operating system (uname -r)

                              .RE
                              .PP \t

                                      current time

                                  .RE
                                  .PP \s

                                          operating system name (uname -s)

                                      .RE
                                      .PP \u

                                              number of users currently logged in

                                          .RE
                                          .PP \U

                                                  same as \u except it is suffixed with "user" or "users" (eg. "1 user" or "10 users")

                                              .RE
                                              .PP \v

                                                      operating system version and build date (uname -v)

                                                  .RE

                                              .SH "OPTIONS"

                                                .PP
                                                    .PP noesc

                                                            Turns off escape code parsing.

                                                        .RE
                                                        .PP issue=issue-file-name

                                                                The file to output if not using the default.

                                                        .RE

                                                      .SH "MODULE TYPES PROVIDED"

                                                        .PP Only the auth module type is provided.

                                                      .SH "RETURN VALUES"

                                                        .PP
                                                            .PP PAM_BUF_ERR

                                                                     Memory buffer error.

                                                                .RE
                                                                .PP PAM_IGNORE

                                                                        The prompt was already changed.

                                                                    .RE
                                                                    .PP PAM_SERVICE_ERR

                                                                            A service module error occurred.

                                                                        .RE
                                                                        .PP PAM_SUCCESS

                                                                                The new prompt was set successfully.

                                                                            .RE

                                                                      .SH "EXAMPLES"

                                                                        .PP Add the following line to /etc/pam.d/login to set the user specific issue at login:

                                                                                auth optional pam_issue.so issue=/etc/issue

                                                                      .SH "SEE ALSO"

                                                                        .PP pam.conf(5), pam.d(5), pam(8)

                                                                      .SH "AUTHOR"

                                                                          .PP pam_issue was written by Ben Collins <bcollins@debian.org>.