Skip to content

Caller Command Reference

This is the sysop-facing reference for caller commands. It documents the current runtime command surface and should be updated whenever a caller-visible command, menu action, prompt, or default screen changes.

Screen art is not authoritative. A command is available only when it is backed by configured menu routing or by an implemented runtime prompt.

Default Login Menu

The starter login menu is configured by [menus.login].

KeyLabelActionStatus
LLogonloginActive
NNew Usernew_userActive
GGoodbyelogoffActive

Default Main Menu

The starter main menu is configured by [menus.main].

KeyLabelActionStatus
DDoorsdoorsActive
MMessagesmessagesActive
GGoodbyelogoffActive

Door Menu

The doors action opens the live door selector for authenticated callers.

InputBehaviorStatus
Door keyLaunches the enabled configured door with that keyActive
Door numberLaunches the enabled configured door at that displayed list numberActive
Blank lineReturns to the main menuActive

Disabled doors and doors that fail runtime validation are not launchable by callers.

Message Menu

The messages action opens message area selection for authenticated callers.

InputBehaviorStatus
Area keyEnters the enabled message area with that keyActive
Blank lineReturns to the main menuActive

Inside a message area, callers use these prompt commands:

KeyLabelBehaviorStatus
RReadPrompts for a message number and displays itActive
PPostPrompts for subject and multi-line body, then posts a messageActive
YReplyPrompts for a message number and multi-line body, then posts a replyActive
BBackReturns to area selectionActive
Blank lineBackReturns to area selectionActive

Message subjects and bodies must be CP437-compatible before they are stored.

Supported Menu Actions

Menu items map single ASCII keys to safe internal actions. Keys route case-insensitively.

ActionRuntime behaviorStatus
loginRuns the login flowActive
new_userRuns new-user registration before loginActive
doorsOpens the door selectorActive
messagesOpens message area selectionActive
logoffDisconnects with a goodbye messageActive
show_screenDisplays a configured screen and returns to the current menuActive
submenuMoves into the configured target menuActive
noopAccepts the key and performs no visible actionActive

Future And Reserved Commands

No caller key is globally reserved by the router. Future commands become real only when the config maps a key to an implemented action or prompt handler.

Key or labelCurrent statusNotes
S / SysopNot implementedSome art may mention a Sysop command, but there is no caller-side sysop menu action yet. Do not show it in production screens unless it is mapped to a real submenu or action.

When adding a future caller command:

  1. Add or update the menu action or runtime prompt.
  2. Update the default config if the key is part of the starter command set.
  3. Update every starter screen asset that displays the command.
  4. Update this reference in the same change.
  5. Mark planned commands as Not implemented until the runtime route exists.

Source Of Truth

The active default menu keys live in config/oxidebbs.example.toml. The runtime routes configured menu keys through the menu router and handles door/message prompt commands in the telnet session flow.

Apache-2.0 licensed.