From a910d2ce86fa2cee0bed31e801173a981330fac1 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Tue, 10 Sep 2013 10:08:47 +0000 Subject: document dtas-tl(1) and the "tl" commands in the protocol Everything should be documented, even if it's a work-in-progress. I reserve the right to change them... --- Documentation/dtas-tl.txt | 75 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 Documentation/dtas-tl.txt (limited to 'Documentation/dtas-tl.txt') 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 \ +Mailing list archives available at \ +No subscription is necessary to post to the mailing list. + +# COPYRIGHT + +Copyright 2013, Eric Wong and all contributors.\ +License: GPLv3 or later + +# SEE ALSO + +dtas-player(1), dtas-player_protocol(7), dtas-ctl(1) -- cgit v1.2.3-24-ge0c7