about summary refs log tree commit homepage
path: root/Documentation/dtas-msinkctl.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-msinkctl.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-msinkctl.txt')
-rw-r--r--Documentation/dtas-msinkctl.txt45
1 files changed, 45 insertions, 0 deletions
diff --git a/Documentation/dtas-msinkctl.txt b/Documentation/dtas-msinkctl.txt
new file mode 100644
index 0000000..d6acb4c
--- /dev/null
+++ b/Documentation/dtas-msinkctl.txt
@@ -0,0 +1,45 @@
+% dtas-msinkctl(1) dtas user manual
+
+# NAME
+
+dtas-msinkctl - activate/deactivate multiple sinks at once
+
+# SYNOPSYS
+
+dtas-msinkctl COMMAND
+dtas-msinkctl COMMAND [SINKS...]
+
+# DESCRIPTION
+
+dtas-msinkctl is useful for activating/deactivating multiple sinks.
+
+# EXAMPLES
+
+Display only active sinks (unlike "dtas-ctl sink ls", which shows all sinks)
+
+    dtas-msinkctl active
+
+Display only non-blocking sinks
+
+    dtas-msinkctl nonblock
+
+Enable only SINK1 and SINK3, and close other sinks
+
+    dtas-msinkctl active-set SINK1 SINK3
+
+Add the default sink to the active set
+
+    dtas-msinkctl active-add default
+
+Remove SINK3 from the active set
+
+    dtas-msinkctl active-add SINK3
+
+# 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)