| •1 |
note 1.3.26 by T.v.Dein (09/02/2015) |
| 2 |
======================================= |
| 3 |
|
| 4 |
Introduction |
| 5 |
============ |
| 6 |
|
| 7 |
This is a small console program written in |
| 8 |
perl, which allows you to manage notes similar |
| •9 |
to programs like "knotes" from command line. |
| 10 |
|
| •11 |
There are currently three different databases backends, |
| 12 |
which you can use with note: |
| 13 |
o NOTEDB::binary - this is the default backend |
| 14 |
and uses a binary file to store your notes. |
| •15 |
o NOTEDB::mysql - this backend uses a mysql |
| 16 |
database to store your notes. You can switch |
| 17 |
easily to another DBMS since this module uses |
| 18 |
the Perl standard module "DBI" for database- |
| 19 |
access. See below for more info on this topic! |
| 20 |
o NOTEDB::dbm - this module uses two DBM files |
| 21 |
for data storage and requires the module DB_FILE, |
| 22 |
which is part of the perl standard distribution. |
| 23 |
See below for more details about the DBM module. |
| 24 |
o NOTEDB::general - uses the module Config::General |
| 25 |
for storage, which makes the data file portable, |
| 26 |
since it is a plain ascii file (binary content |
| 27 |
will be base64 encoded). |
| 28 |
o NOTEDB::text - uses the Storable module for data |
| 29 |
storage (a serializer). Storable is included with |
| 30 |
perl, and since it's written in C, it's very fast. |
| 31 |
But the resulting data files are not that portable |
| 32 |
as the once of NOTEDB::general are. |
| 33 |
|
| 34 |
|
| 35 |
Where to get? |
| 36 |
============= |
| 37 |
|
| 38 |
By now you can download it at http://www.daemon.de/NOTE. |
| •39 |
If you are using debian, you run `can apt-get ìnstall note`. |
| 40 |
If you are using gentoo, you can emerge it. |
| 41 |
|
| 42 |
You may also try your nearest tucows or freshmeat mirror. |
| 43 |
|
| 44 |
|
| 45 |
Features |
| 46 |
======== |
| 47 |
|
| 48 |
o Several different database backends, mysql(DBI), dbm, |
| •49 |
binary (bin file), general and text (text files). |
| 50 |
o Command line interface using the standard perl module |
| 51 |
Getopt::Long, which allows you to use short or long |
| 52 |
command-line options. |
| •53 |
o Interactive interface (pure ascii), the following functions |
| 54 |
are available in interactive mode: list, display, topic, |
| 55 |
delete, edit, help. |
| •56 |
o Highly configurable using a perlish configfile ~/.noterc. |
| 57 |
although it is configurable it is not required, note can |
| 58 |
run without a configfile using useful default presets. |
| 59 |
o Colourized output is supported using ASCII Escape-Sequences. |
| 60 |
o The user can customize the color for each item. |
| 61 |
o Data can be stored in various different database backends, |
| 62 |
since all database access is excluded from the program itself |
| 63 |
in perl modules. |
| 64 |
o Notes can be deleted, edited and you can search trough your notes. |
| •65 |
o Notes can be categorized. Each category (topic) can contain multiple |
| 66 |
notes and even more sup-topics. There is no limitation about |
| 67 |
sub topics. |
| 68 |
o You can view all notes in a list and it is possible only to view |
| 69 |
notes under a certain topic. |
| 70 |
o There is a tree-view, which allows you to get an overview of your |
| 71 |
topic-hierarchy. |
| •72 |
o Notes can be encrypted using DES or IDEA algoroithms and Crypt::CBC. |
| 73 |
o You can dump the contents of your note database into a plain text |
| 74 |
file, which can later be imported. Imports can be appended or it can |
| •75 |
overwrite an existing database (`-o`). |
| 76 |
o Note has scripting capabilities, you can create a new note by piping |
| 77 |
another commands output to note, you can also import a notedump from |
| 78 |
stdin as well es duming to stdout instead a file. Additional, there |
| •79 |
is an option `--raw` available, which prints everything out completely |
| 80 |
without formatting. |
| 81 |
o for better performance, note can cache the database for listings |
| 82 |
or searching. |
| 83 |
o It can be installed without root-privileges. |
| •84 |
o If Term::ReadLine (and Term::ReadLine::Gnu) is installed, history |
| 85 |
and auto-completion are supported in interactive mode. |
| 86 |
o Last, a while ago a user stated: "... it simply does, what it |
| 87 |
says ..." |
| 88 |
|
| 89 |
|
| 90 |
|
| 91 |
Requirements |
| 92 |
============ |
| 93 |
|
| 94 |
You need the following things: |
| 95 |
o perl installed (5.004x) |
| 96 |
o The module IO::Seekable and Fcntl, which should be |
| •97 |
already installed with your perl distribuion if |
| 98 |
you want to use the binary database backend. |
| 99 |
o DBI module and DBI::mysql if you want to use the |
| 100 |
mysql database backend. |
| 101 |
o The module DB_FILE if you want to use the DBM module. |
| •102 |
o Getopt::Long (part of perl std distribution) |
| 103 |
o Term::ReadLine and optionally Term::ReadLine::Gnu if |
| 104 |
you want to use the auto-completion and history functionality. |
| 105 |
o Config::General if you want to use the NOTEDB::general |
| 106 |
backend. |
| 107 |
|
| 108 |
|
| 109 |
Installation |
| 110 |
============ |
| 111 |
|
| 112 |
Unpack the tar-ball and issue the following command: |
| 113 |
|
| 114 |
$ perl Makefile.PL |
| 115 |
|
| 116 |
This creates the Makefile neccessary for installing. |
| •117 |
You may add some additional variables to the command line, the |
| 118 |
most important one is PREFIX. |
| 119 |
|
| 120 |
Then enter the following command to prepare the installation |
| 121 |
process: |
| 122 |
|
| 123 |
$ make |
| 124 |
|
| 125 |
After that, you are ready to install. Become root and issue: |
| 126 |
|
| 127 |
# make install |
| 128 |
|
| 129 |
The installation process installs all modules for every available |
| 130 |
data backends. The default note configuration does not require |
| 131 |
additional perl modules. |
| 132 |
If you want to use the mysql backend refer to the installation |
| 133 |
instructions for the mysql database installation in mysql/README. |
| 134 |
|
| 135 |
If you want to use encryption support, you will need at least |
| 136 |
Crypt:CBC and Crypt::Blowfish (or Crypt::DES or whatever). |
| 137 |
|
| 138 |
|
| 139 |
|
| 140 |
Configuration |
| 141 |
============= |
| 142 |
|
| •143 |
This version of note doesn't necessarily need |
| 144 |
a configuration file. But you can have one and change |
| 145 |
some default values. Take a look to the file config/noterc |
| 146 |
provided with this tarball. There are detailed instructions |
| 147 |
about every available parameter. |
| 148 |
Simply copy this file into your home-directory and name it |
| •149 |
`.noterc` |
| 150 |
If you decide not to use the default database backend (a binary |
| 151 |
file), you will *need* a configuration! |
| 152 |
|
| 153 |
|
| 154 |
Usage |
| 155 |
===== |
| 156 |
|
| 157 |
Refer to the note(1) manpage for usage instructions. |
| 158 |
|
| 159 |
|
| 160 |
Comments |
| 161 |
======== |
| 162 |
|
| 163 |
You can send any comments to Thomas Linden <tom at linden dot at>. |
| 164 |
If you find a bug or if you have a suggestion for improvement of the |
| 165 |
script feel free to send me a patch ;-) |
| 166 |
|
| 167 |
|
| 168 |
|
| 169 |
License |
| 170 |
======= |
| 171 |
|
| 172 |
This program comes with absolutely NO WARRANTY. It is distributed under |
| 173 |
the terms of the GNU General Public License. Use it at your own risk :-) |
| 174 |
You can read the complete GPL at: http://www.gnu.org/copyleft/gpl.html |
| 175 |
|
| 176 |
|
| 177 |
|
| •178 |
Resources |
| 179 |
========= |
| 180 |
|
| 181 |
The command-line options and all commands of the interactive mode are |
| 182 |
described in the supplied note(1) manpage. |
| 183 |
You may also refer to the note website http://www.daemon.de/note/. |
| 184 |
|
| 185 |
|
| 186 |
Author and Copyright |
| 187 |
==================== |
| 188 |
|
| 189 |
The author is T.v.Dein |
| 190 |
note is Copyright of T.v.Dein |
| 191 |
|
| 192 |
|
| 193 |
Contributors / Credits |
| 194 |
====================== |
| 195 |
|
| 196 |
Shouts to all those guys who helped me to enhance note: THANKS A LOT! |
| 197 |
|
| 198 |
Jens Heunemann <[email protected]> - sub tree. |
| 199 |
Peter Palmreuther - various additions. |
| 200 |
|
| 201 |
And many other people who sent bug reports, feature requests. If you |
| 202 |
feel that I forgot your name in this list, then please send me an email |
| 203 |
and I'll add you. |
| 204 |
|
| 205 |
|
| 206 |
|
| 207 |
Last changed |
| 208 |
============ |
| 209 |
|
| •210 |
09/02/2015 |