From 97b851b0dad8f6a3c3352bdff8f4a3aac539d354 Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
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-sinkedit.1.txt | 41 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 Documentation/dtas-sinkedit.1.txt

(limited to 'Documentation/dtas-sinkedit.1.txt')

diff --git a/Documentation/dtas-sinkedit.1.txt b/Documentation/dtas-sinkedit.1.txt
new file mode 100644
index 0000000..892320a
--- /dev/null
+++ b/Documentation/dtas-sinkedit.1.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)
-- 
cgit v1.2.3-24-ge0c7