diff options
| author | Max Kellermann <max@duempel.org> | 2013-12-11 20:57:59 +0100 |
|---|---|---|
| committer | Max Kellermann <max@duempel.org> | 2013-12-11 20:58:06 +0100 |
| commit | 166c70cab36d654aefe70ccba4c1944b177f398b (patch) | |
| tree | 0525c46eb7bbd72e1b38165fcc8cfe158e11f98e | |
| parent | de78fe38c84120c60728a4e670b850a81ac45c3e (diff) | |
| download | mpd-166c70cab36d654aefe70ccba4c1944b177f398b.tar.gz mpd-166c70cab36d654aefe70ccba4c1944b177f398b.tar.xz mpd-166c70cab36d654aefe70ccba4c1944b177f398b.zip | |
doc/user: document the "fifo" output
Move from doc/mpd.conf.5.
| -rw-r--r-- | doc/mpd.conf.5 | 11 | ||||
| -rw-r--r-- | doc/user.xml | 32 |
2 files changed, 32 insertions, 11 deletions
diff --git a/doc/mpd.conf.5 b/doc/mpd.conf.5 index 3c48b5f30..c697eba88 100644 --- a/doc/mpd.conf.5 +++ b/doc/mpd.conf.5 @@ -420,17 +420,6 @@ default is "". 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 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 .TP .B name <name> diff --git a/doc/user.xml b/doc/user.xml index 962b7c280..d90fce9c6 100644 --- a/doc/user.xml +++ b/doc/user.xml @@ -1408,6 +1408,38 @@ systemctl start mpd.socket</programlisting> FIFO (First In, First Out) file. The data can be read by another program. </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> |