home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / XBBS_118.ZIP / DOCS.ZIP / SPECFILE.DOC < prev    next >
Encoding:
Text File  |  1992-03-21  |  14.8 KB  |  275 lines
  1.  
  2.         ╔══╗╔══╗╔═════╗╔═════╗╔════╗    ╓──╖   ╓──╖  ╓────╖
  3.         ║  ║║  ║║ ┌┐  ║║ ┌┐  ║║    ║    ║  ║   ║  ║  ║ ┌┐ ║
  4.         ║  ╚╝  ║║ └┘  ║║ └┘  ║║  ╔═╝    ╙╖ ║   ╙╖ ║  ║ └┘ ║
  5.         ╚╗    ╔╝║    ╔╝║    ╔╝║  ╚═╗     ║ ║    ║ ║  ╙╖  ╓╜
  6.         ╔╝    ╚╗║ ┌┐ ╚╗║ ┌┐ ╚╗╚═╗  ║     ║ ║    ║ ║ ╓─╜  ╙─╖
  7.         ║  ╔╗  ║║ ││  ║║ ││  ║╔═╝  ║     ║ ║    ║ ║ ║ ┌──┐ ║
  8.         ║  ║║  ║║ └┘  ║║ └┘  ║║    ║    ╓╜ ╙╖╓╖╓╜ ╙╖║ └──┘ ║
  9.         ╚══╝╚══╝╚═════╝╚═════╝╚════╝    ╙───╜╙╜╙───╜╙──────╜
  10.  
  11.                    "I don't know.  Why a duck?"
  12.  
  13.                           Special Files:
  14.  
  15.    The following files have special meaning in one way or another to
  16. XBBS.  Note that not all are required (optional files are flagged with
  17. *). You should avoid using these names for your own menu files to
  18. prevent conflicts.
  19.  
  20.  --System files
  21.  
  22.  Filename      Description                               Directory   Made By
  23.  ============  ========================================  ==========  =======
  24.  CONFIG.BBS    Standard configuration file               BBS         System
  25.  NEWUSER.BBS   Logon configuration file                  BBS         System
  26.  USERS.BBS     The user file                             BBS         System
  27.  ONLINE.XBS    Info on online user                       BBS         System
  28.  XBBS.TXT      Text file containing system prompts       BBS         You
  29.                You can edit this file and run Indexer.COM
  30.                on it to customize all sorts of stuff.
  31.  XBBS.IDX      Index file for XBBS.TXT                   BBS         System
  32. *XBBS.GXT      Same as XBBS.TXT for ANSI users           BBS         You
  33. *XBBS.GDX      Same as XBBS.IDX for XBBS.GXT             BBS         System
  34. *BOARDLST.XBS  Displayable listing of message areas      Bulls       You
  35.  PROTOCOL.CTL  Control file for external protocols       BBS         XProto
  36. *TRASHCAN.CTL  Control file for bad user names           BBS         You
  37. *PHONECAN.CTL  Control file for bad phone numbers        BBS         You
  38. *NOTIFY.CTL    Control file listing users you want       BBS         You
  39.                XBBS to notify you of when they log
  40.                on.  List one user per line (name or
  41.                handle).  You can optionally follow
  42.                the name with ",Q!" to have XBBS not
  43.                inform the user that you're being
  44.                notified, and/or ",<filename.xbs>"
  45.                to read a special file (NOTIFY.XBS
  46.                is normally read).
  47. *NOTIFY.XBS    Read under conditions listed for          Menu        You
  48.                NOTIFY.CTL.
  49. *ORIGINS.BBS   List of origins for echo mail areas       Mess        You
  50.                Format: <area #>;text[Enter]
  51.                Example for areas 22 and 23:
  52.                22;The Other XBBS & This Echo
  53.                23;The Other XBBS & That Echo
  54.                Special "commands" for an area:
  55.                NOTEAR (don't put a tear line
  56.                        in this conference--follow
  57.                        with the origin)
  58.                NOORIGIN (don't put an origin
  59.                          line in this conference)
  60.                NOORIGIN/NOTEAR (obvious)
  61.  DORINFO?.DEF  Exit file for Doors                       BBS         System
  62.  DOOR.SYS      Exit file for Doors                       BBS         System
  63.  USERINFO.XBS  Exit file for XBBS QB Doors               BBS         System
  64. *QNL_IDX.BBS   QuickBBS nodelist index for netmail       BBS         Extern
  65. *QNL_DAT.BBS   QuickBBS nodelist data for netmail        BBS         Extern
  66. *AFTERMSG.XBS  If there is no MESSCHEK.EXE file, XBBS    Menu        You
  67.                will try to read this file after a
  68.                message is written, but before it is
  69.                accepted and filed.
  70.  XDATA.###     Message area header file for area ###     Mess        System
  71.  XTEXT.###     Message area text file for area ###       Mess        System
  72.  LASTREAD.BBS  Lastread pointers                         Mess        System
  73.  MSGTMP        Temporary message text file               BBS         Editor
  74. *ARCHIVERS.XBS List of archive extensions and the        BBS         You
  75.                command line used to list the archive.
  76.                Used by Files-mode 'V' command.
  77.                Example:
  78.  
  79.                LZH LHARC.EXE l
  80.                ZIP PKUNZIP.EXE -v
  81.  
  82. *COMTYPES.LST  List of computer types, one per line      BBS         You
  83. *COMTYPES.XBS  List of computer types, for display       Menu        You
  84.                Can be omitted if XConfig Computer-type
  85.                tracking is set to 0 or you use XBBS.TXT
  86.                prompt #394 instead.
  87. *MSGAREAS.XBS  List of message areas in the same format  Mess        You
  88.                you use for the @M command (without the
  89.                prefacing @M, of course).  See the
  90.                sample with HeadEdit.  Note that entries
  91.                in MSGAREAS.XBS should be sorted by area
  92.                number.  Also note that you can use XEdit
  93.                to build and maintain this file (highly
  94.                recommended).
  95.  *DOORLIST.XBS Door control file.                        BBS         You
  96.                Contains entries describing the available
  97.                Doors for Doorsmode in the following
  98.                format:
  99.  
  100.                Security_level Name Type<Errorlevel>
  101.                 String_to_spawn/exec Description_Text
  102.  
  103.                All the above should be on one line, and
  104.                there should be only one entry per line.
  105. *FLSEARCH.CTL  This is a modified version of the file
  106.                QuickBBS uses (or used to, dunno if it
  107.                still does).  Contains entries
  108.                describing the available file areas for
  109.                many XBBS commands and Files mode in the
  110.                following format:
  111.  
  112.                D:\PATH\ SECLVL# Name_of_area <flags>
  113.                 <D:\upload_path\> <Description>,<age>,
  114.                 <userflags>
  115.  
  116.                All the above should be on one line,
  117.                and there should be only one entry per
  118.                line.
  119. *MSGDIRS.XBS   List of message directories if you're     BBS         You
  120.                using more than the one in CONFIG.BBS.
  121.                One per line with trailing backslash.
  122.                You don't need to list the directory in
  123.                CONFIG.BBS.  This file is used by LOGON
  124.                and XUSER to maintain LASTREAD.BBS in
  125.                each directory.
  126. *RULES.###     Rule file for area ### (i.e. area #1      Menu\Bulls  You
  127.                would be RULES.001, area #99 would be
  128.                RULES.063 (99 decimal is 63 hex), etc.)
  129.                If you don't speak hexadecimal, load
  130.                GWBASIC (BASICA) and type ? HEX$(99)
  131.                or whatever number you'd like to convert.
  132.                You get out of GWBASIC by typing SYSTEM.
  133. *INTRO.###     Intro file for area ### (same format as   Menu\Bulls  You
  134.                RULES.### above)
  135. *netnode.MAL   Outgoing mail packet for XHMS use         .\XPORT     System
  136. *netnode.RPK   Incoming mail packet created by XHMS      .\MPORT     XHMS
  137.                XGateKpr imports these
  138.  
  139.  --Text/Menu files (all by you, all in Menu directory, all optional
  140.                     note many have XBBS.TXT defaults if missing)
  141.  
  142.  FileName      Description
  143.  ============  =============================================================
  144.  TOOSLOW.XBS   Read to users below the minimum baud rate (no .GBS)
  145.  LOGO.XBS      Read when Logon comes up before asking for name (no .GBS)
  146.  TRASHCAN.XBS  Read if name or handle found in TRASHCAN.CTL
  147.  PHONECAN.XBS  Read if name or handle found in PHONECAN.CTL
  148.  NOTFOUND.XBS  Read if their entered name isn't in USERS.BBS (no .GBS)
  149.  LOCKED.XBS    Read if the user logging on is locked out
  150.  MYLOGON.XBS   Read if available.  BYPASSES STANDARD LOGON PROCEDURE;
  151.                saves new user.  Only way out without adding user is to
  152.                hang up.  ADVANCED USE ONLY!
  153.  NEWUSER.XBS   Read to new users after they confirm their name (no .GBS)
  154.  DUPEPHON.XBS  Read if user's phone number is a duplicate
  155.  PHONE1.XBS    Read before user is asked for first phone number
  156.  PHONE2.XBS    Read before user is asked for second phone number
  157.  BIRTHDAY.XBS  Read before user is asked for his/her birth date
  158.  LENGTH.XBS    Read before user is asked what his/her terminal length is
  159.  WIDTH.XBS     Read before user is asked what his/her terminal width is
  160.  GRAPHICS.XBS  Read before user is asked if s/he wants ANSI graphics
  161.  FULLSCRN.XBS  Read before user is asked if s/he wants the fullscreen editor
  162.  HIASCII.XBS   Read before user is asked if s/he wants to receive high
  163.                ascii characters
  164.  CLEARING.XBS  Read before user is asked if s/he wants screen clearing
  165.  PAUSING.XBS   Read before user is asked if s/he wants page pausing
  166.  SPECFLAG.XBS  Read before user has opportunity to set special flag
  167.  HANDLE.XBS    Read before user is asked if they want to use a handle
  168.                (Note: you don't _have_ to support handles...see XConfig)
  169.  PASSWORD.XBS  Read before user is asked to enter a password
  170.  CITY.XBS      Read before user is asked what his/her city is
  171.  STATE.XBS     Read before user is asked what his/her state is
  172.  ZIP.XBS       Read before user enters their 5-digit zip code
  173.  NEWQUEST.XBS  Read to new users after login completion
  174.  HAPPY.XBS     Read if it is the user's birthday at logon
  175.  WELCOME.XBS   Read after all users complete login (after NEWQUEST if new)
  176.  CHATON.XBS    Read when you initiate chat mode
  177.  CHATOFF.XBS   Read when you end chat mode
  178.  XCHAT.XBS     Read if an xijitmode chat request is made; overrides
  179.                default xijit action.
  180.  CHAT.XBS      Read when you are paged (via text command @c) and In
  181.  NOCHAT.XBS    Read when you are paged and Out
  182.  GETLOST.XBS   Read to obnoxious users who page too many times
  183.  BULLHELP.XBS  Read when a user hits [Enter] in Bulls-mode
  184.  PROTOCOL.XBS  Alternate menu (list) of protocols for u/d
  185.  JUMPOUT.XBS   Read when the SysOp jumps to DOS via ALT-J
  186.  JUMPBACK.XBS  Read when the SysOp returns from a jump to DOS
  187.  EXTRAMSG.XBS  Read if the user selects [E] in an Extended Msg area
  188.  IJITHELP.XBS  Read if user requests help in Ijit-mode
  189.  IJT2HELP.XBS  Read if user requests help in Ijit-mode #2
  190.  XIJIT###.XBS  Read if user selects an added command in Ijit-mode (see
  191.                XBBS.TXT prompt #448).
  192.  2XIJT###.XBS  Read if user selects an added command in Ijit-mode #2
  193.                (see XBBS.TXT prompt #680-691).
  194.  XUPLOAD.XBS   Read if user selects Upload in Ijit-mode #2.
  195.  XDNLOAD.XBS   Read if user selects Download in Ijit-mode #2.
  196.  XARCVIEW.XBS  Read if user selects View Archive in Ijit-mode #2.
  197.  XRAWDIR.XBS   Read if user selects Raw Directory in Ijit-mode #2.
  198.  XNEWFLES.XBS  Read if user selects New Files in Ijit-mode #2.
  199.  XLSTFLES.XBS  Read if user selects List Files in Ijit-mode #2.
  200.  XCHFAREA.XBS  Read if user selects Change File Area in Ijit-mode #2.
  201.  MSETUP.XBS    Read if user selects Setup Msg Areas in Ijit-modes.
  202.  XCHMAREA.XBS  Read if user selects Change Msg Area in Ijit-mode #2.
  203.  XREDMSG1.XBS  Read if user selects Read Msgs in Ijit-mode #2.
  204.  XREDMSG2.XBS  Read if user selects Personal Msgs in Ijit-mode #2.
  205.  XREDMSG3.XBS  Read if user selects Locate Msgs in Ijit-mode #2.
  206.  XREDMSG4.XBS  Read if user selects Scan Msgs in Ijit-mode #2.
  207.  XWRITMSG.XBS  Read if user selects Write Msg in Ijit-mode #2.
  208.  XYELL.XBS     Read if user selects Yell for Sysop in Ijit-modes.
  209.  CONFG###.XBS  Read if user selects an added command in config-mode (see
  210.                XBBS.TXT prompt #456).
  211.  MACRO###.XBS  Read if user selects an added command in macro-mode (see
  212.                XBBS.TXT prompt #206).
  213.  BULLS###.XBS  Read if user selects an added command in Bulls-mode (see
  214.                XBBS.TXT prompt #433).
  215.  XFILE###.XBS  Read if user selects an added command in Bulls-mode (see
  216.                XBBS.TXT prompt #206).
  217.  FLBBS###.XBS  Read if user selects an added command after a FILES.BBS
  218.                page (see XBBS.TXT prompt #268).
  219.  AFTER###.XBS  Read if user selects an added command after a msg has
  220.                been read (see XBBS.TXT prompt #434).
  221.  NEWS###.XBS   Read if user selects an added command in news-mode.
  222.  LIBRY###.XBS  Read if user selects an added command in library-mode.
  223.  CONFIGUR.XBS  Read if user selects configure in Ijit modes.  Can be used
  224.                to override Ijit's default function.
  225.  DOORS.XBS     Read if user selects Doors in Ijit modes.  Can be used to
  226.                override Ijit's default function.
  227.  DOORLIST.XBS  Door control file
  228.     Security_level Name Type<Errorlevel> String_to_spawn/exec Description_Text
  229.  FILES.XBS     Read if user selects Files in Ijit modes.  Can be used to
  230.                override Ijit's default function.
  231.  MSGS.XBS      Read if user selects Msgs in Ijit modes.  Can be used to
  232.                override Ijit's default function.
  233.  MACROS.XBS    Read if user selects macros in auto modes.  Can be used to
  234.                override default function.
  235.  LISTUSER.XBS  Read if user selects userlist in Ijit modes.  Can be used
  236.                to override Ijit's default function.
  237.  LIBRARY.XBS   Read if user selects Library in Ijit modes.  Can be used
  238.                to override Ijit's default function.
  239.  NEWS.XBS      Read if user selects News in Ijit modes.  Can be used to
  240.                override Ijit's default function.
  241.  XLOGOFF.XBS   Read if user selects Quit in Ijit modes.  Can be used to
  242.                override Ijit's default function.
  243.  XLOGOOP.XBS   Read if user selects Oops in Ijit mode #2.
  244.  VIEWFILE.XBS  Read if the user selects [V] in an Assoc Msg/File area
  245.  CHEKFILE.XBS  Read after user inputs a file string for upload or
  246.                download.  Allows you to do your own acceptance
  247.                processing.
  248.  MARKFILE.XBS  Read if M pressed at paged FILES.BBS prompt under some
  249.                circumstances (see @f).
  250.  BETWEEN.XBS   If there is a ^aINFO: or ^aASSOC: kludge line in the
  251.                message being read, XBBS reads this file after displaying
  252.                the header (and associated file info if found).
  253.  TWEENMSG.XBS  Similar to BETWEEN.XBS but read for any message that does
  254.                *not* qualify for BETWEEN.XBS.
  255.  F1.XBS        Read when F1...F10 key is pressed.
  256.  ...
  257.  F10.XBS
  258.  AF1.XBS       Read when ALT-F1...ALT-F9 key is pressed.
  259.  ...
  260.  AF9.XBS
  261.  SF1.XBS       Read when SHIFT-F1...SHIFT-F10 key is pressed.
  262.  ...
  263.  SF10.XBS
  264.  CF1.XBS       Read when CTRL-F1...CTRL-F10 key is pressed.
  265.  ...
  266.  CF10.XBS
  267.  SYSHELP.XBS   SysOp help file read locally only (even if someone is
  268.                online) when the ALT-F10 key is pressed.  Good for
  269.                reminding you what the other special keys have been set
  270.                up to do.
  271.  GOODBYE.XBS   Read at logoff (you have to explicitly call it; violations
  272.                are not counted if this file is being read when carrier is
  273.                lost.  A @x<#> command should be in that file.)
  274.  
  275.