home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / com / bbs / simplex / urgent2.doc < prev   
Text File  |  1992-08-16  |  19KB  |  468 lines
  1. This document contains any important information that I deem important
  2. for you to read.  Please give it a look over.
  3.  
  4.  
  5. 1) Contacting Chris Laforet Software
  6.  
  7.  You may send me mail through any of the following:
  8.  
  9.  Programmer's Oasis BBS, USA .... 919/226-6984
  10.  Programmer's Oasis 2 BBS, USA .. 919/226-7136
  11.  Fidonet Email .................. Chris Laforet @ 1:151/401 or 1:151/402
  12.  Compuserve Email ............... User ID: 76120,110
  13.  US Mail ........................ Chris Laforet Software
  14.                                   511-D Poplar St
  15.                                   Graham, NC  27253
  16.  
  17.  These I check occassionally:
  18.  
  19.  BIX Email....................... User ID: Laforet
  20.  GEnie Email .................... User ID: XTX74591
  21.  
  22.  
  23. 2) Fidonet users can access a Simplex echo
  24.  
  25.   Users who wish to hook into the private Simplex echo can send me
  26. Fidonet mail at 1:151/401 or 1:151/402 and request it.  What we will do
  27. is set up a passworded session for the mailers and you will have to
  28. poll for mail once or twice a week.  The tag name off the echo is
  29. SIMPLEX.  In your message, send me your node information, the password
  30. you wish the mailers to use (<= 8 letters, case is significant) and
  31. I'll set it up for you.
  32.  
  33.  
  34. 3) Help files
  35.  
  36.   The help files in help.zip are the .asc and .ans formats needed by
  37. Simplex.  The .src files are the source files in SANSI-compilable
  38. format in case you wish to change the help files.
  39.  
  40.  
  41. 4) DOS Overlay version of Simplex
  42.  
  43.   DOS users can get a copy of SIMPLEXO.EXE from any of the following
  44. locations.  It saves about 200K of memory over the regular SIMPLEX.EXE
  45. while running.  If you run door games, it might be better to use this. 
  46. It is not included with the distribution ZIP because it would make it
  47. too large.  Simplexo.exe can be downloaded from the Simplex file area on 
  48. any of the following BBSes:
  49.  
  50.  Programmer's Oasis BBS, USA .... 919/226-6984 HST,2400,1200,300 N,8,1
  51.  Programmer's Oasis 2 BBS, USA .. 919/226-7136 HST,2400,1200,300 N,8,1
  52.  Stardate 1990 BBS, USA ......... 919/376-8432 HST,2400,1200,300 N,8,1
  53.          
  54.  
  55. 5) Developing Utilities for Simplex
  56.  
  57.   You are encouraged to develop external utilities for Simplex.  Please
  58. feel free to ship them over to the Simplex areas on any of those BBSes. 
  59. The data structures for Simplex are in this doc and are BYTE aligned
  60. (-Zp1 in MSC).  If you need extra information, contact Chris Laforet at
  61. any of the above addresses and we'll see what we can do!
  62.  
  63.  
  64. 6) Data information and structures for Simplex v 1.00
  65.  
  66.  
  67. /* these macros access the user_flags bit-mapped options */
  68.  
  69. #define USER_CLS               0x1         /* send cls codes */
  70. #define USER_MORE              0x2         /* use more? paging */
  71. #define USER_ANSI              0x4         /* use ansi */
  72. #define USER_EDITOR            0x8         /* use full screen editor */
  73. #define USER_EXPERT            0x10      /* expert (abbreviated) menus */
  74. #define USER_FILEATTACH        0x20      /* allow user to fileattach in netmail areas? */
  75. #define USER_DELETED           0x8000      /* user is deleted pending purge */
  76.  
  77.  
  78. /* these macros access the menu type options */
  79.  
  80. #define MENU_SHOW              0x0         /* show menu line only */
  81. #define MENU_CALL              0x1         /* call next menu */
  82. #define MENU_GOTO              0x2         /* goto next menu - no return */
  83. #define MENU_RET               0x3         /* return to previous menu */
  84.  
  85. #define MENU_ENTER             0x10      /* enter a message */
  86. #define MENU_READ              0x11      /* read a message */
  87. #define MENU_SCAN              0x12      /* scan messages */
  88. #define MENU_QSCAN             0x13      /* quickscan messages */
  89. #define MENU_USERLIST          0x14      /* search/display users list */
  90. #define MENU_NETSEARCH         0x15      /* search for netmail address */
  91. #define MENU_FREQ              0x16      /* generate File Request to netmail node */
  92.  
  93. #define MENU_LIST              0x20      /* list file.bbs listing */
  94. #define MENU_UPLOAD            0x21      /* upload files to area */
  95. #define MENU_DOWNLOAD          0x22      /* download files from area */
  96. #define MENU_RAW               0x23      /* raw directory list in area */
  97. #define MENU_CONTENTS          0x24      /* view archive contents */
  98. #define MENU_NEW               0x25      /* show new files on system */
  99. #define MENU_SRCHNAME          0x26      /* search for file name on system */
  100. #define MENU_SRCHKEY           0x27      /* search for keyword on system */
  101. #define MENU_KILL              0x28      /* kill/delete file in area */
  102. #define MENU_READFILE          0x29      /* read a textfile in file area */
  103. #define MENU_DOWNLOAD_FILE     0x2a      /* download 1 file from area */
  104. #define MENU_MOVEFILES         0x2b      /* move files to another area */
  105.  
  106. #define MENU_SHOWFILE          0x30      /* show an ansi/ascii file */
  107. #define MENU_SHOWHOT           0x31      /* show an ansi/ascii file with active keys */
  108. #define MENU_SHOWWAIT          0x32      /* show an ansi/ascii file with wait for Enter */
  109. #define MENU_QUESTION          0x33      /* show a questionaire file */
  110.  
  111. #define MENU_CITY              0x40      /* change users city/state */
  112. #define MENU_PASSWORD          0x41      /* change users password */
  113. #define MENU_CLS               0x42      /* toggle users cls state */
  114. #define MENU_MORE              0x43      /* toggle users more state */
  115. #define MENU_SCREENLEN         0x44      /* change users screen len */
  116. #define MENU_ANSI              0x45      /* toggle ansi on/off */
  117. #define MENU_EDITOR            0x46      /* toggle between line and full editor */
  118. #define MENU_EXPERT            0x47      /* toggle between novice and expert mode */
  119. #define MENU_HOMEPHONE         0x48      /* change home phone number */
  120. #define MENU_DATAPHONE         0x49      /* change data phone number */
  121.  
  122. #define MENU_ADENTER           0x50      /* enter an advertisement */
  123. #define MENU_ADREAD            0x51      /* read advertisements */
  124. #define MENU_ADSCAN            0x52      /* scan advertisments */
  125.  
  126. #define MENU_RUN               0xf0      /* run a program from BBS */
  127. #define MENU_EXIT              0xf1      /* exit BBS with errorlevel */
  128. #define MENU_VERS              0xf2      /* show BBS version info */
  129. #define MENU_USAGE             0xf3      /* show users time usage and dl/ul info */
  130. #define MENU_YELL              0xf4      /* yell for sysop */
  131. #define MENU_CLOCK             0xf5      /* show clock for time synchronizing */
  132. #define MENU_CHECKMAIL         0xf6      /* check for mail addressed to user */
  133. #define MENU_USERUPGRADE       0xf7      /* sysop's user-upgrade option */
  134. #define MENU_LOGOFF            0xff      /* hangup and log off */
  135.  
  136. #define M_SIGNATURE            0xa442      /* proves file is actual menu file */
  137.  
  138.  
  139. /* these macros are for message board flags */
  140.  
  141. #define MSG_LOCAL_FILEATTACH   0x0
  142. #define MSG_LOCAL              0x1
  143. #define MSG_ECHO               0x2
  144. #define MSG_NET                0x4
  145. #define MSG_PRIVATE            0x8         /* messages are private */
  146. #define MSG_PUBLIC             0x10      /* messages are public */
  147. #define MSG_ALIAS              0x20      /* aliases are allowed */
  148.  
  149.  
  150. /* these macros are for message header flags */
  151.       
  152. #define MSGH_DELETED           0x1
  153. #define MSGH_PRIVATE           0x2
  154. #define MSGH_RECEIVED          0x4
  155. #define MSGH_NET_UNSENT        0x8      /* is unsent Netmail message */
  156. #define MSGH_NET               0x10   /* is Netmail */
  157. #define MSGH_ECHO_UNSENT       0x20   /* is unsent Echomail message */
  158. #define MSGH_ECHO              0x40   /* is echomail */
  159. #define MSGH_LOCAL_FILEATTACH  0x80   /* is local fileattach */
  160.  
  161. #define NET_KILLSENT           0x100   /* kill/sent netmail */
  162. #define NET_SENT               0x200   /* netmail sent */
  163. #define NET_FILEATTACH         0x400   /* file(s) attached */
  164. #define NET_CRASH              0x800   /* crashmail */
  165. #define NET_RECEIPT_REQ        0x1000   /* receipt requested */
  166. #define NET_AUDIT_REQ          0x2000   /* audit request */
  167. #define NET_RECEIPT            0x4000   /* return receipt */
  168.  
  169.  
  170. /* these macros are for advertisement board header flags */
  171.  
  172. #define ADH_DELETED            0x1
  173. #define ADH_REPLIES            0x2
  174.  
  175.  
  176. /* color macros */
  177.  
  178. #define BLACK                  0
  179. #define BLUE                   1
  180. #define GREEN                  2
  181. #define CYAN                   3
  182. #define RED                    4
  183. #define MAGENTA                5
  184. #define BROWN                  6
  185. #define WHITE                  7
  186. #define BRIGHT                 8
  187. #define BLINK                  0x80
  188. #define ON_BLACK               0x0
  189. #define ON_BLUE                0x10
  190. #define ON_GREEN               0x20
  191. #define ON_CYAN                0x30
  192. #define ON_RED                 0x40
  193. #define ON_MAGENTA             0x50
  194. #define ON_BROWN               0x60
  195. #define ON_WHITE               0x70
  196.  
  197.  
  198. struct user
  199.    {
  200.    char user_name[41];
  201.    char user_password[16];
  202.    char user_city[31];
  203.    char user_home[15];            /* users home number */
  204.    char user_data[15];            /* users data/business number */
  205.    unsigned char user_priv;      /* users privilege level */
  206.    char user_screenlen;         /* length of users screen in lines */
  207.    int user_credit;            /* credit in cents for fidomail */
  208.    int user_flags;               /* bit mapped flags for options */
  209.  
  210.    int user_firstdate;            /* first date user called */
  211.    int user_lastdate;            /* last date called */
  212.    int user_lasttime;            /* last time called */
  213.    int user_calls;               /* number of calls to the BBS */
  214.    int user_timeused;            /* amount of time used for the day (minutes) */
  215.  
  216.    int user_upload;            /* number of uploads */
  217.    long user_uploadbytes;         /* number of bytes uploaded */
  218.    int user_dnload;            /* number of downloads */
  219.    long user_dnloadbytes;         /* number of bytes downloaded */
  220.  
  221.    char user_reserved[6];         /* reserved for later use */
  222.    };
  223.  
  224.  
  225. struct prompt
  226.    {
  227.    int prompt_sig;               /* signiture for valid menu file 0xa442 */
  228.    char prompt_color;
  229.    char prompt_hilite;
  230.    char prompt_string[56];         /* string to show */
  231.    };
  232.  
  233.  
  234. struct menu
  235.    {
  236.    int menu_number;            /* line number */
  237.    unsigned char menu_type;      /* type of choice */
  238.    char menu_key;               /* key to initiate choice */
  239.    unsigned char menu_priv;      /* user priv to see/use choice */
  240.    char menu_auto;               /* automatic execution if true */
  241.    char menu_color;            /* color of choice */
  242.    char menu_hilite;            /* color of hilight */
  243.    char menu_expert;            /* if true show when expert mode is on */
  244.    char menu_line[71];            /* line to show on screen */
  245.    char menu_data[71];          /* data line for menu option */
  246.    char menu_deleted;
  247.    };
  248.  
  249.  
  250. struct cfg
  251.    {
  252.    int cfg_baud;               /* maximum baud rate */
  253.    int cfg_port;               /* port number */
  254.    char cfg_init[61];            /* modem initialization string */
  255.    char cfg_resp[21];            /* normal modem response string */
  256.    char cfg_resp3[21];            /* 300 baud response */
  257.    char cfg_resp12[21];         /* 1200 baud response */
  258.    char cfg_resp24[21];         /* 2400 baud response */
  259.    char cfg_resp48[21];         /* 4800 baud response */
  260.    char cfg_resp96[21];         /* 9600 baud response */
  261.    char cfg_resp192[21];         /* 19200 baud response */
  262.    char cfg_ring[21];            /* ring response */
  263.    char cfg_answer[21];         /* answer string */
  264.    char cfg_hangup[21];         /* hangup string */
  265.    char cfg_busy[21];            /* offhook string */
  266.    int cfg_flags;               /* flags for setup */
  267.  
  268.    int cfg_minbaud;            /* minimum connect rate allowd on BBS */
  269.    int cfg_ansibaud;            /* minimum baud for ansi */
  270.    int cfg_dlstart;            /* start time for downloads */
  271.    int cfg_dlstop;               /* stop time for downloads */
  272.  
  273.    int cfg_zone;
  274.    int cfg_net;
  275.    int cfg_node;
  276.    int cfg_akazone[5];
  277.    int cfg_akanet[5];
  278.    int cfg_akanode[5];
  279.  
  280.    char cfg_sysopname[41];         /* sysop's name */
  281.    char cfg_bbsname[61];         /* BBS name */
  282.    char cfg_origin[66];         /* origin line */
  283.    char cfg_menupath[61];         /* path to menu files */
  284.    char cfg_screenpath[61];      /* path to screen files */
  285.    char cfg_nodepath[61];         /* path to nodelist */
  286.    char cfg_fapath[61];         /* path to local fileattaches */
  287.  
  288.    char cfg_netpath[61];         /* path for net messages */
  289.    char cfg_inboundpath[61];      /* path for inbound message pkts */
  290.    char cfg_outboundpath[61];      /* path for outbound message pkts */
  291.    char cfg_packetpath[61];      /* path for unpacking message pkts */
  292.    char cfg_badmsgpath[61];      /* path for placing bad messages */
  293.    char cfg_unarc[61];            /* command for unarcing ARCed files */
  294.    char cfg_unzip[61];            /* command for unarcing ZIPped files */
  295.    char cfg_unzoo[61];            /* command for unarcing ZOOed files */
  296.    char cfg_unlzh[61];            /* command for unarcing LZHed files */
  297.    char cfg_arc[61];            /* command for arcing ARCed files */
  298.    char cfg_zip[61];            /* command for arcing ZIPped files */
  299.    char cfg_zoo[61];            /* command for arcing ZOOed files */
  300.    char cfg_lzh[61];            /* command for arcing LZHed files */
  301.  
  302.    unsigned char cfg_newpriv;      /* priv level of new user */
  303.    int cfg_newcredit;            /* credit level of new user */
  304.    int cfg_newtime;            /* logon time in mins for newuser */
  305.    char cfg_askhome;            /* ask for home phone */
  306.    char cfg_askdata;            /* ask for data phone */
  307.  
  308.    char cfg_ansi;               /* use ansi on local console */
  309.    char cfg_direct;            /* use direct screen writes? */
  310.    char cfg_snow;               /* use snow checking on screen writes */
  311.    char cfg_pwdtries;            /* number of attempts to get password */
  312.    char cfg_inactive;            /* time before hanging up for inactivity */
  313.    char cfg_yells;               /* number of yells per session */
  314.    char cfg_yelltime;            /* number of seconds for yell bell */
  315.    int cfg_yellstart;            /* start time for yell-bell */
  316.    int cfg_yellstop;            /* stop time for yell-bell */
  317.    };
  318.  
  319.  
  320. struct msg
  321.    {
  322.    int msg_number;               /* message board number */
  323.    char msg_areaname[41];         /* message area name */
  324.    char msg_flags;               /* message area flags */
  325.    unsigned char msg_readpriv;
  326.    unsigned char msg_writepriv;
  327.    unsigned char msg_sysoppriv;
  328.    char msg_origin[66];         /* special origin line for this if echomail area */
  329.    char msg_deleted;            /* true if deleted */
  330.    };
  331.  
  332.  
  333. struct file
  334.    {
  335.    int file_number;            /* file board number */
  336.    char file_areaname[41];         /* file area name */
  337.    char file_pathname[61];         /* path to file area */
  338.    char file_descname[61];         /* if set, this is the path to files.bbs */
  339.    unsigned char file_priv;      /* priv level to search this area */
  340.    char file_deleted;            /* true if deleted */
  341.    };
  342.  
  343.  
  344. struct evt
  345.    {
  346.    char evt_enabled;            /* true if enabled */
  347.    char evt_forced;            /* true if forced event */
  348.    char evt_days;               /* 0-S-M-T-W-T-F-S */
  349.    unsigned int evt_time;         /* encoded time to run */
  350.    char evt_errorlevel;
  351.    char evt_title[21];            /* optional name for event */
  352.    char evt_deleted;            /* true if deleted */
  353.    };
  354.  
  355.  
  356. struct msgh      /* systemwide message number is ((offset/sizeof(struct msgh)) + 1) -- 0 is invalid systemwide message */
  357.    {
  358.    int msgh_area;               /* area number of message */
  359.    int msgh_number;            /* message number int that area! */
  360.    char msgh_to[41];            /* addressee of message */
  361.    char msgh_from[41];
  362.    char msgh_subject[71];
  363.    int msgh_date;
  364.    int msgh_time;
  365.    int msgh_flags;               /* net and message flags */
  366.    int msgh_szone;
  367.    int msgh_snet;
  368.    int msgh_snode;
  369.    int msgh_dzone;
  370.    int msgh_dnet;
  371.    int msgh_dnode;
  372.    int msgh_cost;
  373.    int msgh_prev;               /* previous message link - systemwide message number */
  374.    int msgh_next;               /* next message link - systemwide message number */
  375.    long msgh_offset;            /* start offset of message */
  376.    long msgh_length;            /* message length in bytes */
  377.    };
  378.  
  379.  
  380. struct mdata
  381.    {
  382.    int mdata_msgs;               /* total number of messages */
  383.    int mdata_del;               /* total number of deleted messages */
  384.    };
  385.  
  386.  
  387. struct mc      /* message counts by area */
  388.    {
  389.    int mc_area;
  390.    int mc_msgs;
  391.    };
  392.  
  393.  
  394. struct mlink
  395.    {
  396.    int mlink_area;
  397.    int mlink_number;         /* number of the message in that area! */
  398.    int mlink_flags;         /* a copy of the message flags */
  399.    int mlink_cksum;         /* a checksum on the uppercased TO: person's name */
  400.    };
  401.  
  402.  
  403. struct adh      /* header for advertisements */
  404.    {
  405.    char adh_from[41];
  406.    char adh_subject[71];
  407.    int adh_date;
  408.    int adh_time;
  409.    int adh_killdate;
  410.    int adh_flags;               /* ad flags */
  411.    long adh_prev;               /* previous ad header */
  412.    long adh_next;               /* next ad header */
  413.    long adh_length;            /* ad length in bytes */
  414.    };
  415.  
  416.  
  417. struct m
  418.    {
  419.    char m_name[10];            /* menu's name */
  420.    struct prompt m_prompt;
  421.    struct menu **m_lines;
  422.    int m_maxlines;                 /* number of allocated menu lines */
  423.    int m_curlines;                 /* number of menu lines */
  424.    };
  425.  
  426.  
  427. struct ui      /* User-info structure */
  428.    {
  429.    char ui_name[41];            /* user's name */
  430.    int ui_date;               /* date user logged in */
  431.    int ui_time;               /* time user logged in */
  432.    int ui_baud;               /* baud rate user logged in at */
  433.    int ui_online;               /* time user spent online in minutes */
  434.    int ui_msgread;               /* number of messages user read */
  435.    int ui_msgposted;            /* number of messages user posted */
  436.    int ui_upload;               /* number of uploads */
  437.    long ui_uploadbytes;         /* number of bytes uploaded */
  438.    int ui_dnload;               /* number of downloads */
  439.    long ui_dnloadbytes;         /* number of bytes downloaded */
  440.    };
  441.  
  442.  
  443. struct nl         /* version 6 nodelist entry */
  444.    {
  445.    int nl_net;
  446.    int nl_node;
  447.    int nl_cost;
  448.    char nl_bbsname[34];
  449.    char nl_phone[40];
  450.    char nl_city[30];
  451.    char nl_pwd[8];
  452.    int nl_realcost;
  453.    int nl_hub;
  454.    char nl_baud;
  455.    char nl_modemtype;
  456.    int nl_flags;
  457.    int nl_waste;
  458.    };
  459.  
  460.  
  461. struct nlix         /* version 6 nodelist index */
  462.    {
  463.    int nlix_node;
  464.    int nlix_net;
  465.    };
  466.  
  467.  
  468.