diff options
| author | Zach DeCook <zachdecook@librem.one> | 2022-06-29 21:08:19 -0400 |
|---|---|---|
| committer | Zach DeCook <zachdecook@librem.one> | 2022-06-29 21:51:36 -0400 |
| commit | 9e9cef85c03800cce37055999f25fd6220f05772 (patch) | |
| tree | cf0ee2a94d1c6c732fe1c5b4925690c9f781489f | |
| parent | c006ba2ad828dca1d1c851bb2fbddd457fe577d9 (diff) | |
| download | swipeGuess-9e9cef85c03800cce37055999f25fd6220f05772.tar.gz | |
Documentation: Add man pages for swipeGuess and mapScore
| -rw-r--r-- | mapScore.1.scd | 15 | ||||
| -rw-r--r-- | swipeGuess.1.scd | 23 |
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) |