Debian Codegraph @

README

raw
1 ========================================================================
2 README
3 ========================================================================
4
5 ABOUT:
6 nodau is a simple console based note taking program, it allows you to
7 easily create, edit, and view notes, and search them by name or date
8
9 DEPENDENCIES:
10 nodau requires glibc, ncurses, openssl, and sqlite3. It may work with
11 other C libraries, but this has not been tested.
12
13 INSTALL:
14 If you're reading this then you've already unpacked the tarball,
15 so it's the usual 3 steps:
16 1) cd /path/to/nodau
17 2) make
18 3) su -c "make install"
19
20 UNINSTALL:
21 just cd to the nodau directory and run "make uninstall"
22
23 USE:
24 nodau <option> [data]
25
26 OPTIONS:
27 help print this message
28 list [search] list notes, accepts optional search term
29 new <name> create new note, name must be unique
30 encrypt <name> encrypt a new or existing note
31 decrypt <name> decrypt an encrypted note
32 edit <name> open an existing note for editing
33 append <name> when piping data from stdin, append to an existing note
34 show <name> display an existing note
35 del <search> delete a note/notes, accepts name or search term
36 rename <old> <new> rename an existing note
37
38 CONFIG:
39 The nodau config file is located at $XDG_CONFIG_HOME/nodau/nodau.conf
40 which is typically ~/.config/nodau/nodau.conf
41 The following config settings are currently in use:
42 SETTING VALUES
43 external_editor name of a text editor executable (vim,nano,etc)
44 force_builtin_editor true or false
45 import_old_db true or false
46
47 If import_old_db value is true or not set, nodau will import notes from
48 the 0.2.x database to the 0.3.x database.
49
50 SEARCH TERM:
51 search terms with spaces do not need to be inside "quotes"
52 <name> name of a note, list will search for names similar to
53 the term, del will delete only an exact match
54 t@<datestring> matches notes created at a given date/time
55 t-<datestring> matches notes created before a given date/time
56 t+<datestring> matches notes created after a given date/time
57
58 DATE STRING:
59 datestring can be made of any typical date format such as:
60 dd/mm/yy
61 dd, mm, yyyy hh:mm
62
63 EDITING:
64 the current editor accepts standard printable characters, enter,
65 and backspace. There is no support for moving the cursor with the
66 arrow keys or mouse. To exit the editor and save the note, create
67 a new line with only a dot (.) on it, or press escape.
68
69 LICENSE:
70 nodau is licensed under the GPLv3, there's a copy of it in LICENSE
71 Take note of the special exception given, for linking nodau's GPL
72 licensed code with the OpenSSL library:
73
74 * In addition, as a special exception, the copyright holder (Lisa Milne)
75 * gives permission to link the code of this release of nodau with the
76 * OpenSSL project's "OpenSSL" library (or with modified versions of it
77 * that use the same license as the "OpenSSL" library), and distribute
78 * the linked executables. You must obey the GNU General Public License
79 * in all respects for all of the code used other than "OpenSSL". If you
80 * modify this file, you may extend this exception to your version of the
81 * file, but you are not obligated to do so. If you do not wish to do so,
82 * delete this exception statement from your version.
83
84 DEVELOPMENT:
85 I might do more to it, if so I'll let everyone know through
86 sandbox.ltmnet.com/nodau
87 If you make any changes, let me know: lisa <at> ltmnet.com
88
89 CHANGES:
90 see CHANGELOG