shadow/man/login.defs.d/MAIL_DIR.xml
Serge Hallyn f93cf255d4 Update licensing info
Closes #238

Update all files to list SPDX license shortname.  Most files are
BSD 3 clause license.

The exceptions are:

serge@sl ~/src/shadow$ git grep SPDX-License | grep -v BSD-3-Clause
contrib/atudel:# SPDX-License-Identifier: BSD-4-Clause
lib/tcbfuncs.c: * SPDX-License-Identifier: 0BSD
libmisc/salt.c: * SPDX-License-Identifier: Unlicense
src/login_nopam.c: * SPDX-License-Identifier: Unlicense
src/nologin.c: * SPDX-License-Identifier: BSD-2-Clause
src/vipw.c: * SPDX-License-Identifier: GPL-2.0-or-later

Signed-off-by: Serge Hallyn <serge@hallyn.com>
2021-12-23 19:36:50 -06:00

39 lines
1.4 KiB
XML

<!--
SPDX-FileCopyrightText: 1991 - 1993, Julianne Frances Haugh
SPDX-FileCopyrightText: 1991 - 1993, Chip Rosenthal
SPDX-FileCopyrightText: 2007 - 2008, Nicolas François
SPDX-License-Identifier: BSD-3-Clause
-->
<varlistentry>
<term><option>MAIL_DIR</option> (string)</term>
<listitem>
<para>
The mail spool directory. This is needed to manipulate the mailbox
when its corresponding user account is modified or deleted. If not
specified, a compile-time default is used.
The parameter CREATE_MAIL_SPOOL in <filename>/etc/default/useradd</filename>
determines whether the mail spool should be created.
</para>
</listitem>
</varlistentry><varlistentry>
<term><option>MAIL_FILE</option> (string)</term>
<listitem>
<para>
Defines the location of the users mail spool files relatively to
their home directory.
</para>
</listitem>
</varlistentry>
<!-- FIXME: MAIL_FILE not used in useradd -->
<para>
The <option>MAIL_DIR</option> and <option>MAIL_FILE</option> variables
are used by <command>useradd</command>, <command>usermod</command>, and
<command>userdel</command> to create, move, or delete the user's mail
spool.
</para>
<para condition="no_pam">
If <option>MAIL_CHECK_ENAB</option> is set to
<replaceable>yes</replaceable>, they are also used to define the
<envar>MAIL</envar> environment variable.
</para>