ezstream/doc/ezstream-file.sh.1.in.in

.\" Copyright (c) 2009, 2015 Moritz Grimm <mgrimm@mrsserver.net>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd @BUILD_DATE@
.Dt EZSTREAM-FILE.SH 1
.Os @PACKAGE_NAME@ @PACKAGE_VERSION@
.Sh NAME
.Nm ezstream-file.sh
.Nd script to stream files from the command line
.Sh SYNOPSIS
.Nm
.Bk -words
.Op Fl hqrVv
.Op Fl p Ar pidfile
.Op Fl T Ar cfg_template
.Op Ar
.Ek
.Sh DESCRIPTION
The
.Nm
script uses an
.Nm ezstream
configuration file template to stream a list of files given on the command
line, or via standard input.
In other words, filenames are written to a temporary playlist, and a
template-based configuration is generated to stream them.
.Pp
The path to a configuration template must be provided, either by using the
.Fl T
command line argument, or the
.Dv EZSTREAM_TEMPLATE
environment variable.
.Pp
The configuration template must be a valid playlist configuration, and contain
the follwing configuration statement inside the \&<media\ /\&> block:
.Bd -literal -offset indent
\&<filename\&>%FILENAME%\&</filename\&>
.Ed
.Pp
If no input files are specified, the list of files to be streamed are read
from standard input.
.Pp
Lastly, the
.Dv EZSTREAM
environment variable allows to specify an alternate
.Nm ezstream
binary.
.Ss Command line parameters
.Bl -tag -width Ds
.It Fl h
Print a summary of available command line parameters with short descriptions
and exit.
.It Fl p Ar pidfile
.Po
Passed to
.Nm ezstream .
.Pc
Write the
.Nm
process ID
.Pq a single number
to
.Ar pidfile .
.It Fl q
.Po
Passed to
.Nm ezstream .
.Pc
Be more quiet.
Suppress the output that external programs send to standard error.
.It Fl r
.Po
Passed to
.Nm ezstream .
.Pc
Show a real-time stream status information line on standard output.
Implies
.Fl q .
.It Fl T Ar cfg_template
Use the configuration in
.Ar cfg_template ,
overriding the default set in the
.Dv EZSTREAM_TEMPLATE
environment variable.
.It Fl V
Print the
.Nm
version number and exit.
.It Fl v
.Po
Passed to
.Nm ezstream .
.Pc
Produce more verbose output from
.Nm ezstream .
Use twice for even more verbose output.
.El
.Sh FILES
.Bl -tag -width "!!EXAMPLES_DIR!!" -compact
.It Pa !!EXAMPLES_DIR!!
Directory containing example configuration files for various uses of
.Nm ezstream ,
as well as example playlist and metadata scripts.
.El
.Sh SEE ALSO
.Xr ezstream 1 ,
.Xr ezstream-cfgmigrate 1
.Sh AUTHORS
.An -nosplit
The
.Nm
script and this manual were written by
.An Moritz Grimm .