menu_commands
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
menu_commands [2020/05/16 20:06] – [MATRIX LOGIN] g00r00 | menu_commands [2023/01/03 02:01] – [SEMAPHORE COMMANDS] avon | ||
---|---|---|---|
Line 77: | Line 77: | ||
===== EXTERNAL DOORS ===== | ===== EXTERNAL DOORS ===== | ||
- | Mystic BBS supports DOOR.SYS, CHAIN.TXT, and DORINFO1.DEF DOS-based door formats, as well as Mystic' | + | Mystic BBS supports DOOR.SYS, CHAIN.TXT, and DORINFO1.DEF DOS-based door formats, as well as Mystic' |
- | In the Linux and OS X versions, Mystic automatically redirects the standard input and output of external programs, allowing many programs that are not even designed for BBSes to be used. | + | In the Linux and macOS versions, Mystic automatically redirects the standard input and output of external programs, allowing many programs that are not even designed for BBSes to be used. From a technical perspective it forks and executes your command line with /bin/sh then creates a watchdog on the child process so that it can help trap lost connections even for programs that cannot detect those types of things natively (like a BBS door would). |
Each door action has a command line which will be executed by the operating system when the action is executed. | Each door action has a command line which will be executed by the operating system when the action is executed. | ||
Line 89: | Line 89: | ||
%H = The current socket handle (added 1.12 A34) | %H = The current socket handle (added 1.12 A34) | ||
%N = The current node number (added 1.12 A34) | %N = The current node number (added 1.12 A34) | ||
- | %P = The node's temp directory | + | %P = Node's temp directory |
%R = User's handle (with spaces) | %R = User's handle (with spaces) | ||
%T = User's time left in minutes | %T = User's time left in minutes | ||
Line 101: | Line 101: | ||
%5 = User's hostname | %5 = User's hostname | ||
+ | All of the door menu commands have a helper function to allow switching | ||
+ | directories without relying on scripting or operating system commands. | ||
+ | " | ||
+ | will remove it and change to the directory specified between the <> characters | ||
+ | prior to executing the command line. | ||
+ | | ||
**The following commands are available for executing external programs and doors:** | **The following commands are available for executing external programs and doors:** | ||
Line 122: | Line 128: | ||
operating systems like OS X and Linux that used a different text file | operating systems like OS X and Linux that used a different text file | ||
format. | format. | ||
+ | | ||
+ | **DX - Execute w/ DOSXTRN (Win32)** | ||
+ | Data: <command line to execute> | ||
+ | | ||
+ | Creates DORINFO1.DEF, | ||
+ | temporarily directory and then runs the command line with DOSXTRN DOS | ||
+ | FOSSIL redirection (as an alternative to NetFossil). | ||
+ | only works for Windows 32-bit systems and requires dosxtrn.exe and | ||
+ | sbbsexec.dll to be placed into the root Mystic BBS directory. | ||
+ | the recommended method to run DOS doors if you are using Windows 32-bit | ||
---- | ---- | ||
Line 201: | Line 217: | ||
use these alternative templates, simply execute FI with the data field of | use these alternative templates, simply execute FI with the data field of | ||
" | " | ||
+ | | ||
+ | NOTE: Even if you do not use file groups for anything, there needs to be | ||
+ | at least one file group created for the Index Lister to function. | ||
**FL - List files in current File Base** | **FL - List files in current File Base** | ||
Line 295: | Line 314: | ||
**GA - View ANSI Gallery** | **GA - View ANSI Gallery** | ||
+ | |||
+ | Data: <path to files> [/ | ||
+ | | ||
+ | Opens the ANSI gallery allowing the user to browse and view ANSI | ||
+ | files (including non-standard terminal size art, Amiga specific | ||
+ | variations with font switching, and more). | ||
+ | should contain the root directory where users will start | ||
+ | browsing from. | ||
+ | | ||
+ | The default template of " | ||
+ | but this can be overridden using the /TEMPLATE option as shown | ||
+ | | ||
+ | Depending on the disk and system speed, reading the contents of a | ||
+ | large directory and checking each file for SAUCE information can | ||
+ | take some time. Adding /NOSAUCE on the optional data field will | ||
+ | disable sauce reading for the file listing. | ||
+ | still be used when viewing a file in the ANSI viewer. | ||
+ | also be set in the gallery template but this will override that | ||
+ | setting. | ||
**GD - Show a display file** | **GD - Show a display file** | ||
Line 367: | Line 405: | ||
**GE - Edit User Settings** | **GE - Edit User Settings** | ||
- | Data: <# of field to edit> | + | Data: <# of field to edit> <Field options> |
| | ||
This command can be used to allow users to edit information in their user | This command can be used to allow users to edit information in their user | ||
Line 385: | Line 423: | ||
9 - Terminal Emulation | 9 - Terminal Emulation | ||
11 - Password | 11 - Password | ||
- | *13 - Alias 14 - Language | + | *13 - Alias 14 - Theme Selection |
15 - Editor Type 16 - Toggle Invisibility | 15 - Editor Type 16 - Toggle Invisibility | ||
17 - File List Type 18 - Toggle Availability | 17 - File List Type 18 - Toggle Availability | ||
Line 396: | Line 434: | ||
31 - Select Archive Type 32 - Default Transfer Protocol | 31 - Select Archive Type 32 - Default Transfer Protocol | ||
33 - Use QWKE Packets | 33 - Use QWKE Packets | ||
+ | |||
+ | Some fields have additional options which can be presented after the field | ||
+ | | ||
+ | |||
+ | 14 Theme Selection | ||
+ | | ||
+ | |||
+ | | ||
+ | | ||
+ | |||
+ | When no extra data is provided, Mystic will prompt the user to select a | ||
+ | | ||
+ | | ||
+ | in the theme editor), then Mystic will automatically switch to that theme | ||
+ | | ||
**GH - Hangup/ | **GH - Hangup/ | ||
Line 406: | Line 459: | ||
**GL - Show Last Callers** | **GL - Show Last Callers** | ||
+ | |||
+ | Data: None or < | ||
+ | | ||
+ | This command shows the last callers who connected to the | ||
+ | BBS. By default the last 10 callers are shown but the | ||
+ | optional data field can contain a number up to 99 that | ||
+ | will show anywhere from 1 to 99 "last callers" | ||
**GO - Goto Menu** | **GO - Goto Menu** | ||
Line 476: | Line 536: | ||
**GX - Execute Mystic Programming Language (MPL) Program** | **GX - Execute Mystic Programming Language (MPL) Program** | ||
- | **GY - Execute Mystic Python (MPY) Script** | + | **GY - Execute Mystic Python |
+ | |||
+ | **GZ - Execute Mystic Python 3.x (MPY) Script** | ||
+ | |||
+ | **G! - Execute Mystic Script (MS) Script** | ||
**G? - Open Mystic Help System** | **G? - Open Mystic Help System** | ||
Line 488: | Line 552: | ||
Both RLOGIN and SSH protocols will require a user and password be supplied in the | Both RLOGIN and SSH protocols will require a user and password be supplied in the | ||
- | optional data. | + | optional data. All outbound connection commands can include a /PROMPT in the optional |
+ | data field which will hide display of the " | ||
**IR - Outbound RLOGIN Connection** | **IR - Outbound RLOGIN Connection** | ||
- | Data: / | + | Data: / |
| | ||
This command creates a gated terminal session to another terminal server | This command creates a gated terminal session to another terminal server | ||
Line 498: | Line 563: | ||
included. | included. | ||
of 513 will be used. | of 513 will be used. | ||
+ | | ||
+ | The terminal type will default to " | ||
+ | be overridden by using the /term=value option. | ||
Mystic will replace @USER@ with the current user's name if it is supplied | Mystic will replace @USER@ with the current user's name if it is supplied | ||
Line 558: | Line 626: | ||
will change to the message area that is linked to the supplied unique ID. | will change to the message area that is linked to the supplied unique ID. | ||
- | **MC - Check Private | + | **MC - Check Private |
- | Data: /NOLIST /UNREAD | + | Data: /NOLIST / |
| | ||
This menu command checks the user's private e-mail box for messages and | This menu command checks the user's private e-mail box for messages and | ||
Line 572: | Line 640: | ||
flagged as " | flagged as " | ||
messages. | messages. | ||
+ | | ||
+ | If the /SCAN option is supplied, Mystic will silently calculate the values | ||
+ | of the waiting and unread mail values without any interaction with the user. | ||
+ | These value can then be displayed with the MW or MU MCI codes. | ||
**MD - Set Message Last Read By Date** | **MD - Set Message Last Read By Date** | ||
Line 650: | Line 722: | ||
use these alternative templates, simply execute MI with the data field of | use these alternative templates, simply execute MI with the data field of | ||
" | " | ||
+ | | ||
+ | NOTE: Even if you do not use groups for anything, there needs to be | ||
+ | at least one message group created for the Index Reader to function. | ||
+ | |||
**ML - Browser/ | **ML - Browser/ | ||
Line 668: | Line 744: | ||
**MN - Scan for New Messages** | **MN - Scan for New Messages** | ||
- | Data: /G /P /M /NOLR /NOFROM /NOREAD | + | Data: /G /P /M /NOLR /NOFROM / |
| | ||
This menu command scans for new messages. The optional data field allows | This menu command scans for new messages. The optional data field allows | ||
Line 690: | Line 766: | ||
option: | option: | ||
- | If /NOFROM is provided, Mystic will only look at the To field when | + | If /NOFROM is provided, Mystic will exclude any messages written |
- | | + | |
If /NOREAD is provided, Mystic will not show messages that have been | If /NOREAD is provided, Mystic will not show messages that have been | ||
- | flagged as " | + | flagged as " |
+ | |||
+ | If /YOU is provided, Mystic will look ONLY at the To field to see if | ||
+ | the message is addressed to you. By default Mystic personal scan will | ||
+ | look at both the From and To fields. | ||
**MP - Post New Message** | **MP - Post New Message** | ||
Line 771: | Line 851: | ||
If " | If " | ||
| | ||
- | **MV - View Sent E-mail** | + | **MV - View Sent Local E-mail** |
- | **MW - Send Private | + | **MW - Send Private |
+ | |||
+ | Data: /TO: /SUBJ: /F | ||
+ | |||
+ | Each user has a personal e-mail box that exists only on the BBS and | ||
+ | this command is used to send a message to a user's personal mailbox. | ||
+ | Messages posted here are shown to the user when the MC menu command | ||
+ | is executed to check their local mailbox. | ||
+ | |||
+ | If / | ||
+ | the supplied username in < | ||
+ | by underscores (_) when supplying this. If this is not supplied then | ||
+ | Mystic will ask the user to who to send the message to. | ||
+ | |||
+ | If /SUBJ: is provided, the post will have its subject automatically | ||
+ | set. Spaces should be replaced with underscores. | ||
+ | supplied then Mystic will ask the user for the message subject. | ||
+ | |||
+ | If /F is provided, the post will be forced meaning the user will not | ||
+ | be able to abort posting the message when they are in the message | ||
+ | editor. | ||
**MX - Post text file to message base** | **MX - Post text file to message base** | ||
Line 835: | Line 935: | ||
**NA - Set Note Action** | **NA - Set Note Action** | ||
+ | |||
+ | Data: Action text | ||
+ | | ||
+ | This command will set the node action which appears when a Who's Online | ||
+ | list is done. The optional data field is required for this command and | ||
+ | specifies the text that will appear in the " | ||
+ | current user. | ||
**NC - Multi-node Teleconference/ | **NC - Multi-node Teleconference/ | ||
Line 841: | Line 948: | ||
**NS - Send Node Message** | **NS - Send Node Message** | ||
+ | |||
+ | Data: None or < | ||
+ | |||
+ | Send message to a node. When the optional data field is | ||
+ | | ||
+ | input a message. | ||
+ | |||
+ | The optional data field can also be used to send a message | ||
+ | to another node, or broadcast a system-wide message to all | ||
+ | | ||
+ | node number must be supplied first followed by a semi-colon | ||
+ | and then the message text. For example, 2;Hello would send | ||
+ | a message to node 2 saying Hello. | ||
+ | node number, the message text will be sent to all users | ||
+ | | ||
+ | |||
+ | Two MCI codes can be used to send the user name and node | ||
+ | | ||
+ | |||
+ | & | ||
+ | & | ||
**NW - Show Who's Online** | **NW - Show Who's Online** | ||
+ | |||
+ | If the /SCAN optional data is supplied, Mystic will not display the who's | ||
+ | online list but instead force recalculation of active users (returned by | ||
+ | the NA MCI code). | ||
----- | ----- | ||
Line 849: | Line 981: | ||
**-B - Break Command Execution** | **-B - Break Command Execution** | ||
+ | This command is an advanced menu command that can be used to break the | ||
+ | current menu execution chain. | ||
+ | that all have the same hotkey and call -B on the second one, only the | ||
+ | first two commands will be run. The 3rd and 4th menu command will be | ||
+ | skipped because the -B menu command breaks the chain of commands. | ||
+ | | ||
**-D - Toggle Access Flags (Set 2)** | **-D - Toggle Access Flags (Set 2)** | ||
Line 904: | Line 1042: | ||
**-I - Set TIMER Counter** | **-I - Set TIMER Counter** | ||
+ | |||
+ | Data: < | ||
+ | | ||
+ | Set the counter of the TIMER menu commands. | ||
+ | TIMER menu command set to execute every 30 seconds and you set the | ||
+ | counter to 29, it will execute 1 second later. | ||
+ | |||
+ | **-M - Set menu Marquee text** | ||
+ | | ||
+ | Data: /ADD < | ||
+ | | ||
+ | This command sets the current menu'' | ||
+ | in the data field. | ||
+ | then the text will be appended onto the existing scrolling Marquee. | ||
+ | data field is /RESET it will reset the Marquee to the configured Marquee | ||
+ | text value. | ||
+ | field. | ||
**-N - Ask Yes/No Question (Default to No)** | **-N - Ask Yes/No Question (Default to No)** | ||
+ | |||
+ | Data: < | ||
+ | | ||
+ | This command will display the text in the data field to the user and then | ||
+ | prompt with a Yes/No question, defaulting to an answer of " | ||
+ | of the user's selection will be stored in the " | ||
+ | the user answers Yes, then the OK ACS will evaluate to TRUE. If the user | ||
+ | answers No, the OK ACS will evaluate to FALSE. | ||
**-P - Ask Password** | **-P - Ask Password** | ||
+ | |||
+ | Data: < | ||
+ | | ||
+ | This command will display the Text portion of the data field, and then prompt | ||
+ | for a password which is defined also in the data field as the second parameter, | ||
+ | separated by a semi-color from the text. | ||
+ | | ||
+ | If the user successfully enters the password, the OK ACS function will evaluate | ||
+ | to TRUE. If the user does not enter the password, the OK ACS function will | ||
+ | evaluate to FALSE. | ||
+ | | ||
+ | For example: | ||
+ | | ||
+ | Data: |CR|09Enter password: |11; | ||
**-R - Set Value of OK ACS flag** | **-R - Set Value of OK ACS flag** | ||
+ | |||
+ | Data: <0 or 1> | ||
+ | | ||
+ | This command will set the value of the OK ACS command. | ||
+ | field is set to 1, then the OK ACS will evaluate TRUE and if set to | ||
+ | 0 it will evaluate to FALSE. | ||
**-S - Add Line Into Node Log** | **-S - Add Line Into Node Log** | ||
+ | |||
+ | Data: < | ||
+ | | ||
+ | This command adds the < | ||
+ | log file. The text will automatically be formatted with the time | ||
+ | stamp and spacing to match other log entries in the log file. | ||
**-V - Validate User E-mail** | **-V - Validate User E-mail** | ||
+ | Data: < | ||
+ | | ||
+ | This command sends an e-mail to the user's e-mail address containing | ||
+ | a code that the user must enter into the BBS after the e-mail is sent. | ||
+ | | ||
+ | Once the user has successfully entered the code, their e-mail address | ||
+ | will be considered validated. | ||
+ | strings to determine if the user has validated their e-mail address. | ||
+ | | ||
+ | If the optional data field contains a security level, then Mystic will | ||
+ | automatically upgrade the user's security profile to the security level | ||
+ | provided after successful validation. | ||
+ | | ||
**-Y - Ask Yes/No Question (Default to Yes)** | **-Y - Ask Yes/No Question (Default to Yes)** | ||
+ | |||
+ | Data: < | ||
+ | | ||
+ | This command will display the text in the data field to the user and then | ||
+ | prompt with a Yes/No question, defaulting to an answer of " | ||
+ | of the user's selection will be stored in the " | ||
+ | the user answers Yes, then the OK ACS will evaluate to TRUE. If the user | ||
+ | answers No, the OK ACS will evaluate to FALSE. | ||
----- | ----- | ||
Line 943: | Line 1153: | ||
**VN - Scan for New Questions** | **VN - Scan for New Questions** | ||
+ | | ||
+ | Data: /F | ||
+ | | ||
+ | Scans for new voting booth questions that the user | ||
+ | has not voted on and presents each question to the | ||
+ | user for voting. | ||
+ | | ||
+ | If the /F option is supplied the user will be forced | ||
+ | to vote on all new questions. | ||
**VR - View Results** | **VR - View Results** | ||
**VV - View/Vote On Voting Booth Questions** | **VV - View/Vote On Voting Booth Questions** | ||
+ | |||
+ | Data: < | ||
+ | | ||
+ | This option allows the user to vote on questions in the voting | ||
+ | booth. | ||
+ | presented a list of all voting questions. | ||
+ | | ||
+ | If the Question number is supplied the user will be taken | ||
+ | directly to the question # supplied in the optional data field. | ||
+ | | ||
+ | If /F is supplied along with a question number then the user will | ||
+ | be forced to vote on the question. | ||
----- | ----- | ||
Line 1018: | Line 1249: | ||
**!C - Create Semaphore File** | **!C - Create Semaphore File** | ||
+ | |||
+ | This command adds three lines of text to the semaphore file: | ||
+ | |||
+ | * Line 1: User ID | ||
+ | * Line 2: User Handle | ||
+ | * Line 3: Node number | ||
+ | |||
+ | If no user was logged in when this was created the ID will be -1 and the handle blank. | ||
**!D - Delete Semaphore File** | **!D - Delete Semaphore File** | ||
Line 1027: | Line 1266: | ||
***# - Menu Editor** | ***# - Menu Editor** | ||
+ | | ||
+ | Data: < | ||
+ | | ||
+ | Opens the menu editor. | ||
+ | the theme to edit. If /THEME is in the data field it will | ||
+ | skip this and open the menu editor with the current theme | ||
+ | already selected. | ||
***A - Archive Editor** | ***A - Archive Editor** | ||
Line 1061: | Line 1307: | ||
***4 - View Log Files** | ***4 - View Log Files** | ||
+ | |||
+ | **F1 - Mass upload files** | ||
+ | Data: None | ||
+ | | ||
+ | Search all file base directories for new files that have not been | ||
+ | added to the file listings and import them into the file listings | ||
+ | |||
+ | **F2 - File List Editor** | ||
+ | Data: None | ||
+ | | ||
+ | Edit the file directory listing of the current file base. This | ||
+ | is the same as using the Edit command from the listing, where | ||
+ | you can perform various editing and maintenance functions or | ||
+ | hatch a file from the file listing. | ||
+ | |||
+ | **F3 - Download File (Send to User)** | ||
+ | Data: <Full Path and Filename> | ||
+ | | ||
+ | Send the file supplied in the data field to the user. The user's | ||
+ | file statistics will not be updated. | ||
+ | | ||
+ | If the optional PROT command is used then the Mystic will select | ||
+ | the protocol automatically that is associated to the hotkey in | ||
+ | the Protocol configuration. | ||
+ | select Zmodem by default. | ||
+ | | ||
+ | If the optional /NOPROMPT command is supplied then Mystic will skip | ||
+ | the "Press a key to start transfer or Q to Quit" prompt | ||
menu_commands.txt · Last modified: 2023/01/20 02:39 by g00r00