Differences

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

--- packet:xrouter:help [2024/02/17 16:38] – created g8pzt
+++ packet:xrouter:help [2025/02/22 02:39] (current) – g8pzt
@@ Line 1: / Line 1: @@
 ====== XRouter Tour - Help System ======
-There are 2 help systems, a concise one for "user" commands, and a more detailed one for sysops (which will be covered on the next page).
+[[packet:xrouter:tour|Back to Tour Index Page]]
+There are 2 help systems in XRouter:
+  * a concise one for "user" commands
+  * a more detailed "manual" for sysops (which will be covered on the [[manual | next page]]).
+Typing HELP (or just H) produces the following response:
+{{help1.png}}
+Let's look at the "?" command first. This can be used in several ways..
+==== Listing the Basic Commands ====
+By itself, the "?" command lists the basic commands, and displays further options as follows:
+{{query1.png}}
+==== Listing All Commands in Brief ====
+Using "? *" displays the list of commands (in this case the "user" commands):
+{{query2.png}}
+==== Listing All Commands in More Detail ====
+Entering "?" followed by two asterisks displays the commands with a brief explanation. Unfortunately this was too long for the snapshot
+{{query3.png}}
+==== Syntax Help - Method 1 ====
+Using "?" followed by a command name (e.g. "? ANSI") gives the syntax for that command..
+{{syntaxhelp.png}}
+==== Syntax Help - Method 2 ====
+In many cases, using the "?" AFTER the command name also displays syntax help:
+{{syntax2.png}}
+==== Automatic Syntax Help ====
+When too few arguments are supplied to a command, XRouter automatically displays the syntax for the command. Naturally this only works for commands which expect more than one argument.
+{{syntax3.png}}
+==== Displaying Help Topics ====
+ "H *" displays all the available help topics....
+{{helptopics1.png}}
+==== Using Wildcards ====
+The list of topics can be restricted using wildcards, e.g. "H A*" lists all the topics begining with "A"...
+{{help2.png}}
+==== Suggested Topics ====
+If you make a mistake, e.g. you type "H nides" instead of "H Nodes", XRouter suggests possible topics:
+{{help3.png}}
+==== Detailed Help ====
+Finally, typing H followed by a valid topic name, e.g. "H NRR", displays the full help for that topic.
+{{help4.png}}
+Unfortunately the help can't be TOO detailed, otherwise it would take too long to send via radio!
+**Next:** [[packet:xrouter:manual | Sysop's Manual]]
+[[packet:xrouter:tour|Back to Tour Index Page]]