shadow/man/nologin.8.xml

<?xml version="1.0" encoding="UTF-8"?>
<refentry id='newusers.8'>
  <!-- $Id: nologin.8.xml,v 1.3 2006/10/28 12:29:04 kloczek Exp $ -->
  <refmeta>
    <refentrytitle>nologin</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class="sectdesc">System Management Commands</refmiscinfo>
  </refmeta>
  <refnamediv id='name'>
    <refname>nologin</refname>
    <refpurpose>politely refuse a login</refpurpose>
  </refnamediv>
  <!-- body begins here -->
  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>nologin</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='description'>
    <title>DESCRIPTION</title>
    <para>
      The <command>nologin</command> command displays a message that an account
      is not available and exits non-zero. It is intended as a replacement shell
      field for accounts that have been disabled.
    </para>
    <para>
      To disable all logins, investigate
      <citerefentry><refentrytitle>nologin</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>.
    </para>
  </refsect1>

  <refsect1 id='see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
	<refentrytitle>login</refentrytitle><manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>nologin</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>.
    </para>
  </refsect1>

  <refsect1 id='history'>
    <title>HYSTORY</title>
    <para>
      The <command>nologin</command> command appeared in BSD 4.4.
    </para>
  </refsect1>
</refentry>