tools/gst-launch.1.in: Fix description of how to specify a type in caps. Fixes #553873.

[platform/upstream/gstreamer.git] / tools / gst-launch.1.in

diff --git a/tools/gst-launch.1.in b/tools/gst-launch.1.in
index db7031f..ed09188 100644 (file)
--- a/tools/gst-launch.1.in
+++ b/tools/gst-launch.1.in
@@ -1,4 +1,4 @@
-.TH "GStreamer" "1" "December 2005"
+.TH "GStreamer" "1" "May 2007"
 .SH "NAME"
 gst\-launch \- build and run a GStreamer pipeline
 .SH "SYNOPSIS"
@@ -9,7 +9,7 @@ gst\-launch \- build and run a GStreamer pipeline
 \fIGStreamer\fP pipelines.
 
 In simple form, a PIPELINE\-DESCRIPTION is a list of
-elements separated by exclamation marks (!).  Properties may be appended to
+elements separated by exclamation marks (!). Properties may be appended to
 elements, in the form \fIproperty=value\fR.
 
 For a complete description of possible PIPELINE-DESCRIPTIONS see the section
@@ -162,11 +162,11 @@ If you want to chain caps, you can add more caps in the same format afterwards.
 
 .B Properties
 
-NAME\fI[:TYPE]\fR=VALUE
+NAME=\fI[(TYPE)]\fRVALUE
 .br
-in lists and ranges: [TYPE=]VALUE
+in lists and ranges: \fI[(TYPE)]\fRVALUE
 
-Sets the requested property in capabilites. The name is an alphanumeric value
+Sets the requested property in capabilities. The name is an alphanumeric value
 and the type can have the following case-insensitive values:
 .br
 - \fBi\fR or \fBint\fR for integer values or ranges
@@ -179,7 +179,7 @@ and the type can have the following case-insensitive values:
 .br
 - \fBs\fR, \fBstr\fR or \fBstring\fR for strings
 .br
-- \ffraction\fR for fractions (framerate, pixel-aspect-ratio)
+- \fBfraction\fR for fractions (framerate, pixel-aspect-ratio)
 .br
 - \fBl\fR or \fBlist\fR for lists
 .br
@@ -190,9 +190,9 @@ Integer values must be parsable by \fBstrtol()\fP, floats by \fBstrtod()\fP. FOU
 either be integers or strings. Boolean values are (case insensitive) \fIyes\fR, 
 \fIno\fR, \fItrue\fR or \fIfalse\fR and may like strings be escaped with " or '.
 .br
-Ranges are in this format:  [ PROPERTY, PROPERTY ]
+Ranges are in this format:  [ VALUE, VALUE ]
 .br
-Lists use this format:      ( PROPERTY \fI[, PROPERTY ...]\fR )
+Lists use this format:      ( VALUE \fI[, VALUE ...]\fR )
 
 .SH "PIPELINE CONTROL"
 
@@ -311,15 +311,15 @@ Play an AVI movie
 
 .B Network streaming
 
-FIXME: give example pipelines using RTP and network elements.
+Stream video using RTP and network elements.
 
 .B
-        FIXME: pipeline to send file
+        gst\-launch v4l2src ! video/x-raw-yuv,width=128,height=96,format='(fourcc)'UYVY ! ffmpegcolorspace ! ffenc_h263 ! video/x-h263 ! rtph263ppay pt=96 ! udpsink host=192.168.1.1 port=5000 sync=false
 .br
 Use this command on the receiver
 
 .B
-        FIXME: pipeline to receive file
+        gst\-launch udpsrc port=5000 ! application/x-rtp, clock-rate=90000,payload=96 ! rtph263pdepay queue-delay=0 ! ffdec_h263 ! xvimagesink
 .br
 This command would be run on the transmitter
 
@@ -369,7 +369,7 @@ automatically. To make this even easier, you can use the playbin element:
 These examples show you how to use filtered caps.
 
 .B
-        gst\-launch videotestsrc ! video/x-raw-yuv,format=\(fourcc\)YUY2;video/x-raw-yuv,format=\(fourcc\)YV12 ! xvimagesink
+        gst\-launch videotestsrc ! 'video/x-raw-yuv,format=(fourcc)YUY2;video/x-raw-yuv,format=(fourcc)YV12' ! xvimagesink
 .br
 Show a test image and use the YUY2 or YV12 video format for this.
 
@@ -389,16 +389,30 @@ GST_DEBUG=totem:4,typefind:5
 \fBGST_DEBUG_NO_COLOR\fR
 When this environment variable is set, coloured debug output is disabled.
 .TP
+\fBGST_DEBUG_DUMP_DOT_DIR\fR
+When set to a filesystem path, store dot files of pipeline graphs there.
+.TP
 \fBGST_REGISTRY\fR
-Describe me
+Path of the plugin registry file. Default is
+~/.gstreamer-GST_MAJORMINOR/registry-CPU.xml where CPU is the machine/cpu type
+GStreamer was compiled for, e.g. 'i486', 'i686', 'x86-64', 'ppc', etc. (check
+the output of "uname -i" and "uname -m" for details).
+.TP
+\fBGST_REGISTRY_UPDATE\fR
+Set to "no" to force GStreamer to assume that no plugins have changed,
+been added or been removed. This will make GStreamer skip the initial check
+whether a rebuild of the registry cache is required or not. This may be useful
+in embedded environments where the installed plugins never change. Do not
+use this option in any other setup.
 .TP
 \fBGST_PLUGIN_PATH\fR
-Set to directories in the form of $prefix/lib/gstreamer-0.10 to include plugins
-in non-standart locations. The path does not need to repeat the default
-GStreamer plugin path.
+Specifies a list of directories to scan for additional plugins.
+These take precedence over the system plugins.
 .TP
 \fBGST_PLUGIN_SYSTEM_PATH\fR
-Describe me
+Specifies a list of plugins that are always loaded by default.  If not set, 
+this defaults to the system-installed path, and the plugins installed in the
+user's home directory
 .TP
 \fBOIL_CPU_FLAGS\fR
 Useful liboil environment variable. Set OIL_CPU_FLAGS=0 when valgrind or
@@ -413,9 +427,15 @@ that warning to be triggered and under what circumstances. Simply set G_DEBUG
 as mentioned above and run the program in gdb (or let it core dump). Then get
 a stack trace in the usual way.
 .
+.SH FILES
+.TP 8
+~/.gstreamer-GST_MAJORMINOR/registry-*.xml
+The xml plugin database; can be deleted at any time, will be re-created
+automatically when it does not exist yet or plugins change.
+.
 .SH "SEE ALSO"
-.BR gst\-inspect (1)
+.BR gst\-feedback (1),
+.BR gst\-inspect (1),
 .BR gst\-typefind (1)
-.BR gst\-feedback (1)
 .SH "AUTHOR"
 The GStreamer team at http://gstreamer.freedesktop.org/