about summary refs log tree commit diff
path: root/bundles/s6/files/etc/s6-rc/README
diff options
context:
space:
mode:
Diffstat (limited to 'bundles/s6/files/etc/s6-rc/README')
-rw-r--r--bundles/s6/files/etc/s6-rc/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/bundles/s6/files/etc/s6-rc/README b/bundles/s6/files/etc/s6-rc/README
new file mode 100644
index 0000000..bd9014c
--- /dev/null
+++ b/bundles/s6/files/etc/s6-rc/README
@@ -0,0 +1,18 @@
+
+./services
+----------
+this is the base s6-rc service tree that is merged with the services generated
+by `s6-rc-generate`.
+There MUST at least be a default target, most commonly a `bundle` that declares
+the set of services that should run on boot.
+
+./templates
+-----------
+defines a set of services templates `s6-rc-generate` uses as input,
+the string `+service` will be replaced with the target service name
+(works in file names and inside files)
+
+./generate
+----------
+defines a set of services `s6-rc-generate` should generate,
+the names MUST be in the format <template>.<service>