From f39aba8aa382eecc0021485e03760e6713558fc8 Mon Sep 17 00:00:00 2001 From: David Oberhollenzer Date: Fri, 31 Aug 2018 14:52:26 +0200 Subject: [PATCH] Add man page for service command Signed-off-by: David Oberhollenzer --- cmd/Makemodule.am | 2 +- cmd/service/service.8 | 53 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 cmd/service/service.8 diff --git a/cmd/Makemodule.am b/cmd/Makemodule.am index 7e5bab7..492057b 100644 --- a/cmd/Makemodule.am +++ b/cmd/Makemodule.am @@ -36,7 +36,7 @@ bin_PROGRAMS += syslog dist_man1_MANS += cmd/syslog.1 endif -dist_man8_MANS += cmd/shutdown.8 +dist_man8_MANS += cmd/shutdown.8 cmd/service/service.8 EXTRA_DIST += $(SRVHEADERS) diff --git a/cmd/service/service.8 b/cmd/service/service.8 new file mode 100644 index 0000000..6465db6 --- /dev/null +++ b/cmd/service/service.8 @@ -0,0 +1,53 @@ +.TH service 8 "August 2018" "Pygos Init" +.SH NAME +service \- configure or administrate system services +.SH SYNOPSIS +.B service + +[options] +.SH DESCRIPTION +The service command can be used to configure, control and administrate services +supervised by the init daemon. +.SH COMMANDS +.TP +.BR help " " \fI[command]\fP +If no arguments are provided, displays a short help text and a list of all +available commands with a short description for each. + +If a command name is specified, displays a more elaborate description and +usage information for the specified command. +.TP +.BR list " " \fI[target]\fP +Displays a list of currently enabled services. If an optional target is +specified, lists services only for this target, otherwise, list services +for all targets. +.TP +.BR enable " " \fI\fP " " \fI[arguments]\fP +Enable (but do not start) a system service by creating a symlink in the +configuration directory, pointing to the service template file. + +An optional argument can be supplied to parameterize the template. +.TP +.BR disable " " \fI\fP " " \fI[arguments]\fP +Disable (but do not stop) a system service by removing the corresponding +symlink in the configuration directory. + +If the service is parameterized, arguments have to be specified to disable +the desired service instance. +.TP +.BR dumpscript " " \fI\fP " " \fI[arguments]\fP + +Parse a service file from and produce a pseudo shell script containing the +exact commands executed when starting the service. +.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 . +.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)