diff options
Diffstat (limited to '')
| -rw-r--r-- | modules/pam_issue/pam_issue.8 | 158 | ||||
| -rw-r--r-- | modules/pam_issue/pam_issue.8.xml | 234 |
2 files changed, 392 insertions, 0 deletions
diff --git a/modules/pam_issue/pam_issue.8 b/modules/pam_issue/pam_issue.8 new file mode 100644 index 0000000..abe2585 --- /dev/null +++ b/modules/pam_issue/pam_issue.8 @@ -0,0 +1,158 @@ +'\" t +.\" Title: pam_issue +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 06/08/2020 +.\" Manual: Linux-PAM Manual +.\" Source: Linux-PAM Manual +.\" Language: English +.\" +.TH "PAM_ISSUE" "8" "06/08/2020" "Linux-PAM Manual" "Linux\-PAM Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +pam_issue \- PAM module to add issue file to user prompt +.SH "SYNOPSIS" +.HP \w'\fBpam_issue\&.so\fR\ 'u +\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\*(Aqs (using \ex format)\&. +.PP +Recognized escapes: +.PP +\fB\ed\fR +.RS 4 +current day +.RE +.PP +\fB\el\fR +.RS 4 +name of this tty +.RE +.PP +\fB\em\fR +.RS 4 +machine architecture (uname \-m) +.RE +.PP +\fB\en\fR +.RS 4 +machine\*(Aqs network node hostname (uname \-n) +.RE +.PP +\fB\eo\fR +.RS 4 +domain name of this system +.RE +.PP +\fB\er\fR +.RS 4 +release number of operating system (uname \-r) +.RE +.PP +\fB\et\fR +.RS 4 +current time +.RE +.PP +\fB\es\fR +.RS 4 +operating system name (uname \-s) +.RE +.PP +\fB\eu\fR +.RS 4 +number of users currently logged in +.RE +.PP +\fB\eU\fR +.RS 4 +same as \eu except it is suffixed with "user" or "users" (eg\&. "1 user" or "10 users") +.RE +.PP +\fB\ev\fR +.RS 4 +operating system version and build date (uname \-v) +.RE +.SH "OPTIONS" +.PP +.PP +\fBnoesc\fR +.RS 4 +Turns off escape code parsing\&. +.RE +.PP +\fBissue=\fR\fB\fIissue\-file\-name\fR\fR +.RS 4 +The file to output if not using the default\&. +.RE +.SH "MODULE TYPES PROVIDED" +.PP +Only the +\fBauth\fR +module type is provided\&. +.SH "RETURN VALUES" +.PP +.PP +PAM_BUF_ERR +.RS 4 +Memory buffer error\&. +.RE +.PP +PAM_IGNORE +.RS 4 +The prompt was already changed\&. +.RE +.PP +PAM_SERVICE_ERR +.RS 4 +A service module error occurred\&. +.RE +.PP +PAM_SUCCESS +.RS 4 +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: +.sp +.if n \{\ +.RS 4 +.\} +.nf + auth optional pam_issue\&.so issue=/etc/issue + +.fi +.if n \{\ +.RE +.\} +.sp +.SH "SEE ALSO" +.PP +\fBpam.conf\fR(5), +\fBpam.d\fR(5), +\fBpam\fR(8) +.SH "AUTHOR" +.PP +pam_issue was written by Ben Collins <bcollins@debian\&.org>\&. diff --git a/modules/pam_issue/pam_issue.8.xml b/modules/pam_issue/pam_issue.8.xml new file mode 100644 index 0000000..fb9b737 --- /dev/null +++ b/modules/pam_issue/pam_issue.8.xml @@ -0,0 +1,234 @@ +<?xml version="1.0" encoding='UTF-8'?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> + +<refentry id="pam_issue"> + + <refmeta> + <refentrytitle>pam_issue</refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id="pam_issue-name"> + <refname>pam_issue</refname> + <refpurpose>PAM module to add issue file to user prompt</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis id="pam_issue-cmdsynopsis"> + <command>pam_issue.so</command> + <arg choice="opt"> + noesc + </arg> + <arg choice="opt"> + issue=<replaceable>issue-file-name</replaceable> + </arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id="pam_issue-description"> + + <title>DESCRIPTION</title> + + <para> + 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). + </para> + <para> + Recognized escapes: + </para> + <variablelist> + <varlistentry> + <term><emphasis remap='B'>\d</emphasis></term> + <listitem> + <para>current day</para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis remap='B'>\l</emphasis></term> + <listitem> + <para>name of this tty</para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis remap='B'>\m</emphasis></term> + <listitem> + <para>machine architecture (uname -m)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis remap='B'>\n</emphasis></term> + <listitem> + <para>machine's network node hostname (uname -n)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis remap='B'>\o</emphasis></term> + <listitem> + <para>domain name of this system</para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis remap='B'>\r</emphasis></term> + <listitem> + <para>release number of operating system (uname -r)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis remap='B'>\t</emphasis></term> + <listitem> + <para>current time</para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis remap='B'>\s</emphasis></term> + <listitem> + <para>operating system name (uname -s)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis remap='B'>\u</emphasis></term> + <listitem> + <para>number of users currently logged in</para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis remap='B'>\U</emphasis></term> + <listitem> + <para> + same as \u except it is suffixed with "user" or + "users" (eg. "1 user" or "10 users") + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis remap='B'>\v</emphasis></term> + <listitem> + <para>operating system version and build date (uname -v)</para> + </listitem> + </varlistentry> + </variablelist> + + </refsect1> + + <refsect1 id="pam_issue-options"> + + <title>OPTIONS</title> + <para> + <variablelist> + + <varlistentry> + <term> + <option>noesc</option> + </term> + <listitem> + <para> + Turns off escape code parsing. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>issue=<replaceable>issue-file-name</replaceable></option> + </term> + <listitem> + <para> + The file to output if not using the default. + </para> + </listitem> + </varlistentry> + + </variablelist> + + </para> + </refsect1> + + <refsect1 id="pam_issue-types"> + <title>MODULE TYPES PROVIDED</title> + <para> + Only the <option>auth</option> module type is provided. + </para> + </refsect1> + + <refsect1 id='pam_issue-return_values'> + <title>RETURN VALUES</title> + <para> + <variablelist> + + <varlistentry> + <term>PAM_BUF_ERR</term> + <listitem> + <para> + Memory buffer error. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>PAM_IGNORE</term> + <listitem> + <para> + The prompt was already changed. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>PAM_SERVICE_ERR</term> + <listitem> + <para> + A service module error occurred. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>PAM_SUCCESS</term> + <listitem> + <para> + The new prompt was set successfully. + </para> + </listitem> + </varlistentry> + + </variablelist> + </para> + </refsect1> + + <refsect1 id='pam_issue-examples'> + <title>EXAMPLES</title> + <para> + Add the following line to <filename>/etc/pam.d/login</filename> to + set the user specific issue at login: + <programlisting> + auth optional pam_issue.so issue=/etc/issue + </programlisting> + </para> + </refsect1> + + <refsect1 id='pam_issue-see_also'> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> + + <refsect1 id='pam_issue-author'> + <title>AUTHOR</title> + <para> + pam_issue was written by Ben Collins <bcollins@debian.org>. + </para> + </refsect1> + +</refentry> |