diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /graphics/dot2tex/README |
Initial commit
Diffstat (limited to 'graphics/dot2tex/README')
-rw-r--r-- | graphics/dot2tex/README | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/graphics/dot2tex/README b/graphics/dot2tex/README new file mode 100644 index 0000000000..6a6dae2149 --- /dev/null +++ b/graphics/dot2tex/README @@ -0,0 +1,83 @@ +dot2tex - A Graphviz to LaTeX converter +======================================= + +Copyright (C) 2007 Kjell Magne Fauske +License: MIT (See LICENSE for details.) +Version: 2.7.0 +URL: http://www.fauskes.net/code/dot2tex/ + +Dot2tex is a tool for converting graphs rendered by Graphviz to formats +that can be used with LaTeX. + +The purpose of dot2tex is to give graphs generated by Graphviz a more +LaTeX friendly look and feel. This is accomplished by converting xdot +output from Graphviz to a series of TikZ and PGF, or PSTricks commands. +This approach allows: + + * Typesetting labels with LaTeX, allowing mathematical notation. + * Using native PSTricks and PGF/TikZ commands for drawing arrows. + * Using backend specific styles to customize the output + +Installation +============ + +Before you install dot2tex you have to have a working Python environment +installed on your system. Dot2tex has been developed and tested with +Python 2.4, but it will probably run fine using Python 2.3. In addition +you'll need the following modules: + + * pyparsing (http://pyparsing.wikispaces.com/). A recent version is required. + Older version like for instance 1.3.2 does not work with dot2tex. + * pydot (http://dkbza.org/pydot.html) + * preview (http://www.ctan.org/tex-archive/help/Catalogue/entries/preview.html) + A stand-alone part of the preview-latex/AUCTeX bundle. + Required for preprocessing graphs with LaTeX. + +From source +----------- + +Download a zip or a tarball from the download_ page. It is also available on +CTAN_. Unpack the file to a directory and run ``python`` on the ``setup.py`` +file:: + + $ python setup.py install + +This will create a dot2tex module in your Python module directory and a wrapper +script in your ``SCRIPTS`` directory. Note that a few warnings will be +displayed. You can safely ignore them. The warnings are shown because there is +some extra information in the ``setup.py`` file that distutils does not understand. + +.. _download: http://www.fauskes.net/code/dot2tex/download/ +.. _CTAN: http://www.ctan.org/tex-archive/help/Catalogue/entries/dot2tex.html + +Using easy_install +------------------ + +The easiest way to install dot2tex is to use `easy_install`_:: + + $ easy_install dot2tex + +The command will locate dot2tex and download it automatically. Note that +documentation and examples are not installed by default. `Easy_install`_ +will also create a wrapper script or EXE file for you and install dependencies +if necessary. + +.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall + +Binary packages +--------------- + +Binary packages are available for Debian_ and OpenSUSE_. + +.. _Debian: http://packages.qa.debian.org/d/dot2tex.html +.. _OpenSUSE: http://download.opensuse.org/repositories/home:/jimfunk/ + + +What's new in version 2.7.0 +=========================== + +- Added the --codeonly option. When this option is used, only draw commands + are generated. Intended for use with the dot2texi package. +- Minor improvements to the documentation. + +For a full list of changes see changelog.txt |