summaryrefslogtreecommitdiffstats
path: root/ext/nas/README
diff options
context:
space:
mode:
Diffstat (limited to 'ext/nas/README')
-rw-r--r--ext/nas/README8
1 files changed, 8 insertions, 0 deletions
diff --git a/ext/nas/README b/ext/nas/README
new file mode 100644
index 00000000..34b563c6
--- /dev/null
+++ b/ext/nas/README
@@ -0,0 +1,8 @@
+The nassink plugin
+==================
+
+The nassink plugin is for outputting an audio stream to a Network Audio Server (NCD X/Terminal)
+
+nassink has arguments that it accepts:
+ - 'mute' (boolean value)
+ - 'host' (name of X/Terminal, default is $AUDIOSERVER or $DISPLAY)