From 9d04c21cc23e889ae3e8b110e18d3d04a9729ee5 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Sun, 24 Aug 2014 12:39:38 +0200
Subject: doc/user: document the state file

---
 doc/user.xml | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

(limited to 'doc/user.xml')

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>
-- 
cgit v1.2.3