Differences

This shows you the differences between two versions of the page.

--- packet:xrouter:tour [2024/02/15 05:25] – g8pzt
+++ packet:xrouter:tour [2025/02/22 02:20] (current) – [Other Pages In This Tour:] g8pzt
@@ Line 1: / Line 1: @@
-XRouter Tour
+======= XRouter Tour =======
-Xrouter is a 100% text-mode program, which may be run in a Linux or Windows terminal. This page gives you an overview of the sysop interface. (If xrouter is run as a daemon, the sysop interface is only via packet, telnet, or http)
+[[packet:xrouter|Back to XRouter Main Page]]
+The purpose of this "tour" is to give you an overview of what XRouter is like, without actually running it.
+===== Other Pages In This Tour: =====
+  * [[packet:xrouter:tour2|Sysop Interface 2 - XrMon]]
+  * [[packet:xrouter:htmlinfopage|Sysop Interface 3 - Legacy HTML]]
+  * [[packet:xrouter:full-fat|Sysop Interface 4 - "Full-Fat" HTML]]
+  * [[packet:xrouter:mqtt-iface|MQTT Interface]]
+  * [[packet:xrouter:qttermtcp|Using QTTermTCP With XRouter]]
+  * [[packet:xrouter:languages|Alternate Language Support]]
+  * [[packet:xrouter:customise|Customisable Texts]]
+  * [[packet:xrouter:help|The HELP system]]
+  * [[packet:xrouter:manual|The Sysop MANual]]
+  * [[packet:xrouter:info|The INFO System]]
+  * [[packet:xrouter:weather|Weather Information]]
+  * [[packet:xrouter:chatserver|The Chat/Converse Server]]
+  * [[packet:xrouter:bbs|The XRouter Bulletin Board System]]
+====== Local Sysop Interface 1 ======
+Xrouter is a text-mode program, which may be run in a Linux or Windows terminal. This page gives you an overview of the sysop interface. (If xrouter is run as a daemon, the sysop interface is only available via packet, telnet, http or XrMon)
 If you start XRouter from a GUI environment, in this case the Raspberry Pi desktop, you will see something like this:
@@ Line 8: / Line 42: @@
 The operating system's GUI is not relevant to this tour and will henceforth be ignored.  The bit we are interested in is contained within the terminal, in this case XRLin:
+===== Status Window =====
 {{xrwindow6.png}}
-The above screenshot shows XRouter's "status window". The caption "W6/10" indicates that it is window number 6 in a "carousel" of 10 text-mode "windows" forming the local sysop interface. It displays a general overview of the "health" and second-by-second activity of XRouter. The caption "PMS" flashes on and off when there is unread mail in the integral Personal Message System (mailbox). The protoocol, interface and port indicators light up in different colours to indicate activity. Session indicators are displayed at the top right - In this case "CHAT" shows that a chat session is active.
+The above screenshot shows XRouter's "status window". The caption "W6/10" indicates that it is window number 6 in a "carousel" of 10 text-mode "windows" forming the local sysop interface. It displays a general overview of the "health" and second-by-second activity of XRouter. The caption "PMS" flashes on and off when there is unread mail in the integral Personal Message System (mailbox). The protocol, interface and port indicators light up in different colours to indicate activity. Session indicators are displayed at the top right - In this case "CHAT" shows that a chat session is active.
+By default XRouter starts on the  status window, but it can be configured to start on any of the windows.
+===== Help Panels =====
 Pressing F1 on any of the windows opens up the help panel for that window, for example:
 {{xr6help.png}}
-By default XRouter starts on the  status window, but it can be configured to start on any of the windows.
 Let's have a quick look at the other windows before we have a detailed look at the "consoles"...
-Window 1 (Sysop Chat) is an "always-on" chat window connected to XRChat channel 1234. This channel is used for instant messaging between XR** sysops.
+===== Sysop Chat Window =====
+Window 1 (Sysop Chat) is an "always-on" chat window connected to XRChat channel 1234. This channel is used for instant messaging between XRouter sysops.
 {{xrwindow1.png}}
+===== Chat Monitor Window =====
 Window 2 (Chat Monitor) gives an overview of the currently active channels on the XRChat and RoundTable chat systems.
@@ Line 31: / Line 73: @@
 {{xrwindow2.png}}
-Window 3 (Session Monitor) shows who is currently connected and who has recently connected to your system.
+===== Session Monitor Window =====
-Additionally, it displays a log of the recent connections and disconnections.
+Window 3 (Session Monitor) shows who is currently connected and who has recently connected to your system. Additionally, it displays a log of the recent connections and disconnections:
+{{xrwindow3.png}}
+F2 or Alt-W allows you to "watch" the activity of a specified session. F8 or Alt-K allows you to kill a session.
+===== Nodes Monitor Window =====
 Window 4 (Nodes Monitor) shows how many NetRom nodes your system knows about, organised by hop count.
