aboutsummaryrefslogtreecommitdiff
path: root/share/doc/bashtard.1.scd
diff options
context:
space:
mode:
authorPatrick Spek <p.spek@tyil.nl>2022-04-19 15:32:55 +0200
committerPatrick Spek <p.spek@tyil.nl>2022-04-19 15:32:55 +0200
commit685ccfd9e0d0d89b404129eb4ec068c923b375bc (patch)
treebadeca675a972e07315642f570da0bb6fee82c47 /share/doc/bashtard.1.scd
parent9376473a6ff9ca276aa4650a7103d631005affd9 (diff)
Add documentation
Diffstat (limited to 'share/doc/bashtard.1.scd')
-rw-r--r--share/doc/bashtard.1.scd29
1 files changed, 29 insertions, 0 deletions
diff --git a/share/doc/bashtard.1.scd b/share/doc/bashtard.1.scd
new file mode 100644
index 0000000..c176c57
--- /dev/null
+++ b/share/doc/bashtard.1.scd
@@ -0,0 +1,29 @@
+bashtard(1)
+
+# NAME
+
+bashtard - A Bash-based configuration management utility
+
+# SYNOPSIS
+
+*bashtard* -h++
+*bashtard* add <_playbook_>++
+*bashtard* bootstrap [_repository_]++
+*bashtard* del <_playbook_>++
+*bashtard* ssh <_command_>++
+*bashtard* sync [_playbook_]++
+*bashtard* sysinfo
+
+# DESCRIPTION
+
+*bashtard* is a relatively simple Bash-based utility, providing just enough
+abstractions over certain OS-specific tools to allow you to write generic
+configuration and maintainance scripts, known as *playbooks*.
+
+# SEE ALSO
+
+- _bashtard(3)_ -- Functions and variables exposed by *bashtard* for use in
+ playbooks
+- _bashtard(5)_ -- Configuration files and formats used by *bashtard*
+- _bashtard(7)_ -- Filesystem layout for /etc/bashtard
+- _playbooks.d(7)_ -- Filesystem layout for /etc/bashtard/playbooks.d