Help
Command Information |
|
Keyword |
help |
Type |
BuiltIn |
Arguments |
<subject-or-index> |
Usage |
help |
help <subject-or-index> |
Purpose
Get help for built-in commands.
Syntax
To see the available help subjects and display usage:
help
To view help on a particular subject or to retrieve a command or categorical index:
help <subject-or-index>
Parameters
<subject-or-index>
- A specific subject or index (alphabetical or categorical) you need help with.
Examples
Example 1
If Alkani wanted to remind himself what indices were available in the built-in help system, he would type:
help
Alkani would see:
MUCK Reference Manual for FBMuck 6.00 by Revar Desmera <revar@belfry.com> You may get a listing of topics that you can get help on, either sorted Alphabetically or sorted by Category. To get these lists, type: help alpha or help category
Example 2
If Lepus wanted to get an alphabetical list of all the commands, they would type:
help alpha
Lepus would see:
A's abode B's bogus builder C's cheatsheet chown_ok control costs <etc.>
Example 3
If Jaxen wanted to refresh her memory on which command categories were available, she would type:
help categories
Jaxen would see:
List of Topics by Category: You can get more help on the following topics: Basics (Basics) Building Help (BuildHelp) Object Flags (FlagHelp) Object Properties (PropHelp) MUF Programming (ProgCmds) Wizardly Commands (WizCmds) Miscellaneous (MiscHelp) Use 'help <topicname>' to get more information on a topic.
Example 4
If Morticon wanted to get a list of all the Wizard commands, they would type:
help Wizcmds
Morticon would see:
Wizardly Commands @armageddon @bless @boot @delta @dump @force @newpassword @pcreate @restart @restrict @shutdown @toad @unbless @usage @wall
Example 5
If Alkani needed help for the drop command, he would type:
help drop
Alkani would then see the built-in help entry for the drop command.
Caveats
The built-in help system includes not just commands, but other topics of interest such as object flag information and concepts.
Some built-in commands have been replaced by external software product packages. To verify whether or not a built-in command has been replaced with an external software product package, check the global command list on the wiki or in-game by leveraging the global command listing facility with the list parameter, globals #list .
Related
Commands: Help - Getting Help for Commands
Global Commands List - List of SpinDizzy MUCK System Global Commands
Parent Topic
List of SpinDizzy MUCK System Built-In and Local Commands