Merge remote-tracking branch 'qatar/master'

[ffmpeg] / doc / protocols.texi

diff --git a/doc/protocols.texi b/doc/protocols.texi
index 87773cec87959222a447740613c345a36f24c039..da0e39f56cdb917b2e5e891d2c8dd13c1b15e7ed 100644 (file)
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -52,7 +52,7 @@ resource to be concatenated, each one possibly specifying a distinct
 protocol.
 
 For example to read a sequence of files @file{split1.mpeg},
 protocol.
 
 For example to read a sequence of files @file{split1.mpeg},

-@file{split2.mpeg}, @file{split3.mpeg} with @file{ffplay} use the
+@file{split2.mpeg}, @file{split3.mpeg} with @command{ffplay} use the

 command:
 @example
 ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
 command:
 @example
 ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg


@@ -67,7 +67,7 @@ File access protocol.
 
 Allow to read from or read to a file.
 
 
 Allow to read from or read to a file.
 

-For example to read from a file @file{input.mpeg} with @file{ffmpeg}
+For example to read from a file @file{input.mpeg} with @command{ffmpeg}

 use the command:
 @example
 ffmpeg -i file:input.mpeg output.mpeg
 use the command:
 @example
 ffmpeg -i file:input.mpeg output.mpeg


@@ -134,14 +134,14 @@ pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If @var{number}
 is not specified, by default the stdout file descriptor will be used
 for writing, stdin for reading.
 
 is not specified, by default the stdout file descriptor will be used
 for writing, stdin for reading.
 

-For example to read from stdin with @file{ffmpeg}:
+For example to read from stdin with @command{ffmpeg}:

 @example
 cat test.wav | ffmpeg -i pipe:0
 # ...this is the same as...
 cat test.wav | ffmpeg -i pipe:
 @end example
 
 @example
 cat test.wav | ffmpeg -i pipe:0
 # ...this is the same as...
 cat test.wav | ffmpeg -i pipe:
 @end example
 

-For writing to stdout with @file{ffmpeg}:
+For writing to stdout with @command{ffmpeg}:

 @example
 ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
 # ...this is the same as...
 @example
 ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
 # ...this is the same as...


@@ -155,8 +155,8 @@ be seekable, so they will fail with the pipe output protocol.
 
 Real-Time Messaging Protocol.
 
 
 Real-Time Messaging Protocol.
 

-The Real-Time Messaging Protocol (RTMP) is used for streaming
-multimedia content across a TCP/IP network.
+The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
+content across a TCP/IP network.

 
 The required syntax is:
 @example
 
 The required syntax is:
 @example


@@ -183,7 +183,7 @@ application specified in @var{app}, may be prefixed by "mp4:".
 
 @end table
 
 
 @end table
 

-For example to read with @file{ffplay} a multimedia resource named
+For example to read with @command{ffplay} a multimedia resource named

 "sample" from the application "vod" from an RTMP server "myserver":
 @example
 ffplay rtmp://myserver/vod/sample
 "sample" from the application "vod" from an RTMP server "myserver":
 @example
 ffplay rtmp://myserver/vod/sample


@@ -219,12 +219,12 @@ meaning as specified for the RTMP native protocol.
 See the librtmp manual page (man 3 librtmp) for more information.
 
 For example, to stream a file in real-time to an RTMP server using
 See the librtmp manual page (man 3 librtmp) for more information.
 
 For example, to stream a file in real-time to an RTMP server using

-@file{ffmpeg}:
+@command{ffmpeg}:

 @example
 ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
 @end example
 
 @example
 ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
 @end example
 

-To play the same stream using @file{ffplay}:
+To play the same stream using @command{ffplay}:

 @example
 ffplay "rtmp://myserver/live/mystream live=1"
 @end example
 @example
 ffplay "rtmp://myserver/live/mystream live=1"
 @end example


@@ -249,7 +249,7 @@ The required syntax for a RTSP url is:
 rtsp://@var{hostname}[:@var{port}]/@var{path}
 @end example
 
 rtsp://@var{hostname}[:@var{port}]/@var{path}
 @end example
 

-The following options (set on the @file{ffmpeg}/@file{ffplay} command
+The following options (set on the @command{ffmpeg}/@command{ffplay} command

 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
 are supported:
 
 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
 are supported:
 


@@ -288,7 +288,7 @@ When receiving data over UDP, the demuxer tries to reorder received packets
 order for this to be enabled, a maximum delay must be specified in the
 @code{max_delay} field of AVFormatContext.
 
 order for this to be enabled, a maximum delay must be specified in the
 @code{max_delay} field of AVFormatContext.
 

-When watching multi-bitrate Real-RTSP streams with @file{ffplay}, the
+When watching multi-bitrate Real-RTSP streams with @command{ffplay}, the

 streams to display can be chosen with @code{-vst} @var{n} and
 @code{-ast} @var{n} for video and audio respectively, and can be switched
 on the fly by pressing @code{v} and @code{a}.
 streams to display can be chosen with @code{-vst} @var{n} and
 @code{-ast} @var{n} for video and audio respectively, and can be switched
 on the fly by pressing @code{v} and @code{a}.


@@ -365,13 +365,13 @@ To broadcast a stream on the local subnet, for watching in VLC:
 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
 @end example
 
 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
 @end example
 

-Similarly, for watching in ffplay:
+Similarly, for watching in @command{ffplay}:

 
 @example
 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255
 @end example
 
 
 @example
 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255
 @end example
 

-And for watching in ffplay, over IPv6:
+And for watching in @command{ffplay}, over IPv6:

 
 @example
 ffmpeg -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
 
 @example
 ffmpeg -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]


@@ -472,7 +472,7 @@ For receiving, this gives the benefit of only receiving packets from
 the specified peer address/port.
 @end table
 
 the specified peer address/port.
 @end table
 

-Some usage examples of the udp protocol with @file{ffmpeg} follow.
+Some usage examples of the udp protocol with @command{ffmpeg} follow.

 
 To stream over UDP to a remote endpoint:
 @example
 
 To stream over UDP to a remote endpoint:
 @example