manual: Minor filter text improvement.

[paraslash.git] / web / manual.m4

diff --git a/web/manual.m4 b/web/manual.m4
index 22abf76f85364e8d899029cad661f03fe8fefe17..332d50952727baa0dde07ff07be347c81a8ead14 100644 (file)
--- a/web/manual.m4
+++ b/web/manual.m4
@@ -77,11 +77,11 @@ The paraslash executables
 
 *para_server*
 
 
 *para_server*
 

-para_server streams binary audio data (MP3, OGG/Vorbis, OGG/Speex,
-M4A, WMA files) over local and/or remote networks. It listens on a
-TCP port and accepts commands such as play, stop, pause, next from
-authenticated clients. There are many more commands though, see the
-man page of para_server for a description of all commands.
+para_server streams binary audio data (MP3, ...) over local and/or
+remote networks. It listens on a TCP port and accepts commands such
+as play, stop, pause, next from authenticated clients. There are
+many more commands though, see the man page of para_server for a
+description of all commands.

 
 It supports three built-in network streaming protocols
 (senders/receivers): HTTP, DCCP, or UDP. This is explained in more
 
 It supports three built-in network streaming protocols
 (senders/receivers): HTTP, DCCP, or UDP. This is explained in more


@@ -202,8 +202,16 @@ REFERENCE(Quick start, set up) a typical server and client.
 
 Requirements
 ~~~~~~~~~~~~
 
 Requirements
 ~~~~~~~~~~~~

+For the impatient:

 
 

-In any case you'll need
+       git clone git://git.tuebingen.mpg.de/osl
+       cd osl && make && sudo make install && sudo ldconfig
+       sudo apt-get install autoconf libssl-dev help2man gengetopt \
+              libmad0-dev libid3tag0-dev libasound2-dev libvorbis-dev \
+              libfaad-dev libspeex-dev libFLAC-dev libsamplerate-dev \
+              libasound2-dev libao-dev libreadline-dev libncurses-dev
+
+Detailed description: In any case you'll need

 
        - XREFERENCE(http://systemlinux.org/~maan/osl/, libosl).
        The _object storage layer_ library is used by para_server. To
 
        - XREFERENCE(http://systemlinux.org/~maan/osl/, libosl).
        The _object storage layer_ library is used by para_server. To


@@ -224,14 +232,6 @@ In any case you'll need
        scripts which run during compilation require the EMPH(Bourne
        again shell).  It is most likely already installed.
 
        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.
        - 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.


@@ -241,6 +241,14 @@ In any case you'll need
 
 Optional:
 
 
 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
        - 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


@@ -398,7 +406,7 @@ the directory /var/paraslash that has been created during installation:
 
        sudo chown $LOGNAME /var/paraslash
 
 
        sudo chown $LOGNAME /var/paraslash
 

-Alternatively, use the --afs_socket Option to specify a different
+Alternatively, use the --afs-socket Option to specify a different

 location for the AFS command socket.
 
 For this first try, we'll use the info loglevel to make the output
 location for the AFS command socket.
 
 For this first try, we'll use the info loglevel to make the output


@@ -584,7 +592,7 @@ The user_list file
 
 At startup para_server reads the user list file which contains one
 line per user. The default location of the user list file may be
 
 At startup para_server reads the user list file which contains one
 line per user. The default location of the user list file may be

-changed with the --user_list option.
+changed with the --user-list option.

 
 There should be at least one user in this file. Each user must have
 an RSA key pair. The public part of the key is needed by para_server
 
 There should be at least one user in this file. Each user must have
 an RSA key pair. The public part of the key is needed by para_server


@@ -631,7 +639,7 @@ restricted on platforms that support UNIX socket credentials which
 allow para_audiod to obtain the Unix credentials of the connecting
 process.
 
 allow para_audiod to obtain the Unix credentials of the connecting
 process.
 

-Use para_audiod's --user_allow option to allow connections only for
+Use para_audiod's --user-allow option to allow connections only for

 a limited set of users.
 
 -----------------------
 a limited set of users.
 
 -----------------------


@@ -1498,10 +1506,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.
 
 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
 
        Available filters:
                compress wav amp fecdec wmadec prebuffer oggdec aacdec mp3dec


@@ -1762,7 +1770,7 @@ a curses window. By default the command
 
        para_audioc -- stat -p
 
 
        para_audioc -- stat -p
 

-is executed, but this can be customized via the --stat_cmd option. In
+is executed, but this can be customized via the --stat-cmd option. In

 particular it possible to use
 
        para_client -- stat -p
 particular it possible to use
 
        para_client -- stat -p