bLogbook 01 review

bLogbook is a shell script that makes it easy to keep notes

License: GPL (GNU General Public License) File size: 0K Developer: Fernand Boudreau

0

bLogbook is a shell script that makes it easy to keep notes. bLogbook project uses the file system to manage a hierarchical set of "folders" and files.

bLogbook is configurable and extensible. Extensions can be added using the available plugin infrastructure.

User Guide

logbook has to following command line parameters:

logbook [-v]
Where:
-v: Output the version of logbook and exit.

To launch logbook, enter the command name (bLogbook) with no parameters.

After initialization, you will be presented with the following screen:

bLogbook version 0.1, Copyright (C) 2006 Fernand Boudreau
bLogbook comes with ABSOLUTELY NO WARRANTY; for details type 'license'.
This is free software, and you are welcome to redistribute it under certain conditions; type 'license' for details.

[elogbook]
Number or Command ('h' for help):

The space between '[elogbook]' and 'Number or Command ('h' for help):' normally contains the list of files and/or folders availabe at this level of the hierarchy. The first time you launch logbook, the hierarchy should be empty.

For a list of operation, you can enter 'h' then press enter. You will be presented with a list of commands that are available.

The builtin list of commands are used for such operations as adding and deleting entries (files or folders) into the logbook.

In addition to the built in commands, plugin commands may also be available if plugins have been installed. Plugin commands appear after the list of builtin commands, in the section titled 'Plugin Commands'.

logbook also allows you to specify commands that are available in your $PATH. Simply enter the command at the prompt. If the command is not a builtin and not a plugin command, logbook will passed it to the shell to be executed.

Plugins

Plugins are added to the plugins directory located in the logbook configuration directory (~/.blogbook/plugins)

A plugin is a bash script. The plugin should contain a function named Initialize. This function will be called by the script after all plugins have been loaded (sourced). In this function you may do things to initialize your plugin such as add a command to the user menu.

User Menu

There are two types of menus: builtin and plugin. The builtin menu contains items created that are built into the logbook script. The plugin menu contains items that are added by plugins.

To add an item to the plugin menu, the plugin developer must call AddMenuItem(< command_name > < function_to_invoke > < command description >).

This is normally done in the Initialize function.