about summary refs log tree commit diff
path: root/suggpicker.1.scd
diff options
context:
space:
mode:
authorZach DeCook <zachdecook@librem.one>2022-06-29 21:50:52 -0400
committerZach DeCook <zachdecook@librem.one>2022-06-29 21:53:04 -0400
commitaf63ed2e6fea0b1b13e977d9eb8563119b8bbf2c (patch)
tree3259e8f5b0bdbd68a54a475826b2958ce7e1e380 /suggpicker.1.scd
parentfb48d006fa0d539a1d98ed0b731a0b359f1dce1d (diff)
downloadsuggpicker-af63ed2e6fea0b1b13e977d9eb8563119b8bbf2c.tar.gz
Documentation: Add man page
Diffstat (limited to 'suggpicker.1.scd')
-rw-r--r--suggpicker.1.scd21
1 files changed, 21 insertions, 0 deletions
diff --git a/suggpicker.1.scd b/suggpicker.1.scd
new file mode 100644
index 0000000..9800255
--- /dev/null
+++ b/suggpicker.1.scd
@@ -0,0 +1,21 @@
+suggpicker(1)
+
+# NAME
+suggpicker - floating bar for making decisions
+
+# SYNOPSIS
+
+suggpicker < choices.sock > selection.sock
+
+wvkbd -O | swipeGuess words.txt 5 | *suggpicker* | completelyTypeWord.sh
+
+# DESCRIPTION
+
+*suggpicker* is a persistent dynamic menu for Wayland.
+
+Each line of tab-separated choices it reads changes the choices on the bar. Choices which are clicked or tapped will be outputted into stdout, so it can be processed by another program.
+
+It's made to be used in conjunction with a virtual keyboard, which it will float above or below.
+
+# SEE ALSO
+*bemenu*(1) *swipeGuess*(1) *wvkbd*(1) *SwipeBehavior*(7)