summaryrefslogtreecommitdiffstats
path: root/man/login.defs.d/ENV_HZ.xml
diff options
context:
space:
mode:
Diffstat (limited to 'man/login.defs.d/ENV_HZ.xml')
-rw-r--r--man/login.defs.d/ENV_HZ.xml23
1 files changed, 23 insertions, 0 deletions
diff --git a/man/login.defs.d/ENV_HZ.xml b/man/login.defs.d/ENV_HZ.xml
new file mode 100644
index 0000000..daf1752
--- /dev/null
+++ b/man/login.defs.d/ENV_HZ.xml
@@ -0,0 +1,23 @@
+<!--
+ 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>
+ <!-- XXX: When compiled with PAM support, only sulogin uses ENV_HZ -->
+ <term><option>ENV_HZ</option> (string)</term>
+ <listitem>
+ <para>
+ If set, it will be used to define the HZ environment variable when
+ a user login. The value must be preceded by
+ <replaceable>HZ=</replaceable>. A common value on Linux is
+ <replaceable>HZ=100</replaceable>.
+ </para>
+ <para condition="pam">
+ The <envar>HZ</envar> environment variable is only set when the user
+ (the superuser) logs in with <command>sulogin</command>.
+ </para>
+ <!-- TODO: it can in fact be used to set any other variable-->
+ </listitem>
+</varlistentry>