diff options
Diffstat (limited to 'Documentation/dtas-ctl.pod')
-rw-r--r-- | Documentation/dtas-ctl.pod | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/Documentation/dtas-ctl.pod b/Documentation/dtas-ctl.pod new file mode 100644 index 0000000..771f6b2 --- /dev/null +++ b/Documentation/dtas-ctl.pod @@ -0,0 +1,78 @@ +% dtas-ctl(1) dtas user manual + +=head1 NAME + +dtas-ctl - low-level client for dtas-player + +=head1 SYNOPSYS + +dtas-ctl [ARGS...] + +=head1 DESCRIPTION + +dtas-ctl passes command-line arguments as-is to dtas-player. It is mainly +useful for simple commands such as ("current", "play_pause", "pause", "play", +"rg RGARGS", "seek HH:MM:SS", "skip"). + +See L<dtas-player_protocol(7)> for a detailed description of the protocol. + +=head1 EXAMPLES + +display the currently playing track + + $ dtas-ctl current + +enqueue a file for playback (L<dtas-enq(1)> is easier to use, here) + + $ dtas-ctl enq /absolute/path/to/file + +toggle the play/pause state of the player + + $ dtas-ctl play_pause + +change the ReplayGain mode + + $ dtas-ctl rg mode=album_gain + # "track_gain", "off" may be used, too + +seek 5 seconds forward + + $ dtas-ctl seek +5 + +seek to an absolute position + + $ dtas-ctl seek 1:00 + +skip to the next track + + $ dtas-ctl skip + +To play the output of an arbitrary command (note the quotes) and usage +of $SOXFMT (see L<dtas-player_protocol(7)>). + + $ dtas-ctl enq-cmd 'sox -n $SOXFMT - synth 3 pluck' + +=head1 ENVIRONMENT + +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-enq(1)>, +L<dtas-sinkedit(1)>, L<dtas-sourceedit(1)> |