diff options
Diffstat (limited to 'share/doc/bashtard.5.scd')
| -rw-r--r-- | share/doc/bashtard.5.scd | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/share/doc/bashtard.5.scd b/share/doc/bashtard.5.scd new file mode 100644 index 0000000..c7791cf --- /dev/null +++ b/share/doc/bashtard.5.scd @@ -0,0 +1,30 @@ +bashtard(5) + +# INTRODUCTION + +When it comes to configuration, *bashtard* checks various locations for files +defining key-value pairs, mostly for use in *playbooks*. The files use a very +simple _key_=_value_ construction. The _key_ cannot contain an equals sign (=), +but the _value_ can. Quotes around the _value_ are not needed. If you add these, +they will be taken literally. If a _key_ is found in multiple configuration +files, the first hit will be used and subsequent files will not be tried. + +# PATHS + +The following paths are tried, in order, from top to bottom, to find a _key_: + +- $BASHTARD_ETCDIR/hosts.d/$host +- $BASHTARD_ETCDIR/os.d/${BASHTARD_PLATFORM[key]} +- $BASHTARD_ETCDIR/defaults +- $BASHTARD_ETCDIR/playbooks.d/$BASHTARD_PLAYBOOK/etc/os.d +- $BASHTARD_ETCDIR/playbooks.d/$BASHTARD_PLAYBOOK/etc/defaults +- $BASHTARD_SHAREDIR/os.d/${BASHTARD_PLATFORM[key]} +- $BASHTARD_SHAREDIR/defaults + +The *$BASHTARD_* variables are set by *bashtard* itself. More information about +these variables can be found in _bashtard(3)_. + +# SEE ALSO + +- _bashtard(3)_ -- Functions and variables exposed by *bashtard* for use in + playbooks |