home *** CD-ROM | disk | FTP | other *** search
- Fnordadel Extended Command Tutorial
-
- There are two types of commands in Citadel. The basic, single-key commands
- are the most commonly used ones, and can be listed by typing [?] at any room
- prompt.
-
- The extended commands allow a lot more variety. Whenever possible, things
- are structured so as to be similar to each other, to reduce confusion.
-
- The extended commands are begun with a mode character, followed by a main
- command, then some optional modifiers, and ended by what it is that will be
- processed. Some commands will take a user name, file name, or date parameter;
- these commands are the only ones that must be ended with a carriage return.
-
- The mode character tells the system you're using an extended command and
- what type of extended command it will be. Normal extended commands that deal
- with rooms, messages and files start with a period, ".". Floor extended
- commands, which deal with entire floors, start with a semi-colon, ";". Door
- extended commands, which permit you to run other programs from within the
- system (e.g. games or utilities), start with an exclamation mark, "!".
-
- Most extended commands will either be "enter" or "read" operations.
- Fnordadel defines any command you use that results in data being sent to the
- system as an "enter" command. Any command that results in data being sent
- from the system to you is a "read" command.
-
- To summarize extended command structure:
-
- <mode> <main command> <options> <what to process>
- <prompts for any additional data>
-
- An example: If you enter the characters ".ryu+n", the system will echo back
- to you something like ".read ymodem user after new messages". It will then
- prompt you for a user name and a date. The command lets you use the Ymodem
- transfer protocol to download all new messages in the current room, from a user
- you specify, entered after a date you specify. The command fits the general
- structure like this:
-
- <mode> = "." for "extended command"
- <main command> = "r" for "read"
- <options> = "yu+" for "ymodem user after"
- <what to process> = "n" for "new messages"
- <prompts> = "which user" and "After when"
-
- At all times, the [?] key is available to provide a menu of available
- commands. For example, typing:
-
- .R(ead) [?]
- .E(nter) [?]
- .T(erminate) [?]
-
- will provide menus or option lists for the appropriate commands.
-
- %%SEE ALSO:
- %ENTER The extended Enter command
- %FLOORS All about Floors
- %READ The extended Read command
- %SUMMARY A list of all the extended commands
- %TOPICS Main help topics list
-