home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / mfreq104 / maxifreq.doc < prev    next >
Text File  |  1993-10-07  |  9KB  |  234 lines
  1. ***  **   Maxi*FREQ 1.01<beta> by Erik Williams
  2. **  ***   SunFox Productions, Ltd. <Raleigh, NC>
  3. ***  **   (c) Copyright, 1993.  All rights reserved.
  4. **  ***   "Jesus saves, Gretzky gets the rebound...SCORES!"
  5.  
  6.                      PRELIMINARY DOCUMENTATION
  7.  
  8. LAST MODIFIED:  August 31st, 1993
  9.  
  10. FILES IN ARCHIVE:
  11.  
  12.    MAXIFREQ.TOS => the executable
  13.    MAXIFREQ.CFG => config file...must be in Maxi*FREQ's directory!
  14.    MAXIFREQ.DOC => this documentation
  15.  
  16. INTRODUCTION:
  17.  
  18. Looking for an easy way to generate the list of files available on
  19. your system for FILE REQUEST (FREQ) and the text file that is sent
  20. when someone FREQs the magick name FILES from you?  If so, stick
  21. around for this is the function of Maxi*FREQ.  It works with FoReM or
  22. Turbo version 1.0 systems...and may work with Turbo version 2.0 as well
  23. but this is untested.
  24.  
  25. It will generate the OKFILE used by BinkleyTerm as well as the files
  26. available listing for other sysops...and it will calculate the number
  27. of files in a download area, total space taken up per area, total number
  28. of files in system and the total amount of downloads available and
  29. present that information in an easy to read format.
  30.  
  31. Anyone who has used FREQLIST by Steve Barnes will know exactly
  32. what Maxi*FREQ does...
  33.  
  34. CONFIGURING THIS BUGGER:
  35.  
  36. Configuring Maxi*FREQ to do as you wish is relatively simple...MAXIFREQ.CFG
  37. is pretty much free-format in terms of spacing...feel free to indent as you
  38. wish...Maxi*FREQ's parser isn't fazed by block-style lines.  In fact, I
  39. highly encourage a block-format...it makes reading and fixing the config
  40. file that much easier!  A sample of this is the MAXIFREQ.CFG I have 
  41. included in this archive.
  42.  
  43. REQUIRED CONFIGURATION LINES:
  44.  
  45. LogFile <path and filename of log>
  46.  
  47.           ex.  LogFile g:\logs\maximove.log
  48.  
  49.     LogFile is simply the path and filename that you wish the logging to
  50. be written to.  I use the standard Binkley logging format, so you can use
  51. your main log or one of your choosing...either way is fine.
  52.  
  53. GenFreqLists <day{|day}...> <start time> <end time>
  54.  
  55.     This keyword controls the times that your system will generate the
  56. FREQ lists.  Most people tend to do this either on a daily basis at
  57. a certain time or once a week when they do their weekly batch processing.
  58.  
  59.        The <day> parameter can be any one or a combination of the following
  60.        options:
  61.  
  62.              Mon = Monday
  63.              Tue = Tuesday
  64.              Wed = Wednesday
  65.              Thu = Thursday
  66.              Fri = Friday
  67.              Sat = Saturday
  68.              Sun = Sunday
  69.              Week = Monday through Friday
  70.              WeekEnd = Saturday and Sunday
  71.              All = All seven days
  72.  
  73.        The days are case-sensitive, so please use these abbreviations
  74.        exactly as you see them.  If you wish to use more than one of these
  75.        days then join them together using the "|" character with *NO*
  76.        spaces in the specification.  For example:  Mon|Wed|Fri
  77.  
  78.        The <start_time> and <end_time> are twenty-four hour representations
  79.        of your starting and ending times respectively.  Each of these will
  80.        be eight characters long in the following format using the *MILITARY*
  81.        time scheme:
  82.  
  83.               hh:mm:ss
  84.  
  85.        It is essential that you follow this format exactly or my time
  86.        comparison routines may have unexpected results.  So, for example,
  87.        if you want a start time of 4:30p on the dot, just put in 16:30:00
  88.        for <start_time>.
  89.  
  90.        A word of warning:  you need to keep your times from crossing over
  91.        the midnight boundary or else unpredicted results may come of it.
  92.  
  93.  
  94. OKFile <path and filename>
  95.  
  96.     The OKFile parameter is the path and filename of the file used by
  97. BinkleyTerm as a keeper of the MAGICK names and the paths of the files.
  98. It will usually be some variant of OKFILE.* and the path and filename
  99. should be the same as given in the Okfile statement in BINKLEY.CFG.
  100.  
  101. FREQList <path and filename>
  102.  
  103.     This is the path and filename of the file that is generated by
  104. Maxi*FREQ.  This is the straight text listing of all of the files
  105. plus description, size, etc. that are placed in your OKFile.
  106.  
  107. BannerFile <path and filename>
  108.  
  109.      This is the path and filename of your text file that describes your
  110. BBS...it should be the same as the path and filename used in the About
  111. statement in BINKLEY.CFG.
  112.  
  113. SpecialOKs <path and filename>
  114.  
  115.      This is a listing of magick names and paths that you wish to be
  116. available in your OKFile at all times, even if they aren't files that
  117. are in your regular download areas.  It's also a way of making special
  118. magick names for an area that you don't normally want magick names to
  119. be used.
  120.  
  121.      A general form of a line for the OKFILE is like:
  122.  
  123. @<magick name> <path and filename>
  124.  
  125.      and an example of it is:
  126.  
  127. @MAXIFREQ C:\TURBO\BINK\MISC\MAXIFREQ.ZIP
  128.  
  129.      The most useful feature of SpecialOKs is to password protect certain
  130. files that aren't in your download areas.  For example, I have source
  131. code for the Maxi* programmes that I wish to share with other programmers
  132. of my choice...all I have to do is give them a password to use when 
  133. grabbing the files from my system.  Then, I just add a line like this to
  134. my SpecialOKs file:
  135.  
  136. @MFREQSRC !HOSER C:\TURBO\BINK\SOURCE\MFREQSRC
  137.  
  138.      The critical part here is the !<password>...it will always be the
  139. second parameter in the OKFILE listing if a password is present.
  140.  
  141.      The SpecialOKs file is not parsed for accuracy, it is just copied
  142. over as-is before any other entries are added so make sure that your
  143. syntax is exactly correct.  When in doubt, consult your BinkleyTerm
  144. manual!  :)
  145.  
  146. Archiver <path and filename>
  147.  
  148.      This is the full path to your archiver of choice.  If specified,
  149. it will be used to archive the file given for FREQList into a smaller
  150. file for the convenience of sysops FREQing FILES from you.
  151.  
  152. ArcParams <add command> {options} <dest. path and archive name> <source
  153.            path and filename>
  154.  
  155.      This is the command string that will be sent to your archiver.  The
  156. best way of explaining it is to give an example for ST-ZIP 2.3 as my
  157. archiver of choice:
  158.  
  159.      ArcParams  -aei g:\turbo\bink\sunfox.zip g:\turbo\bink\sunfox.txt
  160.  
  161.      ST-ZIP allows me to stack the commands in one word, so I don't need
  162. the {options} field.  I want an archive named SUNFOX.ZIP created (or
  163. updated) in the g:\turbo\bink\ folder.  Generally, your source path and
  164. file name will be exactly the same as the one specified for your FREQList
  165. parameter, but you may add a space between the path and the filename if
  166. your archiver requires it (like Quester's LZH, for instance).  In this
  167. example, my source path and filename is exactly the FREQList parameter.
  168.  
  169.      If you archive your FREQList text file, make sure that your Avail
  170. keywords in BINKLEY.CFG point to this archive file rather than the
  171. text file as I blow away the raw text listing in favour of the archived
  172. listing.
  173.  
  174. FILEAREAS:
  175.  
  176.      Each of your download directories should have a FileArea...
  177. EndFileArea pair associated with it that tells Maxi*FREQ all about your
  178. download areas.
  179.  
  180.      Each FileArea must have the following directives:
  181.  
  182. Desc <description>
  183.  
  184.      This is your name for the file area limited to 45 characters!
  185.  
  186. MagickNames
  187.  
  188.      If you wish filenames to be available for FREQ without the other
  189. sysop having to remember what the extender of the file is, then choose
  190. this option.  It will truncate the "magick name" of the file to eight
  191. characters or less.  For example, ATARINET.ZIP would be available for
  192. FREQ with ATARINET as the "magick name".
  193.  
  194. NoMagickNames
  195.  
  196.      If you wish the full filename to be the "magick name", then choose
  197. this option.  This is desirable if (for instance) you keep several copies
  198. of the AtariNet nodelist in one of your download areas...each of which has
  199. the last two digits of the julian date of the nodelist creation as part of
  200. its extender (i.e. ATARLIST.A38).
  201.  
  202. (NOTE:  Choose only MagickNames or NoMagickNames...not both!)
  203.  
  204. Paths...EndPaths
  205.  
  206.      A Paths...EndPaths block is used to set off your DLareas.  Most
  207. FoReM/Turbo systems have their DL areas spread over several partitions,
  208. so each partition will need a DLarea directive.
  209.  
  210. DLarea <path of DL area> <.DIR file name>
  211.  
  212.      The DLarea directive lists each path and the .DIR file to be found
  213. in that path.  You may have as many of these as you wish in a Paths...
  214. EndPaths pair (indeed, as many as your computer's memory will permit).
  215. The sample configuration should make the syntax a bit more obvious.
  216.  
  217. Remember to end your FileArea definition with an EndFileArea.  Repeat for
  218. all of your download areas (again, the sample config file will show you
  219. this).
  220.  
  221. FINAL COMMENTS:
  222.  
  223. That should about do it...admittedly, the code is still a bit rough, but
  224. in weeks of testing, it's done the job here.  It works on the TT030 and
  225. the Mega4STE with TOS 3.06 and TOS 2.06, respectively.  These two machines
  226. are *THE* torture test of my programmes...so they should run on anything.
  227.  
  228. Any comments/bug reports you may have, please let me know so I can fix them.
  229. I'm usually in Fayetteville (NC) from Friday morning to Sunday evening and
  230. I will be back at the apartment on Monday morning at 6a (I work nights
  231. from Sunday to Thursday).
  232.  
  233. SunFox
  234.