Command-line InvocationAll Graphviz programs have a similar invocation:
- Set a graph attribute, with default value = true.
- Set a default node attribute, with default value = true.
- Set a default edge attribute, with default value = true.
- Specifies which default layout algorithm to use, overriding the default from the command name. For example, running dot -Kneato is equivalent to running neato.
- Set output language to one of the supported formats.
By default, attributed dot is produced.
Depending on how Graphviz was built, there may be multiple renderers for generating a particular output format, and multiple formatters for creating the final output. For example, a typical installation can produce PNG output using either the Cairo or GD library. The desired rendering engine can be specified after a colon. If there are multiple formatting engines available, the desired one can be specified in a similar fashion after the rendering engine. Thus, -Tpng:cairo specifies PNG output produced by Cairo (using the Cairo's default formatter), and -Tpng:cairo:gd specifies PNG output produced by Cairo formatted using the GD library.
If no renderer is specified, or a renderer but no formatter, the default one is invoked. The flag -Tformat: produces a list of all of the renderers available for the specified format, the first one listed with a prefix matching format being the default. Using the -v flag, described below, will print which format, renderer, and formatter are actually used.
- Emit version information and exit.
- User-supplied, device-dependent library text. Multiple flags may
be given. These strings are passed to the code generator at the
beginning of output.
For PostScript output, they are treated as file names whose content will be included in the preamble after the standard preamble. If library is the empty string "", the standard preamble is not emitted.
- Sets no-op flag in neato.
If set, neato assumes nodes have already been
positioned and all nodes have a pos
the positions. It then performs an optional adjustment to remove node-node
overlap, depending on the value of the
overlap attribute, computes the edge
layouts, depending on the value of the
splines attribute, and
emits the graph in the appropriate format. If num is supplied,
the following actions occur:
- num = 1
- Equivalent to -n.
- num > 1
- Use node positions as specified, with no adjustment to remove node-node overlaps, and use any edge layouts already specified by the pos attribute. neato computes an edge layout for any edge that does not have a pos attribute. As usual, edge layout is guided by the splines attribute.
- Write output to file outfile. By default, output goes to stdout.
- Automatically generate output file names based on the input file name and the various output formats specified by the -T flags.
- Automatically generate a graph that shows the plugin configuration of the current executable. e.g. dot -P -Tps | lpr
- Suppress warning messages.
- Set input scale to scale. If this value is omitted, 72.0 is used. This number is used to convert the point coordinate units used in the pos attribute into inches, which is what is expected by neato and fdp. Thus, feeding the output of a graph laid out by one program into neato or fdp almost always requires this flag. Ignored if the -n flag is used.
- Verbose mode
- In neato, on input, prune isolated nodes and peninsulas. This removes uninteresting graph structure and produces a less cluttered drawing.
- By default, the coordinate system used in generic output formats,
such as attributed dot,
is the standard cartesian system with the origin in the lower left corner,
and with increasing y coordinates as points move from bottom to top.
-yflag is used, the coordinate system is inverted, so that increasing values of y correspond to movement from top to bottom.
- Print usage information, then exit.
Note that the -G, -N and -E flags override any initial attribute declarations in the input graph, i.e., those attribute statements appearing before any node, edge or subgraph definitions. In addition, these flags cause the related attributes to be permanently attached to the graph. Thus, if attributed dot is used for output, the graph will have these attributes.
- List of pathnames giving directories which a program should search for fonts. Overridden by DOTFONTPATH. Used only if Graphviz is not built with the fontconfig library
- List of pathnames giving directories which a program should search for fonts. Overridden by fontpath. Used only if Graphviz is not built with the fontconfig library
- If defined, this indicates that the software is running as a web application, which restricts access to image files. See GV_FILE_PATH.
If SERVER_NAME is defined, image files are
restricted to exist in one of the directories specified by GV_FILE_PATH.
This last is a list of directory pathnames, separated by semicolons in Windows or
by colons otherwise.
Note that sometimes, when using one of the layout programs in a web
script, it is not enough to use an export command but rather the
variables should be set when the command is run, for example,
SERVER_NAME=xxx GV_FILE_PATH="images:etc/images:/usr/share/images" dot -Tpng -o x.png x.gv
Note that the image files must really reside in one of the specified directories. If the image file is specified as an absolute or relative pathname, a warning is given and only the base name is used.
- Indicates which directory contains the Graphviz config file and plug-in libraries. If it is defined, the value overrides any other mechanism for finding this directory. If Graphviz is properly installed, it should not be needed, though it can be useful for relocation on platforms not running Linux or Windows.