summaryrefslogtreecommitdiffstats
path: root/man/login.defs.d/ENV_HZ.xml
blob: daf1752fcc6e46e122530fea2a2c0e3196d44545 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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>