From 0c44e3e8672aaadb621a2567fff50e44bdd09f0e Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 25 Aug 2014 06:06:52 +0000 Subject: doc: document "tl get"/"dtas-tl cat" escaping gotcha We shell-escape filenames, so they may not show up properly when shuttled across the wire. --- Documentation/dtas-player_protocol.txt | 2 +- Documentation/dtas-tl.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/Documentation/dtas-player_protocol.txt b/Documentation/dtas-player_protocol.txt index 42f3bf8..8cde50d 100644 --- a/Documentation/dtas-player_protocol.txt +++ b/Documentation/dtas-player_protocol.txt @@ -252,7 +252,7 @@ Commands here should be alphabetized according to `LC_ALL=C sort' the track list * tl get [TRACKIDS] - returns a list of TRACKIDS mapped to filenames. + returns a list of TRACKIDS mapped to shell-escaped filenames. * tl goto TRACKID [TIMESTAMP] - plays the given TRACKID An optional timestamp may be added to prevent playing the diff --git a/Documentation/dtas-tl.txt b/Documentation/dtas-tl.txt index 1dd42a1..5bb5349 100644 --- a/Documentation/dtas-tl.txt +++ b/Documentation/dtas-tl.txt @@ -24,6 +24,7 @@ client). * current-id - display the TRACKID of the current track "NONE" if not playing * cat - display a newline-delimited list of TRACK_ID=PATH output + Note: this is shell-escaped, multibyte characters may not show up properly. * 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 -- cgit v1.2.3-24-ge0c7