logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

dot2tex - Graphviz to LaTeX converter

Author

dot2tex was written by Kjell Magne Fauske <kjellmf@gmail.com>

       This manual page was written by Peter Collingbourne <peter@pcc.me.uk>, for the Debian project (but may be
       used by others).

                                                November 11, 2006                                     DOT2TEX(1)

Description

       This manual page documents briefly the dot2tex command.

       dot2tex  is  a  tool  for converting graphs generated by Graphviz to formats suitable for use with LaTeX.
       Currently dot2tex generates code for PSTricks and PGF/TikZ.

       The purpose of dot2tex is to give graphs a more LaTeX look and feel. This is accomplished by:

           *   Typesetting labels with LaTeX, allowing mathematical notation.

           *   Using native PSTricks and PGF/TikZ commands for drawing arrows, edges and nodes.

           *   Using backend specific styles to customize the output.

Name

       dot2tex - Graphviz to LaTeX converter

Options

       A summary of options is included below.

       -h, --help
              Display help message.

       -ffmt,--formatfmt
              Set output format. The following values of fmt are supported:
                 pgf    PGF/TikZ. Default.
                 pstricks or pst
                        Use PSTricks.
                 tikz   TikZ format.

       -tmode,--texmodemode
              Text mode. Specify how text is converted.
                 verbatim
                        Text is displayed with all special TeX chars escaped (default).
                 math   Output all text in math mode $$.
                 raw    Output text without any processing.

              Note that you can locally override the text mode by assigning a  special  texlbl  attribute  to  a
              graph element, or by using the texmode attribute.

       -s, --straightedges
              Draw  edges  using  straight  lines.  Graphviz uses bezier curves to draw straight edges. Use this
              option to force the use of line to operations instead of curves. Does not work in duplicate mode.

       -ofilename,--outputfilename
              Write output to file.

       -d, --duplicate
              Duplicate the xdot output. Uses the drawing information embedded in the xdot output to draw  nodes
              and edges.

       --templatefilename
              Use template from file. See the HTML documentation for more details.

       -V, --version
              Print version information and exit.

       -w, --switchdraworder
              Switch drawing order of nodes and edges. By default edges are drawn before nodes.

       -c, --crop
              Use preview.sty to crop the graph. Currently only implemented for the PGF/TikZ backend.

       --figonly
              Output  the  graph  without a document preamble. Useful if the graph is to be included in a master
              document.

       --codeonly
              Output only the drawing commands, without wrapping it in a tikzpicture or  pspicture  environment.
              Useful when used with the dot2texi package.

       --preproc
              Preprocess  the  graph through LaTeX using the preview package. Will generate a new dot file where
              the height and widths of nodes and edge labels are set based on the results from preview.

       --cache
              Enables output caching.  dot2tex will check if the input graph has been processed  before.  If  it
              has not changed the graph will not be converted.

       --autosize
              Preprocess the graph and run Graphviz on the output. Equivalent to:

              dot2tex --preproc dot-file | dot2tex

       --progprogram
              Set  graph  layout  program  to  use  when  the  input is in plain dot format. Allowed values: dot
              (default), neato, circo, fdp, twopi.

       --usepdflatex
              Use pdflatex(1) instead of latex(1) for preprocessing the graph.

       --nominsize
              Ignore minimum node sizes during preprocessing.

       --valignmodemode
              Vertical alignment of node labels, where mode can have the values:
                 center Labels are placed in the middle of the node (default).
                 dot    Use the coordinate given by the xdot output from Graphviz.

       --alignstrstr
              Used to pass a default alignment string to the PSTricks \rput command:

              \rput[alignstr] ...

              Only works for the PSTricks format. PGF/TikZ users can instead pass an anchor=... style using  the
              graphstyle option.

       --tikzedgelabels
              Bypass Graphviz' edge label placement and use PGF/TikZ instead (tikz and pgf formats only).

       --styleonly
              Use TikZ only styles when drawing nodes. No draw or shape option is added (tikz format only).

       --nodeoptionstikzoptions
              Wrap node code in a scope environment with tikzoptions as parameter (tikz format only).

       --edgeoptionstikzoptions
              Wrap edge code in a scope environment with tikzoptions as parameter (tikz format only).

       --debug
              Write detailed debug information to the file dot2tex.log in the current directory.

       --pgf118
              Generate code compatible with PGF 1.18 and earlier.

       The following options are used by the output templates.

       -eencoding,--encodingencoding
              Set text encoding. Supported encodings are utf8 and latin1.

       --docpreambleTeXcode
              Insert TeX code in the document preamble.

       --figpreambleTeXcode
              Insert TeX code in the figure preamble.

       --figpostambleTeXcode
              Insert TeX code in the figure postamble.

       --graphstylestyle
              Sets the <<graphstyle>> tag.

       --marginmargin
              Set  margin  around  the graph when using preview.sty. margin must be a valid TeX unit. By default
              margin is set to 0pt.

See Also

dot(1), latex(1).

       /usr/share/doc/dot2tex/usage.html
              Full documentation for dot2tex/usr/share/doc/dot2tex/examples
              Example Graphviz dot files for use with dot2tex

Synopsis

dot2tex [--proggraphviz-command] [options] dot-file > tex-filedot2tex [options] xdot-file > tex-filegraphviz-command-txdotdot-file | dot2tex [options] > tex-file

Usage

       Input data is read from standard input if no inputfile is specified. Output is written to standard output
       unless a destination file is set with the -o option.

       dot2tex relies on the xdotformat generated by Graphviz. dot2tex will automatically  run  dot(1)  on  the
       input  data  if  it  is  in the plain dot format. If you want to use other layout tools like neato(1) and
       circo(1), use the --prog option.

See Also