path: root/doc/enote.txt
diff options
authorLukas Fleischer <calcurse@cryptocrack.de>2013-07-09 00:31:30 +0200
committerLukas Fleischer <calcurse@cryptocrack.de>2013-07-09 00:34:21 +0200
commit906c2fa02731af0a02338b57096947f5b993759d (patch)
treee932888c24faf56df515051dcfad4ac8d5692cc4 /doc/enote.txt
parenta3d43ead87a742e6c1ffa24c9528608cc68c7e52 (diff)
Export online help as text files
Move the texts of each online help screen to a separate text file. The set of files is supposed to replace the online help screens later. Signed-off-by: Lukas Fleischer <calcurse@cryptocrack.de>
Diffstat (limited to 'doc/enote.txt')
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/enote.txt b/doc/enote.txt
new file mode 100644
index 0000000..e928960
--- /dev/null
+++ b/doc/enote.txt
@@ -0,0 +1,21 @@
+Attach a note to any type of item, or edit an already existing note.
+This feature is useful if you do not have enough space to store all
+of your item description, or if you would like to add sub-tasks to an
+already existing todo item for example.
+Before pressing the 'n' key, you first need to highlight the item you
+want the note to be attached to. Then you will be driven to an
+external editor to edit your note. This editor is chosen the following
+ o if the 'VISUAL' environment variable is set, then this will be
+ the default editor to be called.
+ o if 'VISUAL' is not set, then the 'EDITOR' environment variable
+ will be used as the default editor.
+ o if none of the above environment variables is set, then
+ '/usr/bin/vi' will be used.
+Once the item note is edited and saved, quit your favorite editor.
+You will then go back to Calcurse, and the '>' sign will appear in front
+of the highlighted item, meaning there is a note attached to it. \ No newline at end of file