manual: Explain how to compile from git.

[paraslash.git] / web / manual.m4

diff --git a/web/manual.m4 b/web/manual.m4
index 7eecdbb31ad09169666f4d2e353f215432e12961..5a348bb93fc70655889191c134dbb09db619b3e4 100644 (file)
--- a/web/manual.m4
+++ b/web/manual.m4
@@ -115,6 +115,9 @@ All connections between para_server and para_client are encrypted
 with a symmetric RC4 session key. For each user of paraslash you must
 create a public/secret RSA key pair for authentication.
 
 with a symmetric RC4 session key. For each user of paraslash you must
 create a public/secret RSA key pair for authentication.
 

+If para_client is started without non-option arguments, an interactive
+session (shell) is started. Command history and command completion are
+supported through libreadline.

 
 *para_audiod*
 
 
 *para_audiod*
 


@@ -135,7 +138,8 @@ socket credentials, if available.
 
 The client program which talks to para_audiod. Used to control
 para_audiod, to receive status info, or to grab the stream at any
 
 The client program which talks to para_audiod. Used to control
 para_audiod, to receive status info, or to grab the stream at any

-point of the decoding process.
+point of the decoding process. Like para_client, para_audioc supports
+interactive sessions on systems with libreadline.

 
 *para_recv*
 
 
 *para_recv*
 


@@ -266,6 +270,10 @@ Optional:
        libao). Needed to build the ao writer (ESD, PulseAudio,...).
        Debian package: libao-dev.
 
        libao). Needed to build the ao writer (ESD, PulseAudio,...).
        Debian package: libao-dev.
 

+       - XREFERENCE(http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html,
+       GNU Readline). If this library (libreadline-dev) is installed,
+       para_client and para_audioc support interactive sessions.
+

 Installation
 ~~~~~~~~~~~~
 
 Installation
 ~~~~~~~~~~~~
 


@@ -283,10 +291,20 @@ libmad) is needed for para_server if you only want to stream MP3 or WMA
 files. Also, it's fine to use para_server on a box without sound card.
 
 Next, install the paraslash package on all machines, you'd like this
 files. Also, it's fine to use para_server on a box without sound card.
 
 Next, install the paraslash package on all machines, you'd like this

-software to run on:
+software to run on. If you compile from a released tarball, execute

 
        (./configure && make) > /dev/null
 
 
        (./configure && make) > /dev/null
 

+When compiling from git or from snapshots downloaded via gitweb,
+the above command will not work because the configure script is not
+included in the git repository. In this case the following command
+should be used instead:
+
+       ./autogen.sh
+
+This runs autoconf to generate the configure script, then runs it as
+above. Therefore you'll need autoconf for this to work.
+

 There should be no errors but probably some warnings about missing
 packages which usually implies that not all audio formats will be
 supported. If headers or libs are installed at unusual locations you
 There should be no errors but probably some warnings about missing
 packages which usually implies that not all audio formats will be
 supported. If headers or libs are installed at unusual locations you


@@ -486,7 +504,7 @@ including ssh and gpg. An RSA key consists in fact of two keys,
 called the public key and the private key. A message can be encrypted
 with either key and only the counterpart of that key can decrypt
 the message. While RSA can be used for both signing and encrypting
 called the public key and the private key. A message can be encrypted
 with either key and only the counterpart of that key can decrypt
 the message. While RSA can be used for both signing and encrypting

-a message, paraslash only uses RSA only for the latter purpose. The
+a message, paraslash uses RSA only for the latter purpose. The

 RSA public key encryption and signatures algorithms are defined in
 detail in RFC 2437.
 
 RSA public key encryption and signatures algorithms are defined in
 detail in RFC 2437.