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

update doc

parent dc2ee97a
Branches parser
Tags
No related merge requests found
......@@ -6,7 +6,7 @@
# SYNOPSIS
66-disable [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-S* ] _service_...
66-disable [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-S* ] _service_...
# DESCRIPTION
......@@ -30,6 +30,9 @@ recursively until all dependencies are disabled.
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
- *1* : (Default) Only print error messages.++
......
......@@ -6,14 +6,14 @@
# SYNOPSIS
66-enable [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-f|F* ] [ *-c|C* ] [ *-S* ] _service_...
66-enable [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-f|F* ] [ *-c|C* ] [ *-S* ] _service_...
# DESCRIPTION
*66-enable* expects to find a corresponding _frontend service file_ (see
*66-frontend*(5)), a _directory name_ or a _service instance_, by default at
*%%service_sys%%* or *%%service_packager%%* in this order of precedence for
root user and *%%service_user%%*, *%%service_sys%%* or *%%service_packager%%*
*%%service_adm%%* or *%%service_system%%* in this order of precedence for
root user and *%%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-sys-service=_DIR_, \--with-packager-service=_DIR_ and --with-user-service=_DIR_ to
*./configure.*
......@@ -31,6 +31,9 @@ Multiple _services_ can be enabled by seperating their names with a space.
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
- *1* : (Default) Only print error messages.++
......@@ -79,7 +82,7 @@ This works recursively until all necessary dependencies are enabled.
# DIRECTORY NAME AS SERVICE
When choosing to make a directory be recognised as service the path of the
directory must exist by default at *%%service_sys%%*, *%%service_packager%%*
directory must exist by default at *%%service_adm%%*, *%%service_system%%*
or *$HOME/%%service_user%%* depending of the owner of the process.
All _service_ files found in this directory will be enabled. This process
is done recursively if a sub-directory is found till it not found other
......@@ -115,7 +118,7 @@ frontend service file.
## SERVICE CONFIGURATION FILE
If the *[environment]* section is set on the frontend service file, the parse
result process can be found by default at *%%service_sysconf%%* for the root
result process can be found by default at *%%service_admconf%%* for the root
user and *$HOME/%%service_userconf%%* for a normal user. The default path can
be changed at compile time by passing the --with-sys-service-conf=_DIR_ for the
root user and --with-user-service-conf=_DIR_ for a normal user.
......
......@@ -7,12 +7,12 @@ on the options passed.
# SYNOPSIS
66-env [ *-h* ] [ *-v* _verbosity_ ] [ *-t* _tree_ ] [ *-d* _dir_ ] [ *-L* ] [ *-r* _key=value_ ] _service_
66-env [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-t* _tree_ ] [ *-d* _dir_ ] [ *-L* ] [ *-r* _key=value_ ] _service_
# DESCRIPTION
*66-env* open and read the configuration file of _service_ find at
*%%service_sysconf%%* by default.
*%%service_admconf%%* by default.
It display the contain of the file or replace a _key=value_ pair if requested.
......@@ -21,6 +21,9 @@ It display the contain of the file or replace a _key=value_ pair if requested.
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
*1* : (Default) Only print error messages.++
......
......@@ -14,7 +14,7 @@
hardware shutdown with the *-f* option.
It is normally invoked through *halt*, *poweroff* or *reboot* wrappers
installed by default at *%%sysconfdir%%*.
installed by default at *%%skel%%*.
This program is a modified copy of *s6-linux-init-hpr* program.
......
......@@ -5,7 +5,7 @@
# SYNOPSYS
66-init [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] *classic* | *database* | *both*
66-init [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] *classic* | *database* | *both*
# DESCRIPTION
......@@ -20,6 +20,9 @@ Administrators should invoke *66-init* only once.
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
- *1* : (Default) Only print error messages.++
......
......@@ -6,7 +6,7 @@
# SYNOPSYS
66-inservice [ *-h* ] [ *-v* _verbosity_ ] [ *-c* ] -[ *-n* ] [ *-o* _name,intree,enabled,..._ ] [ *-g* ] [ *-d* _depth_ ] [ *-r* ] [ *-t* _tree_ ] [ *-p* _nline_ ] _service_
66-inservice [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-n* ] [ *-o* _name,intree,enabled,..._ ] [ *-g* ] [ *-d* _depth_ ] [ *-r* ] [ *-t* _tree_ ] [ *-p* _nline_ ] _service_
# DESCRIPTION
......@@ -17,6 +17,9 @@
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
*1* : (Default) Only prints error messages.++
......@@ -24,9 +27,6 @@
*3* : Also prints tracing messages.++
*4* : Also prints debugging messages.
*-c*
enable colorization.
*-n*
do not display the field name(s) specified.
......@@ -116,7 +116,7 @@ In tree : boot
Status : enabled, nothing to display
Type : bundle
Description : Set the hostname and mount filesystem
Source : %%service_packager%%/boot/mount/00
Source : %%service_system%%/boot/mount/00
Live : %%livedir%%/tree/0/boot/servicedirs/00
Dependencies : system-hostname mount-run populate-run mount-tmp
populate-tmp mount-proc mount-sys populate-sys
......
......@@ -6,7 +6,7 @@
# SYNOPSYS
66-intree [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-c* ] [ *-n* ] [ *-o* name,init,enabled,... ] [ *-g* ] [ *-d* _depth_ ] [ *-r* ] _tree_
66-intree [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-n* ] [ *-o* name,init,enabled,... ] [ *-g* ] [ *-d* _depth_ ] [ *-r* ] _tree_
# DESCRIPTION
......@@ -17,6 +17,9 @@
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
*1* : (Default) Only prints error messages.++
......@@ -31,9 +34,6 @@
existing absolute path is expected and should be within a writable
filesystem - likely a RAM filesystem. See *66-scandir*(1).
*-c*
enable colorization.
*-n*
do not display the field name(s) specified.
......
......@@ -6,7 +6,7 @@
# SYNOPSIS
66-parser [ *-h* ] [ *-v* _verbosity_ ] [ *-f* ] [ *-c* | *-C* ] _service destination_
66-parser [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-f* ] [ *-c* | *-C* ] _service destination_
# DESCRIPTION
......@@ -21,6 +21,9 @@ An absolute path is expected for _service_ and _destination_.
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
- *1* : (Default) Only print error messages.++
......@@ -43,7 +46,7 @@ An absolute path is expected for _service_ and _destination_.
key of the given frontend file. This tool is maily intended for debugging
purpose and to see the result of a parsing process before actually enabling
the service on the system. This tool use the exact same parser as *66-enable*
which by default writes the configuration file to *%%service_sysconf%%*/_service_name_.
which by default writes the configuration file to *%%service_admconf%%*/_service_name_.
That's mean that a corresponding file will be overwritten. To avoid this,
it writes the configuration file at _destination/env/_ directory and adjust
the resulting *run/finish* file to match the configuration file path.
......@@ -6,7 +6,7 @@
# SYNOPSIS
66-scanctl [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-o* _owner_ ] _signal_
66-scanctl [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-o* _owner_ ] _signal_
# DESCRIPTION
......@@ -22,6 +22,9 @@ the current process will be used instead.
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
- *1* : (Default) Only print error messages.++
......
......@@ -6,7 +6,7 @@
# SYNOPSYS
66-scandir [ *-h* ] [ *-v* _verbosity_ ] [ *-b* ] [ *-l* _live_ ] [* -t* _rescan_ ] [ *-L* _log_user_ ] [ *-s* _skel_ ] [ *-e* _environment_ ] [ *-c* | *-r* | *-u* ] _owner_
66-scandir [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-b* ] [ *-l* _live_ ] [* -t* _rescan_ ] [ *-L* _log_user_ ] [ *-s* _skel_ ] [ *-e* _environment_ ] [ *-c* | *-r* | *-u* ] _owner_
# DESCRIPTION
......@@ -22,6 +22,9 @@ explicitely set then the user of the current process will be used instead.
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
*1* : (Default) Only print error messages.++
......@@ -56,7 +59,7 @@ explicitely set then the user of the current process will be used instead.
*-s* _skel_
An absolute path. Directory containing _skeleton_ files. This option is
not meant to be used directly even with root. *66-boot*(8) program calls it
at during the boot process.
at during the boot process. Default is %%skel%%.
*-L* _log_user_
Will run as the catch-all logger as _log_user_ user. Default is *%%s6log_user%%*.
......
......@@ -49,8 +49,8 @@ _time_ must follow the following format: [ *now* | [+]_mins_ | _hh_:_mm_ ]
*-a*
Access control. The shutdown sequence will only be launched if one of the
users listed in */etc/shutdown.allow* is currently logged in (as tracked by
utmp). */etc/shutdown.allow* is a text file which accepts one user per
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 comments.
*-t* _sec_
......@@ -87,7 +87,7 @@ _time_ must follow the following format: [ *now* | [+]_mins_ | _hh_:_mm_ ]
- The *66-shutdown* binary is not meant to be called directly. It shuold
always be referenced by the *shutdown* _skeloton_ file installed by default
at *%%sysconfdir%%* directory. The binary *should be copied or symlinked* by
at *%%skel%%* directory. The binary *should be copied or symlinked* by
the administrator into the binary directory of your system.
- *-f* and *-F* options are only accepted for compatibility. LSB says they are
......
......@@ -17,7 +17,7 @@ It is not meant to be called directly by the user. This program is a modified co
they are told to trigger the shutdown procedure.
- When it receives a command to shut down, *66-shutdownd* parses the _skel_
file _rc.init_ define by default at *%%sysconfdir%%* directory and reads the
file _rc.init_ define by default at *%%skel%%* directory and reads the
value of *RCSHUTDOWN* variable to be able to spawns the _rc.shutdown_ script.
- When said script exits, *66-shutdownd* kills all processes with a
......@@ -42,7 +42,7 @@ It is not meant to be called directly by the user. This program is a modified co
*-s* _skel_
An abdolute path. Directory of the skeleton file _rc.init_. Default is
*%%sysconfdir%%*.
*%%skel%%*.
*-g* _gracetime_
Specify a grace time between the SIGTERM and the SIGKILLin milliseconds if
......
......@@ -6,7 +6,7 @@
# SYNOPSYS
66-start [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-r* | *-R* ] _service..._
66-start [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-r* | *-R* ] _service..._
# DESCRIPTION
......@@ -22,6 +22,9 @@ Multiple _services_ can be started by seperating their names with a space.
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
*1* : (Default) Only print error messages.++
......
......@@ -6,7 +6,7 @@
# SYNOPSYS
66-stop [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-u* ] [ *-X* ] [ *-K* ] _service..._
66-stop [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-u* ] [ *-X* ] [ *-K* ] _service..._
# DESCRIPTION
......@@ -21,6 +21,9 @@ Multiple _services_ can be stopped by seperating their names with a space.
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
*1* : (Default) Only print error messages.++
......
......@@ -6,7 +6,7 @@
# SYNOPSYS
66-svctl [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-n* _death_ ] [ *-u* | *-d* | *-r* | *-K* | *-X* ] _service..._
66-svctl [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-n* _death_ ] [ *-u* | *-d* | *-r* | *-K* | *-X* ] _service..._
# DESCRIPTION
......@@ -24,6 +24,9 @@ The command is sent to the _selection_ asynchronously.
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
*1* : (Default) Only print error messages.++
......
......@@ -6,7 +6,7 @@
# SYNOPSYS
66-tree [ *-h* ] [ *-v* _verbosity_ ] [ -l ] [ *-n* | *-R* ] [ *-a* | *-d* ] [ *-c* _clone_ ] [ *-S* _after_tree_ ] [ *-E* | *-D* ] [ *-U* ] [ *-C* ] _tree_
66-tree [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ -l ] [ *-n* | *-R* ] [ *-a* | *-d* ] [ *-c* _clone_ ] [ *-S* _after_tree_ ] [ *-E* | *-D* ] [ *-U* ] [ *-C* ] _tree_
# DESCRIPTION
......@@ -20,6 +20,9 @@ what trees are currently available on the system use the *66-intree*(1) tool.
*-h*
Prints this help.
*-z*
use color.
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
*1* : (Default) Only prints error messages.++
......
......@@ -6,7 +6,7 @@
# SYNOPSYS
66-update [ *-h* ] [ *-v* _verbosity_ ] [* -c* ] [ *-l* _live_ ] [ *-d* ] _tree_
66-update [ *-h* ] [*-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-d* ] _tree_
# DESCRIPTION
......@@ -25,6 +25,9 @@ without needing a reboot.
*-h*
Prints this help.
*-z*
use color
*-v* _verbosity_
Increases/decreases the verbosity of the command.++
*1* : (Default) Only prints error messages.++
......@@ -32,9 +35,6 @@ without needing a reboot.
*3* : Also prints tracing messages.++
*4* : Also prints debugging messages.
*-c*
enable colorization
*-l* _live_
An absolute path. Create the scandir at _live_. Default is *%%livedir%%*.
The default can also be changed at compile-time by passing the
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment