Socket/NetdeviceController: added promisc() methods

[senf.git] / Utils / Console / Mainpage.dox

diff --git a/Utils/Console/Mainpage.dox b/Utils/Console/Mainpage.dox
index 3a378e2..b46ce64 100644 (file)
--- a/Utils/Console/Mainpage.dox
+++ b/Utils/Console/Mainpage.dox
@@ -344,7 +344,7 @@
     The first possibility to control this is to change the root node. This is done by 
     \li passing that root node to the helper class or to the parse helper as an additional argument
         (see the respective documentation).
-    \li passing it to the senf:;console::ConfigBundle constructor when parsing multiple sources.
+    \li passing it to the senf::console::ConfigBundle constructor when parsing multiple sources.
     
     for example:
 
@@ -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
@@ -781,6 +779,20 @@
         .add("over", static_cast<void (*)(int)>(&over));
     senf::console::root()
         .add("over", static_cast<void (*)(int,int)>(&over));
+        
+    class SomeModule {
+      senf::console::ScopedDirectory<SomeModule> dir;
+      
+      unsigned int overlodedMethod() const {....};
+      void overlodedMethod(unsigned int)   {....};
+        
+      void addConsoleCommands() {
+        dir.node().add("overlodedMethod", senf::membind(
+            static_cast<unsigned int (SomeModule::*)() const>(&SomeModule::overlodedMethod), this));
+        dir.node().add("overlodedMethod", senf::membind(
+            static_cast<void (SomeModule::*)(unsigned int)>(&SomeModule::overlodedMethod), this));
+      }
+    }
     \endcode