README

**************************************************************************
*  bibtex2html - A BibTeX to HTML translator                             *
*  Copyright (C) 1997-2014 Jean-Christophe Filliâtre and Claude Marché   *
*                                                                        *
*  This software is free software; you can redistribute it and/or        *
*  modify it under the terms of the GNU General Public                   *
*  License version 2, as published by the Free Software Foundation.      *
*                                                                        *
*  This software is distributed in the hope that it will be useful,      *
*  but WITHOUT ANY WARRANTY; without even the implied warranty of        *
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
*                                                                        *
*  See the GNU General Public License version 2 for more details         *
*  (enclosed in the file GPL).                                           *
**************************************************************************

BibTeX2HTML is a collection of tools for producing automatically HTML
documents from bibliographies written in the BibTeX format. It
consists in three command line tools:

  - bib2bib is a filter tool that reads one or several bibliography
    files, filters the entries with respect to a given criterion, and
    outputs the list of selected keys together with a new bibliography
    file containing only the selected entries;

  - bibtex2html is a translator that reads a bibliography file and
    outputs two HTML documents that respectively the cited
    bibliography in a nice presentation, and the original BibTeX file
    augmented with several transparent HTML links to allow easy
    navigation.

  - aux2bib reads a .aux file as produced by LaTeX and writes
    to standard output a BibTeX file containing exactly the
    BibTeX entries refereed in the .aux file.

COPYRIGHT
=========

This program is distributed under the GNU GPL.
See the enclosed file COPYING.


INSTALLATION
============

  You need OCaml >= 4.03 to compile the sources.

  1. Create the configure script with `autoconf`

  2. Configure with "./configure"

  3. Compile with "make".
     It creates two binary files, "bibtex2html" and "bib2bib" .

     If you want  to build the documentation, do  "make doc" (You need
     both LaTeX and Hevea).

  4. Install with "make install".  You may need superuser permissions.

     (Note:  you  can  also  just  copy the  two  executables  in  any
      directory of your choice)

     To install the doc, do "make install-doc".