From f71168a231698372bc65260fa050b000e282ab4b Mon Sep 17 00:00:00 2001 From: obarun <eric@obarun.org> Date: Tue, 5 Dec 2023 00:24:12 +1100 Subject: [PATCH] provide reconfigure, reload and restart docs --- doc/reconfigure.md | 46 +++++++++++++++++++++++++++++++++++++++++++ doc/reload.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++ doc/restart.md | 46 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 141 insertions(+) create mode 100644 doc/reconfigure.md create mode 100644 doc/reload.md create mode 100644 doc/restart.md diff --git a/doc/reconfigure.md b/doc/reconfigure.md new file mode 100644 index 00000000..c93dcea1 --- /dev/null +++ b/doc/reconfigure.md @@ -0,0 +1,46 @@ +title: The 66 Suite: reconfigure +author: Eric Vidal <eric@obarun.org> + +[66](index.html) + +[Software](https://web.obarun.org/software) + +[obarun.org](https://web.obarun.org) + +# reconfigure + +This command bring down, unsupervise, parse again and bring up service. + +## Interface + +``` +reconfigure [ -h ] [ -P ] service +``` + +This command is a convenient way to execute the [stop](stop.html), [free](free.html), [parse](parse.html), and [start](start.html) commands simultaneously. It's used when you modify a *service*'s frontend file and want to apply the modifications. + +If the *service* is running, it is stopped and then unsupervised. Afterward, the *service* is parsed again and restarted. If the *service* isn't running, only the parse process is executed. + +For `module` *service* types, the same process is applied to all services within the *module*. If the module is part of a tree associated with the boot [group](tree.html#groups-behavior), only the parse process is executed to avoid interrupting the boot sequence. The changes will be applied during the next [reboot](reboot.html). + +Multiple *services* can be disabled by seperating their names with a space. + +This command handles [interdependencies](66.html#handling-dependencies) for the [stop](stop.html), [free](free.html) and [start](start.html) process. + +## Options + +- **-h**: prints this help. + +- **-P**: Do not handle service dependencies. In such cases, the *reconfigure* command will not attempt to stop/start the services that are dependent on the service, regardless of their current state and only apply the parse process. + +## Usage examples + +Reconfigures the `foo` service +``` +66 reconfigure foo +``` + +Reconfigures the `foo@bar` module service +``` +66 reconfigure foo@bar +``` \ No newline at end of file diff --git a/doc/reload.md b/doc/reload.md new file mode 100644 index 00000000..8f0951e6 --- /dev/null +++ b/doc/reload.md @@ -0,0 +1,49 @@ +title: The 66 Suite: reload +author: Eric Vidal <eric@obarun.org> + +[66](index.html) + +[Software](https://web.obarun.org/software) + +[obarun.org](https://web.obarun.org) + +# reload + +This command reloads one or more services. + +## Interface + +``` +reload [ -h ] [ -P ] service(s) +``` + +This command send a `SIGHUP` signal to *service*. Many daemon reacts of `SIGHUP` signal to re-read its configuration file that has been changed. This command expects to find an already running *service*. + +The `66 -t` command option have no effect. `66` will detect automatically the associated *tree* of the service along its required-by dependencies. + +In case of `module` service type, all services within the `module` are reloaded. + +Multiple *services* can be reloaded by seperating their names with a space. + +This command handles [interdependencies](66.html#handling-dependencies). + +**Note**: If you want to reload a logger, use the `-P` option. + +## Options + +- **-h**: prints this help. + +- **-P**: Do not handle service dependencies. In such cases, the *reload* command will not attempt to reload the services that are dependent on the service, regardless of their current state. + +## Usage examples + +Reloads the `foo` service +``` +66 reload foo +``` + +Restarts the `foo-log` service +``` +66 reload -P foo-log +``` + diff --git a/doc/restart.md b/doc/restart.md new file mode 100644 index 00000000..036201a3 --- /dev/null +++ b/doc/restart.md @@ -0,0 +1,46 @@ +title: The 66 Suite: restart +author: Eric Vidal <eric@obarun.org> + +[66](index.html) + +[Software](https://web.obarun.org/software) + +[obarun.org](https://web.obarun.org) + +# restart + +This command restarts one or more services. + +## Interface + +``` +restart [ -h ] [ -P ] service(s) +``` + +This command bring down and bring up again a *service*. This command expects to find an already running *service*. + +The `66 -t` command option have no effect. `66` will detect automatically the associated *tree* of the service along its required-by dependencies. + +In case of `module` service type, all services within the `module` are restarted. + +Multiple *services* can be disabled by seperating their names with a space. + +This command handles [interdependencies](66.html#handling-dependencies). + +## Options + +- **-h**: prints this help. + +- **-P**: Do not handle service dependencies. In such cases, the *restart* command will not attempt to restart the services that are dependent on the service, regardless of their current state. + +## Usage examples + +Restarts the `foo` service +``` +66 restart foo +``` + +Restarts the `foo` service without handling its required-by dependencies +``` +66 restart -P foo +``` \ No newline at end of file -- GitLab