doc/ffserver: rework introducing paragraphs of the "description" chapter

In particular, add some markup, fix empty line, and merge it with "How
does it work?" section.
This commit is contained in:
Stefano Sabatini 2013-01-11 12:53:18 +01:00
parent 0a7cd74043
commit cab85051c0

View File

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