Project

General

Profile

Menu Commands » History » Revision 9

Revision 8 (Hamish, 2008-05-15 19:49) → Revision 9/11 (Hamish, 2018-07-28 21:06)

# h1. Menu Commands 

 Note that it is currently planned to completely replace the menu system for the next version of wconsd, so these commands will be changing. 

 ## binary h2. close 

   binary 

 This command toggles the state of the binary mode.    Binary mode is required for correct use of file transfer protocols, such as *xmodem*.    This mode will be automatically turned on by some telnet clients (if they send the telnet option DO BINARY TRANSMISSION) in which case it may need to be manually turned off using this command. 

 ## h2. close 

   close 

 If the serial port is current open, this command will close it and stop any serial communications. 

 ## h2. copyright 

   copyright 

 Print the copyright notice 

 ## h2. data 

   data *5|6|7|8* 

 Sets the number of data bits.    This command will not have any affect until the port is closed and re-opened. 

 ## h2. help 

 Show some quick help for the menu commands 

 ## h2. keepalive 

   keepalive 

 Toggles the state of Telnet keepalives.    If keepalives are turned on, then a Telnet Keepalive option is sent approximately once every two seconds.    This will create significantly more network traffic than normal, but will help to avoid sessions being terminated unexpectedly 

 ## h2. kill_conn 

   kill_conn *Connection ID* 

 Stop a given connection's serial communications.    This will close the serial port being used by the given *connection ID* and thus allow someone else to open that port.    This command can be used when an existing session has crashed, or if someone else has logged in and is blocking your work.    Since there is no authentication, this command is obviously open to abuse. 

 ## h2. open 

   open *[port number]* 

 Connect or resume communications with a serial port.    If no port number is specified then the current default port number is used.    If an serial port is already open, this will just resume communication with that port. 

 ## h2. parity 

   parity *no|even|odd|mark|space* 

 Set the serial parity.    This command will not have any affect until the port is closed and re-opened. 

 ## h2. port 

   port *port number* 

 Set serial port number.    This command will not have any affect until the port is closed and re-opened. 

 ## h2. quit 

   quit 

 Exit from this session 

 ## h2. show_conn_table 

   show_conn_table 

 Show the connections table.    This table is mostly used for internal debugging information, however it contains the connection ID for all the current connections, which can be used with the *kill_conn* command 

 ``` <pre style="background-color:black; color:green"> 
 w000c2989d2df> show_conn_table 
 Flags: A - Active Slot, N - Network active, S - Serial active, 
        M - Run Menu, B - Binary transmission, E - Echo enabled, 
        K - Telnet Keepalives, * - This connection 

 s flags     id mThr net    netTh serial serialTh netrx nettx peer address 
 - ------- -- ---- ---- ----- ------ -------- ----- ----- ------------ 
 0      ME      1 1884                                 55    1598 192.168.1.1:43686 
 1 ANSMBEK    2 1888 1880       0     1844       1836      68    4264 192.168.1.1:57184 
 2*AN ME      3 1856 1868       0                     109    4657 127.0.0.1:4629 
 3            0      0                                  0       0 
 4            0      0                                  0       0 
 5            0      0                                  0       0 
 6            0      0                                  0       0 
 7            0      0                                  0       0 
 ``` </pre> 

 * *id* contains the connection ID for this slot 

 ## h2. speed 

   speed *bits per second* 

 Set serial port speed.    This command will not have any affect until the port is closed and re-opened. 

 ## h2. status 

   status 

 Show current serial port status 

 ``` <pre style="background-color:black; color:green"> 
 w000c2989d2df> status 
 status: 

   port=1    speed=9600    data=8    parity=0    stop=0 
   state=open 

   connectionid=1    hostname=w000c2989d2df 
   echo=1    binary=0    keepalive=0 

 ``` </pre> 

 ## h2. stop 

   stop *1|1.5|2* 

 Set number of stop bits.    This command will not have any affect until the port is closed and re-opened.