From 3083b7fbe2bc6e8dcd935b10bb7a165257c5252b Mon Sep 17 00:00:00 2001 From: Eric Wong 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.txt | 69 ----------------------------------------- 1 file changed, 69 deletions(-) delete mode 100644 Documentation/dtas-sinkedit.txt (limited to 'Documentation/dtas-sinkedit.txt') diff --git a/Documentation/dtas-sinkedit.txt b/Documentation/dtas-sinkedit.txt deleted file mode 100644 index 07f8ecb..0000000 --- a/Documentation/dtas-sinkedit.txt +++ /dev/null @@ -1,69 +0,0 @@ -% 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. - -On Linux machines with the sleepy_penguin RubyGem installed, 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. - -# OPTIONS --N, \--no-watch -: Disable inotify(7) support on Linux systems - --n, \--dry-run -: Only print commands which would be sent to dtas-player - --V, \--verbose -: Print out commands as they are sent to dtas-player - -# 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 - -# CONTACT - -All feedback welcome via plain-text mail to: \ -Mailing list archives available at and -\ -No subscription is necessary to post to the mailing list. - -# COPYRIGHT - -Copyright 2013-2016 all contributors .\ -License: GPL-3.0+ - -# SEE ALSO - -dtas-player(1), dtas-player_protocol(7), dtas-ctl(1) -- cgit v1.2.3-24-ge0c7