manual page distributed with 4.1BSD

SCCS-vsn: sbin/shutdown/shutdown.8 4.1

diff --git a/usr/src/sbin/shutdown/shutdown.8 b/usr/src/sbin/shutdown/shutdown.8
new file mode 100644 (file)
index 0000000..3395637
--- /dev/null
+++ b/usr/src/sbin/shutdown/shutdown.8
@@ -0,0 +1,96 @@
+.\" Copyright (c) 1980 Regents of the University of California.
+.\" All rights reserved.  The Berkeley software License Agreement
+.\" specifies the terms and conditions for redistribution.
+.\"
+.\"    @(#)shutdown.8  4.1 (Berkeley) %G%
+.\"
+.TH SHUTDOWN 8 4/1/81
+.UC 4
+.SH NAME
+shutdown \- close down the system at a given time
+.SH SYNOPSIS
+.B /etc/shutdown
+[
+.B \-k
+] [
+.B \-r
+] [
+.B \-h
+]
+time [ warning-message ... ]
+.SH DESCRIPTION
+.I Shutdown
+provides an automated shutdown procedure which a super-user
+can use to notify users
+nicely when the system is shutting down, saving them from
+system administrators, hackers, and gurus, who would otherwise
+not bother with niceties.
+.LP
+.I Time
+is the time at which
+.I shutdown
+will bring the system down and
+may take two formats:
+.BR + number
+and
+.RB hour : min.
+The first form brings the system down in
+.I number
+minutes
+and the second brings the system down at the time of day indicated
+(as a 24\-hour clock).
+.PP
+At intervals which get closer together as apocalypse approaches,
+warning messages are displayed at the terminals of all users on the
+system.  Five minutes before shutdown, or immediately if
+shutdown is in less than 5 minutes, logins are disabled by
+creating
+/etc/nologin
+and writing a message there.
+If this file exists when a user logs in,
+.IR login (1)
+prints its contents
+and exits.
+The file is removed just before
+.I shutdown
+exits.
+.PP
+At shutdown time a
+message is written in the file /usr/adm/shutdownlog, containing the
+time of shutdown, who ran shutdown and the reason.
+Then a terminate signal is sent at
+.I init
+to bring the system down to single-user state.
+Alternatively, if
+.B -r,
+.B -h,
+or
+.B -k
+was used, then
+.I shutdown
+will exec
+.IR reboot (8),
+.IR halt (8),
+or avoid shutting the system down (respectively).
+(If it isn't obvious,
+.B \-k
+is to make people
+.I think
+the system is going down!)
+.PP
+The time of the shutdown and the warning message
+are placed in /etc/nologin and should be used to
+inform the users about when the system will be back up
+and why it is going down (or anything else).
+.SH FILES
+.DT
+/etc/nologin   tells login not to let anyone log in
+.br
+/usr/adm/shutdownlog   log file for succesful shutdowns.
+.SH "SEE ALSO"
+login(1), reboot(8)
+.SH BUGS
+Only allows you to kill the system between now and 23:59 if
+you use the absolute time for shutdown.
+.PP
+Times to shutdown are not nice and round, i.e. ``shutdown in 18 seconds''.