.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "NOTEDB::binary 3pm"
.TH NOTEDB::binary 3pm "2019-01-16" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
NOTEDB::binary \- module lib for accessing a notedb from perl
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        # include the module
\&        use NOTEDB;
\&
\&        # create a new NOTEDB object
\&        $db = new NOTEDB("binary", "/home/tom/.notedb", 4096, 24);
\&
\&        # decide to use encryption
\&        # $key is the cipher to use for encryption
\&        # $method must be either Crypt::IDEA or Crypt::DES
\&        # you need Crypt::CBC, Crypt::IDEA and Crypt::DES to have installed.
\&        $db\->use_crypt($key,$method);
\&
\&        # do not use encryption
\&        # this is the default
\&        $db\->no_crypt;
\&
\&        # get a single note
\&        ($note, $date) = $db\->get_single(1);
\&
\&        # search for a certain note 
\&        %matching_notes = $db\->get_search("somewhat");
\&        # format of returned hash:
\&        #$matching_notes{$numberofnote}\->{\*(Aqnote\*(Aq => \*(Aqsomething\*(Aq, \*(Aqdate\*(Aq => \*(Aq23.12.2000 10:33:02\*(Aq}
\&
\&        # get all existing notes
\&        %all_notes = $db\->get_all();
\&        # format of returnes hash like the one from get_search above
\&
\&        # get the next noteid available
\&        $next_num = $db\->get_nextnum();
\&
\&        # modify a certain note
\&        $db\->set_edit(1, "any text", "23.12.2000 10:33:02");
\&
\&        # create a new note
\&        $db\->set_new(5, "any new text", "23.12.2000 10:33:02");
\&
\&        # delete a certain note
\&        $db\->set_del(5);
\&
\&        # turn on encryption. CryptMethod must be IDEA, DES or BLOWFISH
\&        $db\->use_crypt("passphrase", "CryptMethod");
\&
\&        # turn off encryption. This is the default.
\&        $db\->no_crypt();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
You can use this module for accessing a note database. There are currently
two versions of this module, one version for a \s-1SQL\s0 database and one for a
binary file (note's own database-format).
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.
.PP
Currently, \s-1NOTEDB\s0 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
note...
.SH "USAGE"
.IX Header "USAGE"
please see the section \s-1SYNOPSIS,\s0 it says it all.
.SH "AUTHOR"
.IX Header "AUTHOR"
Thomas Linden <tom@daemon.de>.