home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / WILDCAT / WTICK103.ZIP / WILDTICK.DOC < prev    next >
Text File  |  1994-02-24  |  17KB  |  442 lines
  1. Wildtick - The Simple TIC processor for Wildcat 3.x
  2. v1.00 Official Release
  3.  
  4.                           Copyright (C) 1994
  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 many Wildcat sysops, 
  17. 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 option to create a message for
  22. upload to your bbs about your new files, to create or update
  23. a "runlater.txt" for your virus scanner, the option to "passthrough" 
  24. files to other directories without creating a message or updating 
  25. your Wildcat file database, and the option to create a bullx.bbs/
  26. hellox.bbs to announce your new files to your users.
  27.  
  28.  
  29. II.     How does Wildtick work?
  30.  
  31. Wildtick can run "stand-alone" or can be called from a batch file.
  32. Quite simply, all you have to do is type "Wildtick". It takes no
  33. arguments.  There are two configuration files you have to set up 
  34. first, Wildtick.cfg and Wildtick.bbs, otherwise Wildtick won't do 
  35. very much, and they must exist in the same directory as the directory
  36. from which Wildtick.exe is called.  A simple batch file to
  37. call Wildtick might look like this:
  38.  
  39. @echo off
  40. bnu /l:1=38400,8N1 /F
  41.  
  42. :loop
  43. c:
  44. cd\fd
  45. fd /nounpack
  46. if errorlevel 250 goto mail_in
  47. if errorlevel 245 goto call_bbs
  48. if errorlevel 240 goto mail_out
  49. if errorlevel 10 goto user_break
  50. if errorlevel 0 goto stop_bat
  51.  
  52. :mail_in
  53. c:
  54. cd\fd
  55. wm toss netmail
  56. if exist c:\fd\file\*.tic goto tic_in
  57. goto loop
  58.  
  59. :call_bbs
  60. call DOBBS.BAT
  61. goto loop
  62.  
  63. :mail_out
  64. c:
  65. cd\fd
  66. wm scan netmail
  67. goto loop
  68.  
  69. :tic_in
  70. c:
  71. cd\fd
  72. wildtick
  73. goto loop
  74.  
  75. :user_break
  76. goto stop_bat
  77.  
  78. :stop_bat
  79. bnu /u
  80. exit
  81.  
  82. This batch file assumes that Wildtick.exe is in your C:\FD directory
  83. and that the configuration files, Wildtick.cfg and Wildtick.bbs are
  84. there, too.  In fact, Wildtick won't run unless they are in the same
  85. directory.
  86.  
  87. III.    Configuring Wildtick - Part 1 - Wildtick.cfg
  88.  
  89. Wildtick.cfg is a simple text file that tells Wildtick about your
  90. system. The format of Wildtick.cfg is simply
  91.  
  92. STATEMENT=VARIABLE
  93.  
  94. A sample .cfg file is included. Edit it to reflect your setup and name 
  95. it Wildtick.cfg. Pay attention to what you're doing!  The sample.cfg 
  96. file is included here in its entirety and all the Statements and Variables
  97. are explained. 
  98.  
  99. ; Wildtick Configuration File - Wildtick.cfg
  100. ;
  101. ; All statements must begin at Column 1.
  102. ; Leave no blank spaces after the "=" sign and the variable
  103. ; Maximum variable lengths are indicated by the dotted lines 
  104. ;   between "[" and "]" and "Maximum Length = x"
  105. ; All comments must begin with ";"
  106. ; Some directories must be terminated with the "\" character
  107. ; and some should not. Pay careful attention to the instructions
  108. ; in the file.
  109. ;
  110. ;The correct format is STATEMENT=VARIABLE
  111. ;The STATEMENT must be capitalized!!!!!!!
  112. ;
  113. ;All STATEMENTs must have a variable
  114. ;
  115. ;STATEMENTs used by Wildtick are BBSID, UPLOADER, REPLY,
  116. ;SUBJECT, CONF, HEADER, CLOSER, TAGLINE, PACKER,
  117. ;INBOUND, WCDIR, QWKDIR, SCANLIST, REPORT and BULL
  118. ;
  119. ;BBSID is the name you give to the .REP file created by Wildtick
  120. ;Wildtick will create a QWK-style .REP packet for upload to your
  121. ;BBS. In the example, the reply-packet will be named "TOAST.REP".
  122. ;If you do not want to create a message for your BBS, leave this
  123. ;field blank.
  124. ;Maximum Length = 8
  125. ;    [--------] 
  126. BBSID=TOAST
  127. ;If you don't want a message to be uploaded, use
  128. ;BBSID=
  129. ;
  130. ;UPLOADER is the name you wish to use as the message poster in your
  131. ;REP file. This should be your name and should be capitalized.
  132. ;If UPLOADER is not specified, the default "SYSOP" will be used.
  133. ;Maximum Length = 25
  134. ;       [-------------------------]
  135. UPLOADER=LAWRENCE GORDON
  136. ;
  137. ;REPLY is to whom you wish to post your message.
  138. ;If REPLY is not specified, the default "ALL" will be used.
  139. ;Maximum Length = 25
  140. ;    [-------------------------]
  141. REPLY=ALL
  142. ;
  143. ;SUBJECT is the information you want in the .REP subject line.
  144. ;If SUBJECT is not specified, the default "New Files!" will be used.
  145. ;Maximum Length = 25
  146. ;      [-------------------------]
  147. SUBJECT=New Files!
  148. ;
  149. ;CONF is the message area on your board to post the .REP to.
  150. ;We don't advise using 0 as your upload conference area.
  151. ;This field is required only if you direct Wildtick to create
  152. ;a message for uploading to your BBS.
  153. ;Maximum Length = 7
  154. ;   [-------]
  155. CONF=2
  156. ;
  157. ;HEADER can be used for information to your callers.
  158. ;If HEADER is not specified, the default "The following files 
  159. ;have been received:" will be used.
  160. ;Maximum Length = 65
  161. ;     [-----------------------------------------------------------------]
  162. HEADER=The following files have been received:
  163. ;
  164. ;CLOSER can be used for additional information to your callers.
  165. ;If CLOSER is not specified, the default "Now available for download."
  166. ;will be used.
  167. ;Maximum Length = 65
  168. ;     [-----------------------------------------------------------------]
  169. CLOSER=Now available for download or file request.
  170. ;
  171. ;TAGLINE is any tagline you want to give your message.
  172. ;If TAGLINE is not specified, the default "The simple TIC processor 
  173. ;for Wildcat!" will be used.
  174. ;Maximum Length = 60
  175. ;      [------------------------------------------------------------]
  176. TAGLINE=The simple TIC processor for Wildcat!
  177. ;
  178. ;PACKER is the archiver you want to use to bundle your .REP
  179. ;Uncomment the archiver of choice and make sure that it is in
  180. ;your path. Note well that LHA must have the -m argument!
  181. ;If PACKER is not specified, the default "PKZIP" will be used.
  182. ;Maximum Length = 64
  183. ;     [----------------------------------------------------------------]
  184. PACKER=PKZIP
  185. ;PACKER=ARJ a
  186. ;PACKER=PKPAK
  187. ;PACKER=LHA a -m
  188. ;
  189. ;INBOUND is the directory in which your .TIC files can be found.
  190. ;Do not use a trailing backslash in your directory name.
  191. ;This field is required.
  192. ;Maximum Length = 64
  193. ;      [----------------------------------------------------------------]
  194. INBOUND=C:\FD\FILE
  195. ;
  196. ;QWKDIR is the directory to move your .REP file for upload to Wildcat
  197. ;through the Tomcat mail door as defined in TCMAINT.
  198. ;Requires termination of the directory name with the trailing
  199. ;backslash "\".
  200. ;This field is required.
  201. ;Maximum Length = 64
  202. ;     [----------------------------------------------------------------]
  203. QWKDIR=C:\LOADS\
  204. ;
  205. ;WCDIR is the location of your WC30 directory. Wildtick must be
  206. ;able to find both WCFILE.EXE and TOMCAT.EXE in this directory.
  207. ;Do not use a trailing backslash in your directory name.
  208. ;This field is required.
  209. ;Maximum Length = 64
  210. ;    [----------------------------------------------------------------]
  211. WCDIR=C:\WC30
  212. ;
  213. ;SCANLIST is a text file to write to have your virus scanner run on the
  214. ;received files. Include full path and file name.
  215. ;If SCANLIST is not specified, the default "RUNLATER.TXT" will be used.
  216. ;Maximum Length = 64
  217. ;       [----------------------------------------------------------------]
  218. SCANLIST=C:\WC30\TS.LST
  219. ;
  220. ;REPORT is the Wildtick Log file. You can now specify a name and
  221. ;directory for your log file.
  222. ;Maximum Length = 64
  223. ;     [----------------------------------------------------------------]
  224. REPORT=C:\FD\WILDTICK.LOG
  225. ;
  226. ;BULL is the name of the bulletin or hello .bbs to create for advising
  227. ;your callers of your new incoming files. It is not required if you
  228. ;don't wish to create a bulletin. Use a full path and file name of
  229. ;your choice.
  230. ;Wildtick will only create 1 bulletin/hello file.
  231. BULL=C:\WC30\BULL\BULL13.BBS
  232. ;BULL=C:\WC30\DISP\HELLO4.BBS
  233. ;That's all folks!
  234.  
  235. There, that wasn't too bad, was it?
  236.  
  237. IV.     Configuring Wildtick - Part 2 - Wildtick.bbs
  238.  
  239. You have to have Wildtick.bbs, or Wildtick won't work.  It is nothing
  240. but a simple text file, but it _must be set up correctly_.  A 
  241. sample .bbs file is included. Edit it to reflect your setup and name 
  242. it Wildtick.bbs. Pay attention to what you're doing!  The sample.bbs 
  243. file is included here in its entirety. Memorize it like your life 
  244. depends on it! (I know this is repetitious, but it bears repeating!)
  245.  
  246. ; Wildtick BBS File - Wildtick.bbs
  247. ;
  248. ; All statements must begin at Column 1.
  249. ; All comments must begin with ";"
  250. ;
  251. ;Each line must contain 4 arguments.
  252. ;
  253. ;Argument 1: The TIC area name. This can be no more than 8 characters.
  254. ;Argument 2: File Area Description for your callers.
  255. ;Argument 3: The Wildcat file directory to move the files to. This must be 
  256. ;terminated with the backslash "\".
  257. ;Argument 4: The file area number as found in MAKEWILD or P for a
  258. ;"passsthrough" file area.
  259. ;
  260. ;The File Area Description is new. Separate all words in the description
  261. ;with the underscore "_" character.
  262. ;
  263. ;All directories must be terminated with the backslash "\".
  264. ;
  265. ;The file area number must be included.
  266. ;
  267. ;If you only want Wildtick to move incoming files to a new directory
  268. ;without creating a message and updating your Wildcat file database,
  269. ;use P for the Makewild Number.
  270. ;
  271. ;There is no longer any requirement for separating the arguments
  272. ;by one space.
  273. ;
  274. ;TIC Area  File Area Description         Wildcat Directory Makewild No.
  275. NODEDIFF   Fidonet_Nodediff              C:\IM\NODELIST\   P
  276. TOADNET    Toadnet_Files                 C:\IM\NODELIST\   P
  277. ;  note that the Makewild Nos. above are P for Passthrough
  278. PDNBASIC   Programming_-_BASIC           C:\WC30\PROGBAS\  15
  279. ;                     ^ ^ note the underscores
  280. OLR_BETA  OLRNET_Beta_Test              C:\WC30\OLRBETA\  24
  281. OLR_DEV   OLRNET_Development_Programs   C:\WC30\OLRDEV\   25
  282. OLR_MSGB  OLRNET_Messagebase_Tools      C:\WC30\OLRMSGB\  26
  283. OLR_MISC  OLRNET_Miscellaneous_Files    C:\WC30\OLRMISC\  27
  284. OLR_PNT   OLRNET_Point_Related_Files    C:\WC30\OLRPNT\   28
  285. OLR_QNET  OLRNET_QWK_Networking_Files   C:\WC30\OLRQNET\  29
  286. OLR_READ  OLRNET_Readers                C:\WC30\OLRREAD\  30
  287. OLR_UTIL  OLRNET_Utilities              C:\WC30\OLRUTIL\  31
  288. SOFTDIST  SDS_Files                     C:\WC30\SOFTDIST\ 32
  289. UTILNET   UTILNET_Files                 C:\WC30\UTILNET\  33
  290. WDN_DOOR  WDNET_Wildcat_Door_Programs   C:\WC30\WDNDOOR\  34
  291. WDN_WC3   WDNET_Wildcat_Utilities       C:\WC30\WDNWC3\   35
  292. IM_BETA   IMNET_InterMail_Beta_Versions C:\WC30\IMBETA\   36
  293. IM_DEMO   IMNET_InterMail_Demos         C:\WC30\IMDEMO\   37
  294. IM_UTIL   IMNET_InterMail_Utilities     C:\WC30\IMUTIL\   39
  295. ;
  296. ;That's all folks!
  297.  
  298. Set up all your TIC file areas and you'll be fine. If you
  299. omit a TIC area, Wildtick will create a TIC_AREA.BBS (for
  300. example, TOADNET.BBS) file in your inbound directory and not move 
  301. the files to your Wildcat file areas. But if you enter information 
  302. incorrectly in the Wildtick.bbs file, your program will crash.
  303.  
  304. Are you still with me?
  305.  
  306. V.      Output files.
  307.  
  308. Wildtick produces a number of output files.
  309.  
  310.   A.    BBS_ID.REP file.
  311.  
  312.         BBS_ID.REP, where BBS_ID is the name for your bbs QWK-style
  313.         reply file.  If your REPNAME is TOAST, then TOAST.REP
  314.         will be created.  After execution of Wildtick, the REP
  315.         packet will be uploaded to Wildcat through Tomcat. It's
  316.         all done automatically through Wildtick.
  317.  
  318.   B.    WILDTICK.LOG
  319.  
  320.         A log file, called Wildtick.log, is kept of all the TICs 
  321.         processed by Wildtick and is found in your Wildtick directory.
  322.         Review it at your leisure, delete it at your peril!
  323.  
  324.   C.    WILDTICK.ERR
  325.  
  326.         A log file, called Wildtick.err, is kept anytime Wildtick
  327.         exits prematurely. It contains the date, time and
  328.         description of the condition causing the premature exit.
  329.         This will help you figure out where you are going wrong,
  330.         and help me figure out where I'm going wrong.
  331.         (It won't help you figure out where I am going wrong, though.)
  332.  
  333.   D.    RUNLATER.TXT
  334.  
  335.         This is a list of all files processed by Wildtick. You can
  336.         name this file whatever you want (e.g. TS.LST for TranScan)
  337.         and then call your virus-scanner to test them and rearchive
  338.         them as necessary.
  339.  
  340.   E.    XXXXXXXX.WTC
  341.  
  342.         Wildtick saves all TIC files during processing with the
  343.         .WTC extension. If your program aborts for some reason,
  344.         your TIC files may be restored by renaming all *.WTC
  345.         files to *.TIC. Under normal operation, these files will
  346.         be erased.
  347.  
  348.   F.   *.MSG
  349.  
  350.        Wildtick creates several files with the .MSG extension
  351.        during processing. Under normal operation, these will
  352.        be erased. However, program aborts may leave them in
  353.        your INBOUND directory. It is safe to erase them. The particular
  354.        .MSG files are TEST.MSG, TEMP.MSG, REPLY.MSG, PASS.MSG
  355.        and BBS_ID.MSG where BBS_ID is the name of your REP file.
  356.  
  357.   G.   *.BBS
  358.  
  359.        Wildtick creates several messages with the .BBS extension
  360.        during processing. Under normal operation, these will be
  361.        moved to your Wildcat file directories for processing by
  362.        WCFILE.  Some .BBS files may remain in your directory
  363.        because a TIC file could not be associated with a Wildcat
  364.        file area.  Examine the content of the .BBS to see the
  365.        associated files and descriptions and manually add them
  366.        to Wildcat using WCFILE with the name of the .BBS. Be
  367.        sure to add this area, file directory and number to your 
  368.        Wildtick.bbs.
  369.        
  370.    H.  WTICXYZ.BAT
  371.    
  372.        In order to circumvent the out of memory error generated
  373.        with some configurations, WILDTICK now creates this file
  374.        in Wildcat's home directory.  It may be erased after a
  375.        call to Wildtick, or it can be left alone.
  376.  
  377. VI.     The Whole Shebang
  378.  
  379. This is the sequence of events:
  380.  
  381.   A.    User runs Wildtick
  382.   B.    Wildtick checks for TIC files.
  383.   C.    If it finds any, it reads them and moves the associated files
  384.         to the proper Wildcat or passthrough directories.
  385.   D.    Wildtick optionally creates a REP file and calls TOMCAT to 
  386.         upload it to your bbs in the proper conference.
  387.   E.    Wildtick optionally creates a bullx.bbs or hellox.bbs
  388.         announcing your new files.      
  389.   F.    Wildtick calls WCFILE to add the new files to Wildcat.
  390.   G.    Wildtick is done.
  391.  
  392. VII.    Operating Tips/Support
  393.  
  394. This program has been tested on single-node, multitasking,
  395. networked, and Desqview platforms, and it appears to work on all, 
  396. but I cannot guarantee that it will work on yours, no matter what 
  397. your configuration is. All Wildtick is guaranteed to do is take
  398. up space on your harddrive.
  399.  
  400. Users with problems may obtain support by following these rules:
  401.  
  402. 1. Report all problems to me via netmail at Fidonet 1:100/560.  
  403.    All reports should tell me the version number of Wildtick, your 
  404.    directory information, your system configuration, and a copies 
  405.    of your WILDTICK.ERR, WILDTICK.CFG and WILDTICK.BBS files.
  406.    Please archive this files and name them something like
  407.    USER.ZIP where USER is your name.
  408.  
  409. 2. Read the FidoNet WILDCAT echo for messages and announcements
  410.    concerning Wildtick. I monitor the WILDCAT echo and I am
  411.    available there to answer questions and to take your heat when
  412.    the program flops on you.
  413.  
  414. 3. Run Wildtick stand-alone a few times before you set it up as
  415.    an event or call it from your batch file so you can see what
  416.    it is doing and report any problems with it to me.
  417.  
  418. VIII.   Registration
  419.  
  420. Wildtick is distributed under the Shareware concept: fully functional,
  421. no "nag screens" and non-crippled in any way. It does not require
  422. a key file and will not stop running after a particular length of
  423. time.  Be that as it may, if you use it please register it. A
  424. registration form is included with the archive.
  425.  
  426. IX.     Trademarks, Copyrights, etc.
  427.  
  428. Wildcat, WCFile and Tomcat are copyrighted by Mustang Software, Inc.
  429.  
  430. PKZIP is copyrighted by Phil Katz and PKWARE.
  431.  
  432. Wildtick is copyrighted by Lawrence Gordon.
  433.  
  434. Lawrence Gordon
  435. 4 Waverton
  436. St. Louis, MO  63124
  437. BBS Phone (314) 994-0312
  438. FidoNet 1:100/560
  439. ToadNet 86:8012/11
  440.  
  441. Revised 02/09/1994
  442.