From b5bc0240f47dba01ff0a09263c210e5d391f88dc Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sat, 17 Jan 2015 11:30:51 +0000 Subject: dtas-sourceedit: update player as user saves in the editor This allows changes in the source YAML file to be reflected immediately in player after the user saves the file in their favorite $EDITOR. Previously, a user would need to: 1) start dtas-sourceedit, spawning $EDITOR 2) edit the file 3) save changes 4) exit $EDITOR 5) repeat starting from 1) until happy with the results Now, the workflow allows avoiding the context switch between their $EDITOR and terminal to restart dtas-sourcedit: 1) start dtas-sourceedit, spawning $EDITOR 2) edit the file 3) save changes 4) repeat starting from 1) until happy with the results 5) exit $EDITOR In my experience, this greatly speeds up tuning of the playback change, giving all the repeatability and flexibility of editing text files while having the immediacy of an interactive UI. Keep in mind this can cause problems for those with auto-save enabled in their $EDITOR buffer at inopportune times, so a -N/--no-watch option is added. --- Documentation/dtas-sourceedit.txt | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'Documentation') diff --git a/Documentation/dtas-sourceedit.txt b/Documentation/dtas-sourceedit.txt index 4335f14..cff3bbc 100644 --- a/Documentation/dtas-sourceedit.txt +++ b/Documentation/dtas-sourceedit.txt @@ -17,6 +17,22 @@ 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": -- cgit v1.2.3-24-ge0c7