man/login.defs.d/ENV_HZ.xml

   1 <!--
   2    Copyright (c) 1991 - 1993, Julianne Frances Haugh
   3    Copyright (c) 1991 - 1993, Chip Rosenthal
   4    Copyright (c) 2007 - 2008, Nicolas François
   5    All rights reserved.
   6
   7    Redistribution and use in source and binary forms, with or without
   8    modification, are permitted provided that the following conditions
   9    are met:
  10    1. Redistributions of source code must retain the above copyright
  11       notice, this list of conditions and the following disclaimer.
  12    2. Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in the
  14       documentation and/or other materials provided with the distribution.
  15    3. The name of the copyright holders or contributors may not be used to
  16       endorse or promote products derived from this software without
  17       specific prior written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  22    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
  23    HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 -->
  31 <varlistentry>
  32   <!-- XXX: When compiled with PAM support, only sulogin uses ENV_HZ -->
  33   <term><option>ENV_HZ</option> (string)</term>
  34   <listitem>
  35     <para>
  36       If set, it will be used to define the HZ environment variable when
  37       a user login. The value must be preceded by
  38       <replaceable>HZ=</replaceable>. A common value on Linux is
  39       <replaceable>HZ=100</replaceable>.
  40     </para>
  41     <para condition="pam">
  42       The <envar>HZ</envar> environment variable is only set when the user
  43       (the superuser) logs in with <command>sulogin</command>.
  44     </para>
  45     <!-- TODO: it can in fact be used to set any other variable-->
  46   </listitem>
  47 </varlistentry>