From 4663e85eefb6bc5dd68a0d18c947f221176920cb Mon Sep 17 00:00:00 2001
From: Phil Jones <philj56@gmail.com>
Date: Sun, 26 Jun 2022 09:56:32 +0100
Subject: Add generated markdown manpages.

---
 doc/tofi.1.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 doc/tofi.1.md

(limited to 'doc/tofi.1.md')

diff --git a/doc/tofi.1.md b/doc/tofi.1.md
new file mode 100644
index 0000000..6177b2d
--- /dev/null
+++ b/doc/tofi.1.md
@@ -0,0 +1,79 @@
+# NAME
+
+tofi - Tiny dynamic menu for Wayland, inspired by **rofi**(1) and
+**dmenu**(1).
+
+# SYNOPSIS
+
+**tofi** \[options...\]
+
+**tofi-run** \[options...\]
+
+**tofi-compgen**
+
+# DESCRIPTION
+
+**tofi** is a tiny dynamic menu for Wayland compositors supporting the
+layer-shell protocol. It reads newline-separated items from stdin, and
+displays a graphical selection menu. When a selection is made, it is
+printed to stdout.
+
+When invoked via the name **tofi-run**, **tofi** will not accept items
+on stdin, instead presenting a list of executables in the user's $PATH.
+
+**tofi-compgen** just prints the list of executables used by
+**tofi-run**.
+
+# OPTIONS
+
+**-h, --help**
+
+> Print help and exit.
+
+**-c, --config** \<path\>
+
+> Specify path to custom config file.
+
+All config file options described in **tofi**(5) are also accepted, in
+the form **--key=value**.
+
+# KEYS
+
+\<Up\> \| \<Left\>
+
+> Move the selection back one entry.
+
+\<Down\> \| \<Right\>
+
+> Move the selection back forward entry.
+
+\<Enter\>
+
+> Confirm the current selection and quit.
+
+\<Escape\>
+
+> Quit without making a selection.
+
+# FILES
+
+*$XDG_CONFIG_HOME/tofi/config*
+
+> The default configuration file.
+
+*$XDG_CACHE_HOME/tofi-compgen*
+
+> Cached list of executables under $PATH, regenerated as necessary.
+
+*$XDG_STATE_HOME/tofi-history*
+
+> Numeric count of commands selected in **tofi-run**, to enable sorting
+> results by run count.
+
+# AUTHORS
+
+Philip Jones \<philj56@gmail.com\>
+
+# SEE ALSO
+
+**tofi**(5), **dmenu**(1) **rofi**(1)
-- 
cgit v1.2.3