Add example usage
authorSergey Matveev <stargrave@stargrave.org>
Fri, 4 Dec 2020 15:32:37 +0000 (18:32 +0300)
committerSergey Matveev <stargrave@stargrave.org>
Fri, 4 Dec 2020 15:32:37 +0000 (18:32 +0300)
t

diff --git a/t b/t
index 12df2a0a35e61e56eb89c87625b48bfd1703384a..f6fbe967b551e0a45e22cb9e1208e1c6ff690266 100755 (executable)
--- a/t
+++ b/t
@@ -1,13 +1,28 @@
 #!/bin/sh -e
 # t -- simple notes manager
 # Copyright (C) 2013-2020 Sergey Matveev <stargrave@stargrave.org>
 #!/bin/sh -e
 # t -- simple notes manager
 # Copyright (C) 2013-2020 Sergey Matveev <stargrave@stargrave.org>
-# Invoke the script without any arguments to briefly print all notes.
-# Otherwise you can specify the following ones:
-# a   -- add new note (either starts an editor if not arguments are specified,
-#        or save them inside the note silently)
-# d N -- delete note N
-# m N -- modify note N by starting an editor
-# N   -- print out note's N contents
+#
+# Usage:
+# * t -- just briefly print all notes: their number and stripped first
+#   line of content
+# * t N -- print N note's contents
+# * t a [X X X] -- add a new note to the end. If arguments are specified
+#   then they will be the content. Otherwise $EDITOR is started
+# * t d N -- delete note number N. Pay attention that other notes may
+#   change their numbers!
+# * t m N -- edit note N with $EDITOR
+# Also you can specify $N environment variable that acts like some kind
+# of namespace for the notes (prepare directory first!). For example:
+#     $ N=work t a get job done
+#     $ N=work t a # it starts $EDITOR
+#     $ N=work t
+#     [0] get job done (1)
+#     [1] this is first line of 3-lines comment (3)
+#     $ N=work t d 0
+#     $ N=work t
+#     [0] this is first line of 3-lines comment (3)
+#     $ t
+#     [0] some earlier default namespace note (1)
 
 NOTES_DIR=$HOME/.t/$N
 
 
 NOTES_DIR=$HOME/.t/$N