From 3083b7fbe2bc6e8dcd935b10bb7a165257c5252b Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 18 Jan 2016 05:18:09 +0000 Subject: doc: convert to perlpod(1) from Markdown perlpod(1) is already installed by default on Debian and RedHat-based systems; and probably most modern *nixes; pandoc(1) (and Haskell) are not. POD also more standardized than Markdown (which flavor? :P), especially for generating manpages. So save any potential documentation editors some disk space by not forcing them to install Haskell and pandoc. Finally, I'm a mildly proficient in Perl and do not know Haskell at all and have a better chance at reading/hacking the source if the document generator breaks. --- Documentation/dtas-tl.txt | 96 ----------------------------------------------- 1 file changed, 96 deletions(-) delete mode 100644 Documentation/dtas-tl.txt (limited to 'Documentation/dtas-tl.txt') diff --git a/Documentation/dtas-tl.txt b/Documentation/dtas-tl.txt deleted file mode 100644 index 2ff5ff6..0000000 --- a/Documentation/dtas-tl.txt +++ /dev/null @@ -1,96 +0,0 @@ -% 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 - -* aac - *A*dd tracks *A*fter *C*urrent track in the tracklist -* addhead - add tracks to the beginning of the tracklist -* addtail - add 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 - Note: this is shell-escaped, multibyte characters may not show up properly. -* clear - remove all tracks from the tracklist -* edit - spawn an editor to allow editing the tracklist as a text file - See EDITING for more information. -* 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. -* reto REGEXP [POS] - play first track with path matching REGEXP immediately, -optionally seek to POS. POS should be a timestamp in HH:MM:SS.FRAC format. -* next - play the next track in the tracklist -* prev - 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 prev - -# EDITING - -It is possible to edit the player tracklist from your favorite text -editor. Existing lines denoting tracks may be rearranged, deleted, -copied or entirely new lines with path names (without a trailing -"=TRACK_ID") may be added. - -Changes to the tracklist are sent to the player when the user exits the -editor. This functionality only works when there is one user editing -the tracklist at a time, and when no files in the tracklist contain rare -newline characters. - -# ENVIRONMENT - -VISUAL / EDITOR - your favorite *nix text editor, defaults to 'vi' if unset. - -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 and -\ -No subscription is necessary to post to the mailing list. - -# COPYRIGHT - -Copyright 2013-2016 all contributors .\ -License: GPL-3.0+ - -# SEE ALSO - -dtas-player(1), dtas-player_protocol(7), dtas-ctl(1) -- cgit v1.2.3-24-ge0c7