diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-06 01:38:36 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-06 01:38:36 +0000 |
| commit | 26367bfc399cb3862f94ddca8fce87f98f26d67e (patch) | |
| tree | ba3a4e02ed5ec62fe645dfa810c01d26decf591f /modules/pam_issue/pam_issue.8.xml | |
| parent | Initial commit. (diff) | |
| download | pam-a7f3bfc067e4a5009e7c3c294dd7ebca479a0085.tar.xz pam-a7f3bfc067e4a5009e7c3c294dd7ebca479a0085.zip | |
Adding upstream version 1.3.1.upstream/1.3.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'modules/pam_issue/pam_issue.8.xml')
| -rw-r--r-- | modules/pam_issue/pam_issue.8.xml | 234 |
1 files changed, 234 insertions, 0 deletions
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> |