From 3083b7fbe2bc6e8dcd935b10bb7a165257c5252b Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 18 Jan 2016 05:18:09 +0000 Subject: doc: convert to perlpod(1) from Markdown perlpod(1) is already installed by default on Debian and RedHat-based systems; and probably most modern *nixes; pandoc(1) (and Haskell) are not. POD also more standardized than Markdown (which flavor? :P), especially for generating manpages. So save any potential documentation editors some disk space by not forcing them to install Haskell and pandoc. Finally, I'm a mildly proficient in Perl and do not know Haskell at all and have a better chance at reading/hacking the source if the document generator breaks. --- Documentation/dtas-player_sink_examples.txt | 83 ----------------------------- 1 file changed, 83 deletions(-) delete mode 100644 Documentation/dtas-player_sink_examples.txt (limited to 'Documentation/dtas-player_sink_examples.txt') diff --git a/Documentation/dtas-player_sink_examples.txt b/Documentation/dtas-player_sink_examples.txt deleted file mode 100644 index 80d33c4..0000000 --- a/Documentation/dtas-player_sink_examples.txt +++ /dev/null @@ -1,83 +0,0 @@ -% 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 - -## Streaming Ogg-Vorbis to Icecast - -To use oggfwd(1) and Icecast, the following sink works. -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 - -## Stream to a remote host via ssh - -Alternatively, if you have play(1) installed on any remote host and -a slow connection using Ogg-Vorbis: - - # Long lines in YAML can be broken up and the subsequent lines - # indented with by spaces - --- - name: ssh-remote - command: sox $SOXFMT - -t ogg - | - ssh $HOST env AUDIODEV=... play -q -t ogg - - - # Note the use of env(1), as the "env" parameter for the sink may not be - # passed via ssh to the remote $HOST depending on the ssh_config(5) - # configuration. - -If you have a fast connection, there is no need to encode using -Ogg-Vorbis. Alternatively, you may also use "flac" instead of "ogg" in -the above Ogg-Vorbis example. - - --- - name: ssh-remote - command: ssh $HOST env AUDIODEV=... play -q $SOXFMT - - -## Dump audio to a file during playback - -To configure a dumper sink (in addition to the "default" sink). Note -the use of $SOXFMT, this will be automatically expanded to match the -internal format of the player. The internal format of the player is -described in dtas-player_protocol(7). - - $ dtas-ctl sink ed dumper command='sox $SOXFMT - /tmp/dump.sox' - -Non-"default" sinks are not active by default, but may be made active. - - $ dtas-ctl sink ed dumper active=true - -Changing it again to "active=false" will deactivate the sink. - -## Apply a short delay to low frequencies to improve time-alignment - -See dtas-xdelay(1). - -# CONTACT - -All feedback welcome via plain-text mail to: \ -Mailing list archives available at and -\ -No subscription is necessary to post to the mailing list. - -# COPYRIGHT - -Copyright 2013-2016 all contributors .\ -License: GPL-3.0+ - -# SEE ALSO - -dtas-ctl(1), dtas-sinkedit(1), dtas-xdelay(1), -sox(1), play(1), oggfwd(1), ssh(1), ssh_config(5), env(1) -- cgit v1.2.3-24-ge0c7