|
wolffd@0
|
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
|
|
wolffd@0
|
2 <HTML VERSION="2.0">
|
|
wolffd@0
|
3 <HEAD>
|
|
wolffd@0
|
4 <TITLE>Command-line Usage</TITLE>
|
|
wolffd@0
|
5 </HEAD>
|
|
wolffd@0
|
6 <BODY BGCOLOR=white>
|
|
wolffd@0
|
7 <A NAME="top"></A>
|
|
wolffd@0
|
8 <H1 ALIGN=CENTER>Command-line Invocation</H1>
|
|
wolffd@0
|
9 <HR>
|
|
wolffd@0
|
10 All Graphviz programs have a similar invocation:<BR>
|
|
wolffd@0
|
11 <TABLE><TR><TD>
|
|
wolffd@0
|
12 <CODE><I>cmd</I> [ <I>flags</I> ] [ <I>input files</I> ]<CODE>
|
|
wolffd@0
|
13 </TR></TABLE>
|
|
wolffd@0
|
14 If no input files are supplied, the program reads from <STRONG>stdin</STRONG>.
|
|
wolffd@0
|
15 <H3>Flags</H3>
|
|
wolffd@0
|
16 <DL>
|
|
wolffd@0
|
17 <DT><STRONG>-G</STRONG><I>name</I>[=<I>value</I>]
|
|
wolffd@0
|
18 <DD>Set a graph attribute, with default <I>value</I> = <TT>true</TT>.
|
|
wolffd@0
|
19 <DT><STRONG>-N</STRONG><I>name</I>[=<I>value</I>]
|
|
wolffd@0
|
20 <DD>Set a default node attribute, with default <I>value</I> = <TT>true</TT>.
|
|
wolffd@0
|
21 <DT><STRONG>-E</STRONG><I>name</I>[=<I>value</I>]
|
|
wolffd@0
|
22 <DD>Set a default edge attribute, with default <I>value</I> = <TT>true</TT>.
|
|
wolffd@0
|
23 <DT><A NAME=minusK><STRONG>-K</STRONG></A><I>layout</I>
|
|
wolffd@0
|
24 <DD>Specifies which default layout algorithm to use, overriding the default from the command name. For example, running
|
|
wolffd@0
|
25 <TT>dot -Kneato</TT> is equivalent to running <TT>neato</TT>.
|
|
wolffd@0
|
26 <DT><A NAME=d:T><STRONG>-T</STRONG></A><I>format</I>[:<I>renderer</I>[:<I>formatter</I>]]
|
|
wolffd@0
|
27 <DD>Set output language to one of the <A HREF=output.html>supported formats</A>.
|
|
wolffd@0
|
28 By default, <A HREF=output.html#d:dot>attributed dot</A> is produced.
|
|
wolffd@0
|
29 <P>
|
|
wolffd@0
|
30 Depending on how Graphviz was built, there may be multiple renderers for
|
|
wolffd@0
|
31 generating a particular output format, and multiple formatters for
|
|
wolffd@0
|
32 creating the final output. For example, a typical installation
|
|
wolffd@0
|
33 can produce <A HREF="http://www.graphviz.org/doc/info/output.html#d:png">PNG</A>
|
|
wolffd@0
|
34 output using either the Cairo or GD library. The desired rendering engine
|
|
wolffd@0
|
35 can be specified after a colon. If there are multiple formatting engines
|
|
wolffd@0
|
36 available, the desired one can be specified in a similar fashion after
|
|
wolffd@0
|
37 the rendering engine. Thus, <TT>-Tpng:cairo</TT> specifies PNG
|
|
wolffd@0
|
38 output produced by Cairo (using the Cairo's default formatter), and
|
|
wolffd@0
|
39 <TT>-Tpng:cairo:gd</TT> specifies PNG
|
|
wolffd@0
|
40 output produced by Cairo formatted using the GD library.
|
|
wolffd@0
|
41 <P>
|
|
wolffd@0
|
42 If no renderer is specified, or a renderer but no formatter, the default one
|
|
wolffd@0
|
43 is invoked. The flag <TT>-T<I>format</I>:</TT> produces a list of all
|
|
wolffd@0
|
44 of the renderers available for the specified <I>format</I>, the first one
|
|
wolffd@0
|
45 listed with a prefix matching <I>format</I> being the default.
|
|
wolffd@0
|
46 Using the <TT>-v</TT> flag, described below, will print which format,
|
|
wolffd@0
|
47 renderer, and formatter are actually used.
|
|
wolffd@0
|
48 <DT><STRONG>-V</STRONG>
|
|
wolffd@0
|
49 <DD>Emit version information and exit.
|
|
wolffd@0
|
50 <DT><STRONG>-l</STRONG><I>library</I>
|
|
wolffd@0
|
51 <DD>User-supplied, device-dependent library text. Multiple flags may
|
|
wolffd@0
|
52 be given. These strings are passed to the code generator at the
|
|
wolffd@0
|
53 beginning of output.
|
|
wolffd@0
|
54 <P>For PostScript output, they are treated as file names
|
|
wolffd@0
|
55 whose content will be included in the preamble after the standard preamble.
|
|
wolffd@0
|
56 If <I>library</I> is the empty string <TT>""</TT>, the standard preamble
|
|
wolffd@0
|
57 is not emitted.
|
|
wolffd@0
|
58 <DT><A NAME=d:n><STRONG>-n</STRONG>[<I>num</I>]</A>
|
|
wolffd@0
|
59 <DD>Sets no-op flag in <STRONG>neato</STRONG>.
|
|
wolffd@0
|
60 If set, <STRONG>neato</STRONG> assumes nodes have already been
|
|
wolffd@0
|
61 positioned and all nodes have a <A HREF=attrs.html#d:pos>pos</A>
|
|
wolffd@0
|
62 attribute giving
|
|
wolffd@0
|
63 the positions. It then performs an optional adjustment to remove node-node
|
|
wolffd@0
|
64 overlap, depending on the value of the
|
|
wolffd@0
|
65 <A HREF=attrs.html#d:overlap>overlap</A> attribute, computes the edge
|
|
wolffd@0
|
66 layouts, depending on the value of the
|
|
wolffd@0
|
67 <A HREF=attrs.html#d:splines>splines</A> attribute, and
|
|
wolffd@0
|
68 emits the graph in the appropriate format. If <I>num</I> is supplied,
|
|
wolffd@0
|
69 the following actions occur:
|
|
wolffd@0
|
70 <DL>
|
|
wolffd@0
|
71 <DT><I>num</I> = 1
|
|
wolffd@0
|
72 <DD>Equivalent to <STRONG>-n</STRONG>.
|
|
wolffd@0
|
73 <DT><I>num</I> > 1
|
|
wolffd@0
|
74 <DD>Use node positions as specified, with no adjustment to
|
|
wolffd@0
|
75 remove node-node overlaps, and use any edge layouts already specified
|
|
wolffd@0
|
76 by the <A HREF=attrs.html#d:pos>pos</A> attribute. <STRONG>neato</STRONG>
|
|
wolffd@0
|
77 computes an edge layout for any edge that does not have a <B>pos</B> attribute.
|
|
wolffd@0
|
78 As usual, edge layout is guided by the
|
|
wolffd@0
|
79 <A HREF=attrs.html#d:splines>splines</A> attribute.
|
|
wolffd@0
|
80 </DL>
|
|
wolffd@0
|
81 <DT><STRONG>-o</STRONG><I>outfile</I>
|
|
wolffd@0
|
82 <DD>Write output to file <I>outfile</I>. By default, output goes to
|
|
wolffd@0
|
83 <STRONG>stdout</STRONG>.
|
|
wolffd@0
|
84 <DT><STRONG>-O</STRONG>
|
|
wolffd@0
|
85 <DD>Automatically generate output file names based on the input
|
|
wolffd@0
|
86 file name and the various output formats specified by the <STRONG>-T</STRONG>
|
|
wolffd@0
|
87 flags.
|
|
wolffd@0
|
88 <DT><STRONG>-P</STRONG>
|
|
wolffd@0
|
89 <DD>Automatically generate a graph that shows the plugin configuration of
|
|
wolffd@0
|
90 the current executable. e.g. <STRONG>dot -P -Tps | lpr</STRONG>
|
|
wolffd@0
|
91 <DT><STRONG>-q</STRONG>
|
|
wolffd@0
|
92 <DD>Suppress warning messages.
|
|
wolffd@0
|
93 <DT><A NAME=d:s><STRONG>-s</STRONG></A>[<I>scale</I>]
|
|
wolffd@0
|
94 <DD>Set input scale to <I>scale</I>. If this value is omitted,
|
|
wolffd@0
|
95 72.0 is used. This number is used to convert the point coordinate
|
|
wolffd@0
|
96 units used in the <A HREF=attrs.html#d:pos>pos</A> attribute
|
|
wolffd@0
|
97 into inches, which is what is expected by neato and fdp.
|
|
wolffd@0
|
98 Thus, feeding the output of a graph laid out by one program into
|
|
wolffd@0
|
99 neato or fdp almost always requires this flag.
|
|
wolffd@0
|
100 Ignored if the <STRONG>-n</STRONG> flag is used.
|
|
wolffd@0
|
101 <DT><STRONG>-v</STRONG>
|
|
wolffd@0
|
102 <DD>Verbose mode
|
|
wolffd@0
|
103 <DT><STRONG>-x</STRONG>
|
|
wolffd@0
|
104 <DD>In <STRONG>neato</STRONG>, on input, prune isolated nodes and peninsulas.
|
|
wolffd@0
|
105 This removes uninteresting graph structure and produces a less cluttered
|
|
wolffd@0
|
106 drawing.
|
|
wolffd@0
|
107 <DT><STRONG>-y</STRONG>
|
|
wolffd@0
|
108 <DD>By default, the coordinate system used in generic output formats,
|
|
wolffd@0
|
109 such as <A HREF=output.html#d:dot>attributed dot</A>,
|
|
wolffd@0
|
110 <A HREF=output.html#d:xdot>extended dot</A>,
|
|
wolffd@0
|
111 <A HREF=output.html#d:plain>plain</A> and
|
|
wolffd@0
|
112 <A HREF=output.html#d:plain-ext>plain-ext</A>,
|
|
wolffd@0
|
113 is the standard cartesian system with the origin in the lower left corner,
|
|
wolffd@0
|
114 and with increasing y coordinates as points move from bottom to top.
|
|
wolffd@0
|
115 If the <CODE>-y</CODE> flag is used, the coordinate system is inverted,
|
|
wolffd@0
|
116 so that increasing values of y correspond to movement from top to bottom.
|
|
wolffd@0
|
117 <DT><STRONG>-?</STRONG>
|
|
wolffd@0
|
118 <DD>Print usage information, then exit.
|
|
wolffd@0
|
119 </DL>
|
|
wolffd@0
|
120 If multiple <STRONG>-T</STRONG> flags are given, drawings of the graph
|
|
wolffd@0
|
121 are emitted in each of the specified formats. Multiple <STRONG>-o</STRONG>
|
|
wolffd@0
|
122 flags can be used to specify the output file for each format. If there
|
|
wolffd@0
|
123 are more formats than files, the remaining formats are written to
|
|
wolffd@0
|
124 <STRONG>stdout</STRONG>.
|
|
wolffd@0
|
125 <P>
|
|
wolffd@0
|
126 Note that the <STRONG>-G</STRONG>,
|
|
wolffd@0
|
127 <STRONG>-N</STRONG> and
|
|
wolffd@0
|
128 <STRONG>-E</STRONG> flags override any initial attribute declarations
|
|
wolffd@0
|
129 in the input graph,
|
|
wolffd@0
|
130 i.e., those attribute statements appearing before any node, edge or
|
|
wolffd@0
|
131 subgraph definitions.
|
|
wolffd@0
|
132 In addition, these flags cause the related attributes to be permanently
|
|
wolffd@0
|
133 attached to the graph. Thus, if attributed dot is used for
|
|
wolffd@0
|
134 output, the graph will have these attributes.
|
|
wolffd@0
|
135 <H3>Environment Variables</H3>
|
|
wolffd@0
|
136 <DL>
|
|
wolffd@0
|
137 <DT><STRONG>GDFONTPATH</STRONG>
|
|
wolffd@0
|
138 <DD>
|
|
wolffd@0
|
139 List of pathnames giving directories which a program should search for fonts.
|
|
wolffd@0
|
140 Overridden by <A HREF=#d:DOTFONTPATH>DOTFONTPATH</A>.
|
|
wolffd@0
|
141 <IT>Used only if Graphviz is not built with the <TT>fontconfig</TT> library</IT>
|
|
wolffd@0
|
142 <DT><A NAME=d:DOTFONTPATH><STRONG>DOTFONTPATH</STRONG></A>
|
|
wolffd@0
|
143 <DD>
|
|
wolffd@0
|
144 List of pathnames giving directories which a program should search for fonts.
|
|
wolffd@0
|
145 Overridden by <A HREF=attrs.html#d:fontpath><STRONG>fontpath</STRONG></A>.
|
|
wolffd@0
|
146 <IT>Used only if Graphviz is not built with the <TT>fontconfig</TT> library</IT>
|
|
wolffd@0
|
147 <DT><A NAME=d:SERVER_NAME><STRONG>SERVER_NAME</STRONG></A>
|
|
wolffd@0
|
148 <DD>
|
|
wolffd@0
|
149 If defined, this indicates that the software is running as a web application,
|
|
wolffd@0
|
150 which restricts access to image files. See
|
|
wolffd@0
|
151 <A HREF=d:GV_FILE_PATH>GV_FILE_PATH</A>.
|
|
wolffd@0
|
152 <DT><A NAME=d:GV_FILE_PATH><STRONG>GV_FILE_PATH</STRONG></A>
|
|
wolffd@0
|
153 <DD>
|
|
wolffd@0
|
154 If <A HREF=d:SERVER_NAME>SERVER_NAME</A> is defined, image files are
|
|
wolffd@0
|
155 restricted to the directory specified by <TT>GV_FILE_PATH</TT>.
|
|
wolffd@0
|
156 Note that sometimes, when using one of the layout programs in a web
|
|
wolffd@0
|
157 script, it is not enough to use an export command but rather the
|
|
wolffd@0
|
158 variables should be set when the command is run, for example,<BR>
|
|
wolffd@0
|
159 <CODE>
|
|
wolffd@0
|
160 SERVER_NAME=xxx GV_FILE_PATH="images/" dot -Tpng -o x.png x.dot
|
|
wolffd@0
|
161 </CODE>
|
|
wolffd@0
|
162 <DT><A NAME=d:GVBINDIR><STRONG>GVBINDIR</STRONG></A>
|
|
wolffd@0
|
163 <DD>
|
|
wolffd@0
|
164 Indicates which directory contains the Graphviz config file and
|
|
wolffd@0
|
165 plug-in libraries. If it is defined, the value overrides any other
|
|
wolffd@0
|
166 mechanism for finding this directory. If Graphviz is properly installed,
|
|
wolffd@0
|
167 it should not be needed, though it can be useful for relocation on
|
|
wolffd@0
|
168 platforms not running Linux or Windows.
|
|
wolffd@0
|
169 </DL>
|
|
wolffd@0
|
170 </BODY>
|
|
wolffd@0
|
171 </HTML>
|
