0x49/contents/installation

                        <h2>installation of note</h2>
<p>
        Unpack the tar-ball and issue the command:<br>
        $ perl Makefile.PL<br>
        It will ask you a few questions about file destinations.
        The script will find itself the proper destinations for
        the files. So, if you agree with it, simply press ENTER.
        However, you may decide to use other destinations. In this
        case, enter it, when asked. This maybe usefull, if you are
        installing it in your ome-directory and if you are not root! 
<p>
        For installation instructions for the mysql database installation
        see mysql/README.
<p>
        If want to use another SQL database, i.e. postgresql then set
        the option "DbDriver" to the name of the responding DBI-driver
        and create a symlink of this name like this:
<br>        /usr/lib/perl5/siteperl/NOTEDB $ ln -s mysql.pm oracle.pm
<br>        The functionality is the same, but not the name!
<p>
        The default binary file backend does not need any special installation
        procedure, you need only to spceify a filename in your config file.
<p>
        The DBM backend(NOTEDB::dbm) requires the existence of a directory,
        which you must specify in your config using the option "DbName".
<p>


<b>Configuration</b>

        This version of note doesn't neccessarily 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.
<br>        Simply copy this file into your home-directory and name it
        .noterc
        If you decide not to use the default database backend (a binary
        file), you will *need* a configuration!
CHANGED: does no more use the external touch command to create a new file, use perls open() instead. CHANGED: excluded some of the help texts from the usage message and the interactive help command to a manpage. ADDED: new commandline flag "--encrypt" which one can use to encrypt the mysql database password. This will be decrypted before connecting to the db. There is also a new config file option "encrypt_passwd" which indicates an encrypted db-password. ADDED: another new config option "ShortCd", which can be set to "yes" or 1 and if set, then a command like "cd 13" would jump directly to the topic of the note with the number 13. ADDED: now you can at any time cd back to the "root" of the topic-structure using the command "cd /". CHANGED: mysql.pm does now only do a table-lock on single write accesses, no more on the whole session. This allows one to access the same db twice or more. FIXED: Changed README and Changelog for readability on 80 by 25 displays. And changed indentation of the note script itself. ADDED: NOTEDB.pm - a generic module, which holds some methods, which are used by binary.pm, mysql.pm and dbm.pm. ADDED: NOTEDB.pm generate_search(), which allows one to use AND, OR and various combinations of them using ( and ). ADDED: a search does now return the 2nd line of a note if a matching note's first line is a topic. CHANGED: use "unshift" instead of push to add $libpath to @INC. ADDED: a new feature, Caching of notes. supported by binary.pm and mysql.pm. To turn it on, one need to set "Cache" in the config to a true value. 2012-02-10 20:22:49 +01:00			`<h2>installation of note</h2>`
			`<p>`
			`Unpack the tar-ball and issue the command:<br>`
			`$ perl Makefile.PL<br>`
			`It will ask you a few questions about file destinations.`
			`The script will find itself the proper destinations for`
			`the files. So, if you agree with it, simply press ENTER.`
			`However, you may decide to use other destinations. In this`
			`case, enter it, when asked. This maybe usefull, if you are`
			`installing it in your ome-directory and if you are not root!`
			`<p>`
			`For installation instructions for the mysql database installation`
			`see mysql/README.`
			`<p>`
			`If want to use another SQL database, i.e. postgresql then set`
			`the option "DbDriver" to the name of the responding DBI-driver`
			`and create a symlink of this name like this:`
			`<br> /usr/lib/perl5/siteperl/NOTEDB $ ln -s mysql.pm oracle.pm`
			`<br> The functionality is the same, but not the name!`
			`<p>`
			`The default binary file backend does not need any special installation`
			`procedure, you need only to spceify a filename in your config file.`
			`<p>`
			`The DBM backend(NOTEDB::dbm) requires the existence of a directory,`
			`which you must specify in your config using the option "DbName".`
			`<p>`


			`<b>Configuration</b>`

			`This version of note doesn't neccessarily 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.`
			`<br> Simply copy this file into your home-directory and name it`
			`.noterc`
			`If you decide not to use the default database backend (a binary`
			`file), you will need a configuration!`