====== Menus and commands ======

Everything a caller does after logging in is driven by **menus**. A menu is a ''.PBM'' file in your ''MENUS'' folder, paired with a screen (ANSI or ASCII text in ''TXTFILES'') that is shown to the caller. Each menu holds a list of **items**. An item has a hot key, some text, a **function** (what it does), optional **data** for the function, and access rules.

Menus, security levels and flags work the way they did in ProBoard 2.x; only the editor is new. You edit menus in **PBConfig > System > Menu Editor**.

===== Where things live =====

^ Item ^ Where ^
| Menu files (''.PBM'') | ''MENUS'' |
| Menu screens (''.ANS'', ''.ASC'') | ''TXTFILES'' |
| ''GLOBAL.PBM'' | ''MENUS''. Its items are available at **every** menu, and it holds the standard "/" commands. |
| The menu a caller starts at | Set in the **Language Editor** and the new-user settings. |

===== An item =====

  * **Hotkey.** The key a caller presses. The special hot key ''/'' makes the item a **command word** (see [[v4:menus:commands|"/" commands]]).
  * **Text.** What is drawn for the item on a menu that is generated for the caller. Leave it as ''%%;%%'' for an item that should not show on the menu.
  * **Function and data.** See the table below.
  * **Access rules.** Level, flags, age, time left, time frame, nodes, and a password. A caller who fails the rules does not see the item and cannot use it.

===== Menu functions =====

The function numbers below are fixed; they are what the Menu Editor offers in its picker.

^ Number ^ Function ^ Number ^ Function ^
| 0 | Display only | 42 | Toggle hot keys |
| 1 | Go to a menu | 43 | Clear marked messages |
| 2 | Go to a menu and come back (gosub) | 44 | Reset combined boards |
| 3 | Return to the previous menu | 45 | Display a text file and wait |
| 4 | Clear the menu stack and go to a menu | 46 | Change access (flags and level) |
| 5 | Show an ANS or ASC file | 47 | Make a log entry |
| 6 | Change state | 48 | Top lists |
| 7 | Shell | 49 | Set message area |
| 8 | Version information | 50 | Show users online |
| 9 | Log off | 51 | List last callers |
| 10 | Usage graph by hour | 52 | User editor |
| 11 | Chat request (page the sysop) | 53 | Multi-line chat |
| 12 | Questionnaire | 54 | Set file area |
| 13 | User list | 55 | View a GIF |
| 14 | Time information | 56 | Toggle IBM characters |
| 15 | View an ANS or ASC file and wait | 57 | Change phone number |
| 16 | Change city | 58 | Change data phone number |
| 17 | Change password | 59 | Change handle |
| 18 | Change screen size | 60 | Load a ProBoard SDK file (plug-in) |
| 19 | Toggle clear screen | 61 | Show a bulletin |
| 20 | Toggle the "more" prompt | 62 | Toggle AVT/0 |
| 21 | Toggle ANSI graphics | 63 | Toggle AVT/0+ |
| 22 | Check for mail | 64 | Show general usage graph |
| 23 | Read messages | 65 | Show ANS, ASC or RIP with hot keys |
| 24 | Scan messages | 66 | Change RIP font |
| 25 | Quick scan messages | 67 | Toggle RIP graphics |
| 26 | Usage graph by day | 68 | Edit file tags |
| 27 | Write a message | 69 | Select a language |
| 28 | Combined boards select | 70 | Change date format |
| 29 | Usage graph by week | 71 | Change address |
| 30 | Show directory | 72 | Change fax phone |
| 31 | List files | 73 | Change country |
| 32 | Download a file | 74 | Change default protocol |
| 33 | Upload a file | 75 | Select message area group |
| 34 | View an archive | 76 | Select file area group |
| 35 | Keyword search | 77 | Run a door (DOS or native) |
| 36 | Filename search | 78 | Change e-mail address |
| 37 | Show new files | 79 | Select message header style |
| 38 | View a file | 80 | Read or delete inter-BBS messages |
| 39 | Display a named file | 81 | Inter-BBS do-not-disturb on or off |
| 40 | Display ANS or ASC with hot keys | 82 | Change my message avatar |
| 41 | Toggle the full-screen editor | | |

//The data string depends on the function. For Go to a menu it is the menu's name; for Run a door it is the door's name; for Load a ProBoard SDK file it is the plug-in name and options, such as ''/I BBSLINK LORD''.//

===== Changing menus safely =====

  * Make a copy of the ''MENUS'' folder before you start.
  * After you save a menu, a caller sees the change the next time they enter that menu.
  * An item whose function is **Display only** shows text and does nothing. Do not use it for a command word.

See [[v4:menus:commands|"/" commands]] for command words and [[v4:menus:matrix|The Matrix logon]] for an optional "elite BBS" front door.