everything related to duct tape audio suite (dtas)
 help / color / mirror / code / Atom feed
From: Eric Wong <e@80x24.org>
To: <dtas-all@nongnu.org>
Subject: [PATCH] doc: update for dtas-sinkedit inotify support
Date: Mon, 13 Apr 2015 06:17:35 +0000	[thread overview]
Message-ID: <1428905855-5539-1-git-send-email-e@80x24.org> (raw)

New features need to be documented.
---
 Documentation/dtas-sinkedit.txt | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

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
-- 
EW



                 reply	other threads:[~2015-04-13  6:17 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://80x24.org/dtas/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1428905855-5539-1-git-send-email-e@80x24.org \
    --to=e@80x24.org \
    --cc=dtas-all@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/dtas.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).