Commit bc5c199b authored by Tim-Philipp Müller's avatar Tim-Philipp Müller 🐠

docs: mention xdot utility to view .dot files directly

parent 424477d0
......@@ -361,6 +361,11 @@ from the graphviz set of tools, like this:
<command>dot foo.dot -Tpng -o foo.png</command> or
<command>dot foo.dot -Tjpg -o foo.jpg</command>.
</para>
<para>
There is also a utility called <command>xdot</command> which allows you to
view the dot file directly without converting it first.
</para>
</formalpara>
......
......@@ -73,10 +73,12 @@ void gst_debug_bin_to_dot_file_with_ts (GstBin *bin, GstDebugGraphDetails detail
*
* To aid debugging applications one can use this method to write out the whole
* network of gstreamer elements that form the pipeline into an dot file.
* This file can be processed with graphviz to get an image.
* This file can be processed with graphviz to get an image, like this:
* <informalexample><programlisting>
* dot -Tpng -oimage.png graph_lowlevel.dot
* </programlisting></informalexample>
* There is also a utility called xdot which allows you to view the dot file
* directly without converting it first.
*
* The macro is only active if gstreamer is configured with
* &quot;--gst-enable-gst-debug&quot; and the environment variable
......
......@@ -429,7 +429,8 @@ When this environment variable is set, coloured debug output is disabled.
When set to a filesystem path, store 'dot' files of pipeline graphs there.
These can then later be converted into an image using the 'dot' utility from
the graphviz set of tools, like this: dot foo.dot -Tsvg -o foo.svg (png or jpg
are also possible as output format)
are also possible as output format). There is also a utility called 'xdot'
which allows you to view the .dot file directly without converting it first.
.TP
\fBGST_REGISTRY\fR
Path of the plugin registry file. Default is
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment