path: root/share
diff options
authorPatrick Spek <p.spek@tyil.nl>2022-05-06 19:36:09 +0200
committerPatrick Spek <p.spek@tyil.nl>2022-05-06 19:36:09 +0200
commita675781f1e975ce64734b146ca1dcfff6b1e2cec (patch)
treecc4e5a9310e5cf5be3cc1b2e9c56e7de89d38fc1 /share
parentc817f9bc3def0b590bcee70fa0792a48277ab9ee (diff)
Update docsv1.0.0
Diffstat (limited to 'share')
1 files changed, 51 insertions, 1 deletions
diff --git a/share/doc/bashtard.1.scd b/share/doc/bashtard.1.scd
index c8d7e1d..ca8b248 100644
--- a/share/doc/bashtard.1.scd
+++ b/share/doc/bashtard.1.scd
@@ -8,10 +8,12 @@ bashtard - A Bash-based configuration management utility
*bashtard* -h++
*bashtard* add <_playbook_>++
-*bashtard* bootstrap [_repository_]++
*bashtard* del <_playbook_>++
+*bashtard* init [_repository_]++
*bashtard* ssh <_command_>++
*bashtard* sync [_playbook_]++
+*bashtard* var [-p _playbook_] <_key_>++
+*bashtard* var [-s] <_key_> <_value_>++
*bashtard* sysinfo
@@ -20,6 +22,54 @@ bashtard - A Bash-based configuration management utility
abstractions over certain OS-specific tools to allow you to write generic
configuration and maintenance scripts, known as *playbooks*.
+## add
+Adds a playbook to the current host. This will trigger the *playbook_add()*
+function of the *playbook.bash* file in the root of the playbook directory. It
+will also record the playbook name in the host's registry, so it will be taken
+into account during a *sync*.
+## del
+Removes a playbook from the current host. This will trigger the *playbook_del()*
+function of the *playbook.bash* file in the root of the playbook directory. It
+also removes the playbook name from the host's registry, no longer including it
+during a *sync*.
+## init
+Initializes *bashtard*, creating the required directory structure in
+*/etc/bashtard*, or your OS's equivalent directory. You can check the *sysinfo*
+subcommand to determine the *etcdir* if in doubt.
+If a repository URL has been provided, *bashtard* will attempt to use *git
+clone* to create the directory structure, and then add host-specific files to it
+## ssh
+Run a given command over SSH to all configured nodes. Every node needs to have
+*ssh.host* configured for this to work.
+## sync
+Synchronizes the etcdir and all registered playbooks. The etcdir is synchronized
+using *git pull*, after which it will check the host's registry to run the
+*playbook_sync()* function of all playbooks enabled on the machine.
+## var
+Allows debugging of variables used by *bashtard*. When given a key, it will
+return the *key=value* format to give you insight of what a variable will be on
+the current host. It accepts a *-p <playbook>* option, to get the value of a
+given variable when used in a given _playbook_.
+Alternatively, you can also supply a second positional argument, which will
+become the value of the given variable. This will be saved in the host-specific
+configuration file. This variant accepts the *-s* option, to instead save it to
+the *secrets* file, which should only be readable by the user maintaining the
+system through *bashtard*.
- _bashtard(3)_ -- Functions and variables exposed by *bashtard* for use in