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 [2018/04/05 10:32] – [GENERAL COMMANDS] g00r00 | menu_commands [2020/03/27 17:52] – [MESSAGE BASES] g00r00 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== MENU ACTION | + | ====== MENU COMMAND |
+ | ^ Related Categories | ||
+ | | [[themes|Themes]] | | ||
+ | | [[menus|Menus]] | ||
+ | |||
+ | ----- | ||
Mystic BBS has a completely configurable and incredibly flexible menu system that allows for full control over the visual appearance and functionality of the BBS. Each menu consists of the basic settings, and a list of menu commands that define what options are available on each menu. These menu commands can then be assigned one or many " | Mystic BBS has a completely configurable and incredibly flexible menu system that allows for full control over the visual appearance and functionality of the BBS. Each menu consists of the basic settings, and a list of menu commands that define what options are available on each menu. These menu commands can then be assigned one or many " | ||
This section contains a reference to all of the menu actions available in your Mystic BBS as well as any information needed that relates to those actions. | This section contains a reference to all of the menu actions available in your Mystic BBS as well as any information needed that relates to those actions. | ||
+ | |||
+ | The syntax of each menu command is: | ||
+ | |||
+ | Data: available data switches / syntax | ||
+ | | ||
+ | A description of the menu command and available data switches | ||
+ | |||
+ | **Note: Mystic has around 140 different menu commands, not all of them are documented here yet.** | ||
---- | ---- | ||
Line 11: | Line 24: | ||
**AD - Delete Auto Signature** | **AD - Delete Auto Signature** | ||
- | Data: None | + | |
- | | + | |
+ | | ||
**AE - Edit Auto Signature** | **AE - Edit Auto Signature** | ||
- | Data: None | + | |
- | | + | |
+ | | ||
**AT - Toggle Auto Signature** | **AT - Toggle Auto Signature** | ||
- | Data: /NOASK | + | |
- | | + | |
- | | + | |
- | | + | the /NOASK option is supplied on the optional data field, then Mystic |
+ | will toggle the setting without prompting with a Yes/No question. | ||
**AV - View Auto Signature** | **AV - View Auto Signature** | ||
- | Data: None | + | |
- | | + | |
+ | | ||
---- | ---- | ||
Line 34: | Line 51: | ||
**BA - Add new entry to BBS list** | **BA - Add new entry to BBS list** | ||
- | Data: <LIST ID> | + | |
- | | + | |
- | | + | |
+ | list must be specified using the <LIST ID> in the optional data. | ||
**BL - List entries in a BBS list (detailed view)** | **BL - List entries in a BBS list (detailed view)** | ||
- | Data: <LIST ID>; | + | |
- | | + | |
- | | + | |
- | | + | mode. This provides more information than the typical abbreviated list |
- | | + | The <LIST ID> must be specified in the optional data. If "; |
- | | + | appended onto the List ID, then Mystic will prompt and allow the user |
+ | to search for entries in the BBS list. | ||
**BS - List entries in a BBS list (abbreviated view)** | **BS - List entries in a BBS list (abbreviated view)** | ||
- | Data: <LIST ID>; | + | |
- | | + | |
- | | + | |
- | | + | mode. This provides more information than the typical abbreviated list |
- | | + | The <LIST ID> must be specified in the optional data. If "; |
- | | + | appended onto the List ID, then Mystic will prompt and allow the user |
+ | to search for entries in the BBS list. | ||
----- | ----- | ||
Line 63: | Line 83: | ||
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. | ||
+ | %# = User's unique ID | ||
+ | %A = User's real name (spaces are replaced by an underscore) | ||
+ | %B = User's real name (with spaces) | ||
%C = The current user's codepage (CP437 or UTF8) (added 1.12 A39) | %C = The current user's codepage (CP437 or UTF8) (added 1.12 A39) | ||
- | %N = The current node number (added 1.12 A34) | ||
%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) | ||
%P = The node's temp directory | %P = The node's temp directory | ||
- | %# = User' | + | %R = User' |
%T = User's time left in minutes | %T = User's time left in minutes | ||
%U = User's handle (spaces are replaced with an underscore _) | %U = User's handle (spaces are replaced with an underscore _) | ||
Line 81: | Line 104: | ||
**DD - Execute External Program** | **DD - Execute External Program** | ||
- | Data: <command line to execute> /DOS | + | |
- | | + | Creates the DORINFO1.DEF, |
- | | + | temporary directory. |
- | | + | created with full UPPERCASED letters. |
- | | + | to the end of the command line, Mystic will create the drop files in a |
- | | + | DOS text file format, even when used in operating systems like OS X and |
- | | + | Linux that used a different text file format. |
| | ||
**D3 - Execute DOOR32 Door Program** | **D3 - Execute DOOR32 Door Program** | ||
- | Data: <command line to execute> /DOS | + | |
- | | + | |
- | | + | |
- | | + | file is always created in lower cased letters on all operating systems. |
- | | + | If the /DOS option is appended on to the end of the command line, Mystic |
- | | + | will create the drop files in a DOS text file format, even when used in |
- | | + | operating systems like OS X and Linux that used a different text file |
+ | format. | ||
---- | ---- | ||
Line 107: | Line 131: | ||
**FA - Change File Base** | **FA - Change File Base** | ||
- | Data: " | + | |
- | | + | |
- | | + | |
- | | + | and prompt the user to select a new File Base. If /NOLIST is supplied in |
- | | + | data, then Mystic will prompt for the File Base and not automatically |
- | | + | list them first. |
- | | + | next File Base that the user has access to. If the data is set to " |
- | | + | then Mystic will move to the previous File Base. Finally, the Base ID |
- | | + | can be supplied (as shown in the File Base Editor) to automatically change |
+ | the user into a specific File Base. | ||
**FD - Download Files** | **FD - Download Files** | ||
- | Data: None | + | |
- | | + | |
- | | + | |
- | | + | currently has files queued for download, Mystic will ask them first |
- | | + | if they would like to download the queued files. |
- | | + | no or does not have any files in the queue, Mystic will ask them for |
- | | + | a filename to download, and then search the File Bases to allow the |
+ | user to download the requested file. | ||
**FF - Download New/Master File List** | **FF - Download New/Master File List** | ||
- | Data: /NEW, /GLOBAL, None | + | |
- | | + | |
- | | + | |
- | | + | the user's access levels. |
- | | + | generate a list of all files in the File Bases in the user's current |
- | | + | file group. |
- | | + | new files. |
- | | + | will include all File Bases within all File Groups instead of just the |
+ | current group. | ||
**FG - Change File Group** | **FG - Change File Group** | ||
- | Data: " | + | |
- | | + | |
- | | + | |
- | | + | excluding any groups flagged as " |
- | | + | select a File Group. |
- | | + | the next File Group. |
- | | + | the previous File Group. |
- | | + | in the File Group Editor) to automatically change the user into a specific |
- | | + | File Group. |
- | | + | |
- | | + | When joining a file group, Mystic will display the " |
+ | from the theme' | ||
**FI - File Base Index** | **FI - File Base Index** | ||
- | Data: < | + | |
- | | + | |
- | | + | |
- | | + | sorted by group, along with statistics of total and new files for each |
- | | + | base. Users can scroll through and search through this list, and select |
- | | + | File Bases to list files in as well as " |
- | | + | specific bases. |
- | | + | |
- | | + | The data field provides the template name which if left blank defaults to |
- | | + | " |
- | | + | not include a file extension as .ini will be appended to it. |
- | | + | |
- | | + | The template file contains all of the visual configurations for this |
- | | + | function as well as many other options that can completely customize the |
- | | + | experience. |
- | | + | template to file_change.ini, |
- | | + | settings so that it pops up a scroll box of File Bases for the user to |
- | | + | change their current File Base. |
- | | + | |
- | | + | The same could be done to pop up a list of Files Bases that allows the |
- | | + | user to toggle which bases will be included in scans for new files. |
- | | + | use these alternative templates, simply execute FI with the data field of |
+ | " | ||
**FL - List files in current File Base** | **FL - List files in current File Base** | ||
- | Data: SEARCH, None | + | |
- | | + | |
- | | + | |
- | | + | If the word SEARCH is in the data field, Mystic will prompt the user to |
+ | enter a file mask to search for files which match a certain file mask. | ||
**FN - Scan for, and list new files** | **FN - Scan for, and list new files** | ||
- | Data: " | + | |
- | | + | |
- | | + | |
- | | + | the user scanned for new files. |
- | | + | ask the user if they'd like to scan the current base or all bases in |
- | | + | the user's current File Group. |
- | | + | File Bases within all File Groups. |
- | | + | all File Bases in the current group without prompting. |
+ | then Mystic will only scan the user's current File Base. | ||
**FP - Set new file scan date** | **FP - Set new file scan date** | ||
- | Data: None | + | |
- | | + | |
- | | + | |
- | | + | to a user inputted date. After entering the date the user will be |
- | | + | asked if they would like to set the date for the current File Base or |
- | | + | all File Bases. |
+ | date for appropriate Bases. | ||
**FS - Search for files** | **FS - Search for files** | ||
- | Data: None | + | |
- | | + | |
- | | + | |
- | | + | a partial text match against the filename OR any text in the file |
- | | + | description. |
- | | + | if it exists, then prompt the user for search criteria. |
- | | + | user will be asked if they would like to search the current Base, |
+ | all Bases in the group, or all Bases in all Groups. | ||
**FU - Upload a file** | **FU - Upload a file** | ||
- | Data: None | + | |
- | | + | |
- | | + | This command will allow the user to upload a file. If the BBS is |
- | | + | configured to place uploads in a specific File Base, then the file |
- | | + | will be uploaded into that base. Otherwise, it will be uploaded to |
- | | + | the user's currently selected File Base. |
- | | + | |
- | | + | Mystic will first display the " |
- | | + | next ask the user for the file transfer protocol unless the user has |
- | | + | selected a Default protocol in which case it will skip this step. |
- | | + | |
- | | + | Finally, Mystic will prompt to press enter to begin the transfer. |
- | | + | the transfer protocol is anything that was created within the last 25 |
- | | + | years or so, chances are Mystic will never even need to ask for |
- | | + | filenames. |
- | | + | |
- | | + | In fact, a user can upload as many files as they want at one time without |
- | | + | ever entering any file names or information about the file! Mystic |
- | | + | can detect all of the upload files, test them, import descriptions if |
- | | + | they exist, and optionally prompt the user for descriptions if it is |
- | | + | configured to do so (and there wasn't a .DIZ to import). |
- | | + | |
- | | + | In the event a protocol is chosen from the stoneage, like Xmodem, then |
+ | Mystic will simply ask for the filename before beginning the transfer. | ||
+ | |||
+ | If the /current option is specified, Mystic will attempt to upload to | ||
+ | the current file base even if a specific file base has been configured | ||
+ | for uploads | ||
**FV - View contents of a file** | **FV - View contents of a file** | ||
- | Data: None | + | |
- | | + | |
- | | + | |
- | | + | Bases. |
- | | + | searched for throughout all Bases in the user's current file group. |
- | | + | a file is found, the contents will be listed and the user can navigate |
- | | + | through its contents, view and download files within the archive, as |
- | | + | well as view, search and download contents of archives contained with |
+ | that archive. | ||
**FZ - Toggle File Bases for New Scan** | **FZ - Toggle File Bases for New Scan** | ||
- | Data: /ALLGROUP, None | + | |
- | | + | |
- | | + | |
- | | + | scan for new files during a new file scan. The bases listed are the |
- | | + | bases in their current group. |
- | | + | field then Mystic will present them all File Bases in all File Groups |
+ | as long as they meet access requirements. | ||
----- | ----- | ||
Line 256: | Line 296: | ||
//(For information on Random Display Files, see [[display_files|Display Files]])// | //(For information on Random Display Files, see [[display_files|Display Files]])// | ||
- | Data: ([FILE]) or (@[BAUD]@[TRUE/ | + | |
- | | + | |
- | | + | This command sends the contents of a display file to user. There are a |
- | | + | vast number of optional data which can be supplied to change the way in |
+ | which the files are sent. | ||
- | If the [FILE] parameter does not include a directory, then Mystic | + | |
- | | + | will assume the file exists in the user's current Theme' |
- | If the [FILE] parameter does does not include an file extension, Mystic | + | |
- | | + | will display .ANS if it exists or .ASC if the ANSI version does not exist |
- | | + | In this mode, Mystic will also apply the Random Display File logic to the |
- | | + | base filename, selecting a random file if enabled. |
- | If [/NEW] is added to the end of the data command, Mystic will only | + | |
- | | + | display the file if it is NEW. This means if the date of the display |
- | | + | file is newer than the user's last call into the BBS. |
- | The (@[BAUD]@[TRUE/ | + | If [/ABORT] is added to the end of the data command, Mystic will not allow |
- | | + | the user to abort displaying |
- | | + | |
- | | + | |
- | Some examples | + | If [/MCI] is added to the end of the data command, Mystic will not process |
+ | MCI codes of any kind, including pipe colors, while display | ||
- | | + | The (@[BAUD]@[TRUE/ |
- | Result: Mystic will display " | + | emulate a baud rate while displaying, as well as whether or not to pause |
- | directory or " | + | the screen during display (TRUE) or only at the end (END), or not at all |
- | or the user does not have ANSI. If the .AN1 or .AS1 | + | (FALSE). |
- | extension exists, Mystic will apply its random display file | + | |
- | logic to the file and select a file randomly. | + | Some examples of the DATA commands: |
- | + | ||
- | Data: c: | + | Data: myfile |
- | Result: Mystic displays the file if it exists. | + | |
- | + | | |
- | Data: c: | + | |
- | Result: Mystic will display the ANSI version if it exists or the | + | |
- | ASCII version if it does not. (.ans and .asc respectively) | + | |
- | + | ||
- | Data: bbsnews /NEW | + | |
- | Result: Mystic will display bbsnews from the user theme text | + | |
- | directory but only if it has been edited since the user' | + | |
- | last call | + | |
- | + | | |
- | Data: @19200@FALSE@myfile | + | |
- | Result: Mystic will display myfile from the user theme text directory | + | |
- | applying the same extension rules. | + | |
- | baud rate which works on all terminals, and it will NOT pause | + | |
- | + | | |
- | Data: @0@END@myfile | + | |
- | Result: Mystic will display myfile from the user theme text directory | + | |
- | applying the same extension rules. | + | |
- | at full speed and only pause at the END of the display file. | + | |
+ | | ||
+ | | ||
- | | + | Data: @0@END@myfile |
- | Result: Mystic will display myfile.txt from the specified directory | + | |
- | while emulating 38400 baud rate and pausing on each page but | + | |
- | only if it was updated since the user's last login. | + | at full speed and only pause at the END of the display file. |
+ | |||
+ | Data: @38400@FALSE@c: | ||
+ | | ||
+ | | ||
+ | | ||
**GV - View a display file in ANSI viewer** | **GV - View a display file in ANSI viewer** | ||
- | + | | |
- | | + | Data: < |
- | | + | |
- | | + | The ANSI viewer shows a file within the full screen, allowing the user to |
- | | + | scroll up and down through the file using their arrow keys, page up/down, |
- | | + | and home keys. The viewer also has the ability to extract and display |
- | | + | SAUCE tags to get the artist and group information. |
- | | + | also display the file in a " |
- | | + | finish using the supplied emulated baud rate. Several values are required |
+ | in the DATA field for this command, separated by a semi-colon: | ||
- | < | + | |
- | | + | current theme' |
- | | + | configuration of the template, see **TO BE COMPLETED** section. |
- | < | + | |
- | | + | help from within the viewer. |
- | < | + | |
- | | + | user selects < |
- | | + | a full speed display. |
- | + | ||
- | < | + | |
- | If no file extension is provided, " | + | |
- | is provided, Mystic will use the current theme' | + | |
- | + | ||
- | | + | |
- | + | ||
- | < | + | |
- | | + | |
- | + | ||
- | | + | |
- | Command: GV | + | < |
- | Data: ansigalv; | + | If no file extension is provided, |
- | + | is provided, Mystic will use the current theme' | |
- | Command: GV | + | |
- | Data: ansigalv; | + | Optional paramenters: |
- | + | ||
- | The first example will execute | + | |
- | | + | |
- | of 38400 if a user presses < | + | |
- | file "myansifile" | + | |
- | and a file extension, Mystic will use " | + | |
- | text directory. | + | |
- | The second example is the same as the first, except it displays the | + | <END> if "; |
- | | + | viewing at the end of the file instead of the beginning. |
- | | + | |
+ | Examples: | ||
+ | |||
+ | | ||
+ | Data: ansigalv; | ||
+ | |||
+ | | ||
+ | Data: ansigalv; | ||
+ | |||
+ | The first example will execute the display file viewer using the | ||
+ | template " | ||
+ | of 38400 if a user presses < | ||
+ | file " | ||
+ | and a file extension, Mystic will use " | ||
+ | text directory. | ||
+ | |||
+ | | ||
+ | file at full speed instead of 38400 baud emulation, and also starts | ||
+ | showing the file at the end of the file, rather than the beginning. | ||
| | ||
---- | ---- | ||
Line 376: | Line 424: | ||
**IR - Outbound RLOGIN Connection** | **IR - Outbound RLOGIN Connection** | ||
- | Data: / | + | |
- | | + | |
- | | + | |
- | | + | using the RLOGIN protocol. |
- | | + | included. |
+ | of 513 will be used. | ||
- | Mystic will replace @USER@ with the current user's name if it is supplied | + | |
- | | + | in either or both of the /user or /pass options. |
- | The user's password cannot be sent using an @code@ and must be manually | + | |
- | | + | supplied due to the password encryption. |
- | | + | encrypt a users password, meaning at no time does it ever know or store |
- | | + | your actual password. |
**IS - Outbound SSH Connection** | **IS - Outbound SSH Connection** | ||
- | Data: / | + | |
- | | + | |
- | | + | |
- | | + | using the SSH protocol. |
- | | + | included. |
+ | of 22 will be used. | ||
- | Mystic will replace @USER@ with the current user's name if it is supplied | + | |
- | | + | in either or both of the /user or /pass options. |
- | The user's password cannot be sent using an @code@ and must be manually | + | |
- | | + | supplied due to the password encryption. |
- | | + | encrypt a users password, meaning at no time does it ever know or store |
- | | + | your actual password. |
**IT - Outbound TELNET Connection** | **IT - Outbound TELNET Connection** | ||
- | Data: / | + | |
- | | + | |
- | | + | |
- | | + | using the TELNET protocol. |
+ | /port option is not provided then the default port of 23 will be used. | ||
+ | |||
+ | ----- | ||
+ | ===== MESSAGE BASES ===== | ||
+ | |||
+ | The following menu commands related to the Message Bases and reading/ | ||
+ | |||
+ | **MA - Change Message Area** | ||
+ | |||
+ | Data: # + - NOLIST | ||
+ | |||
+ | This menu command allows the user to change to a new message area. If | ||
+ | no optional data is present, then a list of message areas will be shown | ||
+ | to the user. | ||
+ | |||
+ | If the + sign is on the optional data field, Mystic will select the | ||
+ | next available message area that the user has access to. | ||
+ | |||
+ | If the - sign is on the optional data field, Mystic will select the | ||
+ | previous available message area that the user has access to. | ||
+ | |||
+ | If NOLIST is provided on the optional data field, Mystic will prompt the | ||
+ | user to select a message area but will not show the list of areas unless | ||
+ | the user asks to see it by entering ? to list. | ||
+ | |||
+ | If a message area Unique ID is presented on the option data field, Mystic | ||
+ | will change to the message area that is linked to the supplied unique ID. | ||
+ | |||
+ | **MC - Check Private E-mail** | ||
+ | |||
+ | Data: /NOLIST /UNREAD | ||
+ | |||
+ | This menu command checks the user's private e-mail box for messages and | ||
+ | provides a list of all messages in the private mailbox followed by a | ||
+ | prompt asking the user if they would like to read the messages. | ||
+ | |||
+ | If the /NOLIST option is supplied on the optional data field, Mystic will | ||
+ | skip listing the messages and go directly to reading new e-mail messages. | ||
+ | |||
+ | If the /UNREAD option is supplied, Mystic will list only messages that are | ||
+ | flagged as " | ||
+ | messages. | ||
+ | |||
+ | **MN - Scan for New Messages** | ||
+ | |||
+ | Data: /G /P /M /NOLR /NOFROM /NOREAD | ||
+ | |||
+ | This menu command scans for new messages. The optional data field allows | ||
+ | for modifiers to the default behavior. | ||
+ | is provided, Mystic will scan for all new messages in the user's current | ||
+ | message group. | ||
+ | |||
+ | If /P is provided in optional data, Mystic will only scan for personal | ||
+ | messages (messages From or To the user) | ||
+ | |||
+ | If /G is provided in optional data, Mystic will scan all message bases | ||
+ | in all groups. | ||
+ | |||
+ | If /M is provided in optional data, Mystic will forced the user to read | ||
+ | the new messages (mandatory read). | ||
+ | |||
+ | If /NOLR is provided, Mystic will not update the user's "last read" | ||
+ | message when performing the scan. | ||
+ | |||
+ | The following commands augment the behavior of the /P personal scan | ||
+ | option: | ||
+ | |||
+ | If /NOFROM is provided, Mystic will only look at the To field when | ||
+ | scanning for new personal messages (instead of both To and From) | ||
+ | |||
+ | If /NOREAD is provided, Mystic will not show messages that have been | ||
+ | flagged as " | ||
+ | |||
+ | **MX - Post text file to message base** | ||
+ | |||
+ | Data: < | ||
+ | |||
+ | This menu command posts a text file to a message base. It will allow | ||
+ | a file up to 10,000 lines to be posted and will automatically split | ||
+ | them into multiple posts of 1000 lines each if the post is more than | ||
+ | 1000 lines (including automatically appending a message count to the | ||
+ | end of the subject ie: (1 of 3)" | ||
+ | |||
+ | If you want to post an ANSI file, it should be saved with a 79 column | ||
+ | width using a capable ANSI editor. | ||
+ | can save an ANSI file properly formatted for message posting by | ||
+ | specifying a column length of 79 in the Save dialog. | ||
+ | |||
+ | The optional data field is required for this to work, except for the | ||
+ | Network Address field which is only required if you are posting to a | ||
+ | NetMail base. Each value should be separated by a semi-colon (;). | ||
+ | |||
+ | The < | ||
+ | should be a text file with up to 79 columns per line and up to 10,000 | ||
+ | lines. | ||
+ | |||
+ | The <Base ID> is the Message Base ID as found in the Message Base Editor | ||
+ | |||
+ | < | ||
+ | |||
+ | <To> The To field of the message | ||
+ | |||
+ | < | ||
+ | |||
+ | [Network Address] is the To network address used when posting to a | ||
+ | NetMail base. This field can be excluded when not posting Netmail. | ||
+ | |||
+ | Examples: | ||
+ | |||
+ | c: | ||
+ | c: | ||
menu_commands.txt · Last modified: 2023/01/20 02:39 by g00r00