home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR4 / WTICK982.ZIP / WILDTICK.DOC < prev    next >
Text File  |  1994-01-03  |  15KB  |  411 lines
  1. Wildtick - The Simple TIC processor for Wildcat 3.x
  2. v.982 Open Beta Test
  3.  
  4.                           Copyright (C) 1993
  5.                             Lawrence Gordon
  6.                           All Rights Reserved
  7.  
  8. I.      What is Wildtick?
  9.  
  10. Wildtick is a simple to use TIC-processing system for Wildcat BBS
  11. version 3 and higher.  It is very fast, it is very small, and it
  12. is very easy to set up and use.  It integrates with software you 
  13. already have: Tomcat and WCFile.
  14.  
  15. Wildtick is designed specifically for "end nodes"; there is no 
  16. "hatching" or file forwarding ability.  For the majority of Wildcat 
  17. sysops, however, it should do the job - moving files from your mailer's
  18. inbound directory to Wildcat and updating your Wildcat file databases.
  19.  
  20. Wildtick also has a couple of other features that make it a great
  21. tool for the Wildcat sysop: the ability to create a message for
  22. upload to your bbs about your new files, and to create or update
  23. a "runlater.txt" for your virus scanner.
  24.  
  25. II.     How does Wildtick work?
  26.  
  27. Wildtick can run "stand-alone" or can be called from a batch file.
  28. Quite simply, all you have to do is type "Wildtick". It takes no
  29. arguments.  Pretty simple, eh?  Of course, there are two configuration
  30. files you have to set up first, Wildtick.cfg and Wildtick.bbs,
  31. otherwise Wildtick won't do very much.  A simple batch file to
  32. call Wildtick might look like this:
  33.  
  34. @echo off
  35. bnu /l:1=38400,8N1 /F
  36.  
  37. :loop
  38. c:
  39. cd\fd
  40. fd /nounpack
  41. if errorlevel 250 goto mail_in
  42. if errorlevel 245 goto call_bbs
  43. if errorlevel 240 goto mail_out
  44. if errorlevel 10 goto user_break
  45. if errorlevel 0 goto stop_bat
  46.  
  47. :mail_in
  48. c:
  49. cd\fd
  50. wm toss netmail
  51. if exist c:\fd\file\*.tic goto tic_in
  52. goto loop
  53.  
  54. :call_bbs
  55. call DOBBS.BAT
  56. goto loop
  57.  
  58. :mail_out
  59. c:
  60. cd\fd
  61. wm scan netmail
  62. goto loop
  63.  
  64. :tic_in
  65. c:
  66. cd\fd
  67. wildtick
  68. goto loop
  69.  
  70. :user_break
  71. goto stop_bat
  72.  
  73. :stop_bat
  74. bnu /u
  75. exit
  76.  
  77. This batch file assumes that Wildtick.exe is in your C:\FD directory
  78. and that the configuration files, Wildtick.cfg and Wildtick.bbs are
  79. there, too.  In fact, Wildtick won't run unless they are in the same
  80. directory.
  81.  
  82. III.    Configuring Wildtick - Part 1 - Wildtick.cfg
  83.  
  84. You have to have Wildtick.cfg, or Wildtick won't work.  It is nothing
  85. but a simple text file, but it _must be set up correctly_.  A 
  86. sample .cfg file is included. Edit it to reflect your setup and name 
  87. it Wildtick.cfg. Pay attention to what you're doing!  The sample.cfg 
  88. file is included here in its entirety. Memorize it like your life 
  89. depends on it!
  90.  
  91. ; Wildtick Configuration File - Wildtick.cfg
  92. ;
  93. ; All statements must begin at Column 1.
  94. ; Leave no blank spaces after the "=" sign and the variable
  95. ; Maximum variable lengths are indicated by the dotted lines 
  96. ;   between "[" and "]" and "Maximum Length = x"
  97. ; All comments must begin with ";"
  98. ; Some directories must be terminated with the "\" character
  99. ; and some should not. Pay careful attention to the instructions
  100. ; in the file.
  101. ;
  102. ;The correct format is STATEMENT=VARIABLE
  103. ;The STATEMENT must be capitalized!!!!!!!
  104. ;
  105. ;All STATEMENTs must have a variable
  106. ;
  107. ;STATEMENTs used by Wildtick are REPNAME, REPFROM, REPTO,
  108. ;REPSUBJECT, REPCONF, REPHEADER, REPCLOSER, REPTAG, REPPACKER,
  109. ;REPTIC, REPDIR, REPFILES, and REPLATER
  110. ;
  111. ;REPNAME is the name you give to the .REP file created by Wildtick
  112. ;Wildtick will create a QWK-style .REP packet for upload to your
  113. ;BBS. In the example, the reply-packet will be named "TOAST.REP".
  114. ;This field is required.
  115. ;Maximum Length = 8
  116. ;      [--------] 
  117. REPNAME=TOAST
  118. ;
  119. ;REPFROM is the name you wish to use as the message poster in your
  120. ;REP file. This should be your name and should be capitalized.
  121. ;If REPFROM is not specified, the default "SYSOP" will be used.
  122. ;Maximum Length = 25
  123. ;      [-------------------------]
  124. REPFROM=LAWRENCE GORDON
  125. ;
  126. ;REPTO is whom you wish to post your message to.
  127. ;If REPTO is not specified, the default "ALL" will be used.
  128. ;Maximum Length = 25
  129. ;    [-------------------------]
  130. REPTO=ALL
  131. ;
  132. ;REPSUBJECT is the information you want in the .REP subject line.
  133. ;If REPSUBJECT is not specified, the default "New Files!" will be used.
  134. ;Maximum Length = 25
  135. ;         [-------------------------]
  136. REPSUBJECT=New Files!
  137. ;
  138. ;REPCONF is the message area on your board to post the .REP to.
  139. ;This field is required.
  140. ;Maximum Length = 7
  141. ;      [-------]
  142. REPCONF=2
  143. ;
  144. ;REPHEADER can be used for information to your callers.
  145. ;If REPHEADER is not specified, the default "The following files 
  146. ;have been received:" will be used.
  147. ;Maximum Length = 65
  148. ;        [-----------------------------------------------------------------]
  149. REPHEADER=The following files have been received:
  150. ;
  151. ;REPCLOSER can be used for additional information to your callers.
  152. ;If REPCLOSER is not specified, the default "Now available for download."
  153. ;will be used.
  154. ;Maximum Length = 65
  155. ;        [-----------------------------------------------------------------]
  156. REPCLOSER=Now available for download or file request.
  157. ;
  158. ;REPTAG is any tagline you want to give your message.
  159. ;If REPTAG is not specified, the default "The simple TIC processor 
  160. ;for Wildcat!" will be used.
  161. ;Maximum Length = 60
  162. ;     [------------------------------------------------------------]
  163. REPTAG=The simple TIC processor for Wildcat!
  164. ;
  165. ;REPPACKER is the archiver you want to use to bundle your .REP
  166. ;Uncomment the archiver of choice and make sure that it is in
  167. ;your path. Note well that LHA must have the -m argument!
  168. ;If REPPACKER is not specified, the default "PKZIP" will be used.
  169. ;Maximum Length = 64
  170. ;        [----------------------------------------------------------------]
  171. REPPACKER=PKZIP
  172. ;REPPACKER=ARJ a
  173. ;REPPACKER=PKPAK
  174. ;REPPACKER=LHA a -m
  175. ;
  176. ;REPTIC is the directory in which your .TIC files can be found.
  177. ;No trailing backslash!
  178. ;This field is required.
  179. ;Maximum Length = 64
  180. ;     [----------------------------------------------------------------]
  181. REPTIC=C:\FD\FILE
  182. ;
  183. ;REPDIR is the directory to move your .REP file for upload to Wildcat
  184. ;through the Tomcat mail door as defined in TCMAINT.
  185. ;Requires termination of the directory name with the trailing
  186. ;backslash "\".
  187. ;This field is required.
  188. ;Maximum Length = 64
  189. ;     [----------------------------------------------------------------]
  190. REPDIR=C:\LOADS\
  191. ;
  192. ;REPFILES is the location of your WC30 directory. Wildtick must be
  193. ;able to find both WCFILE.EXE and TOMCAT.EXE in this directory.
  194. ;No trailing backslash!
  195. ;This field is required.
  196. ;Maximum Length = 64
  197. ;       [----------------------------------------------------------------]
  198. REPFILES=C:\WC30
  199. ;
  200. ;REPLATER is a text file to write to have your virus scanner run on the
  201. ;received files. Include full path and file name.
  202. ;If REPLATER is not specified, the default "RUNLATER.TXT" will be used.
  203. ;Maximum Length = 64
  204. ;       [----------------------------------------------------------------]
  205. REPLATER=C:\WC30\TS.LST
  206. ;
  207. ;That's all folks!
  208.  
  209. There, that wasn't too bad, was it?
  210.  
  211. IV.     Configuring Wildtick - Part 2 - Wildtick.bbs
  212.  
  213. You have to have Wildtick.bbs, or Wildtick won't work.  It is nothing
  214. but a simple text file, but it _must be set up correctly_.  A 
  215. sample .bbs file is included. Edit it to reflect your setup and name 
  216. it Wildtick.bbs. Pay attention to what you're doing!  The sample.bbs 
  217. file is included here in its entirety. Memorize it like your life 
  218. depends on it! (I know this is repetitious, but it bears repeating!)
  219.  
  220. ; Wildtick BBS File - Wildtick.bbs
  221. ;
  222. ; All statements must begin at Column 1.
  223. ; All comments must begin with ";"
  224. ;
  225. ;Each line may contain 3 or 4 arguments. The fourth argument
  226. ;is the "default uploader" and is optional.
  227. ;Arguments 1, 2 and 3 are required.
  228. ;
  229. ;Argument 1: The TIC area name. This can be no more than 8 characters.
  230. ;Argument 2: The directory to move the files to. This must be terminated
  231. ; with the backslash "\".
  232. ;Argument 3: The file area number as found in MAKEWILD
  233. ;
  234. ;Argument 4: Name of the default uploader.  If there is no argument 4,
  235. ; the default uploader is the person named in the REPFROM field in
  236. ; WILDTICK.CFG.  If you choose to have a different default uploader,
  237. ; then any spaces between words in argument 4 MUST be delineated by
  238. ; the underscore "_" character. (See the TOADNET entry below for
  239. ; an example.)
  240. ;
  241. ;Each argument must have only one blank space between it and the
  242. ;next argument.
  243. ;
  244. ;All directories must be terminated with the backslash "\".
  245. ;
  246. ;The file area number must be included.
  247. ;
  248. PDNBASIC C:\WC30\PROGBAS\ 16
  249. OLR_BETA C:\WC30\OLRBETA\ 25
  250. OLR_DEV C:\WC30\OLRDEV\ 26
  251. OLR_MSGB C:\WC30\OLRMSGB\ 27
  252. OLR_MISC C:\WC30\OLRMISC\ 28
  253. OLR_PNT C:\WC30\OLRPNT\ 29
  254. OLR_QNET C:\WC30\OLRQNET\ 30
  255. OLR_READ C:\WC30\OLRREAD\ 31
  256. OLR_UTIL C:\WC30\OLRUTIL\ 32
  257. SOFTDIST C:\WC30\SOFTDIST\ 33
  258. UTILNET C:\WC30\UTILNET\ 34
  259. TOADNET C:\WC30\TOADNET\ 37 Toast_Master
  260. WDN_DOOR C:\WC30\WDNDOOR\ 35
  261. WDN_WC3 C:\WC30\WDNWC3\ 36
  262. ;
  263. ;That's all folks!
  264.  
  265. Set up all your TIC file areas and you'll be fine. If you
  266. omit a line listing, Wildtick will create an AREANAME.BBS (for
  267. example, TOADNET.BBS) file in your inbound directory and not move 
  268. the files to your Wildcat file areas. But if you enter information 
  269. incorrectly in the Wildtick.bbs file, your program will crash.
  270.  
  271. Are you still with me?
  272.  
  273. V.      Output files.
  274.  
  275. Wildtick produces a number of output files.
  276.  
  277.   A.    BBS_ID.REP file.
  278.  
  279.         BBS_ID.REP, where BBS_ID is the name for your bbs QWK-style
  280.         reply file.  If your REPNAME is TOAST, then TOAST.REP
  281.         will be created.  After execution of Wildtick, the REP
  282.         packet will be uploaded to Wildcat through Tomcat. It's
  283.         all done automatically through Wildtick.
  284.  
  285.   B.    WILDTICK.LOG
  286.  
  287.         A log file, called Wildtick.log, is kept of all the TICs 
  288.         processed by Wildtick and is found in your Wildtick directory.
  289.         Review it at your leisure, delete it at your peril!
  290.  
  291.   C.    WILDTICK.ERR
  292.  
  293.         A log file, called Wildtick.err, is kept anytime Wildtick
  294.         exits prematurely. It contains the date, time and
  295.         description of the condition causing the premature exit.
  296.         This will help you figure out where you are going wrong,
  297.         and help me figure out where I'm going wrong.
  298.         (It won't help you figure out where I am going wrong, though.)
  299.  
  300.   D.    RUNLATER.TXT
  301.  
  302.         This is a list of all files processed by Wildtick. You can
  303.         name this file whatever you want (e.g. TS.LST for TranScan)
  304.         and then call your virus-scanner to test them and rearchive
  305.         them as necessary.
  306.  
  307.   E.    XXXXXXXX.WTC
  308.  
  309.         Wildtick saves all TIC files during processing with the
  310.         .WTC extension. If your program aborts for some reason,
  311.         your TIC files may be restored by renaming all *.WTC
  312.         files to *.TIC. Under normal operation, these files will
  313.         be erased.
  314.  
  315.   F.   *.MSG
  316.  
  317.        Wildtick creates several files with the .MSG extension
  318.        during processing. Under normal operation, these will
  319.        be erased. However, program aborts may leave them in
  320.        your directory. It is safe to erase them. The particular
  321.        .MSG files are TEST.MSG, TEMP.MSG, REPLY.MSG and BBS_ID.MSG
  322.        where BBS_ID is the name of your REP file.
  323.  
  324.   G.   *.BBS
  325.  
  326.        Wildtick creates several messages with the .BBS extension
  327.        during processing. Under normal operation, these will be
  328.        moved to your Wildcat file directories for processing by
  329.        WCFILE.  Some .BBS files may remain in your directory
  330.        because a TIC file could not be associated with a Wildcat
  331.        file area.  Examine the content of the .BBS to see the
  332.        associated files and descriptions and manually add them
  333.        to Wildcat using WCFILE with the name of the .BBS. Be
  334.        sure to add this area, file directory and number to your 
  335.        Wildtick.bbs.
  336.  
  337. VI.     The Whole Shebang
  338.  
  339. This is the sequence of events:
  340.  
  341.   A.    User runs Wildtick
  342.   B.    Wildtick checks for TIC files.
  343.   C.    If it finds any, it reads them and moves the associated files
  344.         to the proper Wildcat directories.
  345.   D.    Wildtick creates a REP file and calls TOMCAT to upload it
  346.         to your bbs in the proper conference.
  347.   E.    Wildtick calls WCFILE to add the new files to Wildcat.
  348.   F.    Wildtick is done.
  349.  
  350. VII.    Beta Testing
  351.  
  352. This version of Wildtick, and all other versions under 1.00, are 
  353. open beta tests, and are free for personal use.  Wildcat sysops are 
  354. encouraged to use and abuse Wildtick to track down those nasty bugs 
  355. and quirks that I couldn't find, report them to me, and to ask for
  356. refinements to the program (that I may or may not add when the
  357. final program is released.)
  358.  
  359. This program has been tested on single-node, multitasking,
  360. networked, and Desqview systems, and appears to work on all, but 
  361. I cannot guarantee that it will work on yours, no matter what your
  362. configuration is.
  363.  
  364. Be that as it may, I still want to know if you are using it,
  365. what your configuration is, your results and problems you might
  366. be having with it. That is my only requirement for this beta test.
  367.  
  368. Beta Testers are also asked to do the following:
  369.  
  370. 1. Send me a netmail message at FidoNet 1:100/560 to let me know
  371.    you are testing Wildtick.
  372.  
  373. 2. Report all problems to me via netmail.  All reports should tell
  374.    me the version number of Wildtick, your directory information,
  375.    and your system configuration, and a copy of your WILDTICK.ERR
  376.    file.
  377.  
  378. 3. Read the FidoNet WILDCAT echo for messages and announcements
  379.    concerning Wildtick. I monitor the WILDCAT echo and I am
  380.    available there to answer questions and to take your heat when
  381.    the program flops on you.
  382.  
  383. 4. Run Wildtick stand-alone a few times before you set it up as
  384.    an event or call it from your batch file so you can see what
  385.    it is doing and report any problems with it to me.  Report
  386.    all error messages you might get, such as
  387.    "Error 76 at program line 5614".
  388.  
  389. VIII.   Final Release
  390.  
  391. Those sysops that have been particularly helpful to me in the beta
  392. test cycle will be entitled to a free copy of Wildtick when then
  393. initial non-beta version is released.
  394.  
  395. IX.     Trademarks, Copyrights, etc.
  396.  
  397. Wildcat, WCFile and Tomcat are copyrighted by Mustang Software, Inc.
  398.  
  399. PKZIP is copyrighted by Phil Katz.
  400.  
  401. Wildtick is copyrighted by Lawrence Gordon.
  402.  
  403. Lawrence Gordon
  404. 4 Waverton
  405. St. Louis, MO  63124
  406. BBS Phone (314) 994-0312
  407. FidoNet 1:100/560
  408. ToadNet 86:8012/11
  409.  
  410. Revised 01/03/1994
  411.