The help system is hierarchic system. On the top of which stands topics. Each topics holds commands. Each command has at least a name and a usage (help) message. Commands may have a optional short name. Their is a special topic for the drivers named "drivers". Help on drivers give the list of all loaded driver. Help on a driver name display information on that driver as well as the commands associate to it. Driver commands are stored by default in a topic of the name of the driver, but driver may choose other topic for each command it provides.
It is possible to have a the same name for different command usage in different topic. To access a command in a given topic help() command allow to specify a full qualified command name `topic/command`. The "*" star may be use as a wild-card on either topic or command. A single "*" or a "* / *" will display topics list and the listing of command for each topic. The wild-card only works for regular topics not for "drivers".
Functions | |
addhelp (var name, var short_name, var topic, var help) | |
Add help about a shell command. | |
remove_help (var name, var short_name, var topic) | |
Remove help. | |
help_list (var tbl, var max_width, var wait_key) | |
Display a list formatted list of commands. | |
help_sort_key (var tbl) | |
Build a sorted table of name (shortname) entry. | |
help_list_key_table (var tbl, var label, var wait_key) | |
Process listing of a table. | |
help_on_topics (var wait_key) | |
Display a list of all topics. | |
help_on_drivers (var wait_key) | |
Display a list of all drivers. | |
help_on_topic (var topic, var wait_key, var no_topics) | |
Display a list of all commands in given topics or the list of drivers. | |
help_on_driver (var driver_name, var wait_key, var no_drivers) | |
Display help a given driver. | |
help_command_usage (var command, var topic, var only_one) | |
Display usage for a command in a given topic. | |
help_on_command (var command_name) | |
Display help on a command. | |
help (var name, var wait_key) | |
Help about a shell command. | |
help_init (var force) | |
Initialize the help system. | |
usage (what, wait_key) | |
Alias for help(). |
|
Add help about a shell command.
|
|
Remove help. The remove_help() function removes help message for given commands. Either long or short name or both can be removed. If topic is nil "general" topic is used. If no more command remains in topic, the topic is removed.
|
|
Display a list formatted list of commands.
|
|
Build a sorted table of name (shortname) entry.
|
|
Process listing of a table. The help_list_key_table() function sort the given table with the help_sort_key() function, finds the longest name and display the list with the help_list() function.
|
|
Display a list of all topics.
|
|
Display a list of all drivers.
|
|
Display a list of all commands in given topics or the list of drivers.
|
|
Display help a given driver.
|
|
Display usage for a command in a given topic.
|
|
Display help on a command. This function is a alias for
|
|
Help about a shell command.
|
|
Initialize the help system.
|
|
Alias for help().
|
dcplaya documentation version 2.0 | Generated on November 2004 by doxygen 1.3.6 |