Debian Codegraph @

README

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