Skip to content

The Console

Jump to bottom
Dusan Ciric edited this page Dec 30, 2017 · 10 revisions

RX Platform Console Interface

The RX Console is one of the platform interfaces you can easily use to access every part of the RX Platform itself.

To skip the introduction you can see commands directly:

Console is built at lowest engine level so with-it system can be easily configured, tested and administered. There are several ways to access the RX Console. Easiest way to access it is by running an Interactive Console Host. On Windows Systems just double-click icon rx_interactive.exe or start it from console, and on Linux Systems just start rx_interactive program. It enables an engine to be tested in an easy way. You can execute program in any terminal emulator and you have interactive server up and running.

        ____________________
       / ____     _  __    /\
      / / __ \   | |/ /   / /\
     / / /_/ /   |   /   / /\
    / / _, _/   /   |   / /\
   / /_/ |_|   /_/|_|  / /\
  /___________________/ /\
  \___________________\/\
   \ \ \ \ \ \ \ \ \ \ \

>>>> Running Interactive Console...
=============================================

/_sys/plugins/host
interactive@RX0001:>

Another way to access the console is terminal access. It is based on telnet protocol so enables the device to open the physically secure connection on hardware COM port. You can also designate some separate Ethernet Card for administration and access it with telnet support. This requires full duplex support on terminal line. Terminal server forces clients to use remote echo for each character so it produces a lot of small network packages and is there-fore not to be used over large network segment. The previous approach enables safer access to server regarding communication errors and other physical factors.

Actually, TCP/IP telnet access to RX Platform is supported only as a replacement for COM port for easier access with Ethernet port, and for testing purposes on local machine or in secure and isolated network surrounding (default port when started as interactive console is 12345, so it’s telnet 127.0.0.1 12345 and you’ll connect to it):

        ____________________
       / ____     _  __    /\
      / / __ \   | |/ /   / /\
     / / /_/ /   |   /   / /\
    / / _, _/   /   |   / /\
   / /_/ |_|   /_/|_|  / /\
  /___________________/ /\
  \___________________\/\
   \ \ \ \ \ \ \ \ \ \ \

>>>> Running Telnet Console...
=============================================

/world
[email protected]:>

The starting point of any console that is new is basic help command. You can try it and get list of all commands with basic explanation (actually not yet quite sure in Atom Ver 0.5.13 witch is current version).

Commands...

There are several groups of commands and most important stuff are exploring commands ls, dir, cd. Using these commands, one can easily explore directories, objects, classes and namespaces.

Current position inside the Platform can be easily seen in the command prompt line. Command prompt contains three import information: current security context user name, position in a directories/namespaces structure and position inside an object structure (seen as a yellow part of path).

  • dir, ls

These commands list content of the current console position. They have the same functionality as in all major operating systems. The command line switches are different:

  • -q includes quality information
  • -t includes timestamps
  • -a includes attributes
  • -c includes created time
  • -f includes all above fields and list everything

Also, behavior of ls and dir command is different if executed without the switches. dir command list items as a table that contains name and type column. ls command displays items as a list of names.

  • cd

This command changes current position of a console interface inside the Platform. Root position of the platform is root / directory. Position can be changed either as a absolute path >cd /_sys/bin or as a relative path from current position >cd ../objects.

Informational commands

Commands from this group enable user to get information about Platform, running environment and items inside the Platform.

  • pname

This command dumps information about Platform and Hardware Environment

  • time

This command dumps information about start time and active time on platform

  • sleep

Puts console to sleep for specified number of milliseconds.

  • term

This command dumps information about terminal stack of the current console

  • host

This command dumps information about hosts stack of the Platform

  • info, code

These commands dumps general information and code information about specific item in the Platform. Item can be specified using either absolute or using relative path from the current console position >info /_sys/objects/io_pool >code /_sys/objects/io_pool.

  • enter, leave

The enter command changes current position of a console interface inside some Object in Current Directory.The objct name cam be specified as absolute and relative path (for example >enter /_sys/objects/io_pool And leave command leaves currently active object.

  • sec

This command dump security related stuff and has several sub commands:

    • sec active

Dumps currently active users and their basic info, also with a * is marked down current user.

  • log

This command dump platform log stuff and has several sub commands:

    • log test

Test currently log engine responsiveness and dump information about it.

Clone this wiki locally