From 2414e6b200348b7c37b44ff77a9ba668b92dc9c6 Mon Sep 17 00:00:00 2001
From: Zach DeCook <zachdecook@librem.one>
Date: Wed, 29 Jun 2022 20:13:45 -0400
Subject: Documentation: Add man pages in scdoc format

---
 SwipeBehavior.7.scd | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 SwipeBehavior.7.scd

(limited to 'SwipeBehavior.7.scd')

diff --git a/SwipeBehavior.7.scd b/SwipeBehavior.7.scd
new file mode 100644
index 0000000..79061a2
--- /dev/null
+++ b/SwipeBehavior.7.scd
@@ -0,0 +1,46 @@
+SwipeBehavior(7) "SwipeBehaviors"
+
+# NAME
+SwipeBehavior - provide function for swipe keyboard
+
+# SYNOPSIS
+
+```
+wvkbd -O | sb_something.sh
+```
+
+# DESCRIPTION
+
+A _SwipeBehavior_ is a program which provides extra functionality to a swipe-capable keyboard.
+
+. The swipe-capable keyboard writes a line of output, representing what keys were intersected during a swipe.
+. The _SwipeBehavior_ acts on that.
+. This repeats as you use the keyboard.
+. When the swipe-capable keyboard closes its stream, the _SwipeBehavior_ quits itself.
+
+A _SwipeBehavior_ could do many things
+- typing words
+- prompt the user for more input
+- log your keystrokes for the NSA
+
+So, you should obviously only use trustworthy software as your _SwipeBehavior_ (i.e. free software which you have audited yourself).
+
+# EXAMPLES
+
+To use a _SwipeBehavior_ linked to by *swipeB* in SXMO-sway,++
+put this in your profile and relog.
+
+```
+export KEYBOARD_ARGS="-O | swipeB"
+```
+
+Then you can choose your preferred behavior using a symlink, e.g.
+
+```
+ln -s "$(which sb_something.sh)" ~/.local/bin/swipeB
+```
+
+and reopen the keyboard.
+
+# SEE ALSO
+*suggpicker*(1) *wvkbd*(1)
-- 
cgit 1.4.1