help
ARES System Manual: help Utility
The onboard help utility is used to display manual pages, similar to the POSIX
Syntax
- Double quotation marks (like this: help) indicate a reference to another help page. If you are viewing this document online, these statements should be automatically hyperlinked.
- Backticks (like this:
- Vertical bars (the | character) indicate alternatives.
- Square brackets (the [ and ] characters) indicate optional arguments. For example,
- Angle brackets (the < and > characters) indicate placeholder names. For example,
- Single quotation marks (like this: 'word') are used according to normal English-language conventions for quotation marks.
The
The syntax of the
Remote Sources
New in ARES 0.4.4 is the ability to host
To rescan the list of remote sources, use
The onboard help utility is used to display manual pages, similar to the POSIX
man command. Entries are each stored in their own files, with the file extension .info.
help [<topic>]: display the specified help topic, or main if no topic is specified.
help reindex: index .info files hosted on remote sources.
Syntax
help pages use the following conventions, which may be machine-parsed if viewed on the web:
- Double quotation marks (like this: help) indicate a reference to another help page. If you are viewing this document online, these statements should be automatically hyperlinked.
- Backticks (like this:
help) indicate samples of input or output, such as sample command lines or fragments thereof.
- Vertical bars (the | character) indicate alternatives.
- Square brackets (the [ and ] characters) indicate optional arguments. For example,
proc [tasks] means that the output of proc and the output of proc tasks are the same.
- Angle brackets (the < and > characters) indicate placeholder names. For example,
@echo <message> means that you should replace <message> with some specific message.
- Single quotation marks (like this: 'word') are used according to normal English-language conventions for quotation marks.
The
.info file format is very simple and uses separate files for each topic. Developers are encouraged to include .info files with their packages.
The syntax of the
.info file format originated as the conventions used by the Companion manual file.
Remote Sources
New in ARES 0.4.4 is the ability to host
.info files on remote sources. These are static sources (see storage), and are listed as URLs in LSD:help.source (see db for an explanation of how settings work.) By listing them separately in this manner, developers avoid overloading the general filesystem with help pages.
To rescan the list of remote sources, use
@help reindex.