Skip to content
Snippets Groups Projects
Commit c1c24511 authored by Eric Vidal's avatar Eric Vidal :speech_balloon:
Browse files

typo fix

parent ccc9617d
No related branches found
No related tags found
No related merge requests found
Pipeline #13671 passed
...@@ -46,36 +46,43 @@ The edition of the [configuration](service-configuration-file.html) file is the ...@@ -46,36 +46,43 @@ The edition of the [configuration](service-configuration-file.html) file is the
## Usage examples ## Usage examples
Lists the defined environment variable of the service `foo` Lists the defined environment variable of the service `foo`
``` ```
66 configure -L foo 66 configure -L foo
``` ```
Change the value of the `CMD_ARGS` variable for the service `nginx` Change the value of the `CMD_ARGS` variable for the service `nginx`
``` ```
66 configure -r CMD_ARGS='-c /etc/nginx/nginx.conf -g "daemon off;"' nginx 66 configure -r CMD_ARGS='-c /etc/nginx/nginx.conf -g "daemon off;"' nginx
``` ```
Import the configuration file from the 0.1.6 version to th e0.1.7 version of the service `foo` Import the configuration file from the 0.1.6 version to th e0.1.7 version of the service `foo`
``` ```
66 configure -i 0.1.6,0.1.7 foo 66 configure -i 0.1.6,0.1.7 foo
``` ```
Get the list of version available for the service `foo` Get the list of version available for the service `foo`
``` ```
66 configure -V foo 66 configure -V foo
``` ```
Edit the configuration file of the service `foo` using the `nano` editor Edit the configuration file of the service `foo` using the `nano` editor
``` ```
sudo 66 configure -e nano foo sudo 66 configure -e nano foo
``` ```
See the the defined environment variable of the service `foo` from the `0.1.6` version See the the defined environment variable of the service `foo` from the `0.1.6` version
``` ```
66 configure -s 0.1.6 -L foo 66 configure -s 0.1.6 -L foo
``` ```
List the defined environment variables of the service `barz` of the module `foo@foobar` List the defined environment variables of the service `barz` of the module `foo@foobar`
``` ```
66 configure -L foo@foobar:barz 66 configure -L foo@foobar:barz
``` ```
......
...@@ -36,16 +36,19 @@ This command handles [interdependencies](66.html#handling-dependencies). ...@@ -36,16 +36,19 @@ This command handles [interdependencies](66.html#handling-dependencies).
## Usage examples ## Usage examples
Disable the service Disable the service
``` ```
66 disable foo 66 disable foo
``` ```
Disable an intanced service Disable an intanced service
``` ```
66 disable foo@foobar 66 disable foo@foobar
``` ```
Disable and stop the service, also increase the default verbosity: Disable and stop the service, also increase the default verbosity:
``` ```
66 -v3 disable -S foo 66 -v3 disable -S foo
``` ```
...@@ -36,16 +36,19 @@ This command handles [interdependencies](66.html#handling-dependencies). ...@@ -36,16 +36,19 @@ This command handles [interdependencies](66.html#handling-dependencies).
## Usage examples ## Usage examples
Enable a service while specifying with the tree name(this only takes effect if the service has not been parsed before): Enable a service while specifying with the tree name(this only takes effect if the service has not been parsed before):
``` ```
66 -t treeA enable foo 66 -t treeA enable foo
``` ```
Enable an instanced service: Enable an instanced service:
``` ```
66 enable foo@foobar 66 enable foo@foobar
``` ```
Enable and start the service, also increase the default verbosity: Enable and start the service, also increase the default verbosity:
``` ```
66 -v3 enable -S foo 66 -v3 enable -S foo
``` ```
......
...@@ -38,21 +38,25 @@ The *when* provided **must be** on these formats: ...@@ -38,21 +38,25 @@ The *when* provided **must be** on these formats:
## Usage examples ## Usage examples
Halts the system. Halts the system.
``` ```
66 halt 66 halt
``` ```
Halts a broken system Halts a broken system
``` ```
66 halt -f 66 halt -f
``` ```
Halts the system after 10 minutes Halts the system after 10 minutes
``` ```
66 halt 10 66 halt 10
``` ```
Sends an "system will be halted in 10 minutes" to connected account and halt the system after 10 minutes Sends an "system will be halted in 10 minutes" to connected account and halt the system after 10 minutes
``` ```
66 halt -m "system will be halted in 10 minutes" 10 66 halt -m "system will be halted in 10 minutes" 10
``` ```
...@@ -50,37 +50,7 @@ See [changes](upgrade.html) between version. ...@@ -50,37 +50,7 @@ See [changes](upgrade.html) between version.
## Commands ## Commands
### Debug command - [66](66.html)
- [parse](parse.html)
- [resolve](resolve.html)
- [state](state.html)
### Admin command
- [boot](boot.html)
- [scandir](scandir.html)
- [init](init.html)
- [signal](signal.html)
### User command
- [start](start.html)
- [stop](stop.html)
- [enable](enable.html)
- [disable](disable.html)
- [reload](reload.html)
- [restart](restart.html)
- [status](status.html)
- [configure](configure.html)
- [reconfigure](reconfigure.html)
- [remove](remove.html)
- [free](free.html)
- [tree](tree.html)
- [poweroff](poweroff.html)
- [reboot](reboot.html)
- [halt](halt.html)
- [version](version.html)
### Extra tools ### Extra tools
......
...@@ -37,6 +37,7 @@ Users, even system administrator, should not need to directly invoke this comman ...@@ -37,6 +37,7 @@ Users, even system administrator, should not need to directly invoke this comman
## Usage examples ## Usage examples
Initiates services of tree `treefoo` Initiates services of tree `treefoo`
``` ```
66 init treefoo 66 init treefoo
``` ```
\ No newline at end of file
...@@ -12,6 +12,7 @@ author: Eric Vidal <eric@obarun.org> ...@@ -12,6 +12,7 @@ author: Eric Vidal <eric@obarun.org>
This documentation describe how to use *module* from an user point of view. If you want to create a *module*, refers to [service module creation](module-creation.html) page. This documentation describe how to use *module* from an user point of view. If you want to create a *module*, refers to [service module creation](module-creation.html) page.
A *module* is a [instantiated service](instantiated-service.html) and can be managed like any other instantiated services. For intance, to [start](start.html) it A *module* is a [instantiated service](instantiated-service.html) and can be managed like any other instantiated services. For intance, to [start](start.html) it
``` ```
66 start foo@bar 66 start foo@bar
``` ```
...@@ -19,16 +20,19 @@ A *module* is a [instantiated service](instantiated-service.html) and can be man ...@@ -19,16 +20,19 @@ A *module* is a [instantiated service](instantiated-service.html) and can be man
where `foo@` is the name of the *module* and `bar` the name of its intance. If the *module* was never parsed before, you will get the default configuration define by the developer of the *module* service. where `foo@` is the name of the *module* and `bar` the name of its intance. If the *module* was never parsed before, you will get the default configuration define by the developer of the *module* service.
Obviously you can [enable](enable.html) it Obviously you can [enable](enable.html) it
``` ```
66 enable foo@bar 66 enable foo@bar
``` ```
or makes these two operations in one pass or makes these two operations in one pass
``` ```
66 enable -S foo@bar 66 enable -S foo@bar
``` ```
The advantage of a *module* reside in the facts that you can [configure](configure.html) the *module* according to your needs. To do so, The advantage of a *module* reside in the facts that you can [configure](configure.html) the *module* according to your needs. To do so,
``` ```
66 configure foo@bar 66 configure foo@bar
``` ```
...@@ -36,6 +40,7 @@ The advantage of a *module* reside in the facts that you can [configure](configu ...@@ -36,6 +40,7 @@ The advantage of a *module* reside in the facts that you can [configure](configu
This command allow you to change the environment variable of the *module* and so, its configuration. This command allow you to change the environment variable of the *module* and so, its configuration.
Now, you need to apply the changes Now, you need to apply the changes
``` ```
66 reconfigure foo@bar 66 reconfigure foo@bar
``` ```
...@@ -45,16 +50,19 @@ The *module* should now use your configuration. The [reconfigure](reconfigure.ht ...@@ -45,16 +50,19 @@ The *module* should now use your configuration. The [reconfigure](reconfigure.ht
# Manage service within *module* # Manage service within *module*
As *module* is a set of services, when you start it, several services may be started. You can get the list of the services within *module* using the [status](status.html) command. As *module* is a set of services, when you start it, several services may be started. You can get the list of the services within *module* using the [status](status.html) command.
``` ```
66 status foo@bar 66 status foo@bar
``` ```
The command display different field notably the `contents` field corresponding to the list of the service within the *module*. You can control the state of these service like you do for any other services applying the following syntax The command display different field notably the `contents` field corresponding to the list of the service within the *module*. You can control the state of these service like you do for any other services applying the following syntax
``` ```
66 <command> <module_name>:<service_name> 66 <command> <module_name>:<service_name>
``` ```
For example, if `foo@bar` contain the service `baz` For example, if `foo@bar` contain the service `baz`
``` ```
66 stop foo@bar:baz 66 stop foo@bar:baz
``` ```
...@@ -62,6 +70,7 @@ For example, if `foo@bar` contain the service `baz` ...@@ -62,6 +70,7 @@ For example, if `foo@bar` contain the service `baz`
Simply separates the name of the *module* and the name of the service by a colon `:`. Simply separates the name of the *module* and the name of the service by a colon `:`.
A *module* can contain instantiated service. In this case use the same syntax specifying the complete name of the instantiated service. If `foo@bar` contain the instantiated service `bar@bou`, do A *module* can contain instantiated service. In this case use the same syntax specifying the complete name of the instantiated service. If `foo@bar` contain the instantiated service `bar@bou`, do
``` ```
66 reload foo@bar:bar@bou 66 reload foo@bar:bar@bou
``` ```
\ No newline at end of file
...@@ -42,21 +42,25 @@ However, a system administrator might want to parse a service frontend file unde ...@@ -42,21 +42,25 @@ However, a system administrator might want to parse a service frontend file unde
## Usage examples ## Usage examples
Parses the frontend file of `foo` service Parses the frontend file of `foo` service
``` ```
66 parse foo 66 parse foo
``` ```
Parses the frontend file of `foo` service without importing `key=value` pair previous configuration file Parses the frontend file of `foo` service without importing `key=value` pair previous configuration file
``` ```
66 parse -I foo 66 parse -I foo
``` ```
Force to parse again an existing parsing result of `foo` service Force to parse again an existing parsing result of `foo` service
``` ```
66 parse -f foo 66 parse -f foo
``` ```
Parses the frontend file of `foo` service specifying the localization of the frontend file Parses the frontend file of `foo` service specifying the localization of the frontend file
``` ```
66 parse %%service_adm%%/foo 66 parse %%service_adm%%/foo
``` ```
\ No newline at end of file
...@@ -38,21 +38,25 @@ The *when* provided **must be** on these formats: ...@@ -38,21 +38,25 @@ The *when* provided **must be** on these formats:
## Usage examples ## Usage examples
Shuts down the system. Shuts down the system.
``` ```
66 poweroff 66 poweroff
``` ```
Shuts down a broken system Shuts down a broken system
``` ```
66 poweroff -f 66 poweroff -f
``` ```
Shuts down the system after 10 minutes Shuts down the system after 10 minutes
``` ```
66 poweroff 10 66 poweroff 10
``` ```
Sends an "system will be shutted down in 10 minutes" to connected account and shuts down the system after 10 minutes Sends an "system will be shutted down in 10 minutes" to connected account and shuts down the system after 10 minutes
``` ```
66 poweroff -m "system will be shutted down in 10 minutes" 10 66 poweroff -m "system will be shutted down in 10 minutes" 10
``` ```
...@@ -38,21 +38,25 @@ The *when* provided **must be** on these formats: ...@@ -38,21 +38,25 @@ The *when* provided **must be** on these formats:
## Usage examples ## Usage examples
reboots the system. reboots the system.
``` ```
66 reboot 66 reboot
``` ```
reboots a broken system reboots a broken system
``` ```
66 reboot -f 66 reboot -f
``` ```
reboots the system after 10 minutes reboots the system after 10 minutes
``` ```
66 reboot 10 66 reboot 10
``` ```
Sends an "system will be rebooted in 10 minutes" to connected account and reboot the system after 10 minutes Sends an "system will be rebooted in 10 minutes" to connected account and reboot the system after 10 minutes
``` ```
66 reboot -m "system will be rebooted in 10 minutes" 10 66 reboot -m "system will be rebooted in 10 minutes" 10
``` ```
...@@ -36,11 +36,13 @@ This command handles [interdependencies](66.html#handling-dependencies) for the ...@@ -36,11 +36,13 @@ This command handles [interdependencies](66.html#handling-dependencies) for the
## Usage examples ## Usage examples
Reconfigures the `foo` service Reconfigures the `foo` service
``` ```
66 reconfigure foo 66 reconfigure foo
``` ```
Reconfigures the `foo@bar` module service Reconfigures the `foo@bar` module service
``` ```
66 reconfigure foo@bar 66 reconfigure foo@bar
``` ```
\ No newline at end of file
...@@ -38,11 +38,13 @@ This command handles [interdependencies](66.html#handling-dependencies). ...@@ -38,11 +38,13 @@ This command handles [interdependencies](66.html#handling-dependencies).
## Usage examples ## Usage examples
Reloads the `foo` service Reloads the `foo` service
``` ```
66 reload foo 66 reload foo
``` ```
Reloads the `foo-log` service Reloads the `foo-log` service
``` ```
66 reload -P foo-log 66 reload -P foo-log
``` ```
......
...@@ -34,11 +34,13 @@ This command handles [interdependencies](66.html#handling-dependencies). ...@@ -34,11 +34,13 @@ This command handles [interdependencies](66.html#handling-dependencies).
## Usage example ## Usage example
Removes the service `foo` Removes the service `foo`
``` ```
66 remove foo 66 remove foo
``` ```
Removes the service `foo` without touching its interdependencies Removes the service `foo` without touching its interdependencies
``` ```
66 remove -P foo 66 remove -P foo
``` ```
\ No newline at end of file
...@@ -28,6 +28,7 @@ This command displays the contents of the service's *resolve* file. This file ar ...@@ -28,6 +28,7 @@ This command displays the contents of the service's *resolve* file. This file ar
## Usage example ## Usage example
Displays the *resolve* file of service `foo` Displays the *resolve* file of service `foo`
``` ```
66 resolve foo 66 resolve foo
``` ```
\ No newline at end of file
...@@ -36,11 +36,13 @@ This command handles [interdependencies](66.html#handling-dependencies). ...@@ -36,11 +36,13 @@ This command handles [interdependencies](66.html#handling-dependencies).
## Usage examples ## Usage examples
Restarts the `foo` service Restarts the `foo` service
``` ```
66 restart foo 66 restart foo
``` ```
Restarts the `foo` service without handling its required-by dependencies Restarts the `foo` service without handling its required-by dependencies
``` ```
66 restart -P foo 66 restart -P foo
``` ```
\ No newline at end of file
...@@ -227,11 +227,13 @@ scandir reload [ -h ] ...@@ -227,11 +227,13 @@ scandir reload [ -h ]
#### Usage examples #### Usage examples
Reloads a running *scandir*. Reloads a running *scandir*.
``` ```
66 scandir reload 66 scandir reload
``` ```
Reloads a *scandir* for the owner `owner` Reloads a *scandir* for the owner `owner`
``` ```
66 scandir -o owner reload 66 scandir -o owner reload
``` ```
...@@ -255,11 +257,13 @@ scandir check [ -h ] ...@@ -255,11 +257,13 @@ scandir check [ -h ]
#### Usage examples #### Usage examples
Checks a *scandir* Checks a *scandir*
``` ```
66 scandir check 66 scandir check
``` ```
Checks a *scandir* for the owner `owner` Checks a *scandir* for the owner `owner`
``` ```
66 scandir -o owner check 66 scandir -o owner check
``` ```
...@@ -283,11 +287,13 @@ scandir quit [ -h ] ...@@ -283,11 +287,13 @@ scandir quit [ -h ]
#### Usage examples #### Usage examples
Quits a *scandir* running *scandir*. Quits a *scandir* running *scandir*.
``` ```
66 scandir quit 66 scandir quit
``` ```
Quits a *scandir* for the owner `owner` Quits a *scandir* for the owner `owner`
``` ```
66 scandir -o owner quit 66 scandir -o owner quit
``` ```
...@@ -311,11 +317,13 @@ scandir abort [ -h ] ...@@ -311,11 +317,13 @@ scandir abort [ -h ]
#### Usage examples #### Usage examples
Aborts a *scandir* Aborts a *scandir*
``` ```
66 scandir abort 66 scandir abort
``` ```
Aborts a *scandir* for the owner `owner` Aborts a *scandir* for the owner `owner`
``` ```
66 scandir -o owner abort 66 scandir -o owner abort
``` ```
...@@ -338,11 +346,13 @@ scandir nuke [ -h ] ...@@ -338,11 +346,13 @@ scandir nuke [ -h ]
#### Usage examples #### Usage examples
Kill s6-supervise processes from a *scandir* Kill s6-supervise processes from a *scandir*
``` ```
66 scandir nuke 66 scandir nuke
``` ```
Kill s6-supervise processes from a *scandir* for the owner `owner` Kill s6-supervise processes from a *scandir* for the owner `owner`
``` ```
66 scandir -o owner nuke 66 scandir -o owner nuke
``` ```
...@@ -366,11 +376,13 @@ Does the same thing as [nuke](#nuke), except that `SIGTERM` is sent to all the r ...@@ -366,11 +376,13 @@ Does the same thing as [nuke](#nuke), except that `SIGTERM` is sent to all the r
#### Usage examples #### Usage examples
Annihilates a *scandir* Annihilates a *scandir*
``` ```
66 scandir annihilate 66 scandir annihilate
``` ```
Annihilates a *scandir* for the owner `owner` Annihilates a *scandir* for the owner `owner`
``` ```
66 scandir -o owner annihilate 66 scandir -o owner annihilate
``` ```
...@@ -394,11 +406,13 @@ Immediately triggers s6-svscan's reaper mechanism. ...@@ -394,11 +406,13 @@ Immediately triggers s6-svscan's reaper mechanism.
#### Usage examples #### Usage examples
Removes zombies from a *scandir* Removes zombies from a *scandir*
``` ```
66 scandir zombies 66 scandir zombies
``` ```
Removes zombies from a *scandir* for the owner `owner` Removes zombies from a *scandir* for the owner `owner`
``` ```
66 scandir -o owner zombies 66 scandir -o owner zombies
``` ```
......
...@@ -59,26 +59,31 @@ This command handles [interdependencies](66.html#handling-dependencies). ...@@ -59,26 +59,31 @@ This command handles [interdependencies](66.html#handling-dependencies).
## Usage examples ## Usage examples
Send a SIGHUP signal to `foo` Send a SIGHUP signal to `foo`
``` ```
66 signal -H foo 66 signal -H foo
``` ```
Send a SIGHUP signal to `foo` by signal name Send a SIGHUP signal to `foo` by signal name
``` ```
66 signal -s SIGHUP foo 66 signal -s SIGHUP foo
``` ```
Triggers a log rotation of `foo-log` Triggers a log rotation of `foo-log`
``` ```
66 signal -a -P foo-log 66 signal -a -P foo-log
``` ```
Take down `foo` and block until the process is down and the finish script has completed Take down `foo` and block until the process is down and the finish script has completed
``` ```
66 signal -wD -d foo 66 signal -wD -d foo
``` ```
Bring up `foo` and block until it has sent notification that it is ready. Exit if it is still not ready after 5 seconds. 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 66 -T 5000 -wU -u foo
``` ```
\ No newline at end of file
...@@ -38,16 +38,19 @@ This command handles [interdependencies](66.html#handling-dependencies). ...@@ -38,16 +38,19 @@ This command handles [interdependencies](66.html#handling-dependencies).
## Usage examples ## Usage examples
Start a service handling its dependencies. Start a service handling its dependencies.
``` ```
66 start foo 66 start foo
``` ```
Start the service without handling any dependencies Start the service without handling any dependencies
``` ```
66 start -P foo 66 start -P foo
``` ```
Start a *service* in a specific *tree* if the service was never parsed Start a *service* in a specific *tree* if the service was never parsed
``` ```
66 -t treeA start foo 66 -t treeA start foo
``` ```
......
...@@ -26,6 +26,7 @@ This command displays the contents of the service's *state* file. This file are ...@@ -26,6 +26,7 @@ This command displays the contents of the service's *state* file. This file are
## Usage example ## Usage example
Display state of service `foo` Display state of service `foo`
``` ```
66 state foo 66 state foo
``` ```
\ No newline at end of file
...@@ -66,31 +66,37 @@ Without specifying the `-o`, all fields are displayed. ...@@ -66,31 +66,37 @@ Without specifying the `-o`, all fields are displayed.
## Usage examples ## Usage examples
Displays all information of service `foo` Displays all information of service `foo`
``` ```
66 status foo 66 status foo
``` ```
Only displays the field `name` and `status` of service `foo` Only displays the field `name` and `status` of service `foo`
``` ```
66 status -o name,status foo 66 status -o name,status foo
``` ```
Also, do not display the name of the field `name` and `status` of service `foo` Also, do not display the name of the field `name` and `status` of service `foo`
``` ```
66 status -no name,status foo 66 status -no name,status foo
``` ```
Only displays the contents of the log file of the service `foo` Only displays the contents of the log file of the service `foo`
``` ```
66 status -o logfile foo 66 status -o logfile foo
``` ```
Also, displays the last 100 lines of the log file of the service `foo` Also, displays the last 100 lines of the log file of the service `foo`
``` ```
66 status -o logfile -p100 foo 66 status -o logfile -p100 foo
``` ```
In a script you can do In a script you can do
``` ```
#!/bin/sh #!/bin/sh
...@@ -107,6 +113,7 @@ fi ...@@ -107,6 +113,7 @@ fi
``` ```
Displays information of the service using the graph mode Displays information of the service using the graph mode
``` ```
66 status -g dbus 66 status -g dbus
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment