[FFmpeg-devel] [PATCH] doc/ffserver: rework introducing paragraphs of the "description" chapter

Stefano Sabatini stefasab at gmail.com
Fri Jan 11 13:56:04 CET 2013


In particular, add some markup, fix empty line, and merge it with "How
does it work?" section.
---
 doc/ffserver.texi |   40 +++++++++++++++++-----------------------
 1 file changed, 17 insertions(+), 23 deletions(-)

diff --git a/doc/ffserver.texi b/doc/ffserver.texi
index 6fa8dc1..83756b8 100644
--- a/doc/ffserver.texi
+++ b/doc/ffserver.texi
@@ -16,34 +16,28 @@ ffserver [@var{options}]
 @chapter Description
 @c man begin DESCRIPTION
 
-ffserver is a streaming server for both audio and video. It supports
+ at command{ffserver} is a streaming server for both audio and video. It
+supports several live feeds, streaming from files and time shifting on
+live feeds (you can seek to positions in the past on each live feed,
+provided you specify a big enough feed storage in
+ at file{ffserver.conf}).
 
-several live feeds, streaming from files and time shifting on live feeds
-(you can seek to positions in the past on each live feed, provided you
-specify a big enough feed storage in ffserver.conf).
+ at command{ffserver} receives prerecorded files or FFM streams from some
+ at command{ffmpeg} instance as input, then streams them over
+RTP/RTSP/HTTP.
 
-This documentation covers only the streaming aspects of ffserver /
-ffmpeg. All questions about parameters for ffmpeg, codec questions,
-etc. are not covered here. Read @file{ffmpeg.html} for more
-information.
+An @command{ffserver} instance will listen on some port as specified
+in the configuration file. You can launch one or more instances of
+ at command{ffmpeg} and send one or more FFM streams to the port where
+ffserver is expecting to receive them. Alternately, you can make
+ at command{ffserver} launch such @command{ffmpeg} instances at startup.
 
- at section How does it work?
-
-ffserver receives prerecorded files or FFM streams from some ffmpeg
-instance as input, then streams them over RTP/RTSP/HTTP.
-
-An ffserver instance will listen on some port as specified in the
-configuration file. You can launch one or more instances of ffmpeg and
-send one or more FFM streams to the port where ffserver is expecting
-to receive them. Alternately, you can make ffserver launch such ffmpeg
-instances at startup.
-
-Input streams are called feeds, and each one is specified by a <Feed>
-section in the configuration file.
+Input streams are called feeds, and each one is specified by a
+ at code{<Feed>} section in the configuration file.
 
 For each feed you can have different output streams in various
-formats, each one specified by a <Stream> section in the configuration
-file.
+formats, each one specified by a @code{<Stream>} section in the
+configuration file.
 
 @section Status stream
 
-- 
1.7.9.5



More information about the ffmpeg-devel mailing list