oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

doc/user: document the "fifo" output

Browse Source 
Move from doc/mpd.conf.5.
This commit is contained in:
Max Kellermann 2013-12-11 20:57:59 +01:00
parent de78fe38c8
commit 166c70cab3
2 changed files with 32 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/mpd.conf.5
View File

@ -420,17 +420,6 @@ default is "".
This specifies how many bytes to write to the audio device at once. This This specifies how many bytes to write to the audio device at once. This
parameter is to work around a bug in older versions of libao on sound cards parameter is to work around a bug in older versions of libao on sound cards
with very small buffers. The default is 1024. with very small buffers. The default is 1024.
.SH REQUIRED FIFO OUTPUT PARAMETERS
.TP
.B path <path>
This specifies the path of the FIFO to output to. Must be an absolute path.
If the path does not exist it will be created when mpd is started, and removed
when mpd is stopped. The FIFO will be created with the same user and group as
mpd is running as. Default permissions can be modified by using the builtin
shell command "umask". If a FIFO already exists at the specified path it will
be reused, and will \fBnot\fP be removed when mpd is stopped. You can use the
"mkfifo" command to create this, and then you may modify the permissions to
your liking.
.SH REQUIRED SHOUT OUTPUT PARAMETERS .SH REQUIRED SHOUT OUTPUT PARAMETERS
.TP .TP
.B name <name> .B name <name>

32
doc/user.xml
View File

@ -1408,6 +1408,38 @@ systemctl start mpd.socket</programlisting>
FIFO (First In, First Out) file. The data can be read by FIFO (First In, First Out) file. The data can be read by
another program. another program.
</para> </para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Setting</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<varname>path</varname>
<parameter>P</parameter>
</entry>
<entry>
This specifies the path of the FIFO to write to.
Must be an absolute path. If the path does not
exist, it will be created when MPD is started, and
removed when MPD is stopped. The FIFO will be
created with the same user and group as MPD is
running as. Default permissions can be modified by
using the builtin shell command "umask". If a FIFO
already exists at the specified path it will be
reused, and will not be removed when MPD is stopped.
You can use the "mkfifo" command to create this, and
then you may modify the permissions to your liking.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section> </section>
<section> <section>