From e6d7a1ec24144312102b0e48fef36ec4393904c6 Mon Sep 17 00:00:00 2001
From: Patrick Spek
Date: Fri, 10 Mar 2023 11:01:54 +0100
Subject: Update docs
---
share/doc/bashtard.3.scd | 18 +++++++++++++++++-
1 file changed, 17 insertions(+), 1 deletion(-)
(limited to 'share/doc/bashtard.3.scd')
diff --git a/share/doc/bashtard.3.scd b/share/doc/bashtard.3.scd
index 341d8fc..0f582fa 100644
--- a/share/doc/bashtard.3.scd
+++ b/share/doc/bashtard.3.scd
@@ -1,6 +1,6 @@
bashtard(3)
-; SPDX-FileCopyrightText: 2022 Patrick Spek
+; SPDX-FileCopyrightText: 2023 Patrick Spek
; SPDX-License-Identifier: AGPL-3.0-or-later
# NAME
@@ -46,6 +46,13 @@ more information on this.
The name of the currently running playbook.
+## BASHTARD_PLAYBOOK_VARS
+
+An associative array, in which the keys are the config keys. The value of each
+element is a space-seperated list of attributes to which the config value must
+adhere. Currently, only _required_ is available, forcing a variable's value to
+be non-empty when the playbook is ran.
+
# FUNCTIONS
## config $key
@@ -75,6 +82,15 @@ resolve the *pkg.nginx*, and install whichever value it came up with. These are
generally defined in the *os.d* of a *playbook*, to handle situations where
certain systems name their packages differently.
+## playbook_path $name
+
+The *playbook_path()* function is a convenience function to allow easy access to
+various (absolute) paths that are useful during playbook exection. Currently,
+the following _name_ arguments are accepted:
+
+- *base*
+- *data*
+
## svc $action $svc
The *svc()* function abstracts away the running system's service manager,
--
cgit v1.1