ADDED: Topic support(requested). You can sort the various notes under

different topics now.
FIXED:          There was another bug, which caused the list command to display
                the notes with a too high value of $maxlen.
This commit is contained in:
TLINDEN
2012-02-10 20:09:11 +01:00
parent a9ee40e5c2
commit 6c5db55b5e
7 changed files with 432 additions and 105 deletions

53
README
View File

@@ -1,4 +1,4 @@
note 0.4.2 by Thomas Linden, 23/01/2000
note 0.5 by Thomas Linden, 23/01/2000
Introduction
@@ -13,7 +13,9 @@ Introduction
You can add, edit, list and delete as many notes
as you want. You can run note from the commandline
or interactive from within your console.
or interactive from within your console. You can
sort your notes in different topics, which is usefull
if you have a lot of them.
There are now two version of note in one package:
o (binary) the binary version resists in the
@@ -86,7 +88,12 @@ Usage
If you want to get an overview of all notes, type "note -l".
You will get a list of all notes, containing the number,
the first line and the creation date.
the first line and the creation date. If topic-support is
turned on (which is by default), then "-l" will display a list
of all existing topics. If you want to get a listing of all
notes under a certain topic, use "-l topicname". You will get
timestamps, if you use "-L" instead of "-l". Read more about
topics below in the section "Topics".
To edit a certain note, type "note -e 1". It will invoke your
editor (vi or pico). You can edit it, after saving, note
@@ -98,6 +105,9 @@ Usage
existent notes. For example there are 3 notes, number 1, 2
and 3. If you delete number 2, then number 3 will become
number 2.
You can also make use of the extended delete-syntax:
To delete note 1 and 2, use "-d 1,2"
To delete note 1,2 and 3, use "-d 1-3".
If you cannot remember, which note you are looking for, you
can use the search capability of note: "note -s <searchstring>".
@@ -107,7 +117,7 @@ Usage
Instead of using note from the commandline you can use the
interactive mode. Run note with "note -i". If you need assistance
type "?" or "h" at the "command>" prompt. The interactive mode
type "?" or "h" at the ">" prompt. The interactive mode
provides you the most functions of note.
You can also dump the contents of your note-database into a
@@ -120,6 +130,41 @@ Usage
Topics
======
If topic-support is turned on (which is by default), the various
notes are sorted under various topics. There is no special database
field for the topic. Instead the topic will be stored right in the
note.
If the first line of your note contains some text bordered by back-
slashes, then note will consider it as the topic of this certain
note. For examle:
\TodoList\
If you are in interactive mode, you can "cd" to a different note simply
by typing it's name at the command-prompt. The list-command will only
show you notes under this topic. If you create a new note, it will auto-
magically inserted under the current topic (note will prepend the string
"\topicname\" to the text of your note).
You can create at any time form any point a new topic. Just create a new
note and type yourself the name of the new topic bordered by backslashes
at the first line of this note. After saving, there will be available a
new topic with one note in it.
If a note does not contain the "magic" \topic\ construction on the first
line, it will be listed under the topic "default". Therefore never use the
word "default" as a topic-name :-)
You can subsequently move a note without a topic to a certain topic. Simply
edit it and insert at the first line the above mentioned construction.
Note: Please don't forget the prepending and appending backslash of a topic.
You will get strange results without it!
Format of the notedb (binary version)
=====================================