man/sulogin.8.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3    Copyright (c) 1989 - 1992, Julianne Frances Haugh
   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 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
  32   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  33 <!ENTITY ENV_HZ                SYSTEM "login.defs.d/ENV_HZ.xml">
  34 <!ENTITY ENV_TZ                SYSTEM "login.defs.d/ENV_TZ.xml">
  35 ]>
  36 <refentry id='sulogin.8'>
  37   <!--  $Id: sulogin.8.xml 2435 2008-10-11 11:44:43Z nekral-guest $ -->
  38   <refmeta>
  39     <refentrytitle>sulogin</refentrytitle>
  40     <manvolnum>8</manvolnum>
  41     <refmiscinfo class="sectdesc">System Management Commands</refmiscinfo>
  42   </refmeta>
  43   <refnamediv id='name'>
  44     <refname>sulogin</refname>
  45     <refpurpose>Single-user login</refpurpose>
  46   </refnamediv>
  47
  48   <refsect1 id='syntax'>
  49     <title>SYNTAX</title>
  50     <para><command>sulogin</command> [<emphasis remap='I'>tty-device</emphasis>]
  51     </para>
  52   </refsect1>
  53
  54   <refsect1 id='description'>
  55     <title>DESCRIPTION</title>
  56     <para>
  57       The <command>sulogin</command> command is invoked by <command>init</command>
  58       prior to allowing the user access to the system when in single user mode.
  59       This feature may only be available on certain systems where
  60       <command>init</command> has been modified accordingly, or where the
  61       <filename>/etc/inittab</filename> has an entry for a single user
  62       login.
  63     </para>
  64
  65     <para>The user is prompted</para>
  66
  67     <para>Type control-d to proceed with normal startup,
  68       <!-- .br -->
  69       (or give root password for system maintenance):
  70     </para>
  71
  72     <para>
  73       Input and output will be performed with the standard file descriptors
  74       unless the optional device name argument is provided.
  75     </para>
  76
  77     <para>
  78       If the user enters the correct root password, a login session is
  79       initiated. When <emphasis>EOF</emphasis> is pressed instead, the
  80       system enters multi-user mode.
  81     </para>
  82
  83     <para>
  84       After the user exits the single-user shell, or presses
  85       <emphasis>EOF</emphasis>, the system begins the initialization process
  86       required to enter multi-user mode.
  87     </para>
  88   </refsect1>
  89
  90   <refsect1 id='caveats'>
  91     <title>CAVEATS</title>
  92     <para>
  93       This command can only be used if <command>init</command> has been
  94       modified to call <command>sulogin</command> instead of
  95       <filename>/bin/sh</filename>, or if the user has set the <emphasis
  96       remap='I'>inittab</emphasis> to support a single user login. For
  97       example, the line:
  98     </para>
  99
 100     <para>co:s:respawn:/etc/sulogin /dev/console</para>
 101
 102     <para>should execute the sulogin command in single user mode.</para>
 103
 104     <para>
 105       As complete an environment as possible is created. However, various
 106       devices may be unmounted or uninitialized and many of the user
 107       commands may be unavailable or nonfunctional as a result.
 108     </para>
 109   </refsect1>
 110
 111   <refsect1 id='configuration'>
 112     <title>CONFIGURATION</title>
 113     <para>
 114       The following configuration variables in
 115       <filename>/etc/login.defs</filename> change the behavior of this
 116       tool:
 117     </para>
 118     <variablelist>
 119       &ENV_HZ;
 120       &ENV_TZ;
 121     </variablelist>
 122   </refsect1>
 123
 124   <refsect1 id='files'>
 125     <title>FILES</title>
 126     <variablelist>
 127       <varlistentry>
 128         <term><filename>/etc/passwd</filename></term>
 129         <listitem>
 130           <para>User account information.</para>
 131         </listitem>
 132       </varlistentry>
 133       <varlistentry>
 134         <term><filename>/etc/shadow</filename></term>
 135         <listitem>
 136           <para>Secure user account information.</para>
 137         </listitem>
 138       </varlistentry>
 139     </variablelist>
 140   </refsect1>
 141
 142   <refsect1 id='see_also'>
 143     <title>SEE ALSO</title>
 144     <para>
 145       <citerefentry>
 146         <refentrytitle>login</refentrytitle><manvolnum>1</manvolnum>
 147       </citerefentry>,
 148       <citerefentry>
 149         <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 150       </citerefentry>,
 151       <citerefentry>
 152         <refentrytitle>init</refentrytitle><manvolnum>8</manvolnum>
 153       </citerefentry>.
 154     </para>
 155   </refsect1>
 156 </refentry>