about summary refs log tree commit homepage
path: root/Documentation/dtas-console.txt
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2013-08-25 00:47:13 +0000
committerEric Wong <normalperson@yhbt.net>2013-08-25 00:47:13 +0000
commitf468d58468b224ea3fb468c9543d8631164f8c55 (patch)
tree8870411e6e8a9aebca82d3175ba71cb808c013f8 /Documentation/dtas-console.txt
parentfbe1dbf48bc0573935e410013da86bda03426af4 (diff)
downloaddtas-f468d58468b224ea3fb468c9543d8631164f8c55.tar.gz
We should be compatible with "gem-man", as well as allowing
installation to prefix ($HOME by default) via:

	make -C Documentation install-man
Diffstat (limited to 'Documentation/dtas-console.txt')
-rw-r--r--Documentation/dtas-console.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/Documentation/dtas-console.txt b/Documentation/dtas-console.txt
new file mode 100644
index 0000000..e41ee87
--- /dev/null
+++ b/Documentation/dtas-console.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)