about summary refs log tree commit homepage
path: root/Documentation
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2013-08-27 20:03:24 +0000
committerEric Wong <normalperson@yhbt.net>2013-08-27 20:03:24 +0000
commitddcd67c03e17dfcd0e584b5a3a2bfc56da0cac12 (patch)
treef81e9dcaf3c76d84a16308d7339f460d3f50813c /Documentation
parent0d3fe1c828c861a28dbd97501a6518c6fd76e277 (diff)
downloaddtas-ddcd67c03e17dfcd0e584b5a3a2bfc56da0cac12.tar.gz
This should hopefully make it easier to introduce users to
sink usage.
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/GNUmakefile5
-rw-r--r--Documentation/dtas-player_sink_examples.txt20
2 files changed, 24 insertions, 1 deletions
diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile
index 94c81d5..1b83c4a 100644
--- a/Documentation/GNUmakefile
+++ b/Documentation/GNUmakefile
@@ -13,9 +13,12 @@ ones += dtas-player
 ones += dtas-xdelay
 ones += dtas-sinkedit
 ones += dtas-sourceedit
+sevens =
+sevens += dtas-player_protocol
+sevens += dtas-player_sink_examples
 
 man1 := $(addsuffix .1, $(ones))
-man7 := $(addsuffix .7,dtas-player_protocol)
+man7 := $(addsuffix .7, $(sevens))
 
 all:: man
 
diff --git a/Documentation/dtas-player_sink_examples.txt b/Documentation/dtas-player_sink_examples.txt
new file mode 100644
index 0000000..30f6846
--- /dev/null
+++ b/Documentation/dtas-player_sink_examples.txt
@@ -0,0 +1,20 @@
+% dtas-player_sink_examples(7) dtas user manual
+
+# NAME
+
+dtas-player_sink_examples - sink examples for dtas-player
+
+# SYNOPSIS
+
+dtas-ctl sink ed SINKNAME command='...'
+dtas-sinkedit SINKNAME
+
+# EXAMPLES
+
+Warning: the following example will likely expose your Icecast source
+password to any local users on the system.
+
+    # set HOST/PORT/PASS via env or directly in the command
+    ---
+    name: oggfwd
+    command: sox $SOXFMT - -t ogg - | oggfwd $HOST $PORT $PASS /dtas.ogg