packet:xrouter:help
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
packet:xrouter:help [2024/02/17 20:51] – g8pzt | packet:xrouter:help [2025/02/22 02:39] (current) – g8pzt | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== XRouter Tour - Help System ====== | ====== XRouter Tour - Help System ====== | ||
- | There are 2 help systems in XRouter, a concise one for " | + | [[packet: |
+ | |||
+ | There are 2 help systems in XRouter: | ||
+ | * a concise one for " | ||
+ | * a more detailed " | ||
Typing HELP (or just H) produces the following response: | Typing HELP (or just H) produces the following response: | ||
Line 23: | Line 27: | ||
==== Listing All Commands in More Detail ==== | ==== Listing All Commands in More Detail ==== | ||
- | Entering "? | + | Entering "?" |
{{query3.png}} | {{query3.png}} | ||
Line 38: | Line 42: | ||
{{syntax2.png}} | {{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 ==== | ==== Displaying Help Topics ==== | ||
Line 45: | Line 55: | ||
{{helptopics1.png}} | {{helptopics1.png}} | ||
- | (to be continued) | + | ==== Using Wildcards ==== |
+ | |||
+ | The list of topics can be restricted using wildcards, e.g. "H A*" lists all the topics begining with " | ||
+ | |||
+ | {{help2.png}} | ||
+ | |||
+ | ==== Suggested Topics ==== | ||
+ | |||
+ | If you make a mistake, e.g. you type "H nides" instead of "H Nodes", | ||
+ | |||
+ | {{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: | ||
+ | |||
+ | [[packet: |
packet/xrouter/help.1708203071.txt.gz · Last modified: 2024/02/17 20:51 by g8pzt