From a24e60da51aada47146e1b3f4fe08e5ca74c7584 Mon Sep 17 00:00:00 2001 From: obarun <eric@obarun.org> Date: Mon, 4 Dec 2023 21:33:57 +1100 Subject: [PATCH] reorganize list of doc --- doc/66.md | 35 ++++++++++++++++++++++------------- doc/index.md | 12 ++++++------ 2 files changed, 28 insertions(+), 19 deletions(-) diff --git a/doc/66.md b/doc/66.md index 9c259e0e..c9ebde8b 100644 --- a/doc/66.md +++ b/doc/66.md @@ -9,7 +9,7 @@ author: Eric Vidal <eric@obarun.org> # 66 -Tool to control the state of the system and service manager. +Program to control the state of the system and service manager. ## Interface @@ -43,24 +43,33 @@ These options are available all commands except the `-t` options. In such cases, ## Commands +### Debug command + +- [parse](parse.html): parse the service frontend file. +- [resolve](resolve.html): display the service's resolve file contents. +- [state](state.html): display service's state file contents. + +### Admin command + +- [boot](boot.html): boot the system. +- [scandir](scandir.html): manage scandir. +- [init](init.html): initiate service of a tree. +- [signal](signal.html): send a signal to services. + +### User command + - [start](start.html): bring up services. - [stop](stop.html): bring down services. -- [reload](reload.html): send a SIGHUP signal to services. -- [restart](restart.html): bring down then bring up services. -- [free](free.html): bring down services and remove it from scandir. -- [reconfigure](reconfigure.html): bring down, unsupervise, parse it again and bring up service. - [enable](enable.html): activate services for the next boot. - [disable](disable.html): deactivate services for the next boot. -- [configure](configure.html): manage service environment variables. +- [reload](reload.html): send a SIGHUP signal to services. +- [restart](restart.html): bring down then bring up services. - [status](status.html): display service information. -- [resolve](resolve.html): display the service's resolve file contents. -- [state](state.html): display service's state file contents. +- [configure](configure.html): manage service environment variables. +- [reconfigure](reconfigure.html): bring down, unsupervise, parse it again and bring up service. - [remove](remove.html): remove service and cleanup all files belong to it within the system. -- [signal](signal.html): send a signal to services. +- [free](free.html): bring down services and remove it from scandir. - [tree](tree.html): manage or see information of trees. -- [parse](parse.html): parse the service frontend file. -- [scandir](scandir.html): manage scandir. -- [boot](boot.html): boot the system. - [poweroff](poweroff.html): poweroff the system. - [reboot](reboot.html): reboot the system. - [halt](halt.html): halt the system. @@ -92,4 +101,4 @@ Any dependency or required-by dependency of a service or a tree chain will be au For instance, during the `stop` command, if the `FooA` service has a declared required-by dependency on `FooB`, `FooB` will be considered and automatically stopped first when `FooA` is stopped. This process will run recursively until all required-by dependencies are stopped. -This applies to all `66` commands when it's necessary. \ No newline at end of file +This applies to all `66` commands when it's necessary. diff --git a/doc/index.md b/doc/index.md index c43c9f1c..2975eb8a 100644 --- a/doc/index.md +++ b/doc/index.md @@ -12,13 +12,12 @@ Sixty-six is a service manager built around [s6](https://skarnet.org/software/s6 Examples of what can be achieved by assembling different programs provided by *66*: - Frontend service files declaration. - - Easy creation of a scandir. - Nested supervision tree. - Instance service file creation. - Multiple directories service file declaration(packager,sysadmin,user). - Easy change of service configuration. -- Automatic logger creation. +- Automatic logger creation even for oneshot service. - Service Notification. - Organizes services as a tree. - Easy view of service status. @@ -46,20 +45,20 @@ See [changes](upgrade.html) between version. ## Commands -### Debug tools +### Debug command -- [parser](parser.html) +- [parse](parse.html) - [resolve](resolve.html) - [state](state.html) -### Admin tools +### Admin command - [boot](boot.html) - [scandir](scandir.html) - [init](init.html) - [signal](signal.html) -### User tools +### User command - [start](start.html) - [stop](stop.html) @@ -76,6 +75,7 @@ See [changes](upgrade.html) between version. - [poweroff](poweroff.html) - [reboot](reboot.html) - [halt](halt.html) +- [version](version.html) ### Extra tools -- GitLab