osl logo

The lightweight storage library


[README] [Download] [INSTALL] [Quick Start] [API] [License] [Contact] [man page]

README

libosl, the object storage layer, is a library for storing small to medium-sized data in relational tables. It is easy to use, lightweight, fast and portable. libosl is suitable for applications that need only a small fraction of the features a full database management system provides.

Libosl is simple:

Libosl is fast:

Libosl is portable:

Libosl is open source:

Apart from the library itself, the package also contains simple examples and an fsck program, oslfsck, which can be used to recover from corrupted tables due to system crashes or bugs in the application or the library.


Download

Only the source code is available for download. Use git to clone the osl repository by executing

git clone git://git.tuebingen.mpg.de/osl.git

or grab the tarball of the current tree. If you prefer to download the tarball of the latest release, select the corresponding snapshot link on the osl gitweb page


INSTALL

As the bare minimum, you’ll need gcc-4 and gnu make to install libosl. gengetopt is needed to build the oslfsck executable, and help2man to generate its man page.

If everything mentioned above is available on your system, type

    make

to build the library, the oslfsck executable and the man page. Then type

    make install

as root to install libosl, oslfsck and the man page. Finally, update the library cache by running either

    ldconfig # Linux, *BSD

or

    update_dyld_shared_cache # MacOS

The default installation prefix is /usr/local. Use

    make install PREFIX=/somewhere/else

to install in /somewhere/else instead.

The make targets in the web/ directory are used for web page generation and are not needed to compile, install or use libosl. In order to make these targets the following additional tools are needed:

The osl logo was created with Adobe Illustrator by Sebastian Schultheiss.


License

osl is open source software, licensed under the GNU General Public License, Version 2.


Contact

Email: André Noll, maan@tuebingen.mpg.de, Homepage: http://people.tuebingen.mpg.de/maan/

Comments and bug reports are welcome. Please provide enough info such as the version of osl you are using and relevant parts of the logs. Including the string [osl] in the subject line is also a good idea.

Man page

OSLFSCK


NAME

oslfsck - manual page for oslfsck 0.1.3

SYNOPSIS

oslfsck [OPTIONS]... [table]...

DESCRIPTION

oslfsck 0.1.3
-h
, --help

Print help and exit

--detailed-help

Print help, including all details and hidden options, and exit

-V, --version

Print version and exit

-l, --loglevel=level

Set loglevel (0-6) (default=’3’)

Log messages are always written to stderr while normal output goes to stdout. Lower values mean more verbose logging.

-d, --database-dir=path

Full path to the database directory

Unless non-option arguments are given, all subdirectories of "path" are considered osl tables which oslfsck will try to fix.

-D, --dump-dir=path

Enable dump mode (default=’’)

If path is non-empty, oslfsck will write a dump of all given tables to the specified path.

-n, --no-fsck

Disable fsck mode. (default=off)

This is mainly useful in conjunction with the --dump-dir option.

-f, --force

Enable force mode (default=off)

Ignore the dirty bit when opening osl tables.

--dry-run

Only report problems, don’t try to fix them. (default=off)

AUTHOR

Written by Andre Noll.

REPORTING BUGS

Report bugs to <maan@tuebingen.mpg.de>.

COPYRIGHT

Copyright © 2008-2009 Andre Noll
This is free software with ABSOLUTELY NO WARRANTY. See COPYING for details.