Introduce new syntax for com_ls().

[paraslash.git] / web / manual.m4

diff --git a/web/manual.m4 b/web/manual.m4
index 0182c5157fa8ff04f835c2aa862b9092a91636c0..8c00c99bb3ef884ff46ba1c8ba9a3d3cfa87e1e7 100644 (file)
--- a/web/manual.m4
+++ b/web/manual.m4
@@ -374,14 +374,6 @@ Finally, tell para_client to connect to server_host:
 
 *Step 2*: Start para_server
 
 
 *Step 2*: Start para_server
 

-Before starting the server make sure you have write permissions to
-the directory /var/paraslash that has been created during installation:
-
-       sudo chown $LOGNAME /var/paraslash
-
-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
 of para_server more verbose.
 
 For this first try, we'll use the info loglevel to make the output
 of para_server more verbose.
 


@@ -426,19 +418,8 @@ You may print the list of all known audio files with
 
 *Step 4*: Configure para_audiod
 
 
 *Step 4*: Configure para_audiod
 

-para_audiod needs to create a "well-known" socket for the clients to
-connect to. The default path for this socket is
-
-       /var/paraslash/audiod_socket.$HOSTNAME
-
-In order to make this directory writable for para_audiod, execute
-as bar@client_host
-
-       sudo chown $LOGNAME /var/paraslash
-
-
-We will also have to tell para_audiod that it should receive the
-audio stream from server_host via http:
+We will have to tell para_audiod that it should receive the audio
+stream from server_host via http:

 
        para_audiod -l info -r '.:http -i server_host'
 
 
        para_audiod -l info -r '.:http -i server_host'
 


@@ -455,9 +436,16 @@ streamed in which order.
 
 *Troubleshooting*
 
 
 *Troubleshooting*
 

-It did not work? To find out why, try to receive, decode and play the
-stream manually using para_recv, para_filter and para_write as follows.
+If you receive a socket related error on server or audiod startup,
+make sure you have write permissions to the /var/paraslash directory:

 
 

+       sudo chown $LOGNAME /var/paraslash
+
+Alternatively, use the --afs-socket (para_server) or --socket
+(para_audiod) option to specify a different socket pathname.
+
+To identify streaming problems try to receive, decode and play the
+stream manually using para_recv, para_filter and para_write as follows.

 For simplicity we assume that you're running Linux/ALSA and that only
 MP3 files have been added to the database.
 
 For simplicity we assume that you're running Linux/ALSA and that only
 MP3 files have been added to the database.
 


@@ -763,7 +751,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.


@@ -1301,10 +1289,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
 ~~~~~~~~~~~~~~~~~~~


@@ -1563,7 +1551,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


@@ -1572,8 +1560,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
 ~~~~~~~~~~~~~~~~~~~~~~~~