Add documentation

1 files changed, 32 insertions, 0 deletions

diff --git a/share/doc/playbooks.d.7.scd b/share/doc/playbooks.d.7.scd
new file mode 100644
index 0000000..1d2af2e
--- /dev/null
+++ b/share/doc/playbooks.d.7.scd
@@ -0,0 +1,32 @@
+playbooks.d(7) "/etc/bashtard/playbooks.d"
+
+# INTRODUCTION
+
+*bashtard* playbooks are, in essence, no more than directories with a small
+number of required files. Even remote playbooks just get cloned into regular
+directories inside _playbooks.d_. The files you must include in any playbook
+are:
+
+- description.txt
+- playbook.bash
+
+The filename are case sensitive, and the extensions are required.
+
+# HIERARCHY
+
+# description.txt
+
+This is a small text file which contains a small description of the playbook,
+usually only a single sentence. This description is shown in the usage output of
+*bashtard*.
+
+# playbook.bash
+
+The _playbook.bash_ file is a regular Bash script. It must contain 3 specific
+functions, which are called by *bashtard* when the appropriate subcommand is
+invoked. These functions are _playbook_add()_, _playbook_sync()_, and
+_playbook_del()_. How you define these functions is up to you.
+
+# SEE ALSO
+
+- _bashtard(3)_ -- Variables and functions exposed by Bashtard