summary refs log tree commit diff
path: root/swipeGuess.1.scd
diff options
context:
space:
mode:
authorZach DeCook <zachdecook@librem.one>2022-06-29 21:08:19 -0400
committerZach DeCook <zachdecook@librem.one>2022-06-29 21:51:36 -0400
commit9e9cef85c03800cce37055999f25fd6220f05772 (patch)
treecf0ee2a94d1c6c732fe1c5b4925690c9f781489f /swipeGuess.1.scd
parentc006ba2ad828dca1d1c851bb2fbddd457fe577d9 (diff)
downloadswipeGuess-9e9cef85c03800cce37055999f25fd6220f05772.tar.gz
Documentation: Add man pages for swipeGuess and mapScore
Diffstat (limited to 'swipeGuess.1.scd')
-rw-r--r--swipeGuess.1.scd23
1 files changed, 23 insertions, 0 deletions
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)