home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / mkfbbs26 / mkfbbs26.doc < prev   
Text File  |  1992-03-27  |  14KB  |  265 lines
  1.  
  2.                       Documentation for Make FILES.BBS v2.6
  3.  
  4.                        Copyright 1992  M.J.Matts  25/01/92
  5.  
  6.                           This program is Public Domain
  7.  
  8.        This software may be distributed freely as long as all associated  
  9.        files are included and no changes are made to any of them.
  10.  
  11. --------------------------------------------------------------------------------                                 
  12. Version changes
  13.  
  14. v1.0 - Initial release. Just waiting for problems to be found!
  15.  
  16. v1.1 - Two days after v1.0 was released John Carolin of Quest BBS discovered
  17.        the program did not work properly in High Rez. No longer a problem, 
  18.        thanks John.
  19.  
  20. v2.0 - A very major upgrade hence the big jump in version numbers. Many new 
  21.        features added including the use of FRONTEND, a block of source code I 
  22.        that acts as a type of Graphical User Interface. A couple of bugs fixed.
  23.  
  24. v2.1 - Extra program included called CONVERT.PRG which reformats a FILES.BBS 
  25.        file into a format used by Make FILES.BBS and QuickBBS. the Edit files 
  26.        option now handles file names without descriptions. Searches for a 
  27.        match in whole file name instead of a match from the left of it.
  28.  
  29. v2.2 - Format of MAKEFBBS.CTL changed. Number at the end of each line forces 
  30.        the first ? lines to be ignored. This feature written in to allow the 
  31.        use of headers. A blank line is added above and below the file 
  32.        description list. File count no longer includes FILES.BBS.
  33.  
  34. v2.3 - Yet another change to the CTL format. Another number is added to the 
  35.        end of each line which tells Make FILES.BBS whether to include that 
  36.        file area in the total files list. You can now enter upto 5 full file 
  37.        names that are NOT to be included in the FILES.BBS file. When an 
  38.        ALLAREAS.LST file has been created you can archive it from the program 
  39.        in one of the following formats, LZH, ARC & ZIP. (external archive 
  40.        programs are needed for this function). BUG FIX - Any blank spaces at 
  41.        the end of a line in the CTL file no longer cause it problems. (Thanks 
  42.        go to Robert Darling for all the above changes)
  43.  
  44. v2.4 - Thanks again to Robert Darling for the following. New option added that 
  45.        allows you to delete the FILES.BAK files. If a trailing backslash was 
  46.        not added to the CTL file pathname the allfile list option and the add 
  47.        a description options did not work, this is now fixed and it does not 
  48.        matter if there is a backslash or not at the end of the path. You can 
  49.        now run Make FILES.BBS from any drive and in any folder, just as long 
  50.        as all the external programs/files it uses are with it.
  51.  
  52. v2.5 - Now works with a program called Hatch & Stick. H & S appends files to 
  53.        the end of a FILES.BBS and MKFBBS was deleting the file descriptions 
  54.        when you updated it. This is now fixed. A FRONTEND button can now be 
  55.        cancelled by moving the mouse pointer away from it before letting go of 
  56.        the mouse button. (Guess who suggested these changes?)
  57.  
  58. v2.6 - You can now copy files and transfer the FILES.BBS description if a 
  59.        FILES.BBS exists in both source & destination areas. (Oh No - Not 
  60.        Robert Darling again!)
  61.  
  62. --------------------------------------------------------------------------------
  63.  
  64. If you get an ERROR 26 (end of file) you must check your CTL file. Chances are 
  65. you have not got a comma inbetween one of the CTL fields. See the examples 
  66. later in this DOC and also the sample CTL file included in the LZH file for 
  67. the correct format to use.
  68.  
  69. --------------------------------------------------------------------------------
  70. You should have 3 files in the MKFBBSxx.LZH file. These should be as follows:-
  71.  
  72. o    MAKEFBBS.PRG - The main program.
  73. o    MKFBBSxx.DOC - This document.
  74. o    MAKEFBBS.CTL - An example CTL file.
  75.  
  76. MAKEFBBS.CTL is the control file and should be edited to suit your own 
  77. environment. This should be similar to the FLSEARCH.CTL file used by QuickBBS. 
  78. A small example of the possible varaitions follows:
  79.  
  80. *** IMPORTANT NOTE *** As of v2.3 the format of the CTL file has changed yet 
  81. again. If v2.3 tries to read an old type CTL file it will give you an alert 
  82. box informing you of an error. Simply return back to the desktop and check the 
  83. format of the CTL file. The new format now has two numbers at the end of each 
  84. line with a commer (,) seperating each field. The first number will force Make 
  85. FILES.BBS to ignore this number of lines at the beginning of the FILES.BBS 
  86. file in that particular area. This will allow you to have headers in your 
  87. files which will be left as they are when Make FILES.BBS is run. The second 
  88. number will allow you to exclude an area from the total files list. This is to 
  89. 'hide' any areas you have that are only available to users with certain access 
  90. rights, for example, on my own BBS there is an area where I keep source code 
  91. for FRONTEND, used by this program, which can only be accessed by users who 
  92. have paid to register the code, therefore I do not want this file area to be 
  93. included on a list for the general users. The number in the CTL file should be 
  94. either 1 or 0. If it is 1 then the area will be included in the ALLAREAS list, 
  95. if it is 0 it will remain private.
  96.  
  97.  
  98. o    Example 1 - C:\QUICKBBS\DOWNLOAD\GAMES,10,1
  99. o    Example 2 - C:\QUICKBBS\DOWNLOAD\GAMES\,6,1
  100. o    Example 3 - \QUICKBBS\DOWNLOAD\GAMES,22,0
  101. o    Example 4 - \QUICKBBS\DOWNLOAD\GAMES\,7,0
  102.  
  103. The paths given can be in any of the above 4 formats. If a drive is specified
  104. the program and CTL file can be on a different drive if needed. The last
  105. backslash is not important as MAKEFBBS will add one if it is missing. The only
  106. specific thing that must be done are the program and CTL file should be in
  107. the same folder as each other and that FILES.BBS is not added to the end of
  108. the path lines in MAKEFBBS.CTL.
  109.  
  110. *****************************************************************************
  111.  
  112.                       *** READ THIS SECTION CAREFULLY ***
  113.  
  114.          Make FILES.BBS only recognises a certain format of FILES.BBS file so 
  115. for it to work correctly you must make sure it is set up as follows. Some file 
  116. area maintainence programs create a file with the following format which 
  117. CANNOT be used by Make FILES.BBS:-
  118.  
  119. FILENAME.LZH description
  120. FIL.LZH description
  121. LZHFIL.LZH description
  122.  
  123.       One space character is placed between every file name and its 
  124. description. The earlier versions of Make FILES.BBS used this format but I 
  125. found it slowed down any routines that needed to seperate the file name from 
  126. the description. The correct format to use is as follows:
  127.  
  128. FILENAME.LZH description
  129. FIL.LZH      description
  130. LZHFIL.LZH   description
  131.  
  132.       Using this format Make FILES.BBS was able to perform certain jobs at 
  133. upto twice the speed. When a BBS user selects a view files function both 
  134. formats will seem to be displayed the same, this is due to QuickBBS being able 
  135. to support both formats. You can change the format of the files using a text 
  136. editor or you can request from me, free of charge, a small program that will 
  137. convert them automatically.
  138.  
  139. *****************************************************************************
  140.  
  141.                  - Options available when using Make FILES.BBS -
  142.  
  143.    Using the FRONTEND interface all options are selected by simply clicking on 
  144. the button. If you click the right mouse button from any screen created using 
  145. FRONTEND you will be able to change & save the colours and switch the hertz 
  146. rate in MED rez and in high the display will switch between black on white & 
  147. white on black.
  148.  
  149. o    Delete .BAK files
  150.  
  151. When Make FILES.BBS writes to a FILES.BBS file it automatically creates a 
  152. backup copy of the original called FILES.BAK. Clicking on this button will 
  153. simply delete all the backup files.
  154.  
  155. o    Copy/Move A File
  156.  
  157. You will be asked to select the file you want to copy/move using the 
  158. normal GEM file selector and then to select the folder where you want to 
  159. copy/move it to, again using the GEM file selector. If a FILES.BBS file is 
  160. found in both the source & destination folders you will be asked if you want 
  161. to transfer the file description aswell. If you select YES the description 
  162. will be added to the end of the FILES.BBS file in the destination folder so 
  163. when it is next updated it will be placed into it's correct alphabetical 
  164. slot. The description is NOT removed from the source folders FILES.BBS. To do 
  165. this select the 'Erase Missing Files' Button on the main screen. When the 
  166. copy/move has finished you will be asked whether you want to delete the 
  167. original file.
  168.  
  169. o    Add descriptions to FILES.BBS.
  170.  
  171. This will allow you to add a description to any file without one. The program
  172. will only prompt you to enter a description if there is not one available.
  173.  
  174. o    Create or Update FILES.BBS
  175.  
  176. If there is not a FILES.BBS file in the specified path MAKEFBBS will create one
  177. that includes all the file names for all files in that directory, except for
  178. any names or extensions that are to be excluded. If a FILES.BBS does exist it 
  179. is simply updated with any new files in that directory. The list will also be 
  180. sorted into alphabetical order. No file descriptions can be added here.
  181.  
  182. o    Edit a FILES.BBS description
  183.  
  184. You will be prompted to enter a file name. This does not need to be a full 
  185. file name as the text you enter will be used as a search mask. ie. You enter 
  186. DIVE and Make FILES.BBS will return anything like DIVErt.lzh or aDIVEr.lzh. 
  187. When a match has been found you can add to or change the description that 
  188. already exists.
  189.  
  190. o    Erase missing files from list
  191.  
  192. This will check every directory against each FILES.BBS and if a file name in 
  193. the FILES.BBS does not exist on the disk it will be removed from the list. 
  194. This function is fairly slow as it physically checks the disk rather then the 
  195. FAT table. This is to lessen the chance of possible errors.
  196.  
  197. o    Generate an all areas list
  198.  
  199. A file called ALLAREAS.LST will be created in the same directory that you ran 
  200. Make FILES.BBS from. Every area that the CTL file has been told to include in 
  201. this list will added, still keeping their headers (if any) to make it easier 
  202. to identify which area the particular set of files are from.
  203.  
  204. o   Toggle the total files count
  205.  
  206. The status of this button is shown at the bottom of the screen. The default is 
  207. to include a total files count. When ever a FILES.BBS is written to a total of 
  208. the available files in that area is included if this option is set to do so. 
  209. Also when an all areas list is created a total of all the files on your BBS 
  210. will be written.
  211.  
  212.  
  213. The main center of the screen has 2 sections where you can enter details of 
  214. full file names and file extensions that are not to be included in the 
  215. FILES.BBS list. When ever a FILES.BBS file is written to, the names and 
  216. extensions specified will not be added. The program will always exclude 
  217. FILES.BAK which is created by MAKEFBBS every time a FILES.BBS is created or 
  218. updated. You know also have the option of saving the names and extensions to 
  219. disk if you exclude them on a regular basis. They will automatically be 
  220. reloaded next time Make FILES.BBS is run. When the list has been finished you 
  221. will be given the option of whether you want to archive the file or not. You 
  222. have a choice of 3 types which are LZH, ARC & ZIP. You simply click on the 
  223. button that corresponds to the format you want. The external archiving 
  224. programs are needed to use this function. They are available from any BBS, 
  225. including my own, & any PD libraries. When you use the archiving feature the 
  226. external programs should be in the same directory as Make FILES.BBS.
  227.  
  228. *****************************************************************************
  229.  
  230. Mant thanks to the following:-
  231.  
  232. Stuart Coates  - Technical help, information  & verbal abuse! (Hows your BIG 
  233.                  harddisk?)
  234.  
  235. Keith Frisby   - Distribution via Compuserve + my mono monitor! (Hows your 
  236.                  LITTLE harddisk?)
  237.  
  238. John Charles   - Author of JCLABEL - Positive attitude and encouragement 
  239.                  regarding the development of the FRONTEND user interface.
  240.  
  241. Robert Darling - Sysop of The FolkeSTone BBS. He use's the program on his BBS 
  242.                  and has offered many good ideas + bug reports. If you want to 
  243.                  contact his BBS details are : The FolkeSTone BBS, speeds upto 
  244.                  2400 bps, online 9pm to 8am, 0303 245203). EVERY improvement 
  245.                  made in v2.3 to v2.6 was due to suggestions made by Robert.
  246.  
  247.  
  248. If you do have a suggestion or idea that you think would improve the program 
  249. or if you would like to know more about the FRONTEND interface source code 
  250. which is available and costs only £10, this gives you full access to the 
  251. support section on my BBS where all the very latest changes/additions to the 
  252. code can be found,  send a letter to my address shown in the info section of 
  253. the program. Alternativly you could leave me E-Mail on my own BBS:
  254.  
  255.           The Confederation - 300\1200\2400 - 10pm to 7am - 0533 413443
  256.  
  257.  
  258.            The Author : Mark Matts, 66 Telford Way, Leicester, LE5 2LX.
  259.  
  260.  
  261. Happy FILES.BBS making...
  262.  
  263. *****************************************************************************
  264.  
  265.