diff options
| author | Max Kellermann <max@duempel.org> | 2014-08-24 12:39:38 +0200 |
|---|---|---|
| committer | Max Kellermann <max@duempel.org> | 2014-08-24 13:24:20 +0200 |
| commit | 9d04c21cc23e889ae3e8b110e18d3d04a9729ee5 (patch) | |
| tree | 3a2c44d9710424b3b99674ad02b7af057431d853 | |
| parent | ed8039e223e95141b6e5da433a181e516111a04e (diff) | |
| download | mpd-9d04c21cc23e889ae3e8b110e18d3d04a9729ee5.tar.gz mpd-9d04c21cc23e889ae3e8b110e18d3d04a9729ee5.tar.xz mpd-9d04c21cc23e889ae3e8b110e18d3d04a9729ee5.zip | |
doc/user: document the state file
| -rw-r--r-- | doc/user.xml | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/user.xml b/doc/user.xml index 2fc61223d..b01703173 100644 --- a/doc/user.xml +++ b/doc/user.xml @@ -856,6 +856,53 @@ systemctl start mpd.socket</programlisting> </informaltable> </section> </section> + + <section> + <title>Other Settings</title> + + <section> + <title>The State File</title> + + <para> + The <emphasis>state file</emphasis> is a file where + <application>MPD</application> saves and restores its state + (play queue, playback position etc.) to keep it persistent + across restarts and reboots. It is an optional setting. + </para> + + <para> + <application>MPD</application> will attempt to load the + state file during startup, and will save it when shutting + down the daemon. Additionally, the state file is refreshed + every two minutes (after each state change). + </para> + + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Setting</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <varname>state_file</varname> + <parameter>PATH</parameter> + </entry> + <entry> + Specify the state file location. The parent + directory must be writable by the + <application>MPD</application> user + (<parameter>+wx</parameter>). + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </section> + </section> </chapter> <chapter> |