From 97b851b0dad8f6a3c3352bdff8f4a3aac539d354 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sat, 24 Aug 2013 23:58:08 +0000 Subject: documentation: initial manpages for all commands We should probably document this before we forget it. --- Documentation/dtas-console.1.txt | 42 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 Documentation/dtas-console.1.txt (limited to 'Documentation/dtas-console.1.txt') diff --git a/Documentation/dtas-console.1.txt b/Documentation/dtas-console.1.txt new file mode 100644 index 0000000..e41ee87 --- /dev/null +++ b/Documentation/dtas-console.1.txt @@ -0,0 +1,42 @@ +% dtas-console(1) dtas user manual + +# NAME + +dtas-console - rudimentary curses console client for dtas-player + +# SYNOPSIS + +dtas-console + +# DESCRIPTION + +dtas-console displays the elapsed decoder time of the track, which can be +used as an approximation of the current playback time of a track. + +It cannot display an accurate playback time due to variable buffering +in the sinks and pipes. + +See dtas-player_protocol(7) for a detailed description of the protocol. + +# KEYBOARD CONTROL + +Key bindings are inspired partially by mplayer(1) + +- 'j'/'k' - seek backward/forward 5 seconds +- LEFT/RIGHT - seek backward/forward 10 seconds +- UP/DOWN - seek forward/backward 1 minute +- PGUP/PGDWN - seek forward/backward 10 minutes +- SPACE - toggle play/pause state of the playback +- 'p'/'P' - decrease/increase timer resolution +- BACKSPACE - seek to the beginning of the track +- Ctrl-C - exit dtas-console + +# ENVIRONMENT + +DTAS_PLAYER_SOCK - the path to the dtas-player control socket. +This defaults to ~/.dtas/player.sock + +# SEE ALSO + +dtas-player(1), dtas-player_protocol(7), dtas-ctl(1), dtas-sinkedit(1), +dtas-sourceedit(1) -- cgit v1.2.3-24-ge0c7