summaryrefslogtreecommitdiffstats
path: root/man/nologin.8.xml
blob: 2fcb0be6e656aa772c9fedc5f160fd8ca3465449 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<?xml version="1.0" encoding="UTF-8"?>
<!--
   SPDX-FileCopyrightText: 1993       , The Regents of the University of California
   SPDX-FileCopyrightText: 2006 - 2008, Nicolas François
   SPDX-License-Identifier: BSD-3-Clause
-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!-- SHADOW-CONFIG-HERE -->
]>
<refentry id='nologin.8'>
  <!-- $Id$ -->
  <refentryinfo>
    <author>
      <firstname>Nicolas</firstname>
      <surname>François</surname>
      <email>nicolas.francois@centraliens.net</email>
      <contrib>shadow-utils maintainer, 2007 - now</contrib>
    </author>
  </refentryinfo>
  <refmeta>
    <refentrytitle>nologin</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class="sectdesc">System Management Commands</refmiscinfo>
    <refmiscinfo class="source">shadow-utils</refmiscinfo>
    <refmiscinfo class="version">&SHADOW_UTILS_VERSION;</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>
    <para>
      If <command>SSH_ORIGINAL_COMMAND</command> is populated it will be logged.
    </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>HISTORY</title>
    <para>
      The <command>nologin</command> command appeared in BSD 4.4.
    </para>
  </refsect1>
</refentry>