about summary refs log tree commit homepage
path: root/Documentation/dtas-tl.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/dtas-tl.txt')
-rw-r--r--Documentation/dtas-tl.txt75
1 files changed, 75 insertions, 0 deletions
diff --git a/Documentation/dtas-tl.txt b/Documentation/dtas-tl.txt
new file mode 100644
index 0000000..7c54f10
--- /dev/null
+++ b/Documentation/dtas-tl.txt
@@ -0,0 +1,75 @@
+% dtas-tl(1) dtas user manual
+
+# NAME
+
+dtas-tl - tracklist manipulation for dtas-player (development)
+
+# SYNOPSYS
+
+dtas-tl [COMMANDS]
+
+# DESCRIPTION
+
+dtas-tl provides utility functions for manipulating the tracklist of the
+dtas-player (not the queue, the tracklist is separate from the queue).
+It is mainly intended as a development tool and will likely go away in
+the future or have its functionality merged into another tool (or MPRIS
+client).
+
+# COMMANDS
+
+* addhead - add multiple tracks to the beginning of the tracklist
+* addtail - add multiple tracks to the end of the tracklist
+* current - display the current track, "NONE" if not playing
+* current-id - display the TRACKID of the current track
+  "NONE" if not playing
+* cat - display a newline-delimited list of TRACK_ID=PATH output
+* clear - remove all tracks from the tracklist
+* goto TRACKID [POS] - play TRACKID immediately, optionally seek to POS
+TRACKID may be looked up via cat, and POS should be a timestamp in
+HH:MM:SS.FRAC format.
+* next - play the next track in the tracklist
+* previous - play the previous track in the tracklist
+* repeat 1 - repeat the current track
+* repeat false - disable repeat
+* repeat true - enable repeat of the whole tracklist
+
+See dtas-player_protocol(7) for a detailed description of the protocol.
+
+# EXAMPLES
+
+display the current tracklist
+
+        $ dtas-tl cat
+
+to add an an entire directory of FLAC files
+
+        $ dtas-tl addtail /path/to/directory/*.flac
+
+to skip forward in the tracklist
+
+        $ dtas-tl next
+
+to skip backwards in the tracklist
+
+        $ dtas-tl previous
+
+# ENVIRONMENT
+
+DTAS_PLAYER_SOCK - the path to the dtas-player control socket.
+This defaults to ~/.dtas/player.sock
+
+# CONTACT
+
+All feedback welcome via plain-text mail to <dtas-all@nongnu.org>\
+Mailing list archives available at <ftp://lists.gnu.org/dtas-all/>\
+No subscription is necessary to post to the mailing list.
+
+# COPYRIGHT
+
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.\
+License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>
+
+# SEE ALSO
+
+dtas-player(1), dtas-player_protocol(7), dtas-ctl(1)