xref: /freebsd/usr.sbin/nologin/nologin.8 (revision 8a7b61203704d362cfbc66c00619f51b24106b55)
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.Dd April 15, 2020
29.Dt NOLOGIN 8
30.Os
31.Sh NAME
32.Nm nologin
33.Nd politely refuse a login
34.Sh SYNOPSIS
35.Nm
36.Sh DESCRIPTION
37The
38.Nm
39is intended as a replacement shell field for accounts that
40have been disabled.
41.Pp
42When executed,
43.Nm
44first writes about the login attempt to
45.Xr syslog 3
46and then displays a message that an account is not available.
47.Pp
48To disable all logins,
49investigate
50.Xr nologin 5 .
51.Sh EXIT STATUS
52The
53.Nm
54utility always exits non-zero.
55.Sh EXAMPLES
56Here is a demonstration of executing
57.Nm :
58.Bd -literal -offset 4n
59$ nologin
60This account is currently not available.
61$ tail -n 1 /var/log/messages
62Mar 30 21:53:07 example.org nologin[65992]: Attempted login by beastie on /dev/pts/18
63.Ed
64.Sh SEE ALSO
65.Xr login 1 ,
66.Xr nologin 5
67.Sh HISTORY
68The
69.Nm
70utility appeared in
71.Bx 4.4 .
72