aboutsummaryrefslogtreecommitdiffstats
path: root/examples/README
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2026-01-23 06:49:25 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2026-01-23 06:49:25 +0000
commit1aa3bc74170f10a4285827efa2748d1d6c2e4613 (patch)
tree3fc6b79944f119dddf85a1cf8758cfbbab607cbe /examples/README
parent3c61b2916c56bfa8d3ce7a6a5480eb93c2ed1470 (diff)
downloads6-rc-1aa3bc74170f10a4285827efa2748d1d6c2e4613.tar.gz
New example batch of service definitions
Diffstat (limited to 'examples/README')
-rw-r--r--examples/README22
1 files changed, 21 insertions, 1 deletions
diff --git a/examples/README b/examples/README
index 7f09970..d3ad328 100644
--- a/examples/README
+++ b/examples/README
@@ -1,4 +1,24 @@
- An example set of service definition directories.
+ Example sets of service definition directories.
+
+demo:
+
+ It is a manually constructed set of services, separated
+into two stores, meant to be used with the repo commands
+of s6-rc, or with the s6-frontend package, so that users
+can test the commands in a sandbox.
+ demo/0 and demo/1 should be the stores, hosting the service definitions.
+ Uppercase means the service is a longrun. Lowercase means the
+service is a oneshot.
+ Services named E*|e* are essential.
+ Services named R*|r* are recommended, i.e. they should appear as
+"active" rather than "usable" by default.
+ Services named N*|n* are only "usable" by default.
+ The number identifies the service.
+ Foo-log means the service is a logger for Foo.
+ Services that don't follow the format are bundles.
+
+
+source-router:
It is a real life example, used for the configuration of
a router with 4 ethernet interfaces and 2 wifi ones, behind