aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Oberhollenzer <david.oberhollenzer@tele2.at>2018-08-28 20:36:29 +0200
committerDavid Oberhollenzer <david.oberhollenzer@tele2.at>2018-08-28 20:55:27 +0200
commitb5c6e9d392b4d8368286f2dd807d668c7213965a (patch)
tree0446627b2d75dc874b532d1bd99d9b86037e97b4
parent0ed964c8a55bbcb94108798e415e31b470789e2a (diff)
Add man page stub for shutdown
Signed-off-by: David Oberhollenzer <david.oberhollenzer@tele2.at>
-rw-r--r--Makefile.am4
-rw-r--r--cmd/Makemodule.am2
-rw-r--r--cmd/shutdown.848
3 files changed, 54 insertions, 0 deletions
diff --git a/Makefile.am b/Makefile.am
index f8d6c04..2b88dcc 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -14,6 +14,8 @@ helperdir = @SCRIPTDIR@
helper_PROGRAMS =
helper_SCRIPTS =
+dist_man8_MANS =
+
include lib/Makemodule.am
include cmd/Makemodule.am
include initd/Makemodule.am
@@ -28,6 +30,8 @@ install-exec-hook:
(cd $(DESTDIR)$(sbindir); $(LN_S) shutdown reboot)
install-data-local:
+ $(MKDIR_P) $(DESTDIR)$(man8dir)
+ (cd $(DESTDIR)$(man8dir); $(LN_S) shutdown.8 reboot.8)
$(MKDIR_P) $(DESTDIR)$(SVCDIR)
$(LN_S) $(TEMPLATEDIR)/loopback $(DESTDIR)$(SVCDIR)/loopback
$(LN_S) $(TEMPLATEDIR)/hostname $(DESTDIR)$(SVCDIR)/hostname
diff --git a/cmd/Makemodule.am b/cmd/Makemodule.am
index ef22284..e68a244 100644
--- a/cmd/Makemodule.am
+++ b/cmd/Makemodule.am
@@ -35,6 +35,8 @@ syslog_LDADD = libinit.a
bin_PROGRAMS += syslog
endif
+dist_man8_MANS += cmd/shutdown.8
+
EXTRA_DIST += $(SRVHEADERS)
sbin_PROGRAMS += service shutdown
diff --git a/cmd/shutdown.8 b/cmd/shutdown.8
new file mode 100644
index 0000000..1e0d921
--- /dev/null
+++ b/cmd/shutdown.8
@@ -0,0 +1,48 @@
+.TH shutdown 8 "August 2018" "Pygos Init"
+.SH NAME
+shutdown \- shutdown or reboot the system
+.SH SYNOPSIS
+.B shutdown
+[options]
+.SH DESCRIPTION
+The shutdown command can notify the init system to shut the system down or to
+reboot the system.
+.PP
+If no option is specified, the default action is to initiate a shutdown.
+.PP
+If invoked as reboot, for instance through a symlink or hard link, the default
+action is to reboot the system.
+.SH OPTIONS
+.TP
+.BR \-h , " \-\-help"
+Display a help text and exit.
+.TP
+.BR \-V , " \-\-version"
+Print version information and exit.
+.TP
+.BR \-p , " \-\-poweroff"
+Do a shutdown and turn the system power off if possible.
+.TP
+.BR \-r , " \-\-reboot"
+Do a system reboot.
+.TP
+.BR \-f , " \-\-force"
+Bypass the init system and directly call the kernel to do a hard
+shutdown or reboot.
+.TP
+.BR \-n , " \-\-no-sync"
+If \-\-force is specified, do not call
+.BR sync (2)
+before bringing the system down.
+.SH AVAILABILITY
+This program is part of the Pygos init system.
+.SH COPYRIGHT
+Copyright \(co 2018 David Oberhollenzer
+.br
+License: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.SH SEE ALSO
+.BR sync (2),
+.BR reboot (2)