mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-04-26 06:54:49 +00:00
tools: escape dashes in the man pages
The portable way to have the dashes to be rendered as ASCII minuses is to use the sequence backslash-dash, use this style at least for text that can be copied and pasted (e.g. command names, file names, element options). Also use backslash-dash in the NAME section as suggested by lexgrog(1). https://bugzilla.gnome.org/show_bug.cgi?id=773917
This commit is contained in:
parent
0e439fe6ad
commit
64c097d296
3 changed files with 15 additions and 15 deletions
|
@ -1,6 +1,6 @@
|
||||||
.TH GStreamer 1 "December 2005"
|
.TH GStreamer 1 "December 2005"
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
gst\-inspect - print info about a GStreamer plugin or element
|
gst\-inspect \- print info about a GStreamer plugin or element
|
||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
.B gst\-inspect [OPTION...] [PLUGIN|ELEMENT]
|
.B gst\-inspect [OPTION...] [PLUGIN|ELEMENT]
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
|
|
|
@ -209,7 +209,7 @@ and the type can have the following case-insensitive values:
|
||||||
.br
|
.br
|
||||||
- \fBs\fR, \fBstr\fR or \fBstring\fR for strings
|
- \fBs\fR, \fBstr\fR or \fBstring\fR for strings
|
||||||
.br
|
.br
|
||||||
- \fBfraction\fR for fractions (framerate, pixel-aspect-ratio)
|
- \fBfraction\fR for fractions (framerate, pixel\-aspect\-ratio)
|
||||||
.br
|
.br
|
||||||
- \fBl\fR or \fBlist\fR for lists
|
- \fBl\fR or \fBlist\fR for lists
|
||||||
.br
|
.br
|
||||||
|
@ -301,10 +301,10 @@ rips track 5 from the CD and converts it into a single mp3 file
|
||||||
|
|
||||||
Using \fBgst\-inspect\fR(1), it is possible to discover settings like the above
|
Using \fBgst\-inspect\fR(1), it is possible to discover settings like the above
|
||||||
for cdparanoiasrc that will tell it to rip the entire cd or only tracks of it.
|
for cdparanoiasrc that will tell it to rip the entire cd or only tracks of it.
|
||||||
Alternatively, you can use an URI and gst-launch will find an element (such as
|
Alternatively, you can use an URI and gst\-launch will find an element (such as
|
||||||
cdparanoia) that supports that protocol for you, e.g.:
|
cdparanoia) that supports that protocol for you, e.g.:
|
||||||
.B
|
.B
|
||||||
gst\-launch cdda://5 ! lame vbr=new vbr-quality=6 ! filesink location=track5.mp3
|
gst\-launch cdda://5 ! lame vbr=new vbr\-quality=6 ! filesink location=track5.mp3
|
||||||
|
|
||||||
.B
|
.B
|
||||||
gst\-launch pulsesrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=input.ogg
|
gst\-launch pulsesrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=input.ogg
|
||||||
|
@ -352,19 +352,19 @@ Play an AVI movie with an external text subtitle stream using playbin
|
||||||
Stream video using RTP and network elements.
|
Stream video using RTP and network elements.
|
||||||
|
|
||||||
.B
|
.B
|
||||||
gst\-launch v4l2src ! video/x-raw,width=128,height=96,format=UYVY ! videoconvert ! ffenc_h263 ! video/x-h263 ! rtph263ppay pt=96 ! udpsink host=192.168.1.1 port=5000
|
gst\-launch v4l2src ! video/x\-raw,width=128,height=96,format=UYVY ! videoconvert ! ffenc_h263 ! video/x\-h263 ! rtph263ppay pt=96 ! udpsink host=192.168.1.1 port=5000
|
||||||
.br
|
.br
|
||||||
This command would be run on the transmitter
|
This command would be run on the transmitter
|
||||||
|
|
||||||
.B
|
.B
|
||||||
gst\-launch udpsrc port=5000 ! application/x-rtp, clock-rate=90000,payload=96 ! rtph263pdepay queue-delay=0 ! ffdec_h263 ! xvimagesink
|
gst\-launch udpsrc port=5000 ! application/x\-rtp, clock\-rate=90000,payload=96 ! rtph263pdepay queue\-delay=0 ! ffdec_h263 ! xvimagesink
|
||||||
.br
|
.br
|
||||||
Use this command on the receiver
|
Use this command on the receiver
|
||||||
|
|
||||||
.B Diagnostic
|
.B Diagnostic
|
||||||
|
|
||||||
.B
|
.B
|
||||||
gst\-launch -v fakesrc num-buffers=16 ! fakesink
|
gst\-launch \-v fakesrc num\-buffers=16 ! fakesink
|
||||||
.br
|
.br
|
||||||
Generate a null stream and ignore it (and print out details).
|
Generate a null stream and ignore it (and print out details).
|
||||||
|
|
||||||
|
@ -407,12 +407,12 @@ automatically. To make this even easier, you can use the playbin element:
|
||||||
These examples show you how to use filtered caps.
|
These examples show you how to use filtered caps.
|
||||||
|
|
||||||
.B
|
.B
|
||||||
gst\-launch videotestsrc ! 'video/x-raw,format=YUY2;video/x-raw,format=YV12' ! xvimagesink
|
gst\-launch videotestsrc ! 'video/x\-raw,format=YUY2;video/x\-raw,format=YV12' ! xvimagesink
|
||||||
.br
|
.br
|
||||||
Show a test image and use the YUY2 or YV12 video format for this.
|
Show a test image and use the YUY2 or YV12 video format for this.
|
||||||
|
|
||||||
.B
|
.B
|
||||||
gst\-launch pulsesrc ! 'audio/x-raw,rate=[32000,64000],format={S16LE,S24LE,S32LE}' ! wavenc ! filesink location=recording.wav
|
gst\-launch pulsesrc ! 'audio/x\-raw,rate=[32000,64000],format={S16LE,S24LE,S32LE}' ! wavenc ! filesink location=recording.wav
|
||||||
.br
|
.br
|
||||||
record audio and write it to a .wav file. Force usage of signed 16 to 32 bit
|
record audio and write it to a .wav file. Force usage of signed 16 to 32 bit
|
||||||
samples and a sample rate between 32kHz and 64KHz.
|
samples and a sample rate between 32kHz and 64KHz.
|
||||||
|
@ -433,15 +433,15 @@ When this environment variable is set, coloured debug output is disabled.
|
||||||
\fBGST_DEBUG_DUMP_DOT_DIR\fR
|
\fBGST_DEBUG_DUMP_DOT_DIR\fR
|
||||||
When set to a filesystem path, store 'dot' files of pipeline graphs there.
|
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
|
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
|
the graphviz set of tools, like this: dot foo.dot \-Tsvg \-o foo.svg (png or jpg
|
||||||
are also possible as output format). There is also a utility called 'xdot'
|
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.
|
which allows you to view the .dot file directly without converting it first.
|
||||||
.TP
|
.TP
|
||||||
\fBGST_REGISTRY\fR
|
\fBGST_REGISTRY\fR
|
||||||
Path of the plugin registry file. Default is
|
Path of the plugin registry file. Default is
|
||||||
~/.cache/gstreamer-GST_API_VERSION/registry-CPU.bin where CPU is the
|
~/.cache/gstreamer\-GST_API_VERSION/registry\-CPU.bin where CPU is the
|
||||||
machine/cpu type GStreamer was compiled for, e.g. 'i486', 'i686', 'x86-64',
|
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).
|
'ppc', etc. (check the output of "uname \-i" and "uname \-m" for details).
|
||||||
.TP
|
.TP
|
||||||
\fBGST_REGISTRY_UPDATE\fR
|
\fBGST_REGISTRY_UPDATE\fR
|
||||||
Set to "no" to force GStreamer to assume that no plugins have changed,
|
Set to "no" to force GStreamer to assume that no plugins have changed,
|
||||||
|
@ -481,7 +481,7 @@ a stack trace in the usual way.
|
||||||
.
|
.
|
||||||
.SH FILES
|
.SH FILES
|
||||||
.TP 8
|
.TP 8
|
||||||
~/.cache/gstreamer-GST_API_VERSION/registry-*.bin
|
~/.cache/gstreamer\-GST_API_VERSION/registry\-*.bin
|
||||||
The plugin cache; can be deleted at any time, will be re-created
|
The plugin cache; can be deleted at any time, will be re-created
|
||||||
automatically when it does not exist yet or plugins change. Based on
|
automatically when it does not exist yet or plugins change. Based on
|
||||||
XDG_CACHE_DIR, so may be in a different location than the one suggested.
|
XDG_CACHE_DIR, so may be in a different location than the one suggested.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
.TH GStreamer 1 "May 2003"
|
.TH GStreamer 1 "May 2003"
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
gst\-typefind - print Media type of file
|
gst\-typefind \- print Media type of file
|
||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
.B gst\-typefind <file>
|
.B gst\-typefind <file>
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
|
|
Loading…
Reference in a new issue