Mystic BBS Wiki

User Tools

Site Tools

Trace:
menu_commands

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
menu_commands [2018/12/14 04:52] – [GENERAL COMMANDS] g00r00menu_commands [2019/03/24 21:17] – g00r00
Line 1: Line 1:
-====== MENU ACTION REFERENCE ======+====== MENU COMMAND REFERENCE ======
  
 +^ 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 "actions" to perform when the item is selected.  Each action may also have parameters that can be or will be required to be specified in the "data" field. 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 "actions" to perform when the item is selected.  Each action may also have parameters that can be or will be required to be specified in the "data" field.
  
 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.
 +
 +**Note: Mystic has around 140 different menu commands, not all of them are documented here yet.**
  
 ---- ----
Line 47: Line 54:
  
 **BS - List entries in a BBS list (abbreviated view)** **BS - List entries in a BBS list (abbreviated view)**
-         Data: <LIST ID>;SEARCH +  Data: <LIST ID>;SEARCH 
-  Description: This option allows the user view the BBS list using the abbreviated view +   
-               mode.  This provides more information than the typical abbreviated list +  This option allows the user view the BBS list using the abbreviated view 
-               The <LIST ID> must be specified in the optional data.  If ";SEARCH" is +  mode.  This provides more information than the typical abbreviated list 
-               appended onto the List ID, then Mystic will prompt and allow the user +  The <LIST ID> must be specified in the optional data.  If ";SEARCH" is 
-               to search for entries in the BBS list.+  appended onto the List ID, then Mystic will prompt and allow the user 
 +  to search for entries in the BBS list.
  
 ----- -----
Line 63: Line 71:
 Each door action has a command line which will be executed by the operating system when the action is executed.  There are a number of codes that Mystic will replace with specific values if they are found in the command line: Each door action has a command line which will be executed by the operating system when the action is executed.  There are a number of codes that Mystic will replace with specific values if they are found in the command line:
  
 +   %# = 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's unique ID+   %R = User's handle (with spaces)
    %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 207: Line 218:
  
 **FU - Upload a file** **FU - Upload a file**
-         Data: None+         Data: /current
   Description: This command will allow the user to upload a file.  If the BBS is   Description: 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                configured to place uploads in a specific File Base, then the file
Line 230: Line 241:
                In the event a protocol is chosen from the stoneage, like Xmodem, then                In the event a protocol is chosen from the stoneage, like Xmodem, then
                Mystic will simply ask for the filename before beginning the transfer.                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**
Line 418: Line 433:
                using the TELNET protocol.  The /addr option must be included.  If the                using the TELNET protocol.  The /addr option must be included.  If the
                /port option is not provided then the default port of 23 will be used.                /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/posting of messages.
 +
 +**MN - Scan for New Messages**
 +
 +         Data: /G /P /M /NOLR /NOFROM /NOREAD
 +  Description: This menu command scans for new messages. The optional data field allows
 +               for modifiers to the default behavior.  By default if no optional data
 +               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 "Read" by the user. 
 +
 +**MX - Post text file to message base**
 +
 +         Data: <File>;<Base ID>;<From>;<To>;<Subject>;[Network To Address]
 +  Description: 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.  Mystic's own built in 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 <File> field contains the filename to post to the base.  This file
 +               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
 +               
 +               <From>  The From field of the message
 +             
 +               <To> The To field of the message
 +               
 +               <Subject> The Subject 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:\mystic\temp1\msgtext.txt;1;g00r00;All;Statistics for January
 +               c:\mystic\temp1\msgtext.txt;3;g00r00;Avon;Automated post;21:1/101
  
menu_commands.txt · Last modified: 2023/01/20 02:39 by g00r00
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki