xref: /freebsd/usr.sbin/nologin/nologin.8 (revision 57b9e06a3aae88b14d2c3e22c03b2636b73d2146)
1.\" Copyright (c) 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)nologin.8	8.1 (Berkeley) 6/19/93
29.\" $FreeBSD$
30.\"
31.Dd April 15, 2020
32.Dt NOLOGIN 8
33.Os
34.Sh NAME
35.Nm nologin
36.Nd politely refuse a login
37.Sh SYNOPSIS
38.Nm
39.Sh DESCRIPTION
40The
41.Nm
42is intended as a replacement shell field for accounts that
43have been disabled.
44.Pp
45When executed,
46.Nm
47first writes about the login attempt to
48.Xr syslog 3
49and then displays a message that an account is not available.
50.Pp
51To disable all logins,
52investigate
53.Xr nologin 5 .
54.Sh EXIT STATUS
55The
56.Nm
57utility always exits non-zero.
58.Sh EXAMPLES
59Here is a demonstration of executing
60.Nm :
61.Bd -literal -offset 4n
62$ nologin
63This account is currently not available.
64$ tail -n 1 /var/log/messages
65Mar 30 21:53:07 example.org nologin[65992]: Attempted login by beastie on /dev/pts/18
66.Ed
67.Sh SEE ALSO
68.Xr login 1 ,
69.Xr nologin 5
70.Sh HISTORY
71The
72.Nm
73utility appeared in
74.Bx 4.4 .
75