Simple utility to turn swipes into words -- "plugin" for wvkbd to enable swipe-typing under wayland SXMO.
Documentation: Add man pages for swipeGuess and mapScore
Zach DeCook 2022-06-29
parent c006ba2 · commit 9e9cef8
-rw-r--r--mapScore.1.scd15
-rw-r--r--swipeGuess.1.scd23
2 files changed, 38 insertions, 0 deletions
diff --git a/mapScore.1.scd b/mapScore.1.scd
new file mode 100644
index 0000000..8bf97b6
--- /dev/null
+++ b/mapScore.1.scd
@@ -0,0 +1,15 @@
+mapScore(1)
+
+# NAME
+mapScore - score words by path length through 2D letter map
+
+# SYNOPSIS
+
+*mapScore* _map.tsv_ [_bee_] < _words.txt_ > _scored_words.tsv_
+
+# OPTIONS
+_bee_
+ Calculates score differently by treating _map.tsv_ as a hex-grid (even lines indented halfway)
+
+# SEE ALSO
+*swipeGuess*(1)
diff --git a/swipeGuess.1.scd b/swipeGuess.1.scd
new file mode 100644
index 0000000..01d02c7
--- /dev/null
+++ b/swipeGuess.1.scd
@@ -0,0 +1,23 @@
+swipeGuess(1)
+
+# NAME
+swipeGuess - infer the word you meant from a swipe
+
+# SYNOPSIS
+
+*swipeGuess* _words.txt_ [_n_] < _input_swipes.txt_ > _output_guesses.tsv_
+
+wvkbd -O | *swipeGuess* _words.txt_ | completelyTypeWord.sh
+
+wvkbd -O | *swipeGuess* _words.txt_ 5 | suggpicker | completelyTypeWord.sh
+
+# OPTIONS
+_n_
+ Number of results that should be returned (default 1).
+
+# DESCRIPTION
+
+For each line of stdin, outputs the first _n_ results from _words.txt_ which could be an ordered subset of that line, separated by tabs.
+
+# SEE ALSO
+*suggpicker*(1) *wvkbd*(1) *SwipeBehavior*(7)