cgit.sxemacs.org Git - packages/blob - xemacs-packages/auctex/preview/latex/README

   1 The preview.sty style file
   2 ==========================
   3
   4 Purpose
   5 -------
   6
   7 The main purpose of the preview package is the extraction of selected
   8 elements from a LaTeX source, like formulas or graphics, into separate
   9 pages of a DVI file.  A flexible and convenient interface allows it to
  10 specify what commands and constructs should be extracted.  This works
  11 with DVI files postprocessed by either Dvips and Ghostscript or
  12 dvipng, but it also works when you are using PDFTeX for generating PDF
  13 files.
  14
  15 Current uses of the package include the preview-latex package for
  16 WYSIWYG functionality in the AUCTeX editing environment, generation of
  17 previews in LyX, as part of the operation of the ps4pdf and pst-pdf
  18 packages, the tbook XML system and some other tools.
  19
  20 Availability
  21 ------------
  22
  23 The preview package is being developed along and distributed with
  24 AUCTeX.  It can therefore be obtained as part of AUCTeX distribution
  25 files available at <URL:ftp://ftp.gnu.org/pub/gnu/auctex/> or its
  26 mirror at <CTAN:support/auctex>.  CTAN also provides a standalone
  27 version at <CTAN:macros/latex/contrib/preview>.  The project page at
  28 <URL:http://savannah.gnu.org/projects/auctex/> offers downloads and
  29 anonymous CVS access for cutting edge versions.  For more information
  30 about the preview package please refer to the home page of AUCTeX at
  31 <URL:http://www.gnu.org/software/auctex/>.
  32
  33 Installation
  34 ------------
  35
  36 To install the preview style file on its own without the entire AUCTeX
  37 package, run
  38 tex preview.ins
  39 If preview.ins happens to be missing, you can regenerate it by running
  40 tex docstrip
  41 on preview.dtx with the option `installer'.
  42
  43 Running TeX on preview.ins will then extract further files:
  44 preview.drv which you can run through LaTeX in order to get the
  45 documentation for preview.sty, preview.sty itself, a bunch of option
  46 files with extension .def and a few configuration files with extension
  47 .cfg.  In case your docstrip configuration has not already taken care
  48 of that, install the files with extension .sty, .def and .cfg to a
  49 location where LaTeX will be able to find them, generate the
  50 documentation and have fun.
  51
  52 The license of the original file is the GPL which you'll find a copy
  53 of in the complete AUCTeX distribution.  The distribution will also
  54 unpack and install the respective LaTeX files with an
  55 autoconf-supported mechanism, so you might consider using that.
  56
  57 Bug reporting
  58 -------------
  59
  60 Please report problems to <URL:mailto:bug-auctex@gnu.org>, including a
  61 small example file which uses the \listfiles statement, and the
  62 resulting log file.
  63
  64 David Kastrup