aniani/ezstream
1
0
Fork 0
mirror of https://gitlab.xiph.org/xiph/ezstream.git synced 2025-01-03 14:56:35 -05:00
Code

Spelink.

Browse Source 
git-svn-id: https://svn.xiph.org/trunk/ezstream@13252 0101bb08-14d6-0310-b084-bc0e0c8e3800
This commit is contained in:
moritz 2007-07-13 10:30:58 +00:00
parent a51be920c4
commit 47d842ef7a
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/ezstream.1.in
View File

@ -23,7 +23,7 @@ In its basic mode of operation, it streams media files and data from standard
input input
.Qq as-is .Qq as-is
\(em such as Ogg Vorbis, Ogg Theora and MP3 \(em to a server. \(em such as Ogg Vorbis, Ogg Theora and MP3 \(em to a server.
It can also use various external decoders and encoders to reencode from one It can also use various external decoders and encoders to re-encode from one
format to another, and stream the result. format to another, and stream the result.
The only requirement is that the external programs support writing to or The only requirement is that the external programs support writing to or
reading from standard input, and can be used from the command line. reading from standard input, and can be used from the command line.
@ -55,7 +55,7 @@ and
.Fl v .Fl v
parameters are provided simultaneously, an additional line of information about parameters are provided simultaneously, an additional line of information about
the currently streamed file \(em playlist position, approximate playing time the currently streamed file \(em playlist position, approximate playing time
and bitrate \(em is displayed. and bit rate \(em is displayed.
.Ss Runtime control .Ss Runtime control
On POSIX systems, On POSIX systems,
.Nm .Nm
@ -121,7 +121,7 @@ element as their parent.
.Bl -tag -width -Ds .Bl -tag -width -Ds
.It Sy \&<url\ /\&> .It Sy \&<url\ /\&>
.Pq Mandatory. .Pq Mandatory.
Specifies the location and mountpoint of the Icecast server, to which the Specifies the location and mount point of the Icecast server, to which the
stream will be sent. stream will be sent.
The content must be of the form The content must be of the form
.Pa http://server:port/mountpoint .Pa http://server:port/mountpoint
@ -133,11 +133,11 @@ For example:
Sets the source password for authentication with the Icecast server. Sets the source password for authentication with the Icecast server.
.It Sy \&<format\ /\&> .It Sy \&<format\ /\&>
.Pq Mandatory. .Pq Mandatory.
This element has two different meanings, depending on whether reencoding is This element has two different meanings, depending on whether re-encoding is
enabled or not. enabled or not.
It specifies the It specifies the
.Em output format .Em output format
of the stream if reencoding is enabled. of the stream if re-encoding is enabled.
Otherwise, it specifies the Otherwise, it specifies the
.Em input format .Em input format
of of
@ -272,11 +272,11 @@ Set the description of the broadcast.
Informational only, used for YP. Informational only, used for YP.
.It Sy \&<svrinfobitrate\ /\&> .It Sy \&<svrinfobitrate\ /\&>
.Pq Optional. .Pq Optional.
Set the bitrate of the broadcast. Set the bit rate of the broadcast.
This setting is also purely informational and only used for YP. This setting is also purely informational and only used for YP.
The value is set by the user and not The value is set by the user and not
.Nm , .Nm ,
and should match the bitrate of the stream. and should match the bit rate of the stream.
.It Sy \&<svrinfoquality\ /\&> .It Sy \&<svrinfoquality\ /\&>
.Pq Optional. .Pq Optional.
Set the quality setting of an Ogg Vorbis broadcast. Set the quality setting of an Ogg Vorbis broadcast.
@ -309,11 +309,11 @@ the default if the
element is absent. element is absent.
.It Sy \&<reencode\ /\&> .It Sy \&<reencode\ /\&>
.Pq Optional. .Pq Optional.
Element that contains child elements, which specify if and how reencoding Element that contains child elements, which specify if and how re-encoding
should be done. should be done.
.El .El
.Ss Reencoding settings .Ss Re-encoding settings
Each of the reencoding configuration elements have the Each of the re-encoding configuration elements have the
.Li \&<reencode/\&> .Li \&<reencode/\&>
element as their parent. element as their parent.
.Bl -tag -width -Ds .Bl -tag -width -Ds
@ -321,11 +321,11 @@ element as their parent.
Set to Set to
.Sy 1 .Sy 1
.Pq one .Pq one
to enable reencoding. to enable re-encoding.
If set to If set to
.Sy 0 .Sy 0
.Pq zero , .Pq zero ,
no reencoding will be done, which is also the default if the no re-encoding will be done, which is also the default if the
.Li \&<enable/\&> .Li \&<enable/\&>
element is absent. element is absent.
.It Sy \&<encdec\ /\&> .It Sy \&<encdec\ /\&>
@ -378,8 +378,8 @@ contain whitespaces.
.Pp .Pp
Metadata placeholders can be used in the Metadata placeholders can be used in the
.Li \&<decode/\&> .Li \&<decode/\&>
element as well, for combined de-/encoder programs that produce streamable element as well, for combined de-/encoder programs that produce data that can
data. be streamed.
See the See the
.Sy METADATA .Sy METADATA
section for details on how metadata is handled by section for details on how metadata is handled by
@ -424,7 +424,7 @@ The program must be an executable file.
.It .It
The program must write one line to standard output and exit. The program must write one line to standard output and exit.
.It .It
The program must not require arbitary command line options to function. The program must not require arbitrary command line options to function.
A wrapper script must be used if there is no other way. A wrapper script must be used if there is no other way.
.El .El
.Ss Playlist Programs .Ss Playlist Programs