From 3083b7fbe2bc6e8dcd935b10bb7a165257c5252b Mon Sep 17 00:00:00 2001
From: Eric Wong <e@80x24.org>
Date: Mon, 18 Jan 2016 05:18:09 +0000
Subject: doc: convert to perlpod(1) from Markdown

perlpod(1) is already installed by default on Debian and
RedHat-based systems; and probably most modern *nixes; pandoc(1)
(and Haskell) are not.

POD also more standardized than Markdown (which flavor? :P),
especially for generating manpages.  So save any potential
documentation editors some disk space by not forcing them to install
Haskell and pandoc.

Finally, I'm a mildly proficient in Perl and do not know Haskell
at all and have a better chance at reading/hacking the source if
the document generator breaks.
---
 Documentation/dtas-sinkedit.pod | 79 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 Documentation/dtas-sinkedit.pod

(limited to 'Documentation/dtas-sinkedit.pod')

diff --git a/Documentation/dtas-sinkedit.pod b/Documentation/dtas-sinkedit.pod
new file mode 100644
index 0000000..98dee27
--- /dev/null
+++ b/Documentation/dtas-sinkedit.pod
@@ -0,0 +1,79 @@
+% dtas-sinkedit(1) dtas user manual
+
+=head1 NAME
+
+dtas-sinkedit - edit the command and environment of a sink
+
+=head1 SYNOPSYS
+
+dtas-sinkedit SINKNAME
+
+=head1 DESCRIPTION
+
+dtas-sinkedit spawns an editor to allow editing of a sink as a YAML file.
+See L<dtas-player_protocol(7)> for details on SINKARGS.
+
+On Linux machines with the sleepy_penguin RubyGem installed, L<inotify(7)>
+is used to monitor the file for changes while the text exitor is running.
+Each time a user finishes saving a file, changes are committed immediately.
+This behavior may be disabled by using the -N or --no-watch command-line
+switch.
+
+=head1 OPTIONS
+
+=over
+
+=item -N, --no-watch
+
+Disable L<inotify(7)> support on Linux systems
+
+=item -n, --dry-run
+
+Only print commands which would be sent to dtas-player
+
+=item -V, --verbose
+
+Print out commands as they are sent to dtas-player
+
+=back
+
+=head1 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.
+
+=head1 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
+
+=head1 CONTACT
+
+All feedback welcome via plain-text mail to: L<mailto:dtas-all@nongnu.org>
+
+Mailing list archives available at L<http://80x24.org/dtas-all/>
+and L<ftp://lists.gnu.org/dtas-all/>
+
+No subscription is necessary to post to the mailing list.
+
+=head1 COPYRIGHT
+
+Copyright 2013-2016 all contributors L<mailto:dtas-all@nongnu.org>
+
+License: GPL-3.0+ L<http://www.gnu.org/licenses/gpl-3.0.txt>
+
+=head1 SEE ALSO
+
+L<dtas-player(1)>, L<dtas-player_protocol(7)>, L<dtas-ctl(1)>
-- 
cgit v1.2.3-24-ge0c7