Preface

refdb is a free and portable reference database and bibliography application similar to Reference Manager or EndNote. The bibliography part is like bibtex for markup languages. Unlike the commercial programs refdb targets SGML, XML, and LaTeX documents. It consists of an application server which interacts with a relational database like MySQL on the server side and a variety of clients on the workstation side. These clients perform the common tasks of a reference database, like adding and searching entries, as well as generating bibliographies.

Part 2 of this manual explains the installation of the components and the administration of refdb. These tasks should be performed by a system administrator, as you'll need certain privileges.

Part 3 explains the general use of refdb for the regular user. This is the place to look if you just need to add or retrieve references or if you want to generate bibliographies.

Part 4 contains all the nasty details of the applications that refdb ships with: All these confusing command-line switches, interactive commands, and configuration file variables that your brain refuses to memorize.

Part 5 is meant for programmers who want to modify or extend the behaviour of refdb. You'll find a few internals which are of no interest for the regular user but might be of interest for people trying to customize or extend refdb.

Please visit the refdb homepage for additional information and new versions.

The refdb-users mailing list is intended to discuss the use of the RefDB package. This covers all topics from installation to running queries. Visit the refdb-users list page to subscribe and for further information.

The refdb-devel mailing list is intended to discuss the development of refdb. Use this list to send patches and discuss the further development of this project. Visit the refdb-devel list page to subscribe and for further information.

Please send general bug reports to the users list (it might be a configuration or usage problem, and would thus be of interest to other users). However, if you have investigated the source code and either have a good idea what might cause the bug or even have a patch, please send the report to the devel list. In both cases you may wish to include the output of the refdb-bug script. This will create a file refdb-bug.txt in the present working directory which contains all sorts of information about your RefDB setup.

refdb is maintained by Markus Hoenicka.