path: root/doc
diff options
authorLukas Fleischer <calcurse@cryptocrack.de>2013-07-17 01:03:05 +0200
committerLukas Fleischer <calcurse@cryptocrack.de>2013-07-17 14:03:53 +0200
commit08f5064ef7b204d3c564f76b1c2e78d83d586a1a (patch)
tree5a5ab4e671aaba1694f70e40bceec7e9830c5831 /doc
parent2c25d99ad036c9ad473167b4f2f8e7dea9cd946e (diff)
Add introduction to the new online help system
This adds a very basic explanation of the new help command that can be displayed using ":help intro". This introduction is also added as default page so that users can simply type ":help" instead. Signed-off-by: Lukas Fleischer <calcurse@cryptocrack.de>
Diffstat (limited to 'doc')
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 8c74706..6c549c9 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -29,6 +29,7 @@ dist_doc_DATA = \
general.txt \
goto.txt \
import.txt \
+ intro.txt \
main.txt \
manual.txt \
other.txt \
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
+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