RefDB handbook covers version 0.9.9 Markus Hoenicka RefDB handbook: covers version 0.9.9 Markus Hoenicka Table of Contents Preface ............................................................................................................... xi 1. RefDB in a nutshell ................................................................................... xi 2. Organization of this manual ........................................................................ xi 3. Further information ................................................................................... xi I. Overview .......................................................................................................... 1 1. Introduction .............................................................................................. 3 1.1. What is RefDB? .............................................................................. 3 1.2. Who should use RefDB? ................................................................... 3 1.3. General features .............................................................................. 4 1.4. Interfaces ....................................................................................... 5 1.5. Reference management features ......................................................... 5 1.6. Bibliography tool features ................................................................. 6 1.6.1. SGML and XML .................................................................. 6 1.6.2. LaTeX ................................................................................ 7 1.7. Credits .......................................................................................... 7 2. System requirements .................................................................................. 8 2.1. Operating system ............................................................................ 8 2.2. Libraries necessary to build and run refdb ............................................ 8 2.2.1. System libraries .................................................................... 8 2.2.2. Other libraries ...................................................................... 9 2.3. Perl modules .................................................................................. 9 2.4. External applications .......................................................................10 2.5. Related Software ............................................................................12 3. Current limitations and platform issues .........................................................14 3.1. Limitations ...................................................................................14 3.2. Platform issues ..............................................................................14 II. Administrator manual .......................................................................................15 4. Installation ..............................................................................................17 4.1. Quickstart guide .............................................................................17 4.2. Upgrading from an older version .......................................................17 4.2.1. 0.9.9 ..................................................................................17 4.2.2. 0.9.8 ..................................................................................18 4.2.3. 0.9.7 ..................................................................................18 4.3. Things to know before you start ........................................................18 4.3.1. Which database server? .........................................................18 4.3.2. Where do the components go? ................................................19 4.3.3. The mystery of the configuration files ......................................20 4.3.4. Environment variables ..........................................................22 4.3.5. Some notes on the filesystem .................................................22 4.4. Installation on Linux and other Unix variants .......................................23 4.4.1. Generic instructions .............................................................23 4.4.2. OS-specific hints .................................................................29 4.5. Installation on Windows NT/2000/XP ................................................31 4.5.1. Prerequisites .......................................................................31 4.5.2. Installation from the sources ..................................................32 4.5.3. Installation of prebuilt binaries ...............................................35 4.6. Installation on Windows 95/98/ME ....................................................35 4.7. Other operating systems ..................................................................35 4.8. Finishing the RefDB installation .......................................................36 4.8.1. Using the interactive setup script ............................................36 4.8.2. Manual setup ......................................................................36 4.9. Testing your installation ..................................................................40 4.10. SRU support ................................................................................43 4.10.1. Setting up SRU support as a CGI program ..............................43 4.10.2. Setting up SRU support using a standalone web server ..............45 4.11. Install the PHP interface ................................................................45 4.11.1. Prerequisites .....................................................................45 iv RefDB handbook 4.11.2. Web server configuration .....................................................45 4.11.3. Test your PHP interface .......................................................46 5. refdbd administration .................................................................................47 5.1. Create a database ............................................................................47 5.2. Delete a database ............................................................................47 5.3. Add or remove a user ......................................................................47 5.3.1. Add users ...........................................................................47 5.3.2. Remove users ......................................................................49 5.4. Configure the application server ........................................................49 5.4.1. Configuration at startup ........................................................49 5.4.2. Reconfiguring a running refdbd process ...................................49 5.5. Add, edit, or delete bibliography styles ...............................................50 5.6. Logging data .................................................................................50 5.6.1. What to log .........................................................................51 5.6.2. Destinations ........................................................................51 5.6.3. Log levels ..........................................................................51 5.6.4. Interpreting the log information ..............................................52 5.7. Security issues ...............................................................................53 5.7.1. Passwords ..........................................................................53 5.7.2. Database server access control ................................................53 5.8. How to run several refdb instances ....................................................55 5.9. Backup your data ...........................................................................56 5.9.1. Creating a risx dump ............................................................56 5.9.2. Creating a SQL dump ...........................................................56 III. User manual ...................................................................................................58 6. Overview of the RefDB command-line clients ................................................61 6.1. Quickstart guide .............................................................................61 6.2. The interactive mode of refdba and refdbc ...........................................62 6.3. The non-interactive mode of refdba and refdbc ....................................63 6.4. The non-interactive mode of refdbib ..................................................63 6.5. Common command-line options for all clients .....................................64 7. Data input ...............................................................................................66 7.1. Writing RIS datasets .......................................................................66 7.1.1. Overview ...........................................................................66 7.1.2. Character encodings .............................................................67 7.1.3. RIS tags .............................................................................67 7.1.4. Examples ...........................................................................72 7.2. The Emacs helpers .........................................................................73 7.3. Input filters ...................................................................................74 7.4. Writing risx datasets .......................................................................75