notedb::mysql(3pm) [debian man page]

NOTEDB::mysql(3pm)					User Contributed Perl Documentation					NOTEDB::mysql(3pm)

NAME

       NOTEDB::mysql - module lib for accessing a notedb from perl

SYNOPSIS

	       # include the module
	       use NOTEDB;

	       # create a new NOTEDB object (the last 4 params are db table/field names)
	       $db = new NOTEDB("mysql","note","localhost","username","password","note","number","note","date");

	       # 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}->{'note' => 'something', 'date' => '23.12.2000 10:33:02'}

	       # 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();

	       # recount all noteids starting by 1 (useful after deleting one!)
	       $db->set_recountnums();

	       # 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();

DESCRIPTION

       You can use this module for accessing a note database. There are currently two versions of this module, one version for a SQL 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.

       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 note...

USAGE

       please see the section SYNOPSIS, it says it all.

AUTHOR

       Thomas Linden <tom@daemon.de>.

perl v5.10.1							    2011-02-12							NOTEDB::mysql(3pm)

NODAU(1)						      General Commands Manual							  NODAU(1)

NAME

       nodau - simple console notetaking program

SYNOPSIS

       nodau <OPTION> [DATA]

DESCRIPTION

       This manual page documents briefly the nodau command.

       nodau is a simple console notetaking program.

   OPTIONS:
       help   print this message

       list [SEARCH]
	      list notes, accepts optional search term

       new <NAME>
	      create new note, <NAME> must be unique

       encrypt <NAME>
	      encrypt a new or existing note

       decrypt <NAME>
	      decrypt an existing note

       edit <NAME>
	      open an existing note for editing

       show <NAME>
	      display an existing note

       del <SEARCH>
	      delete a note/notes, accepts name or search term

   SEARCH TERM:
	      search terms with spaces do not need to be inside "quotes"
	      <NAME>	      name of a note, list will search for names similar to the term, del will delete only an exact match
	      t@<DATESTRING>  matches notes created at a given date/time
	      t-<DATESTRING>  matches notes created before a given date/time
	      t+<DATESTRING>  matches notes created after a given date/time

   DATE STRING:
	      <DATESTRING> can be made of any typical date format such as:
	      dd/mm/yy
	      dd, mm, yyyy hh:mm

   EDITING:
	      By  default nodau will use the EDITOR environment variable to edit notes, simply edit the file as usual, nodau will save the note to
	      it's database when you exit the editor. If EDITOR is not set the nodau builtin editor will be used.
	      Use of the builtin editor can be forced by setting `force_builtin_editor = true' in  the	nodau  config  file.   Alternatively,  the
	      external_editor  config  setting	can  be  set  to  use  a  specific  editor  regardless	of  the EDITOR environment variable value.
	      `force_builtin_editor = true' takes precedence over EDITOR and external_editor settings.
	      The builtin editor accepts standard printable characters, enter, and backspace. There is no support for moving the cursor  with  the
	      arrow keys or mouse. To exit the editor and save the note, create a new line with only a dot (.) on it, or press escape.

   ENCRYPTION:
	      Encrypting a note will apply DES encryption to the note using a passphrase which is requested from the user during the process.  The
	      passphrase is then required to decrypt, edit, or read the note. Decrypting a note will restore the  note	as  plain  text,  and  the
	      passphrase will no longer be required for access.

   CONFIGURATION FILE:
	      The nodau config file is located at $XDG_CONFIG_HOME/nodau/nodau.conf which is typically ~/.config/nodau/nodau.conf.

	      The following config settings are currently in use:

	      SETTING			 VALUES
	      external_editor		 name of a text editor executable (vim, nano,etc)
	      force_builtin_editor	 true or false
	      import_old_db		 true or false

	      If import_old_db value is true or not set, nodau will import notes from the 0.2.x database to the 0.3.x database.

AUTHOR

       This  manual page was modified by Lisa Milne <lisa@ltmnet.com> from an original written by Salvatore Bonaccorso <carnil@debian.org> for the
       Debian system (but may be used by others).

								    April 2012								  NODAU(1)