Generate man pages with m4.
[oweals/dinit.git] / doc / manpages / shutdown.8.m4
1 changequote(`@@@',`$$$')dnl
2 @@@.TH SHUTDOWN "8" "$$$MONTH YEAR@@@" "Dinit $$$VERSION@@@" "Dinit \- service management system"
3 .SH NAME
4 shutdown, halt, reboot \- system shutdown 
5 .\"
6 .SH SYNOPSIS
7 .\"
8 .B shutdown
9 [\fB\-r\fR|\fB\-h\fR|\fB\-p\fR] [\fB\-\-use\-passed\-cfd\fR]
10 [\fB\-\-system\fR]
11 .br
12 \fBhalt\fR [\fIoptions...\fR]
13 .br
14 \fBreboot\fR [\fIoptions...\fR]
15 .\"
16 .SH DESCRIPTION
17 .\"
18 This manual page is for the shutdown utility included with the \fBDinit\fR
19 service manager package. See \fBdinit\fR(8).
20
21 The shutdown, reboot and halt commands can be used to instruct the service
22 manager daemon to perform a service rollback and then to shutdown the
23 system. They can also perform shutdown directly, without service rollback.
24
25 Note that for consistency with other packages a "halt" alias is provided,
26 however it has no special significance. Note that the default action is to
27 power down the system.
28 .\"
29 .SH OPTIONS
30 .TP
31 \fB\-r\fP
32 Request a shutdown followed by restart. This is the default if executed as
33 \fBreboot\fR.
34 .TP
35 \fB\-h\fP
36 Shutdown and then halt the system (without powering down).
37 .TP
38 \fB\-p\fP
39 Shutdown and then power down the system. This is the default unless executed
40 as \fBreboot\fR.
41 .TP
42 \fB\-\-use\-passed\-cfd\fR
43 Instead of attempting to open a socket connection to the service daemon,
44 use a pre-opened connection that has been passed to the process from its parent
45 via an open file descriptor. The file descriptor with the connection is identifed
46 by the DINIT_CS_FD environment variable.
47 .TP
48 \fB\-\-system\fR
49 Shut down directly, instead of by issuing a command to the service manager. Use of
50 this option should be avoided, but it may allow performing a clean shutdown in case
51 the service manager has stopped responding.
52
53 The service manager may invoke \fBshutdown\fR with this option in order to perform
54 system shutdown after it has rolled back services.
55 .\"
56 .SH SEE ALSO
57 .\"
58 \fBdinit\fR(8), \fBdinitctl\fR(8)
59 .\"
60 .SH AUTHOR
61 Dinit, and this manual, were written by Davin McCall.
62 $$$dnl