summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2011-12-19 22:29:25 +0000
committerPatrick Totzke <patricktotzke@gmail.com>2011-12-19 22:29:25 +0000
commit807783439f89470218da5d913f7bf845b0210e82 (patch)
tree4e0a7cf938a87a1293cbdfebfe848fb3cb7b1b25 /docs
parent3b2debb8797a7d888c896cb8b291354f742ec1bd (diff)
add help2man include file for man generation
use gnu help2man to generate a manpage like this: help2man -o alot.1 -I manpage.in -N alot and nroff to read it: nroff -mandoc alot.1
Diffstat (limited to 'docs')
-rw-r--r--docs/man/manpage.in35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/man/manpage.in b/docs/man/manpage.in
new file mode 100644
index 00000000..621b9448
--- /dev/null
+++ b/docs/man/manpage.in
@@ -0,0 +1,35 @@
+[NAME]
+mail user agent for the notmuch mail system
+
+[SYNOPSIS]
+
+[DESCRIPTION]
+A terminal-based interface for the notmuch mail system.
+It features a modular and command prompt driven interface to provide a full MUA
+experience as an alternative to the Emacs mode shipped with notmuch.
+
+In all views, arrows, page-up/down, `j`,`k` and `Space` can be used to move the
+focus. `Escape` cancels prompts and `Enter` selects. Hit `:` at any time and type
+in commands to the prompt. Usage information on any command can be listed by typing
+`help YOURCOMMAND` to the prompt; The keybindings for the current mode are listet
+upon pressing `?`.
+
+See the COMMANDS section of this document for a list of commands interpreted by alot.
+
+
+
+[COMMANDS]
+todo
+
+
+[BUGS]
+Alot is a fairly new project, so expect misbehaviour. Bugs can be reported via the
+issue tracker on the projecs github page (https://github.com/pazz/alot).
+
+
+[AUTHOR]
+Patrick Totzke <patricktotzke at googlemail dot com>
+
+
+[SEE ALSO]
+notmuch(1)