share/man/man5/nologin.5

   1 .\"     $NetBSD: nologin.5,v 1.1 2005/12/09 17:02:53 ginsbach Exp $
   2 .\"
   3 .\" Copyright (c) 2005 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This document is derived from works contributed to The NetBSD Foundation
   7 .\" by Brian Ginsbach.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd December 9, 2005
  31 .Dt NOLOGIN 5
  32 .Os
  33 .Sh NAME
  34 .Nm nologin
  35 .Nd file disallowing and containing reason for disallowing logins
  36 .Sh DESCRIPTION
  37 The file
  38 .Pa /etc/nologin ,
  39 if it exists, causes the login procedure, used by programs such as
  40 .Xr login 1 ,
  41 to terminate.
  42 The program may display the contents of
  43 .Pa /etc/nologin
  44 to the user before exiting.
  45 .Pp
  46 This file is a simple mechanism to temporarily prevent incoming logins.
  47 As such,
  48 the file
  49 .Pa /etc/nologin
  50 is created by
  51 .Xr shutdown 8
  52 five minutes before system shutdown,
  53 or immediately if shutdown is in less than five minutes.
  54 The file
  55 .Pa /etc/nologin
  56 is removed just before
  57 .Xr shutdown 8
  58 exits.
  59 .Pp
  60 To disable logins on a per-account basis,
  61 see
  62 .Xr nologin 8 .
  63 .Pp
  64 The file
  65 .Pa /etc/nologin
  66 has no affect on the login procedure for the root user.
  67 .Sh FILES
  68 .Bl -tag -width /etc/nologin -compact
  69 .It Pa /etc/nologin
  70 The
  71 .Nm
  72 file resides in
  73 .Pa /etc .
  74 .El
  75 .Sh EXAMPLES
  76 .Bd -literal
  77 NO LOGINS: System going down at 18:22
  78 .Ed
  79 .Sh SEE ALSO
  80 .Xr login 1 ,
  81 .Xr ftpd 8 ,
  82 .Xr nologin 8 ,
  83 .Xr rshd 8 ,
  84 .Xr shutdown 8 ,
  85 .Xr sshd 8