X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=web%2Fmanual.m4;h=84f399d26aacea78e22431f09491d11189fce969;hp=55bb49a653bdfc10c5a84eaeb8c058080b2aa345;hb=4e1c5848328ee28822b75ef7ae8c66b63c832409;hpb=282a5e463090205ef8a12f50a9ecf6498b860e88 diff --git a/web/manual.m4 b/web/manual.m4 index 55bb49a6..84f399d2 100644 --- a/web/manual.m4 +++ b/web/manual.m4 @@ -232,14 +232,6 @@ Detailed description: In any case you'll need scripts which run during compilation require the EMPH(Bourne again shell). It is most likely already installed. - - XREFERENCE(http://www.openssl.org/, openssl) or - XREFERENCE(ftp://ftp.gnupg.org/gcrypt/libgcrypt/, 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 libgcrypt are usually shipped with the - distro, but you might have to install the development package - (libssl-dev or libgcrypt-dev on debian systems) as well. - - XREFERENCE(ftp://ftp.gnu.org/pub/gnu/gengetopt/, gengetopt) is needed to generate the C code for the command line parsers of all paraslash executables. @@ -249,6 +241,14 @@ Detailed description: In any case you'll need Optional: + - XREFERENCE(http://www.openssl.org/, openssl) or + XREFERENCE(ftp://ftp.gnupg.org/gcrypt/libgcrypt/, 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 libgcrypt are usually shipped with the + distro, but you might have to install the development package + (libssl-dev or libgcrypt-dev on debian systems) as well. + - XREFERENCE(http://www.underbit.com/products/mad/, libmad). To compile in MP3 support for paraslash, the development package must be installed. It is called libmad0-dev on @@ -1071,17 +1071,18 @@ It is possible to change the behaviour of the add command by using the Troubleshooting ~~~~~~~~~~~~~~~ -Use the debug loglevel (option -l debug for most commands) to show -debugging info. Almost all paraslash executables have a brief online -help which is displayed by using the -h switch. The --detailed-help -option prints the full help text. +Use the debug loglevel (-l debug) to show debugging info. All paraslash +executables have a brief online help which is displayed when -h is +given. The --detailed-help option prints the full help text. If para_server crashed or was killed by SIGKILL (signal 9), it may refuse to start again because of "dirty osl tables". In this case you'll have to run the oslfsck program of libosl to fix your -database. It might be necessary to use --force (even if your name -isn't Luke). However, make sure para_server isn't running before -executing oslfsck --force. +database: + + oslfsck -fd ~/.paraslash/afs_database-0.4 + +However, make sure para_server isn't running before executing oslfsck. If you don't mind to recreate your database you can start from scratch by removing the entire database directory, i.e. @@ -1099,6 +1100,14 @@ care about the table contents. To check for invalid table contents, use This prints out references to missing audio files as well as invalid playlists and mood definitions. +Similarly, para_audiod refuses to start if its socket file exists, since +this indicates that another instance of para_audiod is running. After +a crash a stale socket file might remain and you must run + + para_audiod --force + +once to fix it up. + --------------------------------------- Audio formats and audio format handlers --------------------------------------- @@ -1135,7 +1144,17 @@ Excited Linear Prediction) coding. It is designed for voice over IP applications, has modest complexity and a small memory footprint. Wideband and narrowband (telephone quality) speech are supported. As for Vorbis audio, Speex bit-streams are often stored -in OGG files. +in OGG files. As of 2012 this codec is considered obsolete since the +Oppus codec, described below, surpasses its performance in all areas. + +*OGG/Opus* + +Opus is a lossy audio compression format standardized through RFC +6716 in 2012. It combines the speech-oriented SILK codec and the +low-latency CELT (Constrained Energy Lapped Transform) codec. Like +OGG/Vorbis and OGG/Speex, Opus data is usually encapsulated in OGG +containers. All known software patents which cover Opus are licensed +under royalty-free terms. *AAC* @@ -1506,10 +1525,10 @@ the output to STDOUT, the filter modules of para_audiod are always connected to a receiver which produces the input stream and a writer which absorbs the output stream. -Some filters depend on a specific library being installed and are -not compiled in if this library was not found at compile time. To -see the list of supported filters, run para_filter and para_audiod -with the --help option. The output looks similar to the following: +Some filters depend on a specific library and are not compiled in +if this library was not found at compile time. To see the list of +supported filters, run para_filter and para_audiod with the --help +option. The output looks similar to the following: Available filters: compress wav amp fecdec wmadec prebuffer oggdec aacdec mp3dec @@ -2181,6 +2200,8 @@ RFCs Congestion Control ID 2: TCP-like Congestion Control - XREFERENCE(http://www.ietf.org/rfc/rfc4342.txt, RFC 4342) (2006): Congestion Control ID 3: TCP-Friendly Rate Control (TFRC) + - XREFERENCE(http://www.ietf.org/rfc/rfc6716.txt, RFC 6716) (2012): + Definition of the Opus Audio Codec Application web pages ~~~~~~~~~~~~~~~~~~~~~