"Fossies" - the Fresh Open Source Software Archive

Member "hevea-2.35/README" (16 Jan 2021, 3843 Bytes) of package /linux/www/hevea-2.35.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "README": 2.34_vs_2.35.

    1 This is HEVEA, version 2.35, a fast Latex to HTML translator.
    2 
    3 
    4 ADVERTISEMENT
    5     HEVEA is a LaTeX to HTML translator.  The input language is a fairly
    6     complete subset of LaTeX2e (old LaTeX style is also accepted) and the
    7     output language is HTML that is (hopefully) correct with respect to
    8     version 5.
    9 
   10     Exotic symbols are translated into the so-called HTML 'entities',
   11     in other words into references to UNICODE chararacters.
   12 
   13     HEVEA understands LaTeX macro definitions. Simple user style
   14     files are understood with little or no modifications.
   15     Furthermore, HEVEA customization is done by writing LaTeX code.
   16     
   17     HEVEA is written in OCaml, as many lexers. It is quite fast
   18     and flexible. Using HEVEA it is possible to translate large documents
   19     such as manuals, books, etc. very quickly. All documents are
   20     translated as one single HTML file. Then, the output file can be cut
   21     into smaller files, using the companion program HACHA.
   22 
   23 LAW
   24     For legal matters see the LICENSE File.
   25 
   26 CONTENTS
   27     This distribution includes HEVEA sources.
   28 
   29 CONTACTS
   30     mail:       Luc.Maranget@inria.fr
   31     home page:  http://hevea.inria.fr/
   32 
   33 DOCUMENTATION
   34     On-line documentation is available at
   35     http://hevea.inria.fr/doc/
   36 
   37 DISTRIBUTION
   38     By HTTP
   39       http://hevea.inria.fr/distri/
   40 
   41 
   42 
   43 REQUIREMENTS
   44      HEVEA is written in Objective Caml version 3.12 or later
   45      (OCaml). It compiles under OCaml, which should thus be properly
   46      installed.
   47 
   48      More information on OCaml can be found at
   49        http://caml.inria.fr/ocaml/
   50 
   51      However there exists binary distributions of HEVEA for PCs
   52      Those are provided by external packagers, see hevea home page
   53      for a (partial) list.
   54 
   55      There also exist a Win-32 distribution, by Philip A. Viton, see
   56      http://facweb.knowlton.ohio-state.edu/pviton/support/hevea.html
   57 
   58     HEVEA is fully functional when other software are installed
   59      * A modern LaTeX installation including dvips.
   60      * The ghostcript Postcript interpreter.
   61      * the netpbm image processing package.
   62        ftp://wuarchive.wustl.edu/graphics/graphics/packages/NetPBM
   63     However, these softwares are optional and hevea runs without them.
   64     
   65 INSTALLATION FROM THE SOURCE DISTRIBUTION
   66 
   67   Download the source distribution
   68     http://hevea.inria.fr/distri/hevea-2.35.tar.gz
   69 
   70   Unzip,
   71     gunzip hevea-2.35.tar.gz
   72 
   73   Untar,
   74     tar xf  hevea-2.35.tar
   75 
   76   Go to the source directory
   77     cd hevea-2.35
   78 
   79 CONFIGURATION
   80     There are a few configuration variables at the beginning of
   81     the Makefile.
   82      * TARGET
   83 
   84       TARGET=opt makes hevea compile under ocamlopt, the
   85       OCaml compiler that produces native code. This is
   86       the default.
   87 
   88       TARGET=byte makes hevea compile under ocamlc, the
   89       OCaml compiler that produces bytecode.
   90 
   91       Using opt, hevea is about three times faster than
   92       using byte. However, some OCaml installations may only
   93       provide ocamlc.
   94 
   95      * LIBDIR is the library directory of hevea, that contains
   96       hevea style files. It defaults to /usr/local/lib/hevea.
   97 
   98      * BINDIR is the directory where to install, hevea, hacha and
   99       imagen. It defaults to /usr/local/bin.
  100 
  101 
  102     
  103 
  104 MAKE
  105     Once configuration variables are set, type:
  106       make 
  107 
  108    Then, install hevea binary in BINDIR and hevea library files in LIBDIR     
  109    (This might require gaining root privilege)
  110       make install
  111 
  112       
  113   ** Note that the hevea.sty file,  is simply copied to LIBDIR.
  114      It remains users responsability to make it accessible to LaTeX.
  115      Some packagers make additional installation efforts as regards
  116      this file.
  117 
  118    Once hevea is installed, you can remove the sources.
  119 
  120 
  121 IN CASE OF TROUBLE.
  122   - You do need version 4.02.3 (or newer) of the Objective Caml System.
  123     Older versions of Objective Caml may not compile hevea.
  124