From 7720549ed14b93997f7566ce98c67975599a78ba Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 13 Apr 2015 05:32:03 +0000 Subject: doc: update for dtas-sinkedit inotify support New features need to be documented. --- Documentation/dtas-sinkedit.txt | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'Documentation') diff --git a/Documentation/dtas-sinkedit.txt b/Documentation/dtas-sinkedit.txt index d6653fb..7a4f30f 100644 --- a/Documentation/dtas-sinkedit.txt +++ b/Documentation/dtas-sinkedit.txt @@ -14,6 +14,22 @@ dtas-sinkedit SINKNAME 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 -- cgit v1.2.3-24-ge0c7