From 108a14bfee8d7e1a79e6accf75217a0ff8569d52 Mon Sep 17 00:00:00 2001
From: Frank Herchet <frank.fh.herchet@bmw.de>
Date: Fri, 10 Feb 2012 10:27:49 +0100
Subject: * Update README; Short howto about the telnetserver

---
 README | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)

(limited to 'README')

diff --git a/README b/README
index 95fd403..4458fa8 100644
--- a/README
+++ b/README
@@ -137,6 +137,71 @@ The commandline options of the AudioManager:
 		-L<Name> add command plugin directory with <Name> (full path)	
 		-R<Name> add routing plugin directory with <Name> (full path)	
 
+Telnet-Server:
+   If you compile your AudioManager with TelnetServer support (cmake -DWITH_TELNET=ON), you will be able to set with commandline argument -t the port number and
+   with -m the maximum supported connections. The default telnet port is 6060. 
+   
+   For example, launch a telnet session on port 6060:
+      telnet localhost 6060
+   
+      #>Welcome to GENIVI AudioManager ver-0.0.1-37-ga004215
+      #>
+   
+   press 'help' to get a list of all supported commands on this level:
+   
+      #>help
+      ####################################################
+      ####### The following commands are supported: ######
+      ####################################################
+      #
+      #exit  - quit telnet session
+      #get   - Go into 'get'-submenu
+      #help  - show all possible commands
+      #info  - Go into 'info'-submenu
+      #list  - Go into 'list'-submenu
+      #set   - Go into 'set'-submenu
+      #
+      #\>
+   
+   Now type one of these commands, for example 'get', followed with another 'help' to get a list of supported commands:
+   
+      #\>get
+      #
+      #\Get>help
+      ####################################################
+      ####### The following commands are supported: ######
+      ####################################################
+      # 
+      #.. - one step back in menu tree (back to root folder)
+      #exit  - close telnet session
+      #help  - show all possible commands
+      #recv  - show receiverversion 
+      #routing  - show current routing
+      #sendv - show senderversion
+      #
+      #\Get>
+   
+   You can also execute several commands in a line:
+   
+      #\Get>recv sendv .. help exit
+      #   Receiver versions:
+      #   Ctrl: 1 | Cmd: 1 | Routing: 1
+      #   Sender versions:
+      #   Ctrl: 1 | Cmd: 1 | Routing: 1
+      ####################################################
+      ######## The following commands are supported: ######
+      ####################################################
+      #
+      #exit  - quit telnet session
+      #get   - Go into 'get'-submenu
+      #help  - show all possible commands
+      #info  - Go into 'info'-submenu
+      #list  - Go into 'list'-submenu
+      #set   - Go into 'set'-submenu
+      #
+      #Your wish is my command ... bye!
+      #Connection closed by foreign host.
+
 
 
 The source code if formatted with eclipse, the style sheet used can be found in the cmake folder:
-- 
cgit v1.2.1