]> git.tuebingen.mpg.de Git - paraslash.git/blobdiff - web/manual.md
play.c: Replace NULL check by assertion.
[paraslash.git] / web / manual.md
index b20168c017cbef3cba9573d446ebdb7bfd7480eb..0db1e22c26fdee83b3df4aaf60bad0537e40a0f1 100644 (file)
@@ -287,9 +287,9 @@ Requirements
 ------------
 <h3> For the impatient </h3>
 
-       git clone git://git.tuebingen.mpg.de/lopsub
+       git clone https://git.tuebingen.mpg.de/lopsub
        cd lopsub && make && sudo make install
-       git clone git://git.tuebingen.mpg.de/osl
+       git clone https://git.tuebingen.mpg.de/osl
        cd osl && make && sudo make install && sudo ldconfig
        sudo apt-get install autoconf libssl-dev m4 \
               libmad0-dev libid3tag0-dev libasound2-dev libvorbis-dev \
@@ -306,7 +306,7 @@ option parser for subcommands generates the command line and config
 file parsers for all paraslash executables. Clone the source code
 repository with
 
-               git clone git://git.tuebingen.mpg.de/lopsub
+               git clone https://git.tuebingen.mpg.de/lopsub
 
 - [gcc](ftp://ftp.gnu.org/pub/gnu/gcc) or
 [clang](http://clang.llvm.org). All gcc versions >= 5.4 are currently
@@ -324,11 +324,11 @@ from templates by the m4 macro processor.
 
 Optional:
 
-- [libosl](http://people.tuebingen.mpg.de/maan/osl/). The _object
+- [libosl](https://people.tuebingen.mpg.de/maan/osl/). The _object
 storage layer_ library is used by para_server. To clone the source
 code repository, execute
 
-               git clone git://git.tuebingen.mpg.de/osl
+               git clone https://git.tuebingen.mpg.de/osl
 
 - [openssl](https://www.openssl.org/) or
 [libgcrypt](ftp://ftp.gnupg.org/gcrypt/libgcrypt/).  At least one
@@ -339,7 +339,7 @@ to install the development package (`libssl-dev` or `libgcrypt-dev`
 on debian systems) as well.
 
 - [flex](https://github.com/westes/flex) and
-[bison](https://www.gnu.org/software/bison) are needed to build the
+[bison](https://www.gnu.org/software/bison/) are needed to build the
 mood parser of para_server. The build system will skip para_server
 if these tools are not installed.
 
@@ -385,7 +385,7 @@ the ao writer (ESD, PulseAudio,...).  Debian package: `libao-dev`.
 para_gui. Debian package: `libncurses-dev`.
 
 - [GNU
-Readline](http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html). If
+Readline](https://www.gnu.org/software/readline/). If
 this library (`libreadline-dev`) is installed, para_client, para_audioc
 and para_play support interactive sessions.
 
@@ -714,7 +714,7 @@ tables. The section on [playlists and moods](#Playlists-and-moods)
 explains these two audio file selection mechanisms in detail
 and contains practical examples. The way [file renames and content
 changes](#File-renames-and-content-changes) are detected is discussed
-briefly before the [Troubleshooting](#Troubleshooting) section
+briefly before the [Troubleshooting](#Common-problems) section
 concludes the chapter.
 
 The AFS process
@@ -774,7 +774,7 @@ entry with metadata obtained from the audio format handler is added
 to the database.
 
 Note that AFS employs
-[libosl](http://people.tuebingen.mpg.de/maan/osl/), the object
+[libosl](https://people.tuebingen.mpg.de/maan/osl/), the object
 storage layer library, as the database backend. This library offers
 functionality similar to a relational database, but is much more
 lightweight than a full featured database management system.
@@ -1166,7 +1166,7 @@ data remains as before.
 It is possible to change the behaviour of the add command by using the
 "-l" (lazy add) or the "-f" (force add) option.
 
-Troubleshooting
+Common problems
 ---------------
 
 Use the debug loglevel (-l debug) to show debugging info. All paraslash
@@ -1884,8 +1884,8 @@ shown by this theme. See gui_theme.c for examples.
 
 The "." and "," keys are used to switch between themes.
 
-Examples
---------
+Gui examples
+------------
 
 -> Show server info:
 
@@ -1953,7 +1953,7 @@ from tar balls) and for contributing non-trivial changes to the
 paraslash project, some additional tools should be installed on a
 developer machine.
 
-- [git](http://git.or.cz/). As described in more detail
+- [git](https://git-scm.com/). As described in more detail
 [below](#Git-branches), the git source code management tool is used for
 paraslash development. It is necessary for cloning the git repository
 and for getting updates.
@@ -1967,7 +1967,7 @@ 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.
 
-- [doxygen](http://www.stack.nl/~dimitri/doxygen/). The documentation
+- [doxygen](https://www.doxygen.nl/). The documentation
 of paraslash's C sources uses the doxygen documentation system. The
 conventions for documenting the source code is described in the
 [Doxygen section](#Doxygen).
@@ -2294,53 +2294,42 @@ and contributed significant improvements.
 References
 ==========
 
-Articles
---------
-- [Polynomial Codes over Certain Finite
-Fields](http://kom.aau.dk/~heb/kurser/NOTER/KOFA01.PDF) by Reed, Irving
-S.; Solomon, Gustave (1960), Journal of the Society for Industrial
-and Applied Mathematics (SIAM) 8 (2): 300-304, doi:10.1137/0108018)
-
 RFCs
 ----
 
-- [RFC 768](http://www.ietf.org/rfc/rfc768.txt) (1980): User Datagram
+- [RFC 768](https://www.ietf.org/rfc/rfc768.txt) (1980): User Datagram
 Protocol
 
-- [RFC 791](http://www.ietf.org/rfc/rfc791.txt) (1981): Internet
+- [RFC 791](https://www.ietf.org/rfc/rfc791.txt) (1981): Internet
 Protocol
 
-- [RFC 2437](http://www.ietf.org/rfc/rfc2437.txt) (1998): RSA
+- [RFC 2437](https://www.ietf.org/rfc/rfc2437.txt) (1998): RSA
 Cryptography Specifications
 
-- [RFC 4340](http://www.ietf.org/rfc/rfc4340.txt) (2006): Datagram
+- [RFC 4340](https://www.ietf.org/rfc/rfc4340.txt) (2006): Datagram
 Congestion Control Protocol (DCCP)
 
-- [RFC 4341](http://www.ietf.org/rfc/rfc4341.txt) (2006): Congestion
+- [RFC 4341](https://www.ietf.org/rfc/rfc4341.txt) (2006): Congestion
 Control ID 2: TCP-like Congestion Control
 
-- [RFC 4342](http://www.ietf.org/rfc/rfc4342.txt) (2006): Congestion
+- [RFC 4342](https://www.ietf.org/rfc/rfc4342.txt) (2006): Congestion
 Control ID 3: TCP-Friendly Rate Control (TFRC)
 
-- [RFC 6716](http://www.ietf.org/rfc/rfc6716.txt) (2012): Definition
+- [RFC 6716](https://www.ietf.org/rfc/rfc6716.txt) (2012): Definition
 of the Opus Audio Codec
 
 Application web pages
 ---------------------
 
-- [paraslash](http://people.tuebingen.mpg.de/maan/paraslash/)
+- [paraslash](https://people.tuebingen.mpg.de/maan/paraslash/)
 - [mpg123](http://www.mpg123.de/)
 - [gstreamer](https://gstreamer.freedesktop.org/)
-- [icecast](http://www.icecast.org/)
-- [Audio Compress](https://beesbuzz.biz/code/audiocompress.php)
+- [icecast](https://www.icecast.org/)
+- [Audio Compress](https://github.com/fluffy-critter/audiocompress)
 
 External documentation
 ----------------------
 
-- [The mathematics of
-Raid6](https://www.kernel.org/pub/linux/kernel/people/hpa/raid6.pdf)
-by H. Peter Anvin
-
 - [Effective Erasure Codes for reliable Computer Communication
 Protocols](http://info.iet.unipi.it/~luigi/fec_ccr.ps.gz) by Luigi
 Rizzo