diff --git a/doc/tree.md b/doc/tree.md index 09c6f20234bad8a5660e8673b818f2d83ba4b5ed..4f68f8a868ef7dff32297dfee918fee74de6876d 100644 --- a/doc/tree.md +++ b/doc/tree.md @@ -14,7 +14,7 @@ This command handles a *tree* containing a set of *services*. ## Interface ``` -tree [ -h ] create|admin|remove|enable|disable|current|status|resolve|start|stop|free tree +tree [ -h ] create|admin|remove|enable|disable|current|status|resolve|init|start|stop|free tree ``` The `tree` command functions similarly to services, wherein each *tree* can have dependencies or be required by another *tree*. These subcommands facilitate various actions such as creating, managing, activating, and checking the status of trees, among other functionalities, within the system. Additionally, it manages dependencies between different trees, enabling effective control and organization of *tree* structures. @@ -23,9 +23,9 @@ The default tree named `%%default_treename%%` is provided. This *tree* is automa Configuration of the *tree* during its creation can be managed through a configuration file called `seed`.—see [Seed files](#seed-files). -Services within *tree* need to be *enabled*, with the [enable](enable.html) subcommand, to be managed by the `start` subcommand. The `stop` and `free` subcommand manages any running services within *tree*. +Services within *tree* need to be *enabled*, with the [66 enable](enable.html) command, to be managed by the `start` subcommand. The `stop` and `free` subcommand manages any running services within *tree*. -A non-existing *tree* can also be created automatically when invocating of the `66 -t` option with commands that accept it. For example, the `66 -t treefoo enable foo` call automatically creates `treefoo` if it doesn't exist yet, applying the [basic creation configuration](#basic-creation-configuration) or utilizing the `seed` file configuration if such file exists. +A non-existing *tree* can also be created automatically when invocating of the `66 -t` option with commands that accept it. For example, the `66 -t treefoo enable foo` call automatically creates the tree `treefoo` if it doesn't exist yet, applying the [basic creation configuration](#basic-creation-configuration) or utilizing the `seed` file configuration if such file exists. ## Why trees? @@ -37,7 +37,11 @@ tree named print contains services cups and nfs tree named graphic contains services xorg, notification-daemon, gvfsd and dbus ``` -When booting your machine and opting for console-only usage, your concern might solely be a working internet connection, disregarding xorg or cups. Initially, you would only enable `network` at the base level. Upon every boot, this *tree* and all its *enabled* services will automatically start. Later, when you need to print a document stored on another server, you'd typically start `cups` and then `nfs`. By leveraging the *tree* concept, you can start `print`, making all necessary services available. After finishing the printing task, instead of individually stopping the required services, you can simply stop `print`, and all services within it will cease automatically. The functionality extends further: say, you now wish to watch a video, requiring an active X server and potentially other services. Enter `graphics`, specifically designed for such purposes. +When booting your machine and opting for console-only usage, your concern might solely be a working internet connection, disregarding xorg or cups. Initially, you would only enable `network` at the base level. Upon every boot, this *tree* and all its *enabled* services will automatically start. + +Later, when you need to print a document stored on another server, you'd typically start `cups` and then `nfs`. By leveraging the *tree* concept, you can start `print`, making all necessary services available. After finishing the printing task, instead of individually stopping the required services, you can simply stop `print`, and all services within it will cease automatically. + +The functionality extends further: say, you now wish to watch a video, requiring an active X server and potentially other services. Enter `graphics`, specifically designed for such purposes. ## Options @@ -100,7 +104,7 @@ This subcommand creates a *tree* that doesn't exist and potentially configures i 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 [enable](enable.html) command. +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. #### Options @@ -125,7 +129,7 @@ Creates a tree named `treefoo` 66 tree create treefoo ``` -Creates, configures and clones a *tree* named `treefoo` and a clone of `treefoo` named `treefoo2` +Creates, configures and clones a *tree* named `treefoo` where the clone of `treefoo` is named `treefoo2` ``` 66 tree create -o depends=treebar,treebaz:groups=admin:deny=none:allow=root:clone=treefoo2 treefoo ``` @@ -159,6 +163,16 @@ valid fields for `-o` options are: #### Usage examples +Changes the dependencies of `treefoo` to `treebaz` where `treefoo` depended previously of tree `treebar` +``` +66 tree admin -o depends=treebaz treefoo +``` + +Deny all user of `treefoo` +``` +66 tree admin -o deny=user treefoo +``` + ### Remove #### Interface @@ -565,7 +579,7 @@ This `template` example of `seed` file can be found at [contributions/seed](http ## Groups behavior -This feature is in progress. Currently, the only group that has an effect is the `boot` group. A tree set to the `boot` group cannot be *enabled*. Trees associated with the `boot` group are automatically managed by `66` during boot time. Enabling a *tree* within the `boot` group results in services within the *tree* starting twice, which is likely not the intended behavior. +This feature is in progress. Currently, the only group that has an effect is the `boot` group. A tree set to the `boot` group **cannot be** *enabled*. Trees associated with the `boot` group are automatically managed by `66` during boot time. Enabling a *tree* within the `boot` group results in services within the *tree* starting twice, which is likely not the intended behavior. The primary purpose and future goal of this feature are to manage *tree* permissions and provide the ability to handle multiple trees simultaneously. For instance, requesting to `start` the `admin` group will initiate all trees within this group. diff --git a/src/lib66/exec/ssexec_help.c b/src/lib66/exec/ssexec_help.c index 4f2cc6b3b6d25ef424961521e379f0d9474872da..bc816ec3489b5e3d2ea26f371642cf4e2a2223b1 100644 --- a/src/lib66/exec/ssexec_help.c +++ b/src/lib66/exec/ssexec_help.c @@ -306,7 +306,7 @@ char const *help_tree_wrapper = " stop: bring down all services from tree\n" " free: bring down and unsupervise all services from tree\n" "\n" -"Use '66 tree <command> -h' to see command options\n" +"Use '66 tree <subcommand> -h' to see subcommand options\n" ; char const *usage_tree_create = "66 tree create [ -h ] [ -o depends=:requiredby=:... ] tree" ; @@ -393,7 +393,7 @@ char const *help_tree_resolve = " -h: print this help\n" ; -char const *usage_tree_status = "66 tree status [ -h ] [ -n ] [ -o name,init,enabled,... ] [ -g ] [ -d depth ] [ -r ] tree" ; +char const *usage_tree_status = "66 tree status [ -h ] [ -n ] [ -o name,enabled,... ] [ -g ] [ -d depth ] [ -r ] tree" ; char const *help_tree_status = "\ndisplay information about tree\n" @@ -411,11 +411,10 @@ char const *help_tree_status = " name: displays the name of the tree\n" " current: displays a boolean value of the current state\n" " enabled: displays a boolean value of the enable state\n" -" init: displays a boolean value of the initialization state\n" " depends: displays the list of tree(s) started before\n" " requiredby: displays the list of tree(s) started after\n" " allowed: displays a list of allowed user to use the tree\n" -" contents: displays the contents of the tree\n" +" contents: displays the list of services associated to tree\n" "\n" "If no tree name are provided, it display all trees from the system\n" ; @@ -429,16 +428,15 @@ char const *help_tree_init = " -h: print this help\n" ; -char const *usage_tree_start = "66 tree start [ -h ] [ -f ] tree" ; +char const *usage_tree_start = "66 tree start [ -h ] tree" ; char const *help_tree_start = "\nbring up all enabled services of tree\n" "\n" "options:\n" " -h: print this help\n" -" -f: fork the process\n" "\n" -"If no tree name are provided, it bring up all enabled trees from the system\n" +"If no tree name are provided, it bring up all enabled services within all enabled trees of the system\n" ; char const *usage_tree_stop = "66 tree stop [ -h ] [ -f ] tree" ; @@ -450,7 +448,7 @@ char const *help_tree_stop = " -h: print this help\n" " -f: fork the process\n" "\n" -"If no tree name are provided, it bring down all enabled trees from the system\n" +"If no tree name are provided, it bring down all services within all enabled trees of the system\n" ; char const *usage_tree_unsupervise = "66 tree free [ -h ] [ -f ] tree" ; @@ -462,7 +460,7 @@ char const *help_tree_unsupervise = " -h: print this help\n" " -f: fork the process\n" "\n" -"If no tree name are provided, it unsupervise all enabled trees from the system\n" +"If no tree name are provided, it unsupervise all services within all trees of the system\n" ; char const *usage_scandir_wrapper = "66 scandir [ -h ] [ -o owner ] create|remove|start|stop|reconfigure|rescan|quit|halt|abort|nuke|annihilate|zombies [<command options>]" ; @@ -488,7 +486,7 @@ char const *help_scandir_wrapper = " annihilate: annihilate a running scandir\n" " zombies: destroy zombies from a running scandir\n" "\n" -"Use '66 scandir <command> -h' to see command options\n" +"Use '66 scandir <subcommand> -h' to see subcommand options\n" ; char const *usage_scandir_create = "66 scandir create [ -h ] [ -b|B ] [ -c ] [ -L log_user ] [ -s skel ]" ;