mirror of
https://codeberg.org/scip/note.git
synced 2025-12-16 20:21:04 +01:00
fix-spelling
Fix spelling on several filesIndex: note/lib/NOTEDB/README Gbp-Pq: Name 0001-fix-spelling.patch Signed-off-by: Emmanuel Arias <emmanuelarias30@gmail.com>
This commit is contained in:
51
README
51
README
@@ -1,4 +1,4 @@
|
||||
note 1.3.20 by T.v.Dein (09/02/2015)
|
||||
note 1.3.26 by T.v.Dein (09/02/2015)
|
||||
=======================================
|
||||
|
||||
Introduction
|
||||
@@ -6,13 +6,13 @@ Introduction
|
||||
|
||||
This is a small console program written in
|
||||
perl, which allows you to manage notes similar
|
||||
to programs like "knotes" from commandline.
|
||||
to programs like "knotes" from command line.
|
||||
|
||||
There are currently three different database backends,
|
||||
There are currently three different databases backends,
|
||||
which you can use with note:
|
||||
o NOTEDB::binary - this is the default backend
|
||||
and uses a binary file to store your notes.
|
||||
o NOTEDB::mysql - this backend uses a mysql
|
||||
o NOTEDB::mysql - this backend uses a mysql
|
||||
database to store your notes. You can switch
|
||||
easily to another DBMS since this module uses
|
||||
the Perl standard module "DBI" for database-
|
||||
@@ -36,26 +36,24 @@ Where to get?
|
||||
=============
|
||||
|
||||
By now you can download it at http://www.daemon.de/NOTE.
|
||||
If you are using debian, you can apt-get it. If you are
|
||||
using gentoo, you can emerge it.
|
||||
If you are using debian, you run `can apt-get ìnstall note`.
|
||||
If you are using gentoo, you can emerge it.
|
||||
|
||||
You may also try your nearest tucows or freshmeat mirror.
|
||||
|
||||
|
||||
|
||||
|
||||
Features
|
||||
========
|
||||
|
||||
o Several different database backends, mysql(DBI), dbm,
|
||||
binary(bin file), general and text (text files).
|
||||
o Commandline interface using the standard perl module
|
||||
binary (bin file), general and text (text files).
|
||||
o Command line interface using the standard perl module
|
||||
Getopt::Long, which allows you to use short or long
|
||||
command-line options.
|
||||
o Interactive interface(pure ascii), the following functions
|
||||
o Interactive interface (pure ascii), the following functions
|
||||
are available in interactive mode: list, display, topic,
|
||||
delete, edit, help.
|
||||
o Highly confiurable using a perlish configfile ~/.noterc.
|
||||
o Highly configurable using a perlish configfile ~/.noterc.
|
||||
although it is configurable it is not required, note can
|
||||
run without a configfile using useful default presets.
|
||||
o Colourized output is supported using ASCII Escape-Sequences.
|
||||
@@ -64,46 +62,44 @@ o Data can be stored in various different database backends,
|
||||
since all database access is excluded from the program itself
|
||||
in perl modules.
|
||||
o Notes can be deleted, edited and you can search trough your notes.
|
||||
o Notes can be categorized. Each category(topic) can contain multiple
|
||||
o Notes can be categorized. Each category (topic) can contain multiple
|
||||
notes and even more sup-topics. There is no limitation about
|
||||
sub topics.
|
||||
o You can view all notes in a list and it is possible only to view
|
||||
notes under a certain topic.
|
||||
o There is a tree-view, which allows you to get an overview of your
|
||||
topic-hierarchy.
|
||||
o Notes can be encrypted using DES or IDEA algorythms and Crypt::CBC.
|
||||
o Notes can be encrypted using DES or IDEA algoroithms and Crypt::CBC.
|
||||
o You can dump the contents of your note database into a plain text
|
||||
file, which can later be imported. Imports can be appended or it can
|
||||
overwrite an existing database (-o).
|
||||
overwrite an existing database (`-o`).
|
||||
o Note has scripting capabilities, you can create a new note by piping
|
||||
another commands output to note, you can also import a notedump from
|
||||
stdin as well es duming to stdout instead a file. Additional, there
|
||||
is an option --raw available, which prints everything out completely
|
||||
is an option `--raw` available, which prints everything out completely
|
||||
without formatting.
|
||||
o for better performance, note can cache the database for listings
|
||||
or searching.
|
||||
o It can be installed without root-privileges.
|
||||
o if Term::ReadLine (and Term::ReadLine::Gnu) is installed, history
|
||||
o If Term::ReadLine (and Term::ReadLine::Gnu) is installed, history
|
||||
and auto-completion are supported in interactive mode.
|
||||
o Last, a while ago a user stated: "... it simply does, what it
|
||||
says ..."
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Requirements
|
||||
============
|
||||
|
||||
You need the following things:
|
||||
o perl installed (5.004x)
|
||||
o The module IO::Seekable and Fcntl, which should be
|
||||
already installed with your perl distributuion if
|
||||
already installed with your perl distribuion if
|
||||
you want to use the binary database backend.
|
||||
o DBI module and DBI::mysql if you want to use the
|
||||
mysql database backend.
|
||||
o The module DB_FILE if you want to use the DBM module.
|
||||
o Getopt::Long (part of perl std ditribution)
|
||||
o Getopt::Long (part of perl std distribution)
|
||||
o Term::ReadLine and optionally Term::ReadLine::Gnu if
|
||||
you want to use the auto-completion and history functionality.
|
||||
o Config::General if you want to use the NOTEDB::general
|
||||
@@ -118,7 +114,7 @@ Unpack the tar-ball and issue the following command:
|
||||
$ perl Makefile.PL
|
||||
|
||||
This creates the Makefile neccessary for installing.
|
||||
You may add some additional variables to the commandline, the
|
||||
You may add some additional variables to the command line, the
|
||||
most important one is PREFIX.
|
||||
|
||||
Then enter the following command to prepare the installation
|
||||
@@ -144,25 +140,23 @@ Crypt:CBC and Crypt::Blowfish (or Crypt::DES or whatever).
|
||||
Configuration
|
||||
=============
|
||||
|
||||
This version of note doesn't neccessarily need
|
||||
This version of note doesn't necessarily need
|
||||
a configuration file. But you can have one and change
|
||||
some default values. Take a look to the file config/noterc
|
||||
provided with this tarball. There are detailed instructions
|
||||
about every available parameter.
|
||||
Simply copy this file into your home-directory and name it
|
||||
.noterc
|
||||
`.noterc`
|
||||
If you decide not to use the default database backend (a binary
|
||||
file), you will *need* a configuration!
|
||||
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
Refer to the note(1) manpage for usage instructions.
|
||||
|
||||
|
||||
|
||||
Comments
|
||||
========
|
||||
|
||||
@@ -181,7 +175,7 @@ You can read the complete GPL at: http://www.gnu.org/copyleft/gpl.html
|
||||
|
||||
|
||||
|
||||
Recources
|
||||
Resources
|
||||
=========
|
||||
|
||||
The command-line options and all commands of the interactive mode are
|
||||
@@ -189,7 +183,6 @@ described in the supplied note(1) manpage.
|
||||
You may also refer to the note website http://www.daemon.de/note/.
|
||||
|
||||
|
||||
|
||||
Author and Copyright
|
||||
====================
|
||||
|
||||
@@ -214,4 +207,4 @@ and I'll add you.
|
||||
Last changed
|
||||
============
|
||||
|
||||
09/02/2015
|
||||
09/02/2015
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
perl modules for note used as database backends.
|
||||
the install.sh script will install both of them,
|
||||
although you may only need one backend. Perhaps
|
||||
other users on your system have oter ideas in mind...
|
||||
other users on your system have other ideas in mind...
|
||||
|
||||
Therefore, please ignore these file. There is nothing
|
||||
to edit or to do. Simply leave this directory :-)
|
||||
|
||||
@@ -451,7 +451,7 @@ NOTEDB::binary - module lib for accessing a notedb from perl
|
||||
|
||||
# get all existing notes
|
||||
%all_notes = $db->get_all();
|
||||
# format of returnes hash like the one from get_search above
|
||||
# format of returns hash like the one from get_search above
|
||||
|
||||
# get the next noteid available
|
||||
$next_num = $db->get_nextnum();
|
||||
@@ -481,7 +481,7 @@ However, both versions provides identical interfaces, which means, you do
|
||||
not need to change your code, if you want to switch to another database format.
|
||||
|
||||
Currently, NOTEDB module is only used by note itself. But feel free to use it
|
||||
within your own project! Perhaps someone want to implement a webinterface to
|
||||
within your own project! Perhaps someone want to implement a web interface to
|
||||
note...
|
||||
|
||||
=head1 USAGE
|
||||
|
||||
@@ -230,12 +230,12 @@ NOTEDB::dbm - module lib for accessing a notedb from perl
|
||||
|
||||
# get all existing notes
|
||||
%all_notes = $db->get_all();
|
||||
# format of returnes hash like the one from get_search above
|
||||
# format of returns hash like the one from get_search above
|
||||
|
||||
# get the next noteid available
|
||||
$next_num = $db->get_nextnum();
|
||||
|
||||
# recount all noteids starting by 1 (usefull after deleting one!)
|
||||
# recount all noteids starting by 1 (useful after deleting one!)
|
||||
$db->set_recountnums();
|
||||
|
||||
# modify a certain note
|
||||
@@ -253,7 +253,7 @@ You can use this module for accessing a note database. This is the dbm module.
|
||||
It uses the DB_FILE module to store it's data and it uses DBM files for tis purpose.
|
||||
|
||||
Currently, NOTEDB module is only used by note itself. But feel free to use it
|
||||
within your own project! Perhaps someone want to implement a webinterface to
|
||||
within your own project! Perhaps someone want to implement a web interface to
|
||||
note...
|
||||
|
||||
=head1 USAGE
|
||||
|
||||
@@ -329,7 +329,7 @@ NOTEDB::text - module lib for accessing a notedb from perl
|
||||
|
||||
# get all existing notes
|
||||
%all_notes = $db->get_all();
|
||||
# format of returnes hash like the one from get_search above
|
||||
# format of returns hash like the one from get_search above
|
||||
|
||||
# get the next noteid available
|
||||
$next_num = $db->get_nextnum();
|
||||
@@ -356,7 +356,7 @@ You can use this module for accessing a note database. This backend uses
|
||||
a text file for storage and Storable for accessing the file.
|
||||
|
||||
Currently, NOTEDB module is only used by note itself. But feel free to use it
|
||||
within your own project! Perhaps someone want to implement a webinterface to
|
||||
within your own project! Perhaps someone want to implement a web interface to
|
||||
note...
|
||||
|
||||
=head1 USAGE
|
||||
|
||||
@@ -370,7 +370,7 @@ NOTEDB::general - module lib for accessing a notedb from perl
|
||||
|
||||
# get all existing notes
|
||||
%all_notes = $db->get_all();
|
||||
# format of returnes hash like the one from get_search above
|
||||
# format of returns hash like the one from get_search above
|
||||
|
||||
# get the next noteid available
|
||||
$next_num = $db->get_nextnum();
|
||||
@@ -397,7 +397,7 @@ You can use this module for accessing a note database. This backend uses
|
||||
a text file for storage and Config::General for accessing the file.
|
||||
|
||||
Currently, NOTEDB module is only used by note itself. But feel free to use it
|
||||
within your own project! Perhaps someone want to implement a webinterface to
|
||||
within your own project! Perhaps someone want to implement a web interface to
|
||||
note...
|
||||
|
||||
=head1 USAGE
|
||||
|
||||
@@ -377,12 +377,12 @@ NOTEDB::mysql - module lib for accessing a notedb from perl
|
||||
|
||||
# get all existing notes
|
||||
%all_notes = $db->get_all();
|
||||
# format of returnes hash like the one from get_search above
|
||||
# format of returns hash like the one from get_search above
|
||||
|
||||
# get the next noteid available
|
||||
$next_num = $db->get_nextnum();
|
||||
|
||||
# recount all noteids starting by 1 (usefull after deleting one!)
|
||||
# recount all noteids starting by 1 (useful after deleting one!)
|
||||
$db->set_recountnums();
|
||||
|
||||
# modify a certain note
|
||||
@@ -409,7 +409,7 @@ However, both versions provides identical interfaces, which means, you do
|
||||
not need to change your code, if you want to switch to another database format.
|
||||
|
||||
Currently, NOTEDB module is only used by note itself. But feel free to use it
|
||||
within your own project! Perhaps someone want to implement a webinterface to
|
||||
within your own project! Perhaps someone want to implement a web interface to
|
||||
note...
|
||||
|
||||
=head1 USAGE
|
||||
|
||||
@@ -568,7 +568,7 @@ NOTEDB::pwsafe3 - module lib for accessing a notedb from perl
|
||||
|
||||
# get all existing notes
|
||||
%all_notes = $db->get_all();
|
||||
# format of returnes hash like the one from get_search above
|
||||
# format of returns hash like the one from get_search above
|
||||
|
||||
# get the next noteid available
|
||||
$next_num = $db->get_nextnum();
|
||||
@@ -595,7 +595,7 @@ You can use this module for accessing a note database. This backend uses
|
||||
a text file for storage and Config::General for accessing the file.
|
||||
|
||||
Currently, NOTEDB module is only used by note itself. But feel free to use it
|
||||
within your own project! Perhaps someone want to implement a webinterface to
|
||||
within your own project! Perhaps someone want to implement a web interface to
|
||||
note...
|
||||
|
||||
=head1 USAGE
|
||||
|
||||
@@ -310,7 +310,7 @@ NOTEDB::text - module lib for accessing a notedb from perl
|
||||
|
||||
# get all existing notes
|
||||
%all_notes = $db->get_all();
|
||||
# format of returnes hash like the one from get_search above
|
||||
# format of returns hash like the one from get_search above
|
||||
|
||||
# get the next noteid available
|
||||
$next_num = $db->get_nextnum();
|
||||
@@ -337,7 +337,7 @@ You can use this module for accessing a note database. This backend uses
|
||||
a text file for storage and Storable for accessing the file.
|
||||
|
||||
Currently, NOTEDB module is only used by note itself. But feel free to use it
|
||||
within your own project! Perhaps someone want to implement a webinterface to
|
||||
within your own project! Perhaps someone want to implement a web interface to
|
||||
note...
|
||||
|
||||
=head1 USAGE
|
||||
|
||||
36
note.pod
36
note.pod
@@ -14,7 +14,7 @@ note [options] [ number [,number...]]
|
||||
|
||||
B<note> is a small console program written in perl, which allows
|
||||
you to manage notes similar to programs like "knotes" but from
|
||||
the commandline. Note can use different database-backends for
|
||||
the command line. Note can use different database-backends for
|
||||
notes-storage. It ships with a DBI-based mysql-module(which
|
||||
can also be used for other by DBI supported DBMS), another
|
||||
module, which uses a binary file for storage and a DBM module.
|
||||
@@ -108,7 +108,7 @@ for details on this mode.
|
||||
=item I<--encrypt cleartext>
|
||||
|
||||
Encrypt the given clear text string. You would need that if you want to
|
||||
store the mysql password not in cleartext in the config(if you are using
|
||||
store the mysql password not in cleartext in the config (if you are using
|
||||
the mysql backend!).
|
||||
|
||||
|
||||
@@ -140,7 +140,7 @@ note from STDIN until EOF. This makes it possible to pipe text into a new note,
|
||||
=head2 GENERAL USAGE
|
||||
|
||||
If you don't know, how to run note, try "note -h" first.
|
||||
It will tell you all available commandline options.
|
||||
It will tell you all available command line options.
|
||||
|
||||
To create a new note, simply run "note". You can enter
|
||||
the note (the length is by default limited to 4096 bytes,
|
||||
@@ -188,7 +188,7 @@ 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>".
|
||||
note will search the whole note database case insensitive for
|
||||
an occurence of this string and tell you the number and first-
|
||||
an occurrence of this string and tell you the number and first-
|
||||
line it has.
|
||||
|
||||
You can extend the searchstring using B<AND>, B<OR> ( and ) and
|
||||
@@ -206,9 +206,9 @@ display it's second line.
|
||||
These rules apply for the interactive search too.
|
||||
|
||||
You need to know, that note searches for the expression in every
|
||||
note. In other words, "moses AND lenin" searches for an occurence
|
||||
note. In other words, "moses AND lenin" searches for an occurrence
|
||||
of "moses" and "lenin" in ONE note. Or, if you are looking for
|
||||
"mike OR daniel", then it searches for an occurence of "mike" or
|
||||
"mike OR daniel", then it searches for an occurrence of "mike" or
|
||||
daniel" in ONE note. Thus a note with the text "mike oldfield" will
|
||||
match that search.
|
||||
|
||||
@@ -288,7 +288,7 @@ topic. You will get strange results without it!
|
||||
|
||||
=head2 INTERACTIVE MODE
|
||||
|
||||
If you start note with the commandline flag B<-i>, then it starts
|
||||
If you start note with the command line flag B<-i>, then it starts
|
||||
with an interactive interface.
|
||||
It will start with a listing under the default top-topic ("/").
|
||||
You can enter the name of a topic to change to that topic. This works
|
||||
@@ -316,8 +316,8 @@ You can achieve the same result by simply pressing enter at any time.
|
||||
You can create a new note by simply pressing B<N> or B<n>. You favorite
|
||||
editor will be started and you can enter your note text. If you are already
|
||||
under a topic then this new note will automatically go to this topic.
|
||||
note adds an aditional line to the top of the note with the topic. But
|
||||
you can of course specify your own topic.
|
||||
note adds an additional line to the top of the note with the topic. But
|
||||
you can, of course, specify your own topic.
|
||||
|
||||
Note will tell you which number it has assigned to the newly created note.
|
||||
|
||||
@@ -338,7 +338,7 @@ Say if you delete 1 and 2, then 3 will become 1, 4 will become 5 and so forth.
|
||||
|
||||
=item B<S [expression]>
|
||||
|
||||
You can search for the occurence of a text in your notes-database with the
|
||||
You can search for the occurrence of a text in your notes-database with the
|
||||
command B<S> or B<s>. If you omit an expression note will ask you for one.
|
||||
|
||||
If your search criteria matches on exactly one entry, note will display
|
||||
@@ -393,14 +393,14 @@ Quit note.
|
||||
|
||||
You can also dump the contents of your note-database into a
|
||||
ASCII-textfile(I<-D>). You can use this file later to import it into
|
||||
your note-database(-I). This is usefull, if you want quickly trans-
|
||||
your note-database(-I). This is useful, if you want quickly trans-
|
||||
fer your notes from one host to another (i.e. you could mail
|
||||
your note-dump form your office to home and import it there
|
||||
for further use).
|
||||
|
||||
The dumps from the two versions of note are in the same format.
|
||||
Using dumps it is also possible to reinitialize your database. You
|
||||
can use the "-o" switch whcih causes note to overwrite your existing
|
||||
can use the "-o" switch which causes note to overwrite your existing
|
||||
database. This is very handy if you changed heavily your config. And
|
||||
it is required, if you changed: encryption, db-driver, (binary-format)
|
||||
and the password. You can use the following command for reinitializing:
|
||||
@@ -414,7 +414,7 @@ What the hell, does this do?! Step by step:
|
||||
=item *
|
||||
|
||||
B<note -D -> creates a note-database dump and prints it out
|
||||
to stantdard output.
|
||||
to standard output.
|
||||
|
||||
=item *
|
||||
|
||||
@@ -466,8 +466,8 @@ character. Here are the available things, you can do:
|
||||
|
||||
The text will be formatted using the actually note-color.
|
||||
|
||||
The hidden formatting will use blue forground and blue background
|
||||
to hide a string from the terminal, which is usefull for passwords.
|
||||
The hidden formatting will use blue foreground and blue background
|
||||
to hide a string from the terminal, which is useful for passwords.
|
||||
|
||||
If you set "FormatText" to I<simple> then the formatting can be
|
||||
done this way instead:
|
||||
@@ -495,7 +495,7 @@ Crypt::DES
|
||||
Crypt::CBC
|
||||
|
||||
After turning on encryption, note will ask you for a passphrase
|
||||
everytime it runs! It will *not* store this passphrase!
|
||||
every time it runs! It will *not* store this passphrase!
|
||||
So, don't forget it! Be careful!
|
||||
|
||||
|
||||
@@ -507,7 +507,7 @@ You can use a configuration file with note but it is not required.
|
||||
Note will use default values if there is no config.
|
||||
|
||||
The default config file is B<~/.noterc>. You may specify another
|
||||
one with the commandline flag I<--config>.
|
||||
one with the command line flag I<--config>.
|
||||
|
||||
Comments start with #, empty lines will be ignored.
|
||||
|
||||
@@ -534,6 +534,6 @@ T.v.Dein <tlinden@cpan.org>
|
||||
|
||||
=head1 VERSION
|
||||
|
||||
1.3.20
|
||||
1.3.26
|
||||
|
||||
=cut
|
||||
|
||||
Reference in New Issue
Block a user