summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLukas Fleischer <calcurse@cryptocrack.de>2012-05-16 13:01:21 +0200
committerLukas Fleischer <calcurse@cryptocrack.de>2012-05-17 17:54:04 +0200
commit6d88b330f25769551338366f1f081fd58b58b44b (patch)
tree126c54dd1656ac35fedbf9c99eb63c2a1e3e9e60
parent60ad4adb378e5ca0f9bd2122743ebeb26ae7dcde (diff)
downloadcalcurse-6d88b330f25769551338366f1f081fd58b58b44b.tar.gz
calcurse-6d88b330f25769551338366f1f081fd58b58b44b.zip
doc/manual.txt: Update note file naming scheme
We are now using hash-based note file names instead of mkstemp() (cf. commit 5c6a00ee93e54cc044aee5146e9fcfbcb732a2ee). Update the documentation accordingly. Also, add a note on the garbage collector we added in 8d71923d4f498c8d2fcb22a72346e3e77a7c4a5b. Signed-off-by: Lukas Fleischer <calcurse@cryptocrack.de>
-rw-r--r--doc/manual.txt7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/manual.txt b/doc/manual.txt
index 03abdd3..f074826 100644
--- a/doc/manual.txt
+++ b/doc/manual.txt
@@ -538,9 +538,10 @@ $HOME/.calcurse/
----
`notes/`::
this subdirectory contains descriptions of the notes which are attached to
- appointments, events or todos. One text file is created per note, whose name
- is built using mkstemp(3) and should be unique, but with no relation with the
- corresponding item's description.
+ appointments, events or todos. Since the file name of each note file is a
+ SHA1 hash of the note itself, multiple items can share the same note file.
+ calcurse provides a garbage collector (see the `-g` command line parameter)
+ that can be used to remove note files which are no longer linked to any item.
`conf`::
this file contains the user configuration
`keys`::