Document interactive sessions and add link to libreadline.

[paraslash.git] / web / manual.m4

diff --git a/web/manual.m4 b/web/manual.m4
index 7163bb7b8d700788795ce23ef8110fb90a1154a5..5d9fbbb7c78514317238b49f08a538fe1f7abb92 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*
 


@@ -223,6 +227,10 @@ In any case you'll need
        distro, but you might have to install the development package
        (libssl-dev or libgcrypt-dev on debian systems) as well.
 
        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/help2man, help2man)
        is used to create the man pages.
 
        - XREFERENCE(ftp://ftp.gnu.org/pub/gnu/help2man, help2man)
        is used to create the man pages.
 


@@ -258,6 +266,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
 ~~~~~~~~~~~~
 


@@ -1804,11 +1816,6 @@ branches, below), the git source code management tool is used for
 paraslash development. It is necessary for cloning the git repository
 and for getting updates.
 
 paraslash development. It is necessary for cloning the git repository
 and for getting updates.
 

-ftp://ftp.gnu.org/pub/gnu/gengetopt/ (gengetopt). The C code for
-the command line parsers of all paraslash executables is generated
-by gengetopt. The generated C files are shipped in the tarballs but
-are not contained in the git repository.
-

 ftp://ftp.gnu.org/pub/gnu/m4/ (m4). Some input files for gengetopt
 are generated from templates by the m4 macro processor.
 
 ftp://ftp.gnu.org/pub/gnu/m4/ (m4). Some input files for gengetopt
 are generated from templates by the m4 macro processor.