about summary refs log tree commit homepage
path: root/Documentation
diff options
authorEric Wong <e@80x24.org>2015-04-13 05:32:03 +0000
committerEric Wong <e@80x24.org>2015-04-13 05:32:47 +0000
commit7720549ed14b93997f7566ce98c67975599a78ba (patch)
tree45ec2e69868c45649d2db1ed6772398327baa94e /Documentation
parent7681d9416cae1236e31cdada571ec163b3d02d9b (diff)
New features need to be documented.
Diffstat (limited to 'Documentation')
1 files changed, 16 insertions, 0 deletions
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
+-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
 To get a list of existing sink names