summaryrefslogtreecommitdiff
path: root/doc/intro.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/intro.txt')
-rw-r--r--doc/intro.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/intro.txt b/doc/intro.txt
new file mode 100644
index 0000000..a841739
--- /dev/null
+++ b/doc/intro.txt
@@ -0,0 +1,15 @@
+calcurse Online Help
+====================
+
+Welcome to the calcurse online help. The online help system allows for easily
+getting help on specific calcurse features.
+
+On the calcurse main screen, type `:help <feature>` (e.g. `:help add`) to get
+help on a specific feature. Type `:help` without any parameter to display this
+introduction or simply use the corresponding keyboard shortcut (`?` by
+default).
+
+All help texts are displayed using an external pager. You need to exit the
+pager in order to get back to calcurse (pressing `q` should almost always
+work). The default pager can be changed by setting the PAGER environment
+variable.