From e96579d088b9e8ab541b1ed7d4413051128b770d Mon Sep 17 00:00:00 2001 From: obarun <eric@obarun.org> Date: Sat, 2 Dec 2023 20:29:13 +1100 Subject: [PATCH] typo fix --- doc/66-hpr.md | 22 +++++++++++----------- doc/66-shutdown.md | 28 ++++++++++++++-------------- doc/66-shutdownd.md | 12 ++++++------ doc/66.md | 26 +++++++++++++------------- doc/boot.md | 14 +++++++------- doc/configure.md | 14 +++++++------- doc/disable.md | 4 ++-- doc/enable.md | 4 ++-- doc/execl-envfile.md | 14 +++++++------- doc/frontend.md | 5 +++-- doc/init.md | 2 +- doc/module-service.md | 10 +++++----- doc/parse.md | 6 +++--- doc/prototype.md | 2 +- doc/start.md | 6 +++--- doc/stop.md | 6 +++--- 16 files changed, 88 insertions(+), 87 deletions(-) diff --git a/doc/66-hpr.md b/doc/66-hpr.md index af07544f..c2dfc6cf 100644 --- a/doc/66-hpr.md +++ b/doc/66-hpr.md @@ -33,32 +33,32 @@ This is the traditional sysvinit interface for the `halt`, `poweroff` and `reboo ## Options -- **-H** : prints this help. +- **-H**: prints this help. -- **-l** *live* : changes the supervision directory of *service* to *live*. By default this will be `%%livedir%%`. The default can also be changed at compile time by passing the `--livedir=live` option to `./configure`. An existing absolute path is expected and should be within a writable and executable filesystem - likely a RAM filesystem—see [66-scandir](66-scandir.html). +- **-l** *live*: changes the supervision directory of *service* to *live*. By default this will be `%%livedir%%`. The default can also be changed at compile time by passing the `--livedir=live` option to `./configure`. An existing absolute path is expected and should be within a writable and executable filesystem - likely a RAM filesystem—see [66-scandir](66-scandir.html). -- **-b** *banner* : Text to display before executing the shutdown process. Defaults to: +- **-b** *banner*: Text to display before executing the shutdown process. Defaults to: ``` *** WARNING *** The system is going down NOW! ``` -- **-f** : force. The command will not trigger a clean shutdown procedure; it will only sync the filesystems then tell the kernel to immediately `halt`, `poweroff` and `reboot`. This should be the last step in the lifetime cycle of the machine. +- **-f**: force. The command will not trigger a clean shutdown procedure; it will only sync the filesystems then tell the kernel to immediately `halt`, `poweroff` and `reboot`. This should be the last step in the lifetime cycle of the machine. -- **-h** : halt. The system will be shut down but the power will remain connected. +- **-h**: halt. The system will be shut down but the power will remain connected. -- **-p** : poweroff. Like halt but the power will also be turned off. +- **-p**: poweroff. Like halt but the power will also be turned off. -- **-r** : reboot. The system will initialize a warm boot without disconnecting power. +- **-r**: reboot. The system will initialize a warm boot without disconnecting power. -- **-n** : Do not call [sync()](https://pubs.opengroup.org/onlinepubs/9699919799/functions/sync.html) before the hardware shutdown. The default is to sync, just in case. This option is only relevant when combined with **-f**; without it, it has no effect. +- **-n**: Do not call [sync()](https://pubs.opengroup.org/onlinepubs/9699919799/functions/sync.html) before the hardware shutdown. The default is to sync, just in case. This option is only relevant when combined with **-f**; without it, it has no effect. -- **-d** : Do not write a wtmp shutdown entry—see [utmp,wtmp and btmp](https://en.wikipedia.org/wiki/Utmp). +- **-d**: Do not write a wtmp shutdown entry—see [utmp,wtmp and btmp](https://en.wikipedia.org/wiki/Utmp). -- **-w** : Only write a wtmp shutdown entry; does not actually shut down the system. +- **-w**: Only write a wtmp shutdown entry; does not actually shut down the system. -- **-W** : Do not send a *wall* message to users before shutting down the system. Some other implementations of the `halt`, `poweroff` and `reboot` commands use the `‑‑no‑wall` long option to achieve this. +- **-W**: Do not send a *wall* message to users before shutting down the system. Some other implementations of the `halt`, `poweroff` and `reboot` commands use the `‑‑no‑wall` long option to achieve this. ## Notes diff --git a/doc/66-shutdown.md b/doc/66-shutdown.md index 3c823d51..7f647e72 100644 --- a/doc/66-shutdown.md +++ b/doc/66-shutdown.md @@ -28,11 +28,11 @@ The *66-shutdown* program abides to the standards of the LSB-3.0.0 [shutdown](ht *time* must be one of these formats: `[ now | [+]mins | hh:mm ]` where: -- *now* : triggers the shutdown sequence immediately. +- *now*: triggers the shutdown sequence immediately. -- *mins* or *+mins* : relative time; triggers the shutdown sequence after *mins* minutes. +- *mins* or *+mins*: relative time; triggers the shutdown sequence after *mins* minutes. -- *hh:mm* : absolute time; triggers the shutdown sequence when the time *hh:mm* occurs. If that time has passed for the current day, it will wait for the next day. *hh* can have 1 or 2 digits; *mm* must have 2 digits. +- *hh:mm*: absolute time; triggers the shutdown sequence when the time *hh:mm* occurs. If that time has passed for the current day, it will wait for the next day. *hh* can have 1 or 2 digits; *mm* must have 2 digits. ## Exit codes @@ -43,27 +43,27 @@ The *66-shutdown* program abides to the standards of the LSB-3.0.0 [shutdown](ht ## Options -- **-H** : prints this help. +- **-H**: prints this help. -- **-l** *live* : changes the supervision directory of *service* to *live*. By default this will be `%%livedir%%`. The default can also be changed at compile time by passing the `--livedir=live` option to `./configure`. An existing absolute path is expected and should be within a writable and executable filesystem - likely a RAM filesystem—see [66-scandir](66-scandir.html). +- **-l** *live*: changes the supervision directory of *service* to *live*. By default this will be `%%livedir%%`. The default can also be changed at compile time by passing the `--livedir=live` option to `./configure`. An existing absolute path is expected and should be within a writable and executable filesystem - likely a RAM filesystem—see [66-scandir](66-scandir.html). -- **-a** : access control. The shutdown sequence will only be launched if one of the users listed in `%%skel%%/shutdown.allow` is currently logged in (as tracked by utmp). `%%skel%%/shutdown.allow` is a text file which accepts one user per line. Lines starting with `#` are commented out. +- **-a**: access control. The shutdown sequence will only be launched if one of the users listed in `%%skel%%/shutdown.allow` is currently logged in (as tracked by utmp). `%%skel%%/shutdown.allow` is a text file which accepts one user per line. Lines starting with `#` are commented out. -- **-t** *sec* : have a "grace time" period of sec seconds between the `SIGTERM` and the `SIGKILL` at the end of the shutdown sequence when it is time to kill all processes (allows processes to receive `SIGTERM` to exit cleanly). Default is `3` seconds. +- **-t** *sec*: have a "grace time" period of sec seconds between the `SIGTERM` and the `SIGKILL` at the end of the shutdown sequence when it is time to kill all processes (allows processes to receive `SIGTERM` to exit cleanly). Default is `3` seconds. -- **-k** : do not shut down; send a warning message to all logged in users. +- **-k**: do not shut down; send a warning message to all logged in users. -- **-h** : halt the system at the end of the shutdown sequence. +- **-h**: halt the system at the end of the shutdown sequence. -- **-p** : power off the system at the end of the shutdown sequence. This option is provided as an extension it is not required by the LSB interface. +- **-p**: power off the system at the end of the shutdown sequence. This option is provided as an extension it is not required by the LSB interface. -- **-r** : reboot the system at the end of the shutdown sequence. +- **-r**: reboot the system at the end of the shutdown sequence. -- **-f** : ignored. +- **-f**: ignored. -- **-F** : ignored. +- **-F**: ignored. -- **-c** : cancel a planned shutdown. Can only cancel the effect of a previous call to *shutdown* with a time argument that was not *now*. This cannot be used to interrupt a shutdown sequence that has already started. +- **-c**: cancel a planned shutdown. Can only cancel the effect of a previous call to *shutdown* with a time argument that was not *now*. This cannot be used to interrupt a shutdown sequence that has already started. ## Notes diff --git a/doc/66-shutdownd.md b/doc/66-shutdownd.md index b30ae981..edc128b9 100644 --- a/doc/66-shutdownd.md +++ b/doc/66-shutdownd.md @@ -33,17 +33,17 @@ The daemon that manages the shutdown procedure for a [66-boot](66-boot.html) ins ## Options -- **-h** : prints this help. +- **-h**: prints this help. -- **-l** *live* : changes the supervision directory of *service* to *live*. By default this will be `%%livedir%%`. The default can also be changed at compile time by passing the `--livedir=live` option to `./configure`. An existing absolute path is expected and should be within a writable and executable filesystem - likely a RAM filesystem—see [66-scandir](66-scandir.html). +- **-l** *live*: changes the supervision directory of *service* to *live*. By default this will be `%%livedir%%`. The default can also be changed at compile time by passing the `--livedir=live` option to `./configure`. An existing absolute path is expected and should be within a writable and executable filesystem - likely a RAM filesystem—see [66-scandir](66-scandir.html). -- **-s** *skel* : an absolute path; directory of the skeleton file `rc.init`. Default is `%%skel%%`. +- **-s** *skel*: an absolute path; directory of the skeleton file `rc.init`. Default is `%%skel%%`. -- **-g** *gracetime* : specify a grace time between the `SIGTERM` and the `SIGKILL` in milliseconds if the shutdown command does not provide one. Defaults to `3000`. +- **-g** *gracetime*: specify a grace time between the `SIGTERM` and the `SIGKILL` in milliseconds if the shutdown command does not provide one. Defaults to `3000`. -- **-B** : inform the shutdown daemon that it is running in a container. This changes the nature of *stage 4*, since exiting a container is slightly different from rebooting a real machine (in particular, pid 1 has to exit, and great care must be given not to leave any zombie hanging around). +- **-B**: inform the shutdown daemon that it is running in a container. This changes the nature of *stage 4*, since exiting a container is slightly different from rebooting a real machine (in particular, pid 1 has to exit, and great care must be given not to leave any zombie hanging around). -- **-c** : inform the shutdown daemon that no catch-all logger is running. This also changes the shutdown procedure slightly, since some operations are specific to the existence of a catch-all logger. +- **-c**: inform the shutdown daemon that no catch-all logger is running. This also changes the shutdown procedure slightly, since some operations are specific to the existence of a catch-all logger. ## Note diff --git a/doc/66.md b/doc/66.md index 42f670a3..dc6d8b70 100644 --- a/doc/66.md +++ b/doc/66.md @@ -21,23 +21,23 @@ Tool to control the state of the system and service manager. These options are available all commands except the `-t` options. In such cases, the help of the specific command provides clarification. -- **-h** : prints this help. +- **-h**: prints this help. -- **-z** : use color. +- **-z**: use color. -- **-v** *verbosity* : increases/decreases the verbosity of the command. - * *0* : only print error messages. - * *1* : also, print informative messages. This is the default. - * *2* : also, print warning messages. - * *3* : also, print tracing messages. - * *4* : also, print function name and line code of the messages. - * *5* : also, display the sequence of the current process function by function. +- **-v** *verbosity*: increases/decreases the verbosity of the command. + * *0*: only print error messages. + * *1*: also, print informative messages. This is the default. + * *2*: also, print warning messages. + * *3*: also, print tracing messages. + * *4*: also, print function name and line code of the messages. + * *5*: also, display the sequence of the current process function by function. -- **-l** *live* : changes the supervision directory of *service* to *live*. By default this will be `%%livedir%%`. The default can also be changed at compile time by passing the `--livedir=` option to `./configure`. An existing absolute path is expected and should be within a writable and executable filesystem - likely a RAM filesystem—see [scandir](scandir.html) command. +- **-l** *live*: changes the supervision directory of *service* to *live*. By default this will be `%%livedir%%`. The default can also be changed at compile time by passing the `--livedir=` option to `./configure`. An existing absolute path is expected and should be within a writable and executable filesystem - likely a RAM filesystem—see [scandir](scandir.html) command. -- **-T** *timeout* : specifies a general timeout (in milliseconds) passed to command. By default the timeout is set to 0 (infinite). +- **-T** *timeout*: specifies a general timeout (in milliseconds) passed to command. By default the timeout is set to 0 (infinite). -- **-t** *tree* : only handles *service(s)* for *tree*. +- **-t** *tree*: only handles *service(s)* for *tree*. ## Commands @@ -91,4 +91,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 automatically considered and stopped first when `FooA` is stopped. This process will run recursively until all required by dependencies are stopped. -This applies to all `66` commands. +This applies to all `66` commands. \ No newline at end of file diff --git a/doc/boot.md b/doc/boot.md index 736aef17..d70ee558 100644 --- a/doc/boot.md +++ b/doc/boot.md @@ -27,19 +27,19 @@ Command *boot* never exits. It spawns the `rc.init` script and execs into [scand ## Options -- **-h** : prints this help. +- **-h**: prints this help. -- **-m** : umount the basename of the *LIVE* directory set into the *init.conf* skeleton file, if it is already mounted, and mounts a tmpfs on it. By default, the *LIVE* basename is mounted if it is not already a valid mountpoint. Otherwise without the **-m** option, it does nothing. +- **-m**: umount the basename of the *LIVE* directory set into the *init.conf* skeleton file, if it is already mounted, and mounts a tmpfs on it. By default, the *LIVE* basename is mounted if it is not already a valid mountpoint. Otherwise without the **-m** option, it does nothing. -- **-s** *skel* : an absolute path. Directory that holds skeleton files. By default this will be `%%skel%%`. The default can also be changed at compile time by passing the `--with-skeleton=DIR` option to `./configure`. This directory ***must*** contain the necessary skeleton files to properly boot the machine, without it the system **will not boot**. +- **-s** *skel*: an absolute path. Directory that holds skeleton files. By default this will be `%%skel%%`. The default can also be changed at compile time by passing the `--with-skeleton=DIR` option to `./configure`. This directory ***must*** contain the necessary skeleton files to properly boot the machine, without it the system **will not boot**. -- **-l** *log_user* : the `catch-all` logger will run as *log_user*. Default is `%%s6log_user%%`. The default can also be changed at compile-time by passing the `--with-s6-log-user=user` option to `./configure`. +- **-l** *log_user*: the `catch-all` logger will run as *log_user*. Default is `%%s6log_user%%`. The default can also be changed at compile-time by passing the `--with-s6-log-user=user` option to `./configure`. -- **-e** *environment* : an absolute path. *stage 1 init* empties its environment before spawning the `rc.init` skeleton file and executing into [scandir start](scandir.html) in order to prevent kernel environment variables from leaking into the process tree. The *PATH* variable is the only variable set for the environment. If you want to define additional environment variables then use this option. Behaves the same as [scandir start -e](scandir.html). +- **-e** *environment*: an absolute path. *stage 1 init* empties its environment before spawning the `rc.init` skeleton file and executing into [scandir start](scandir.html) in order to prevent kernel environment variables from leaking into the process tree. The *PATH* variable is the only variable set for the environment. If you want to define additional environment variables then use this option. Behaves the same as [scandir start -e](scandir.html). -- **-d** *dev* : mounts a devtmpfs on *dev*. By default, no such mount is performed - it is assumed that a devtmpfs is automounted on `/dev` at boot time by the kernel or an initramfs. +- **-d** *dev*: mounts a devtmpfs on *dev*. By default, no such mount is performed - it is assumed that a devtmpfs is automounted on `/dev` at boot time by the kernel or an initramfs. -- **-b** *banner* : prints banner to */dev/console* at the start of the stage 1 init process. Defaults to: +- **-b** *banner*: prints banner to */dev/console* at the start of the stage 1 init process. Defaults to: `[Starts stage1 process ...]` ## Early preparation diff --git a/doc/configure.md b/doc/configure.md index b2a0b744..01c711ba 100644 --- a/doc/configure.md +++ b/doc/configure.md @@ -23,23 +23,23 @@ The edition of the configuration file is the **default** option if neither optio ## Options -- **-h** : prints this help. +- **-h**: prints this help. -- **-c** *version* : makes *version* as the current one to use by default. If the service is already running, you need to restart the *service* to apply the change by the command e.g. `66 restart foo`. +- **-c** *version*: makes *version* as the current one to use by default. If the service is already running, you need to restart the *service* to apply the change by the command e.g. `66 restart foo`. -- **-s** *version* : specifies the version to handles with the options **-V**, **-L**, **-r** and **-e** instead of using the current one. +- **-s** *version*: specifies the version to handles with the options **-V**, **-L**, **-r** and **-e** instead of using the current one. -- **-V** : lists available versioned configuration directories of the *service*. The term `current` is used to specific the current version in use as follow: +- **-V**: lists available versioned configuration directories of the *service*. The term `current` is used to specific the current version in use as follow: ```` 0.2.0 0.1.4 current ```` -- **-r** *key=value* : override an existing `key=value` pair with the given one. The `key=value` needs to be single quoted in case of multiple arguments.This option can be specified multiple times. +- **-r** *key=value*: override an existing `key=value` pair with the given one. The `key=value` needs to be single quoted in case of multiple arguments.This option can be specified multiple times. -- **-L** : lists defined environment variables for the *service*. It do the same for all files found at the configuration directory. +- **-L**: lists defined environment variables for the *service*. It do the same for all files found at the configuration directory. -- **-i** *src,dst* : imports configuration file from *src* version to *dst* version. The *src* version and *dst* version need to be separated by a comma without space before and after it. It **do not import** the configuration written by the parse process but only deal with extra configuration files written by the sysadmin. +- **-i** *src,dst*: imports configuration file from *src* version to *dst* version. The *src* version and *dst* version need to be separated by a comma without space before and after it. It **do not import** the configuration written by the parse process but only deal with extra configuration files written by the sysadmin. - **-e** *editor*: edit the configuration file with *editor*. If you don't specify this option, it try to found the `EDITOR` variable from the environment variable. Note: the upstream file (meaning the one prefixed with a dot) is **never** touched. A copy of the upstream file is copied (if it doesn't exist yet) and the *configure* command modifies that file.(see [Service configuration file](service-configuration-file.html) for further information). diff --git a/doc/disable.md b/doc/disable.md index a52ccf91..b93d0714 100644 --- a/doc/disable.md +++ b/doc/disable.md @@ -29,9 +29,9 @@ Multiple *services* can be disabled by seperating their names with a space. ## Options -- **-h** : prints this help. +- **-h**: prints this help. -- **-S** : stops the *service* on the fly directly after disabling it. If the state of the *service* is already down, this option will have no effect. This also applies to the required by dependencies of the service. +- **-S**: stops the *service* on the fly directly after disabling it. If the state of the *service* is already down, this option will have no effect. This also applies to the required by dependencies of the service. ## Usage examples diff --git a/doc/enable.md b/doc/enable.md index b7f140a3..c9bb8fc3 100644 --- a/doc/enable.md +++ b/doc/enable.md @@ -29,9 +29,9 @@ Dependencies of services are also managed in chains. For example, if the `foo` s ## Options -- **-h** : prints this help. +- **-h**: prints this help. -- **-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. +- **-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 diff --git a/doc/execl-envfile.md b/doc/execl-envfile.md index 52c8f5e7..9bf48ac1 100644 --- a/doc/execl-envfile.md +++ b/doc/execl-envfile.md @@ -39,15 +39,15 @@ This tool expects to find a regular file or a directory in *src* containing one ## Options -- **-h** : prints this help. +- **-h**: prints this help. -- **-v** *verbosity* : increases/decreases the verbosity of the command. - * *1* : only print error messages. This is the default. - * *2* : also print warning messages. - * *3* : also print tracing messages. - * *4* : also print debugging messages. +- **-v** *verbosity*: increases/decreases the verbosity of the command. + * *1*: only print error messages. This is the default. + * *2*: also print warning messages. + * *3*: also print tracing messages. + * *4*: also print debugging messages. -- **-l** : loose; do nothing and execute *prog* directly if *src* does not contain any regular file(s) or *src* does not exist. +- **-l**: loose; do nothing and execute *prog* directly if *src* does not contain any regular file(s) or *src* does not exist. ## File syntax diff --git a/doc/frontend.md b/doc/frontend.md index 37dfc1a8..d09ee542 100644 --- a/doc/frontend.md +++ b/doc/frontend.md @@ -591,7 +591,7 @@ This section is *mandatory*. (!) * Any valid number. - This will create the file *max-death-tally*. Once this file was created the value will equal the maximum number of service death events that the supervisor will keep track of. If the service dies more than this number of times, the oldest event will be forgotten and the transition ([66-start](66-start.html) or [66-stop](66-stop.html)) will be declared as failed. Tracking death events is useful, for example, when throttling service restarts. The value cannot be greater than 4096. Without this file a default of 3 is used. + This will create the file *max-death-tally*. Once this file was created the value will equal the maximum number of service death events that the supervisor will keep track of. If the service dies more than this number of times, the oldest event will be forgotten and the transition ([66-start](66-start.html) or [66-stop](66-stop.html)) will be declared as failed. Tracking death events is useful, for example, when throttling service restarts. The value cannot be greater than 4096. Without this file a default of 10 is used. --- @@ -1062,7 +1062,7 @@ The minimal template is: ``` [main] @type = classic,bundle,longrun,oneshot,module - @version = + @version = 0.0.0 @description = "" @user = () @@ -1128,4 +1128,5 @@ This prototype contain all valid section with all valid `key=value` pair. @files = ( key=value key=value ) @infiles = ( :filename:key=value ::key=value ) @addservices = () + @applyto = () ``` diff --git a/doc/init.md b/doc/init.md index 54704163..f5e8a6b6 100644 --- a/doc/init.md +++ b/doc/init.md @@ -22,7 +22,7 @@ Ther command `66 scandir create` need to executed before trying to run the `init ## Options -- **-h** : prints this help. +- **-h**: prints this help. ## Initialization process diff --git a/doc/module-service.md b/doc/module-service.md index b8257525..fce248fe 100644 --- a/doc/module-service.md +++ b/doc/module-service.md @@ -29,15 +29,15 @@ The [instantiated frontend service](instantiated-service.html) is written as any The module directory can contain three sub-directories: -- *configure* : This directory can contain an **executable** file script named configure. For example, `%%module_system%%/foo@/configure/configure`. The sub-directory **must** be named *configure* and the file script **must** be named *configure*. This file **is not** mandatory. The [66-enable](66-enable.html) process will detect if the file exists and it runs it if it's the case. It's up to you to write the *configure* script file with the language of your choice as long as you define a correct *shebang*. +- *configure*: This directory can contain an **executable** file script named configure. For example, `%%module_system%%/foo@/configure/configure`. The sub-directory **must** be named *configure* and the file script **must** be named *configure*. This file **is not** mandatory. The [66-enable](66-enable.html) process will detect if the file exists and it runs it if it's the case. It's up to you to write the *configure* script file with the language of your choice as long as you define a correct *shebang*. Also, this directory can contain any files or directories that you need to configure your module. It's the responsability of the module creator to properly use or dispatch files or directories found inside the *configure* directory with the help of the *configure* script or during the module installation phase. [66-enable](66-enable.html) will not handle any other file than the *configure* script for you. - **Note** : The *configure* script is launched after the parsing of the frontend file, meaning all regex operations on directories and files are already made. + **Note**: The *configure* script is launched after the parsing of the frontend file, meaning all regex operations on directories and files are already made. -- *service* : This directory can contain any frontend files for any kind of service ***except*** instantiated frontend service files. Also, this directory can contain sub-directories containing another frontend service files. This can be done recursively. +- *service*: This directory can contain any frontend files for any kind of service ***except*** instantiated frontend service files. Also, this directory can contain sub-directories containing another frontend service files. This can be done recursively. -- *service@* : This directory can contain any instantiated frontend service files and **only** instantiated frontend service files. Also, this directory can contain sub-directories containing other instantiated frontend service files. This can be done recursively. +- *service@*: This directory can contain any instantiated frontend service files and **only** instantiated frontend service files. Also, this directory can contain sub-directories containing other instantiated frontend service files. This can be done recursively. Any services that you need **must** be present inside the *service* or *service@* directory. [66-enable](66-enable.html) only deals with these directories. If a service `fooA` has `fooB` as dependency, `fooA` ***and*** `fooB` **must** exist in the `%%module_system%%/<module_name>/service` directory. @@ -77,7 +77,7 @@ When you do `66-enable foo@system`: - It verbatim copies the `%%module_system%%/foo@` directory to `%%service_system%%/foo@system`. If the frontend file was found at `%%service_adm%%/foo@` the module, it is copied to `%%service_adm%%/foo@system`, and if the frontend file was found at `$HOME/%%service_user%%/foo@`, the module is copied to `$HOME/%%service_user%%/foo@system`. - **Note** : if the module already exists and the **-F** was not passed to [66-enable](66-enable.html), the configuration of the modules is skipped. If The **-F** was passed to [66-enable](66-enable.html) the corresponding `%%service_system%%/foo@system` directory is erased and the verbatim copy is made. + **Note**: if the module already exists and the **-F** was not passed to [66-enable](66-enable.html), the configuration of the modules is skipped. If The **-F** was passed to [66-enable](66-enable.html) the corresponding `%%service_system%%/foo@system` directory is erased and the verbatim copy is made. - It reads all frontend file found at `%%service_system%%/foo@system/service` and `%%service_system%%/foo@system/service@` and applies the regex defined with `@infiles` field. diff --git a/doc/parse.md b/doc/parse.md index b27fb86d..2a0db9b4 100644 --- a/doc/parse.md +++ b/doc/parse.md @@ -25,11 +25,11 @@ The absolute path of the frontend service file can also be set. In this case, th ## Options -- **-h** : prints this help. +- **-h**: prints this help. -- **-f** : force. Owerwrite an existing parsing result. +- **-f**: force. Owerwrite an existing parsing result. -- **-I** : do not imports modified configuration files from the previous version used. Refer to [Service configuration file](service-configuration-file.html) for further information. +- **-I**: do not imports modified configuration files from the previous version used. Refer to [Service configuration file](service-configuration-file.html) for further information. ## Note diff --git a/doc/prototype.md b/doc/prototype.md index 5715f486..bb14eae7 100644 --- a/doc/prototype.md +++ b/doc/prototype.md @@ -23,4 +23,4 @@ author: Eric Vidal <eric@obarun.org> ## Options -- **- ** : +- **- **: diff --git a/doc/start.md b/doc/start.md index bc621935..9dee0a0e 100644 --- a/doc/start.md +++ b/doc/start.md @@ -29,9 +29,9 @@ In case of `module` *service* type, all *services* declared within the `module` ## Options -- **-h** : prints this help. +- **-h**: prints this help. -- **-P** : Do not handle service dependencies. In such cases, the *start* command will not attempt to start the services that are dependent on the service, regardless of their current state. +- **-P**: Do not handle service dependencies. In such cases, the *start* command will not attempt to start the services that are dependent on the service, regardless of their current state. ## Usage examples @@ -64,4 +64,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 b3dbde71..cbeadc1f 100644 --- a/doc/stop.md +++ b/doc/stop.md @@ -27,9 +27,9 @@ In case of `module` *service* type, all *services* declared within the `module` ## Options -- **-h** : prints this help. +- **-h**: prints this help. -- **-P** : Do not handle services required by dependencies. In such cases, the *stop* command will not attempt to stop the services that depend on the service, regardless of their current state. +- **-P**: Do not handle services required by dependencies. In such cases, the *stop* command will not attempt to stop the services that depend on the service, regardless of their current state. ## Usage examples @@ -57,4 +57,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 -- GitLab