diff --git a/doc/index.md b/doc/index.md index 2975eb8aabb15ac899219710ef1a039a8e391b0b..e67ce03eeb86b01b08694ea8c892d80b5701279f 100644 --- a/doc/index.md +++ b/doc/index.md @@ -7,9 +7,9 @@ author: Eric Vidal <eric@obarun.org> # What is 66? -Sixty-six is a service manager built around [s6](https://skarnet.org/software/s6) created to make the implementation and manipulation of service files on your machine easier. It is meant to be a toolbox for the declaration, implementation and administration of services to achieve powerful functionality with small amounts of code. +Sixty-six is an init and service manager built around [s6](https://skarnet.org/software/s6) created to make the implementation and manipulation of service files on your machine easier. It is meant to be a toolbox for the declaration, implementation and administration of services to achieve powerful functionality with small amounts of code. -Examples of what can be achieved by assembling different programs provided by *66*: +Examples of what can be achieved by assembling different programs provided by `66`: - Frontend service files declaration. - Easy creation of a scandir. @@ -21,10 +21,15 @@ Examples of what can be achieved by assembling different programs provided by *6 - Service Notification. - Organizes services as a tree. - Easy view of service status. +- log file in human readable format. - User service declaration. - Automatic dependencies service chain. - ... +`66` can easily be used within container. With one command, [66 scandir start](scandir.html), you are ready to go to supervise and manage any kind of service as root or regular account. + +Booting with `66` to be able to supervise and manage services **is not** mandatory. You can use it in parallel with another init or service manager, start a `scandir` directory with the [66 scandir start](scandir.html) command, and you are ready to supervise any kind of services. + **Note**: This documentation tries to be complete and self-contained. However, if you have never heard of [s6](https://skarnet.org/software/s6) you might be confused at first. Please refer to the skarnet documentation if in doubt. ## Installation @@ -35,7 +40,7 @@ Please refer to the [INSTALL.md](https://git.obarun.org/Obarun/66) file for deta ### Licensing -*66* is free software. It is available under the [ISC license](http://opensource.org/licenses/ISC). +`66` is free software. It is available under the [ISC license](http://opensource.org/licenses/ISC). ### Upgrade @@ -100,11 +105,11 @@ See [changes](upgrade.html) between version. ## Why is 66 necessary? -Implementation and handling of service files based on [s6](https://skarnet.org/software/s6) can be complex and difficult to understand. This led to the creation of the 66 program. +Implementation and handling of service files based on [s6](https://skarnet.org/software/s6) can be complex and difficult to understand. This led to the creation of the `66` program. Why the name? -Previously *66* was the result of the combination of the former [s6](https://skarnet.org/software/s6) and [s6-rc](https://skarnet.org/software/s6-rc). With time and code improvement the `s6-rc` was dropped. `66` is now a fully independent service manager, although the name has been retained. +Previously `66` was the result of the combination of the former [s6](https://skarnet.org/software/s6) and [s6-rc](https://skarnet.org/software/s6-rc). With time and code improvement the `s6-rc` program was dropped. `66` is now a fully independent service manager, although the name has been retained. It is a lot faster and easier to write and remember when writing. Apart from that it is a nice command prefix to have. It identifies the origin of the software and it's short. -Expect more use of the *66-* prefix in future [obarun](https://web.obarun.org) software releases and please avoid using it for your own projects. +Expect more use of the `66-` prefix in future [obarun](https://web.obarun.org) software releases and please avoid using it for your own projects.