about summary refs log tree commit homepage
path: root/Documentation/dtas-msinkctl.1.txt
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2013-08-24 23:58:08 +0000
committerEric Wong <normalperson@yhbt.net>2013-08-24 23:58:08 +0000
commit97b851b0dad8f6a3c3352bdff8f4a3aac539d354 (patch)
tree4a324e416932f51012a283cfeb4b208d2b6fd8ec /Documentation/dtas-msinkctl.1.txt
parent09178fca7320ed4919b7c5e845598f9ad998d6d3 (diff)
downloaddtas-97b851b0dad8f6a3c3352bdff8f4a3aac539d354.tar.gz
We should probably document this before we forget it.
Diffstat (limited to 'Documentation/dtas-msinkctl.1.txt')
-rw-r--r--Documentation/dtas-msinkctl.1.txt45
1 files changed, 45 insertions, 0 deletions
diff --git a/Documentation/dtas-msinkctl.1.txt b/Documentation/dtas-msinkctl.1.txt
new file mode 100644
index 0000000..d6acb4c
--- /dev/null
+++ b/Documentation/dtas-msinkctl.1.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)