wmadec: Simplify wma_lsp_to_curve_init().

[paraslash.git] / web / manual.m4

diff --git a/web/manual.m4 b/web/manual.m4
index b7e059785b193ccb67a1c47d34a6d60143b23229..d63b07e8cbb69067439db6bca4875f9867908831 100644 (file)
--- a/web/manual.m4
+++ b/web/manual.m4
@@ -259,7 +259,8 @@ Optional:
        - XREFERENCE(http://www.underbit.com/products/mad/,
        libid3tag). For version-2 ID3 tag support, you'll need
        the libid3tag development package libid3tag0-dev. Without
        - XREFERENCE(http://www.underbit.com/products/mad/,
        libid3tag). For version-2 ID3 tag support, you'll need
        the libid3tag development package libid3tag0-dev. Without

-       libid3tag, only version one tags are recognized.
+       libid3tag, only version-1 tags are recognized. The mp3 tagger
+       also needs this library for modifying (id3v1 and id3v2) tags.

 
        - XREFERENCE(http://www.xiph.org/downloads/, ogg vorbis).
        For ogg vorbis streams you'll need libogg, libvorbis,
 
        - XREFERENCE(http://www.xiph.org/downloads/, ogg vorbis).
        For ogg vorbis streams you'll need libogg, libvorbis,


@@ -751,7 +752,7 @@ is applied to all audio files matching this pattern:
 
 The command
 
 
 The command
 

-       para_client -- ls -lv
+       para_client -- ls -l=v

 
 gives you a verbose listing of your audio files also showing which
 attributes are set.
 
 gives you a verbose listing of your audio files also showing which
 attributes are set.


@@ -1289,10 +1290,10 @@ to the database, so they need to transfer data the other way round,
 from the client to the server.
 
 There is no knowledge about the server commands built into para_client,
 from the client to the server.
 
 There is no knowledge about the server commands built into para_client,

-so it does not know about addblob commands. Instead, it inspects the
-first data package sent by the server for a magic string. If this
-string was found, it sends STDIN to the server, otherwise it dumps
-data from the server to STDOUT.
+so it does not know about addblob commands. Instead, the server sends
+a special "awaiting data" packet for these commands. If the client
+receives this packet, it sends STDIN to the server, otherwise it
+dumps data from the server to STDOUT.

 
 Streaming protocols
 ~~~~~~~~~~~~~~~~~~~
 
 Streaming protocols
 ~~~~~~~~~~~~~~~~~~~


@@ -1551,7 +1552,7 @@ can be directly sent to the sound device or any other software that
 operates on undecoded PCM data (visualizers, equalizers etc.). Such
 filters are called _decoders_ in general, and xxxdec is the name of
 the paraslash decoder for the audio format xxx. For example, the mp3
 operates on undecoded PCM data (visualizers, equalizers etc.). Such
 filters are called _decoders_ in general, and xxxdec is the name of
 the paraslash decoder for the audio format xxx. For example, the mp3

-decoder filter is called mp3dec.
+decoder is called mp3dec.

 
 Note that the output of the decoder is about 10 times larger than
 its input. This means that filters that operate on the decoded audio
 
 Note that the output of the decoder is about 10 times larger than
 its input. This means that filters that operate on the decoded audio


@@ -1560,8 +1561,7 @@ the audio stream before it is fed to the decoder.
 
 Paraslash relies on external libraries for most decoders, so these
 libraries must be installed for the decoder to be included in the
 
 Paraslash relies on external libraries for most decoders, so these
 libraries must be installed for the decoder to be included in the

-para_filter and para_audiod executables. The oggdec filter depends
-on the libogg and libvorbis libraries for example.
+executables. For example, the mp3dec filter depends on the mad library.

 
 Forward error correction
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
 Forward error correction
 ~~~~~~~~~~~~~~~~~~~~~~~~


@@ -2010,21 +2010,19 @@ Doxygen
 ~~~~~~~
 
 Doxygen is a documentation system for various programming
 ~~~~~~~
 
 Doxygen is a documentation system for various programming

-languages. The paraslash project uses Doxygen for generating the API
-reference on the web pages, but good source code documentation is
-also beneficial to people trying to understand the code structure
-and the interactions between the various source files.
+languages. The API reference on the paraslash web page is generated
+by doxygen.

 
 It is more illustrative to look at the source code for examples than
 
 It is more illustrative to look at the source code for examples than

-to describe the conventions for documenting the source in this manual,
-so we only describe which parts of the code need doxygen comments,
-but leave out details on documentation conventions.
+to describe the conventions in this manual, so we only describe which
+parts of the code need doxygen comments, but leave out details on
+documentation conventions.

 
 As a rule, only the public part of the C source is documented with
 Doxygen. This includes structures, defines and enumerations in header
 files as well as public (non-static) C functions.  These should be
 
 As a rule, only the public part of the C source is documented with
 Doxygen. This includes structures, defines and enumerations in header
 files as well as public (non-static) C functions.  These should be

-documented completely. For example each parameter and the return
-value of a public function should get a descriptive comment.
+documented completely. For example, each parameter and the return
+value of a public function should get a descriptive doxygen comment.

 
 No doxygen comments are necessary for static functions and for
 structures and enumerations in C files (which are used only within
 
 No doxygen comments are necessary for static functions and for
 structures and enumerations in C files (which are used only within