diff options
author | David Oberhollenzer <david.oberhollenzer@tele2.at> | 2018-08-22 00:43:11 +0200 |
---|---|---|
committer | David Oberhollenzer <david.oberhollenzer@tele2.at> | 2018-08-28 14:25:28 +0200 |
commit | 0ed964c8a55bbcb94108798e415e31b470789e2a (patch) | |
tree | 42eec0f313a205b2d5365a5541900ecff29ed8a1 /docs/cmdline.md | |
parent | 066efaa33e7641d378ac4d8a1419a525df6f70d2 (diff) |
Cleanup and update documentation
Signed-off-by: David Oberhollenzer <david.oberhollenzer@tele2.at>
Diffstat (limited to 'docs/cmdline.md')
-rw-r--r-- | docs/cmdline.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/cmdline.md b/docs/cmdline.md new file mode 100644 index 0000000..c3945ec --- /dev/null +++ b/docs/cmdline.md @@ -0,0 +1,43 @@ +# Available Command Line Tools + +## The service command + +The `service` utility can be used for control and administration of services. + +It is composed of several sub commands run by issuing +`service <command> [arguments..]`. + +Currently available service commands are: + + * enable - enable a service with the given list of arguments. + * disable - disable a service. If the service is parameterized, requires the + same arguments used for enabling, to disable the specific instance of the + service. + * dumpscript - generate an equivalent shell script from the `exec` lines of + a service after applying all parameter substitutions. + * list - list all enabled service. A target can be specified to only list + services for the specified target. + * help - display a short help text and a list of available commands. + + +## shutdown and reboot + +The programs `shudown` and `reboot` can be used to signal to the `init` program +that it should transition to the `shutdown` or `reboot` target respectively. + +The option `-f` or `--force` can be used to by pass the init system entirely +and force a hard reset or power off by directly signalling the kernel. + +Running any one of those programs requires superuser privileges. + + +## syslog + +If the `usyslogd` service is built as part of this package, a program called +`syslog` is built that can be used from the command line to send syslog +messages. + +This can for instance be used to produce log messages from shell scripts. + +The log level, facility and identity string can be specified. +See `syslog --help` for more information. |