From 440a527a8dfb841a84bc236ff76c5736b8610757 Mon Sep 17 00:00:00 2001 From: obarun <eric@obarun.org> Date: Tue, 5 Dec 2023 22:37:16 +1100 Subject: [PATCH] provide remove doc --- doc/remove.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 doc/remove.md diff --git a/doc/remove.md b/doc/remove.md new file mode 100644 index 00000000..1686f844 --- /dev/null +++ b/doc/remove.md @@ -0,0 +1,42 @@ +title: The 66 Suite: remove +author: Eric Vidal <eric@obarun.org> + +[66](index.html) + +[Software](https://web.obarun.org/software) + +[obarun.org](https://web.obarun.org) + +# remove + +This command remove all components of a service. This operation **cannot be** undone. Process with caution. + +## Interface + +``` +remove [ -h ] [ -P ] service +``` + +This command remove all files belongs to *service* from the system even its log file. The only exception is its [frontend](frontend.html) file. + +If the *service* is running, it will be stopped and unsupervised before removing it. This is also applied to its required-by dependencies except if the `-P` is passed. + +In case of `module` *service* type, all *services* declared within the `module` will be removed. The `-P` has no effect on the *services* within the `module` and only affects the module's dependencies. + +This command handles [interdependencies](66.html#handling-dependencies). + +## Options + +- **-h** : prints this help. + +## Usage example + +Removes the service `foo` +``` +66 remove foo +``` + +Removes the service `foo` without touching its interdependencies +``` +66 remove -P foo +``` \ No newline at end of file -- GitLab