From 5ba015a55e09015cb5bffaf995214910093c6ab5 Mon Sep 17 00:00:00 2001 From: obarun <eric@obarun.org> Date: Mon, 4 Dec 2023 21:37:26 +1100 Subject: [PATCH] refers to the same page documentation concerning interdependencies --- doc/disable.md | 6 +++--- doc/enable.md | 6 +++--- doc/signal.md | 4 +++- doc/start.md | 4 +++- doc/stop.md | 4 +++- doc/tree.md | 18 +++++++++++------- 6 files changed, 26 insertions(+), 16 deletions(-) diff --git a/doc/disable.md b/doc/disable.md index e932ae47..bc891bd6 100644 --- a/doc/disable.md +++ b/doc/disable.md @@ -17,16 +17,16 @@ This command disables one or more services. disable [ -h ] [ -S ] service(s) ``` -This tool expects to find an already enabled *service*. The targeted service(s) can also be stopped on the fly when disabling it with the **-S** option. Generally speaking this command is the strict opposite of the [enable](enable.html) tool. +This command expects to find an already enabled *service*. The targeted service(s) can also be stopped on the fly when disabling it with the **-S** option. Generally speaking this command is the strict opposite of the [enable](enable.html) command. 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 disabled. -required-by dependencies of services are also managed in chains. For example, if the `foo` service is disabled and required-by `foobar`, `foobar` will also be disabled. This process occurs recursively. - 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. diff --git a/doc/enable.md b/doc/enable.md index c9bb8fc3..fb0b7713 100644 --- a/doc/enable.md +++ b/doc/enable.md @@ -17,7 +17,7 @@ This command enables one or more services within a specified *tree* depending of enable [ -h ] [ -S ] service(s) ``` -This tool will also parse the service if it was never parsed. In this case, it expects to find a corresponding [frontend service file](frontend.html), or a *service* instance (see [instance](#Instantiated service)), by default at `%%service_adm%%` or `%%service_system%%` in this order of precedence for root user and `$HOME/%%service_user%%`, `%%service_adm%%` or `%%service_system%%` in this order of precedence for a normal user. The default path can be changed at compile time by passing the `--with-system-service=DIR`, `--with-sysadmin-service=DIR` and `--with-user-service=DIR` to `./configure`.The *service* will then be available in the given *tree* for the next boot depending on the state of the *tree*. The targeted service(s) can also be started on the fly when enabling it with the **-S** option. +This command will also parse the service if it was never parsed. In this case, it expects to find a corresponding [frontend service file](frontend.html), or a *service* instance (see [instance](#Instantiated service)), by default at `%%service_adm%%` or `%%service_system%%` in this order of precedence for root user and `$HOME/%%service_user%%`, `%%service_adm%%` or `%%service_system%%` in this order of precedence for a normal user. The default path can be changed at compile time by passing the `--with-system-service=DIR`, `--with-sysadmin-service=DIR` and `--with-user-service=DIR` to `./configure`.The *service* will then be available in the given *tree* for the next boot depending on the state of the *tree*. The targeted service(s) can also be started on the fly when enabling it with the **-S** option. The given *tree* can be define through the `-t` option in the `66` general option or by using the `@intree` field within the frontend file or setting a current tree through the [66 tree current](66-tree.html) subcommand. If neither `-t` options nor `@intree` is provided, or if no tree is marked as a current one, it will enable the service within the default tree named `%%default_treename%%`. The default tree name can be changed at compile time by passing the `--with-default-tree-name` to `./configure`. @@ -25,7 +25,7 @@ In case of `module` service type, all services within the `module` are enabled. Multiple *services* can be enabled by seperating their names with a space. -Dependencies of services are also managed in chains. For example, if the `foo` service is enabled and depends on `foobar`', `foobar` will also be enabled. This process occurs recursively. +This command handles [interdependencies](66.html#handling-dependencies). ## Options @@ -33,7 +33,7 @@ Dependencies of services are also managed in chains. For example, if the `foo` s - **-S**: starts the *service* on the fly directly after enabling it. If the state of the *service* is already up, this option will have no effect. This also applies to the dependencies of the service. -## Usage example +## Usage examples Enable a service while specifying with the tree name(this only takes effect if the service has not been parsed before): ``` diff --git a/doc/signal.md b/doc/signal.md index d919974a..d097f0bb 100644 --- a/doc/signal.md +++ b/doc/signal.md @@ -23,6 +23,8 @@ This command is the heart of `66` concerning service state change. Every other ` Multiple *services* can be handled by separating their names with a space. +This command handles [interdependencies](66.html#handling-dependencies). + ## Options - **-h**: print this help. @@ -79,4 +81,4 @@ Take down `foo` and block until the process is down and the finish script has co Bring up `foo` and block until it has sent notification that it is ready. Exit if it is still not ready after 5 seconds. ``` 66 -T 5000 -wU -u foo -``` \ No newline at end of file +``` diff --git a/doc/start.md b/doc/start.md index 9dee0a0e..5190efac 100644 --- a/doc/start.md +++ b/doc/start.md @@ -27,6 +27,8 @@ If the *service* was already parsed, the `66 -t` command option have no effect. In case of `module` *service* type, all *services* declared within the `module` will start. 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. @@ -64,4 +66,4 @@ You also can use the `-P` option to avoid handling the dependencies of the servi ``` 66 start -P foo@foobar:foobaz -``` \ No newline at end of file +``` diff --git a/doc/stop.md b/doc/stop.md index acd6577c..c90bdce7 100644 --- a/doc/stop.md +++ b/doc/stop.md @@ -25,6 +25,8 @@ The `66 -t` command option have no effect. `66` will detect automatically the as In case of `module` *service* type, all *services* declared within the `module` will stop. The **-P** has no effect on the *services* within the `module` and only affects the module's required-by dependencies. +This command handles [interdependencies](66.html#handling-dependencies). + ## Options - **-h**: prints this help. @@ -57,4 +59,4 @@ You also can use the `-P` option to avoid handling the required-by dependencies ``` 66 stop -P foo@foobar:foobaz -``` \ No newline at end of file +``` diff --git a/doc/tree.md b/doc/tree.md index 5804c3f9..61852c6a 100644 --- a/doc/tree.md +++ b/doc/tree.md @@ -106,6 +106,8 @@ tree create [ -h ] [ -o depends=:requiredby=:... ] *tree* After creation *tree* do not contain any services. You need to [associate](#associated-service-to-a-tree) services within *tree* with the [66 enable](enable.html) command. +This command handles [interdependencies](66.html#handling-dependencies). + #### Options - **-h**: prints this help. @@ -146,6 +148,8 @@ tree admin [ -h ] [ -o depends=:requiredby=:... ] tree If the *tree* does not exist, it is created and configured based on the options used. +This command handles [interdependencies](66.html#handling-dependencies). + #### Options - **-h**: prints this help. @@ -209,10 +213,10 @@ tree enable [ -h ] tree If the *tree* does not exist, it is created and configured with [basic creation configuration](#basic-creation-configuration). -Dependencies of trees are also managed in chains. For example, if the `treefoo` is enabled and depends on `treebar`', `treebar` will also be enabled. This process occurs recursively. - Trees associated to the `boot` [group](#groups-behavior) cannot be enabled. +This command handles [interdependencies](66.html#handling-dependencies). + #### Options - **-h**: prints this help. @@ -234,7 +238,7 @@ This command is the exact opposite of `enable` command. tree disable [ -h ] tree ``` -required-by dependencies of trees are also managed in chains. For example, if the `treefoo` is disabled and required-by `treebar`', `treebar` will also be disabled. This process occurs recursively. +This command handles [interdependencies](66.html#handling-dependencies). #### Options @@ -395,7 +399,7 @@ This command displays the complete contents of the [resolve](deeper.html#resolve 66 tree resolve [ -h ] tree ``` -Resolve file are used internally by `66` to know *tree* information. This subcommand is purely a debug tool used by system administrator or developers in case of issues. +Resolve file are used internally by `66` to know *tree* information. This subcommand is purely a debug command used by system administrator or developers. #### Options @@ -444,7 +448,7 @@ tree start [ -h ] [ -f ] tree If *tree* is not specified, the command manages all *enabled* services within all *enabled* trees available of the system. -Dependencies of *tree* are also managed in chains. For example, if the `treefoo` tree is started and depends on `treebar`', `treebar` will be started first. This process occurs recursively. +This command handles [interdependencies](66.html#handling-dependencies). #### Options @@ -474,7 +478,7 @@ This command stops all **running services** within tree If *tree* is not specified, the command manages all services within all *enabled* trees available of the system. -required-by dependencies of *tree* are also managed in chains. For example, if the `treefoo` tree is stopped and required-by `treebar`', `treebar` will be stopped first. This process occurs recursively. +This command handles [interdependencies](66.html#handling-dependencies). #### Options @@ -505,7 +509,7 @@ This command stops and unsupervise tree. If *tree* is not specified, the command manages all services within all *enabled* trees available of the system. -required-by dependencies of *tree* are also managed in chains. For example, if the `treefoo` tree is stopped and required-by `treebar`', `treebar` will be stopped first. This process occurs recursively. +This command handles [interdependencies](66.html#handling-dependencies). #### Options -- GitLab