about summary refs log tree commit homepage
path: root/Documentation/dtas-sinkedit.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-sinkedit.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-sinkedit.txt')
-rw-r--r--Documentation/dtas-sinkedit.txt41
1 files changed, 41 insertions, 0 deletions
diff --git a/Documentation/dtas-sinkedit.txt b/Documentation/dtas-sinkedit.txt
new file mode 100644
index 0000000..892320a
--- /dev/null
+++ b/Documentation/dtas-sinkedit.txt
@@ -0,0 +1,41 @@
+% dtas-sinkedit(1) dtas user manual
+%
+
+# NAME
+
+dtas-sinkedit - edit the command and environment of a sink
+
+# SYNOPSYS
+
+dtas-sinkedit SINKNAME
+
+# DESCRIPTION
+
+dtas-sinkedit spawns an editor to allow editing of a sink as a YAML file.
+See dtas-player_protocol(7) for details on SINKARGS.
+
+# EXAMPLES
+
+To get a list of existing sink names
+
+        $ dtas-ctl ls
+
+Invoking dtas-sinkedit will spawn your favorite text editor on a
+given SINKNAME:
+
+        $ dtas-sinkedit SINKNAME
+
+If SINKNAME was not listed, it will be created (in an inactive state).
+Successfully exiting your text editor will send the changes to the
+running dtas-player.
+
+# ENVIRONMENT
+
+VISUAL / EDITOR - your favorite *nix text editor, defaults to 'vi' if unset.
+
+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)