home *** CD-ROM | disk | FTP | other *** search
/ Network PC / Network PC.iso / amiga utilities / communication / bbs / hydrabbsa8 / docs / suggestions / user_docs < prev   
Encoding:
Text File  |  1997-11-21  |  5.7 KB  |  153 lines
  1. These docs are very rudimentary docs and are NOT complete, at present
  2. they are only a guideline and WILL change.
  3.  
  4. Config File Definition
  5. ======================
  6.  
  7. you may use YES/NO or TRUE/FALSE for boolean options
  8.  
  9. /'s will be added to paths if required.
  10.  
  11. space's are NOT permitted in filenames.
  12.  
  13. all strings should be enclosed in "'s eg NodeName="Node 1"
  14.  
  15. Any string may contain C style escape codes, of course if you are
  16. writing a door that has specific field lengths you may strip the ansi codes
  17. using the hbbs.library function designed to do this.
  18.  
  19. ;'s are used for comment lines, they may be after an option or on seperate lines
  20.  
  21. blank lines are allowed (aids structure)
  22.  
  23. all optionnames MUST start on the first character of the line
  24.  
  25. Options take the following format:
  26.  
  27. Optionname=<Option Parameter>
  28.  
  29. Option Parameters are dependant on the option and the data it requires
  30. here are how they are defined
  31.  
  32. String="some text"           ; must be enclosed in "'s
  33. Path=drive:dir               ; need not have trailing /
  34. File=drive:dir/dir/file      ; paths/files MAY NOT have spaces in the filenames
  35. Boolean=[YES|NO|TRUE|FALSE]  ; one of four possible options without ['s
  36.  
  37.  
  38. System Config
  39. =============
  40.  
  41. There is one main program with a GUI (that can be turned off/closed) that controls
  42. the node programs, the main programs sends messages to the node programs and the
  43. node program sends messages back to the main program depending on what is
  44. happening.
  45.  
  46. each node program only controls the actual serial port device and the order in
  47. which a user can go around the bbs system, running commands/doors when appropriate
  48.  
  49. for every option/system event the node program loads external programs.  e.g.
  50.  
  51. a user logs on, the node program runs a frontend door that may ask for the username
  52. and password, after that door is finished the control goes back to the node program
  53. which then runs an initial login door that may display ansi screens etc.  then
  54. the node program would calla command to join the last conference the user was in,
  55. then it goes back to the node program which then prompts the user for a command, and
  56. depending on what the user types in the node program runs another external door.
  57.  
  58. so EVERY SINGLE PART OF THE PROGRAM can be changed, so if you don't like the way
  59. the system does mail messages then just change the associated doors that
  60. handle the mail system!  it's so configurable it's untrue!
  61.  
  62. BBS Path Structure
  63. ==================
  64.  
  65. + defines directory,
  66. - defines a config file (always text files)
  67. = defines an executable file
  68. * defines a door/system file
  69.  
  70. NOTE: files in subdirectories ALWAYS override the options that may be set in
  71.       files in its parent directory.  E.G.  Nodes/Node1/NodeLocal will override
  72.       settings Nodes/NodeGlobal, likewise Conferences/#?/Commands/User/#?
  73.       would override settings in Commands/User/#?
  74.  
  75. BBS:
  76.   - BBSGlobal                    ; defines a few settings for the bbs
  77.   + Nodes
  78.    - NodeGlobal                  ; defines settings for ALL nodes
  79.    + Node1
  80.     + Work                       ; temporary files will go in this directory
  81.     + Playpen                    ; all uploads go in this directory
  82.     - NodeLocal                  ; Defines config options specific to the node
  83.     - Device                     ; defines the modem/device for the node
  84.    + Node2
  85.     + Work
  86.     + Playpen
  87.     - NodeLocal
  88.     - Device
  89.    + ...
  90.  
  91.   + Access
  92.    - NewUser                     ; access file for NewUsers
  93.    + Users
  94.     - Level_List                 ; file that lists the various access levels
  95.     - Level_Global               ; defines access setting for ALL levels
  96.     - Level_#?                   ; then each level overrides the global settings
  97.                                  ; and there must be one for each level defined in
  98.                                  ; level_list (above)
  99.  
  100.   + Conferences
  101.    - ConfList                    ; defines the amount of conferences and where
  102.                                  ; each conference directory is located
  103.    + <conference directory>
  104.     - ConfConfig                 ; config file for conference
  105.     + Screens
  106.     + FileLists
  107.     + Hold                       ; default hold path for conference (see ConfConfig)
  108.     + Access
  109.      - Level_#?                  ; lets you override access's for each conference
  110.                                  ; great for allowing a user to write "everybody"
  111.                                  ; messages in their groups conference but nowhere
  112.                                  ; else
  113.     + Commands
  114.      + System
  115.       - #?                       ; each file is the name of the system option
  116.                                  ; e.g.  WriteMail.1, FileExamine.1
  117.      + User
  118.       - AliasList                ; command alias definition file
  119.                                  ; eg,  DIR=FR, NEW=N S U
  120.       - #?                       ; each file is the same as the menu option
  121.                                  ; the same as /X's BBS:Commands/BBSCMD/#? files
  122.      + Sysop
  123.       - #?
  124.  
  125.   + Scripts
  126.    - #?                          ; bbs system script files go in here
  127.  
  128.   + Doors
  129.    + System
  130.     * #?                         ; System Executables, E.g.  writemail, readmail,
  131.                                  ; filecheck, logoff, logon, joinconf, filelist...
  132.    + User
  133.     * #?                         ; User Executables. E.G.  New Cool Filelister,
  134.                                  ; Voting Booth, Nuker......  same as /X doors
  135.  
  136.   + Screens
  137.    + Special
  138.    + Bulletins
  139.  
  140.  
  141. Files are not stored in the bbs: directory structure as the sysop may have other
  142. devices that may be setup in a particular way,  below is how we recommend you
  143. organize your file direcotories as it is a more structures way of doing it.
  144.  
  145. Files_#?:
  146.   + <conference directory>
  147.    + Hold
  148.    + Files
  149.   + <conference directory>
  150.    + Hold
  151.    + Files
  152.   + ...
  153.