view release on metacpan or  search on metacpan

note.pod  view on Meta::CPAN

=head3 BACKUP FILE FORMAT

B<Caution>: since version 1.3.8 note uses a new file format
for backups: YAML. The old format is only supported by the
B<-I> option to import old backups. New backups are always
created as YAML files. See L<YAML>.



=head2 FORMATING

Another very nice feature is the possibility to format the note-text
(as much as shell allows it). First, you can use the note-internal
"magic-strings" for colorizing. Those strings looks much like HTML:
"<green>here is a green line of text</green> no more green."
As you see, the beginning of another color starts with a tag(kinda) of
the color <colorname> and ends with an end tag </colorname>.

The following colors are available:
black, red, green, yellow, blue, magenta, cyan and white.

Beside colorizing text, you can also create bold or underlined text! If
you decide to use this (additional) feature, you need to set the
Config-Option "FormatText" to 1 which turns it on.
Usage is very straightforward, if a word (a word is defined as some
text with at least one space surrounded) is between a magic mark-
character. Here are the available things, you can do:

 bold:       **word**
 underlined: __word__
 inverse:    {{word}}
 hidden:     //word//

The text will be formatted using the actually note-color.

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:

 bold:       *word*
 underlined: _word_
 inverse:    {word}
 hidden:     /word/

=head1 ENCRYPTION

You can turn on encryption from the config file.
Simply set UseEncryption to 1. Please note, that you need
to decide, if you want to use encryption before the first use
of note! If have already a note database and want to "migrate"
to encryption, I suggest you to follow the directions in the
file UPGRADE!

You can choose from different encryption algorythms. The default
is IDEA, but DES or BLOWFISH are also possible. You need to have
installed the following additional perl-modules on your system:
MD5
Crypt::IDEA
Crypt::DES
Crypt::CBC

After turning on encryption, note will ask you for a passphrase
every time it runs! It will *not* store this passphrase!
So, don't forget it! Be careful!




=head1 CONFIGURATION

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 command line flag I<--config>.

Comments start with #, empty lines will be ignored.

To turn on an option, set it to: B<1>, B<on> or B<yes>.

To turn off an option, set it to: B<0>, B<off> or B<no>.

An option consists of an atribute-value pair separated
by minimum one space (more spaces and/or tabs are allowed)
and an optional equal sign in between.

Variable names are case in-sensitive.

For a detailed explanation of each possible parameter take a look
at the supplied sample configuration file in B<config/noterc>.





=head1 AUTHOR

T.v.Dein <tlinden@cpan.org>

=head1 VERSION

1.4.0

=cut