X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=web%2Fmanual.md;h=44799e910fc8c041667599fcff8669a1a89608c1;hb=267c322e02364c331f523ce16bdadb46fd3449f8;hp=904ac18077691aacc3444b9bdd6e477609b4a840;hpb=3d3a2f50a05501cf27f1155629799953f952bd4b;p=paraslash.git diff --git a/web/manual.md b/web/manual.md index 904ac180..44799e91 100644 --- a/web/manual.md +++ b/web/manual.md @@ -230,9 +230,9 @@ compatible with arbitrary HTTP streaming sources (e.g. icecast). In addition to the three network streaming modes, para_recv can also operate in local (afh) mode. In this mode it writes the content of an audio file on the local file system in complete chunks to stdout, -optionally 'just in time'. This allows to cut an audio file without -first decoding it, and it enables third-party software which is unaware -of the particular audio format to send complete frames in real time. +optionally 'just in time'. This allows cutting audio files without +decoding, and it enables third-party software which is unaware of +the particular audio format to send complete frames in real time.

para_filter

@@ -330,7 +330,7 @@ code repository, execute git clone git://git.tuebingen.mpg.de/osl -- [openssl](http://www.openssl.org/) or +- [openssl](https://www.openssl.org/) or [libgcrypt](ftp://ftp.gnupg.org/gcrypt/libgcrypt/). At least one of these two libraries is needed as the backend for cryptographic routines on both the server and the client side. Both openssl and @@ -349,12 +349,12 @@ is called `libmad0-dev` on debian-based systems. Note that libmad is not necessary on the server side, i.e., for sending MP3 files. - [libid3tag](http://www.underbit.com/products/mad/). For version-2 -ID3 tag support, you willl need the libid3tag development package +ID3 tag support, you will need the libid3tag development package `libid3tag0-dev`. Without libid3tag, only version-1 tags are recognized. The mp3 tagger also needs this library for modifying (id3v1 and id3v2) tags. -- [ogg vorbis](http://www.xiph.org/downloads/). For ogg vorbis streams +- [ogg vorbis](https://www.xiph.org/downloads/). For ogg vorbis streams you need libogg, libvorbis, libvorbisfile. The corresponding Debian packages are called `libogg-dev` and `libvorbis-dev`. @@ -364,10 +364,10 @@ that for some distributions, e.g. Ubuntu, mp4ff is not part of the libfaad package. Install the faad library from sources (available through the above link) to get the mp4ff library and header files. -- [speex](http://www.speex.org/). In order to stream or decode speex +- [speex](https://www.speex.org/). In order to stream or decode speex files, libspeex (`libspeex-dev`) is required. -- [flac](http://flac.sourceforge.net/). To stream or decode files +- [flac](https://xiph.org/flac/). To stream or decode files encoded with the _Free Lossless Audio Codec_, libFLAC (`libFLAC-dev`) must be installed. @@ -378,7 +378,7 @@ installed. Debian package: `libsamplerate-dev`. - [alsa-lib](ftp://ftp.alsa-project.org/pub/lib/). On Linux, you will need to have the ALSA development package `libasound2-dev` installed. -- [libao](http://downloads.xiph.org/releases/ao/). Needed to build +- [libao](https://ftp.osuosl.org/pub/xiph/releases/ao/). Needed to build the ao writer (ESD, PulseAudio,...). Debian package: `libao-dev`. - [curses](ftp://ftp.gnu.org/pub/gnu/ncurses). Needed for @@ -446,7 +446,7 @@ following commands: Next, change to the "bar" account on client_host and generate the key pair with the commands - ssh-keygen -q -t rsa -b 2048 -N '' -f $key + ssh-keygen -q -t rsa -b 2048 -N '' -m RFC4716 This generates the two files id_rsa and id_rsa.pub in ~/.ssh. Note that para_server won't accept keys shorter than 2048 bits. Moreover, @@ -1439,7 +1439,7 @@ only for Linux. - UDP. Recommended for multicast LAN streaming. -See the Appendix on [network protocols](/#Network.protocols) +See the Appendix on [network protocols](#Network.protocols) for brief descriptions of the various protocols relevant for network audio streaming with paraslash. @@ -1541,27 +1541,6 @@ currently running server process. para_client si -The sender command of para_server prints information about senders, -like the various access control lists, and it allows to (de-)activate -senders and to change the access permissions at runtime. - --> List all senders - - para_client sender - --> Obtain general help for the sender command: - - para_client help sender - --> Get help for a specific sender (contains further examples): - - s=http # or dccp or udp - para_client sender $s help - --> Show status of the http sender - - para_client sender http status - By default para_server activates both the HTTP and th DCCP sender on startup. This can be changed via command line options or para_server's config file. @@ -1570,13 +1549,6 @@ config file. para_server -h -All senders share the "on" and "off" commands, so senders may be -activated and deactivated independently of each other. - --> Switch off the http sender: - - para_client sender http off - -> Receive a DCCP stream using CCID2 and write the output into a file: host=foo.org; ccid=2; filename=bar @@ -1587,20 +1559,11 @@ receiver has its own set of command line options and its own command line parser, so arguments for the dccp receiver must be protected from being interpreted by para_recv. --> Start UDP multicast, using the default multicast address: - - para_client sender udp add 224.0.1.38 - -> Receive FEC-encoded multicast stream and write the output into a file: filename=foo para_recv -r udp > $filename --> Add an UDP unicast for a client to the target list of the UDP sender: - - t=client.foo.org - para_client sender udp add $t - -> Receive this (FEC-encoded) unicast stream: filename=foo @@ -1778,7 +1741,7 @@ These filters are rather simple and do not modify the audio stream at all. The wav filter is only useful with para_filter and in connection with a decoder. It asks the decoder for the number of channels and the sample rate of the stream and adds a Microsoft wave header containing -this information at the beginning. This allows to write wav files +this information at the beginning. This allows writing wav files rather than raw PCM files (which do not contain any information about the number of channels and the sample rate). @@ -1792,17 +1755,6 @@ Both filters require almost no additional computing time, even when operating on uncompressed audio streams, since data buffers are simply "pushed down" rather than copied. -Examples --------- - --> Decode an mp3 file to wav format: - - para_filter -f mp3dec -f wav < file.mp3 > file.wav - --> Amplify a raw audio file by a factor of 1.5: - - para_filter -f amp --amp 32 < foo.raw > bar.raw - ====== Output ====== @@ -1852,8 +1804,8 @@ emulation for backwards compatibility. This API is rather simple but also limited. For example only one application can open the device at any time. The OSS writer is activated by default on BSD Systems. -- *FILE*. The file writer allows to capture the audio stream and -write the PCM data to a file on the file system rather than playing +- *FILE*. The file writer allows capturing the audio stream and +writing the PCM data to a file on the file system rather than playing it through a sound device. It is supported on all platforms and is always compiled in. @@ -2007,7 +1959,7 @@ and for getting updates. the configure file which is shipped in the tarballs but has to be generated when compiling from git. -- [discount](http://www.pell.portland.or.us/~orc/Code/discount). The +- [discount](http://www.pell.portland.or.us/~orc/Code/discount/). The HTML version of this manual and some of the paraslash web pages are written in the Markdown markup language and are translated into html with the converter of the *Discount* package. @@ -2111,7 +2063,7 @@ Coding Style The preferred coding style for paraslash coincides more or less with the style of the Linux kernel. So rather than repeating what is -written [there](http://www.kernel.org/doc/Documentation/process/coding-style.rst), +written [there](https://www.kernel.org/doc/Documentation/process/coding-style.rst), here are the most important points. - Burn the GNU coding standards. @@ -2374,17 +2326,17 @@ Application web pages --------------------- - [paraslash](http://people.tuebingen.mpg.de/maan/paraslash/) -- [xmms](http://xmms2.org/wiki/Main_Page) +- [xmms](https://xmms2.org/wiki/Main_Page) - [mpg123](http://www.mpg123.de/) -- [gstreamer](http://gstreamer.freedesktop.org/) +- [gstreamer](https://gstreamer.freedesktop.org/) - [icecast](http://www.icecast.org/) -- [Audio Compress](http://beesbuzz.biz/code/audiocompress.php) +- [Audio Compress](https://beesbuzz.biz/code/audiocompress.php) External documentation ---------------------- - [The mathematics of -Raid6](http://kernel.org/pub/linux/kernel/people/hpa/raid6.pdf) +Raid6](https://www.kernel.org/pub/linux/kernel/people/hpa/raid6.pdf) by H. Peter Anvin - [Effective Erasure Codes for reliable Computer Communication