From 9e9cef85c03800cce37055999f25fd6220f05772 Mon Sep 17 00:00:00 2001
From: Zach DeCook <zachdecook@librem.one>
Date: Wed, 29 Jun 2022 21:08:19 -0400
Subject: Documentation: Add man pages for swipeGuess and mapScore

---
 swipeGuess.1.scd | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 swipeGuess.1.scd

(limited to 'swipeGuess.1.scd')

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)
-- 
cgit 1.4.1