|author||Eric Wong <email@example.com>||2013-09-01 02:06:51 +0000|
|committer||Eric Wong <firstname.lastname@example.org>||2013-09-01 02:12:13 +0000|
This helps in case dtas-player is hit with SIGKILL or the system crashes. This does not fsync(2) as that could introduce delays on slow filesystems. Users should open the file manually and fsync themselves if they need to.
Diffstat (limited to 'Documentation')
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/dtas-player_protocol.txt b/Documentation/dtas-player_protocol.txt
index efbd065..b431180 100644
@@ -203,6 +203,14 @@ Commands here should be alphabetized according to `LC_ALL=C sort'
1. input type (flac/opus/mp3/etc)
2. transport protocol (local FS/http/ftp/sftp/etc)
+* state dump [FILENAME]
+ Immediately dump the state of the player. If a FILENAME is specified,
+ the state is written to that file. Otherwise, the default state file
+ (configured via DTAS_PLAYER_STATE environment variable, defaulting
+ to ~/.dtas/player_state.yml) is written to. This does not use fsync(2),
+ users requiring fsync should open(2) that file and fsync(2) it
+ themselves if necessary.
* watch - adds the client to the passive watch list for notifications.
It is recommended clients issue no further commands and open
another client socket to issue non-watch commands.