about summary refs log tree commit homepage
path: root/Documentation/dtas-sourceedit.txt
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2016-01-18 05:18:09 +0000
committerEric Wong <e@80x24.org>2016-01-18 07:02:39 +0000
commit3083b7fbe2bc6e8dcd935b10bb7a165257c5252b (patch)
treeaf5d87ea9a2ea161df619c2305ef951cb18d087a /Documentation/dtas-sourceedit.txt
parent0699498e5eb717a351c223e6a5a6a3bd3d3c6cde (diff)
downloaddtas-3083b7fbe2bc6e8dcd935b10bb7a165257c5252b.tar.gz
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.
Diffstat (limited to 'Documentation/dtas-sourceedit.txt')
-rw-r--r--Documentation/dtas-sourceedit.txt77
1 files changed, 0 insertions, 77 deletions
diff --git a/Documentation/dtas-sourceedit.txt b/Documentation/dtas-sourceedit.txt
deleted file mode 100644
index 8e87008..0000000
--- a/Documentation/dtas-sourceedit.txt
+++ /dev/null
@@ -1,77 +0,0 @@
-% dtas-sourceedit(1) dtas user manual
-%
-
-# NAME
-
-dtas-sourceedit - edit parameters of a source decoder
-
-# SYNOPSYS
-
-dtas-sourceedit {sox | av | ff}
-
-# DESCRIPTION
-
-dtas-sourceedit spawns an editor to allow editing of a source as a YAML file.
-See dtas-player_protocol(7) for details on SOURCEARGS.  If standard input is
-a pipe or file, it is parsed as YAML and fed to the dtas-player(1) instance
-non-interactively.  This is useful for loading various profiles from the
-filesystem.
-
-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
-
-Invoking dtas-sourceedit will spawn your favorite text editor on "sox":
-
-        $ dtas-sourceedit sox
-
-To load an existing YAML profile for sox.  saved.yml could be the output
-of a previous "dtas-ctl source cat sox" invocation:
-
-        $ dtas-sourceedit sox < saved.yml
-
-To change the way dtas-player calls avconv (part of libav):
-
-        $ dtas-sourceedit av
-
-To change the way dtas-player calls ffmpeg (lightly-tested):
-
-        $ dtas-sourceedit ff
-
-# 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: <dtas-all@nongnu.org>\
-Mailing list archives available at <http://80x24.org/dtas-all/> and
-<ftp://lists.gnu.org/dtas-all/>\
-No subscription is necessary to post to the mailing list.
-
-# COPYRIGHT
-
-Copyright 2013-2016 all contributors <dtas-all@nongnu.org>.\
-License: GPL-3.0+ <http://www.gnu.org/licenses/gpl-3.0.txt>
-
-# SEE ALSO
-
-dtas-player(1), dtas-player_protocol(7), dtas-ctl(1)