-It also shows which routes they were heard via, and the "health" of each node is indicated by colour and shape of the characters.
+It also shows which routes they were heard via, and the "health" of each node is indicated by colour and shape of the characters:
+{{xrwindow4.png}}
+==== Nodes Table Statistics Pane ====
+F2 or Alt-S shows the nodes table statistics pane:
+{{nodestatspane.png}}
+F3 or Alt-L displays a browseable list of all the nodes, or you can jump directly to a particular node using F4 / Alt-V[iew]
+==== Nodes Browser Pane ====
+{{nodeinfopane.png}}
+===== Routes Monitor Window =====
 Window 5 (Routes Monitor) shows the status of the "Routes" to your NetRom neighbours.
@@ Line 43: / Line 107: @@
 You can see at a glance which routes are healthy and which ones might need attention.
-Window 7 (Security Monitor) summarises some of the findings of XRPI's Intrusion Detection System (IDS).
+{{xrwindow5.png}}
+===== Security Monitor Window =====
+Window 7 (Security Monitor) summarises some of the findings of XRPI's Intrusion Detection System (IDS).
+As my test system has no activity to show, the following example shows window 7 of XRPi being displayed remotely on a Windows system, using XRMon, which in turn is being viewed through a low-bandwidth VNC connection, hence the abysmal quality: (more on XrMon later)
+{{xrwindow7.jpg}}
+===== Console Windows =====
+Windows 8 and above (if present) are "Console" windows, which allow you to interact with the software via a command line interface. You may configure 0 to 5 of these:
+{{console.png}}
+If you select one of the "console" windows, you can type commands to the software, monitor and capture protocol activity, and make connections etc. Consoles are ANSI colour compatible, and if you connect to another XRouter, that session is automatically in colour as the above example shows..
+==== Packet Tracing ====
+The F2 key toggles "monitoring" (tracing) on / off. You can select which port(s) and which protocol(s) to trace. The trace data can be captured to disk using F5..
+{{consoletrace.png}}
+==== Scroll-Back ====
+Using the up and down arrow keys, PgUp, PgDn, Home and End keys you can "scroll back" the console window to look at something that has gone off the screen. The default scroll buffer is 400 lines, but you can set it as large of as small as you like. If disk capture is enabled, it continues in the background during scroll-back:
+{{scrollback.png}}
+===== Drop Down Menus =====
+Instead of scrolling "left" and "right" through the carousel of XRouter windows, you can jump directly to a particular window using the "view" menu, invoked by Alt-V from any window, as shown below:
+{{viewmenu.png}}
+==== Hot Keys ====
+Each menu option has a "**hot key**" highlighted in red, so for example to view the "Nodes Monitor" window, the sequence would be Alt-V followed by N.
+Alternatively, use the up/down arrow keys to move the blue highlight bar to the desired option, then hit <CR> to action it.
+==== File Menu ====
+{{filemenu.jpg }} The file menu is accessed using Alt-F, or you can use the left and right arrow keys from an adjacent menu. There isn't much on this menu at present.
+==== Help Menu ====
+{{helpmenu.jpg }} The help menu is accessed using Alt-H, or the arrow keys. The "Help Topics" option displays a panel with a scrollable list of the help topics.
+{{helptopics.png}}
+==== Help Viewer ====
+Selecting a help topic displays it in a scrollable pane:
+{{helpblog.png}}
+==== Manual Topics Browser ====
+The "manual topics" option displays a list of ..... yes, you guessed it - sysop's manual topics:
+{{mantopics.png}}
+==== Manual Viewer ====
+And you can select a topic and read it in a scrollable pane...
+{{manbcpoll.png}}
+==== Configuration Viewer ====
+Finally, the "config Info" displays a handy summary of your node's configuration, again in a scrollable pane:
+{{configinfo.png}}
+===== TELSTAR =====
+If you like a bit of retro, XRouter's console automatically decodes "teletext"-style  pages from the Telstar app...
+{{telstar0.png}}
+===== Alternate Languages =====
+The console texts may also be configured for alternate languages:
+{{french.jpg}}
-Windows 8 and above (if present) are "Console" windows, which allow you to interact with the software via a command line interface. You may configure 0 to 5 of these.
+Next we'll have a look at an alternative interface - xrmon
-If you select one of the "console" windows, you can type commands to the software and make connections etc. Try typing "?" for help.
+Up: [[packet:xrouter|XRouter Main Page]]
+Next: [[packet:xrouter:tour2 | xrmon - XRouter Monitor Program]]
-(to be continued...)