diff options
Diffstat (limited to 'modules/pam_umask/pam_umask.8.xml')
| -rw-r--r-- | modules/pam_umask/pam_umask.8.xml | 216 |
1 files changed, 216 insertions, 0 deletions
diff --git a/modules/pam_umask/pam_umask.8.xml b/modules/pam_umask/pam_umask.8.xml new file mode 100644 index 0000000..92693f7 --- /dev/null +++ b/modules/pam_umask/pam_umask.8.xml @@ -0,0 +1,216 @@ +<?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_umask"> + + <refmeta> + <refentrytitle>pam_umask</refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id="pam_umask-name"> + <refname>pam_umask</refname> + <refpurpose>PAM module to set the file mode creation mask</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis id="pam_umask-cmdsynopsis"> + <command>pam_umask.so</command> + <arg choice="opt"> + debug + </arg> + <arg choice="opt"> + silent + </arg> + <arg choice="opt"> + usergroups + </arg> + <arg choice="opt"> + umask=<replaceable>mask</replaceable> + </arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id="pam_umask-description"> + + <title>DESCRIPTION</title> + + <para> + pam_umask is a PAM module to set the file mode creation mask + of the current environment. The umask affects the default + permissions assigned to newly created files. + </para> + <para> + The PAM module tries to get the umask value from the + following places in the following order: + <itemizedlist> + <listitem> + <para> + umask= entry in the user's GECOS field + </para> + </listitem> + <listitem> + <para> + umask= argument + </para> + </listitem> + <listitem> + <para> + UMASK entry from /etc/login.defs + </para> + </listitem> + <listitem> + <para> + UMASK= entry from /etc/default/login + </para> + </listitem> + </itemizedlist> + </para> + <para> + The GECOS field is split on comma ',' characters. The module + also in addition to the umask= entry recognizes pri= entry, + which sets the nice priority value for the session, and + ulimit= entry, which sets the maximum size of files the processes + in the session can create. + </para> + + </refsect1> + + <refsect1 id="pam_umask-options"> + + <title>OPTIONS</title> + <para> + <variablelist> + + <varlistentry> + <term> + <option>debug</option> + </term> + <listitem> + <para> + Print debug information. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>silent</option> + </term> + <listitem> + <para> + Don't print informative messages. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>usergroups</option> + </term> + <listitem> + <para> + If the user is not root and the username is the same as + primary group name, the umask group bits are set to be the + same as owner bits (examples: 022 -> 002, 077 -> 007). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>umask=<replaceable>mask</replaceable></option> + </term> + <listitem> + <para> + Sets the calling process's file mode creation mask (umask) + to <option>mask</option> & 0777. The value is interpreted + as Octal. + </para> + </listitem> + </varlistentry> + + </variablelist> + + </para> + </refsect1> + + <refsect1 id="pam_umask-types"> + <title>MODULE TYPES PROVIDED</title> + <para> + Only the <option>session</option> type is provided. + </para> + </refsect1> + + <refsect1 id='pam_umask-return_values'> + <title>RETURN VALUES</title> + <para> + <variablelist> + + <varlistentry> + <term>PAM_SUCCESS</term> + <listitem> + <para> + The new umask was set successfully. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>PAM_SERVICE_ERR</term> + <listitem> + <para> + No username was given. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>PAM_USER_UNKNOWN</term> + <listitem> + <para> + User not known. + </para> + </listitem> + </varlistentry> + + </variablelist> + </para> + </refsect1> + + <refsect1 id='pam_umask-examples'> + <title>EXAMPLES</title> + <para> + Add the following line to <filename>/etc/pam.d/login</filename> to + set the user specific umask at login: + <programlisting> + session optional pam_umask.so umask=0022 + </programlisting> + </para> + </refsect1> + + <refsect1 id='pam_umask-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_umask-author'> + <title>AUTHOR</title> + <para> + pam_umask was written by Thorsten Kukuk <kukuk@thkukuk.de>. + </para> + </refsect1> + +</refentry> |