Merge branch 'master' of ssh://git.freedesktop.org/git/gstreamer/gstreamer
[platform/upstream/gstreamer.git] / tools / gst-xmllaunch.1.in
1 .TH "GStreamer" "1" "March 2001"
2 .SH "NAME"
3 gst\-xmllaunch \- build and run a GStreamer pipeline from an XML serialization
4 .SH "SYNOPSIS"
5 \fBgst\-xmllaunch\fR \fI[OPTION...]\fR XML\-FILE [ ELEMENT.PROPERTY=VALUE ... ]
6 .SH "DESCRIPTION"
7 .LP 
8 \fIgst\-xmllaunch\fP is a tool that is used to build and run a basic
9 \fIGStreamer\fP pipeline, loading it from an XML description. You can
10 produce the XML description using gst-launch(1) with the -o option or by
11 calling gst_xml_write_file() in your own app.
12
13 A simple commandline looks like:
14
15  gst\-xmllaunch my\-pipeline.xml filesrc0.location=music.mp3
16
17 This sets the location property of the element named filesrc0 to the value
18 "music.mp3". See gst\-launch(1) for syntax on setting element names, and
19 gst\-inspect to see what properties various elements have.
20
21 You can pass "-" as the XML\-FILE to read from stdin.
22
23 XML\-FILE can be a URI as well, thanks to the wizardry of libxml. I'm not really
24 sure what all is supported, it seems http works just fine though.
25
26 .
27 .SH "OPTIONS"
28 .l
29 \fIgst\-xmllaunch\fP accepts the following options:
30 .TP 8
31 .B  \-\-help
32 Print help synopsis and available FLAGS
33 .TP 8
34 .B  \-\-silent
35 Do not output status information
36 .TP 8
37 .B  \-\-exclude=TYPE, \-XTYPE
38 Do not output status information of TYPE
39 .TP 8
40 .B  \-\-output=FILE, \-oFILE
41 Save XML representation of pipeline to FILE and exit
42 .TP 8
43 .B  \-\-gst\-info\-mask=FLAGS
44 \fIGStreamer\fP info flags to set (list with \-\-help)
45 .TP 8
46 .B  \-\-gst\-debug\-mask=FLAGS
47 \fIGStreamer\fP debugging flags to set (list with \-\-help)
48 .TP 8
49 .B  \-\-gst\-mask=FLAGS
50 \fIGStreamer\fP info and debugging flags to set (list with \-\-help)
51 .TP 8
52 .B  \-\-gst\-plugin\-spew
53 \fIGStreamer\fP info flags to set
54 Enable printout of errors while loading \fIGStreamer\fP plugins
55 .TP 8
56 .B  \-\-gst\-plugin\-path=PATH
57 Add directories separated with ':' to the plugin search path
58 .
59 .SH "SEE ALSO"
60 .BR gst\-feedback (1),
61 .BR gst\-inspect (1),
62 .BR gst\-launch (1),
63 .BR gst\-typefind (1)
64 .SH "AUTHOR"
65 The GStreamer team at http://gstreamer.freedesktop.org/