docs: mention xdot utility to view .dot files directly
authorTim-Philipp Müller <tim@centricular.com>
Fri, 16 Oct 2015 14:59:49 +0000 (15:59 +0100)
committerTim-Philipp Müller <tim@centricular.com>
Fri, 16 Oct 2015 14:59:49 +0000 (15:59 +0100)
docs/gst/running.xml
gst/gstdebugutils.h
tools/gst-launch.1.in

index 103aebb8978bdc5a3af351723fc988b0539185ae..b034e6abbdf83998c4b4d7af37772cd225c50dc9 100644 (file)
@@ -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>
 
index 06618f9d9b4e5e685268c80d964819af334cf566..8363e2dc9ffd27be2b275b6cdeb50072bc7d1fcb 100644 (file)
@@ -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
index c04ddc6719a593a5093098fa2922ea7ebe50e82b..409727ffa35f03dc720cfbb11da1b70512a01a35 100644 (file)
@@ -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