Utils/Console: Documentation

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1055 270642c3-0616-0410-b53a-bc976706d245

diff --git a/Utils/Console/LineEditor.hh b/Utils/Console/LineEditor.hh
index 39e13b6..2a94a7e 100644 (file)
--- a/Utils/Console/LineEditor.hh
+++ b/Utils/Console/LineEditor.hh
@@ -39,6 +39,15 @@ namespace senf {
 namespace console {
 namespace detail {
 
+    /** \brief Internal: Client reader switching between LineEditorClientReader or DumbClientReader
+        
+        This ClientReader implementation will try to initialize a LineEditorClientReader. If the
+        setup fails, a DumbClientReader is initialized instead. LineEditor support may fail to be
+        initialized if
+        
+        \li The telnet client does not support necessary functionality
+        \li or the terminal type of the client is missing some functionality.
+     */
     class LineEditorSwitcher
         : public ClientReader
     {
@@ -55,6 +64,10 @@ namespace detail {
         boost::scoped_ptr<ClientReader> reader_;
     };
 
+    /** \brief Internal: ClientReader using senf::term::LineEditor for interactive input
+
+        This ClientReader implementation uses a senf::term::LineEditor for interactive input. 
+     */
     class LineEditorClientReader
         : public ClientReader, public term::TelnetTerminal
     {

diff --git a/Utils/Console/Mainpage.dox b/Utils/Console/Mainpage.dox
index 3a378e2..eb39f76 100644 (file)
--- a/Utils/Console/Mainpage.dox
+++ b/Utils/Console/Mainpage.dox
@@ -511,10 +511,9 @@
 
     \subsection console_shell The interactive console shell
 
-    The interactive shell will use the GNU readline library for the first connected
-    instance. Further users will not have access to this functionality since GNU readline is
-    completely non-reentrant. GNU readline supports history and some command keys (like C-d for \c
-    exit or C-c to clear and restart the input).
+    The interactive shell implements a fully function line editor on capable terminals. This support
+    is available when using a full featured telnet client on a fully supported terminal (like vt100
+    or xterm).
 
     The shell supports auto-cd and auto-completion: If you enter the name of a directory at the
     prompt, the console will change to that directory. With auto-completion, any unique beginning of
@@ -525,8 +524,7 @@
     \subsection console_noninteractive Non-interactive network console
 
     After a new connection is established, the console server waits a short time for data to arrive.
-    arrive. Only if nothing happens in the first 500ms, readline is initialized (if available) and
-    the interactive prompt is displayed.
+    arrive. Only if nothing happens in the first 500ms, an interactive session is initialized.
 
     By sending data immediately after opening the connection, the console is switched into
     non-interactive mode. In this mode, no prompt is displayed. In this mode, commands are \e not