about summary refs log tree commit homepage
path: root/Documentation/dtas-tl.pod
blob: 44bdfbb7e3ac51c3a6d4fd3f976decc2eca78524 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
% dtas-tl(1) dtas user manual

=head1 NAME

dtas-tl - tracklist manipulation for dtas-player (development)

=head1 SYNOPSYS

dtas-tl [COMMANDS]

=head1 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).

=head1 COMMANDS

=over

=item aac - B<A>dd tracks B<A>fter B<C>urrent track in the tracklist

=item addhead - add tracks to the beginning of the tracklist

=item addtail - add tracks to the end of the tracklist

=item current - display the current track, "NONE" if not playing

=item current-id - display the TRACKID of the current track

"NONE" if not playing

=item cat - display a newline-delimited list of TRACK_ID=PATH output

=item clear - remove all tracks from the tracklist

=item edit - spawn an editor to allow editing the tracklist as a text file

See EDITING for more information.

=item 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.

=item 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.

=item next - play the next track in the tracklist

=item prev - play the previous track in the tracklist

=item repeat 1 - repeat the current track

=item repeat false - disable repeat

=item repeat true - enable repeat of the whole tracklist

=back

See L<dtas-player_protocol(7)> for a detailed description of the protocol.

=head1 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

=head1 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.

=head1 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

=head1 CONTACT

All feedback welcome via plain-text mail to: L<mailto:dtas-all@nongnu.org>

Mailing list archives available at L<http://80x24.org/dtas-all/>
and L<ftp://lists.gnu.org/dtas-all/>

No subscription is necessary to post to the mailing list.

=head1 COPYRIGHT

Copyright 2013-2016 all contributors L<mailto:dtas-all@nongnu.org>

License: GPL-3.0+ L<http://www.gnu.org/licenses/gpl-3.0.txt>

=head1 SEE ALSO

L<dtas-player(1)>, L<dtas-player_protocol(7)>, L<dtas-ctl(1)>