home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / filedocs / simtel35.arc / SIMTEL.MAN < prev    next >
Text File  |  1989-12-12  |  14KB  |  309 lines

  1.                      SIMTEL20 CATALOG VIEWER
  2.                            Version 3.5
  3.  
  4.                                by
  5.                       2LT Michael P. Kelly
  6.                      U.S. Army Signal Corps
  7.             Copyright (c) 1989, All Rights Reserved.
  8.                                 
  9.  
  10. DISCLAIMER
  11.  
  12.      This software is copyrighted but public domain, pass it
  13. around until your heart is content.  Just remember that it is
  14. provided "AS IS" with no warranty, expressed or implied, blah,
  15. blah, blah.  What is comes down to is this: by using this
  16. software, you assume full responsibility for anything that
  17. happens.
  18.  
  19. NEW FEATURES IN 3.5
  20.  
  21.      I added three things to this new version that will make the
  22. program more useful to everyone.  In the past, I had been
  23. reluctant to make the program work on monochrome systems.  This
  24. was due in part to the method of development chosen and not out of
  25. spitefulness or laziness.  Since the user interface has been
  26. unchanged for many versions, I decided to solidify it as it is and
  27. make adjustments for the two video systems.  Using the Video
  28. command, you may change to either color or monochrome now, thus
  29. pleasing everyone!  OK.  Now you can have it both ways!
  30.      The next major addition was the inclusion of script files for
  31. AutoFTP30.  If you do not already have a copy of this marvelous
  32. automatic, in the background, SIMTEL20.ARPA downloader, you should
  33. think about getting one.  I have used it many times and it is
  34. great.  With my program and this utility, you can now examine the
  35. catalog, make selections and then download them at your leisure. 
  36. This now frees you to do other things at home or work, like wash
  37. the dishes or listen to your boss ramble on, etc.
  38.      The third addition is minor league.  The file name prompt now
  39. allows for a greater number of characters for path specification.
  40.  
  41. SOURCE CODE
  42.  
  43.      The source code was written in Clipper Summer '87 and
  44. compiled on my PC/AT 10 mHz clone with 42 Meg Miniscribe 3650.  I
  45. used no add-on libraries for the development and in this version
  46. no development tools.
  47.      The source code is available for anyone interested in
  48. learning the operation of the program or wants to change it to
  49. meet their personal needs.  You may not, of course, upload the
  50. source code and pass it around though.  It consists of about 900
  51. lines of Clipper.  The source is available for $25 if anyone is
  52. interested.
  53.  
  54. EXTENDED/EXPANDED MEMORY
  55.  
  56.      One user reported problems running this program on his
  57. machines that had large amounts of memory (over 2 MB).  I have
  58. found from perusing the local Clipper/dBASE BBSs, that Clipper
  59. sometimes has trouble utilizing this extra memory.  Normally,
  60. Clipper code will detect and then use this extra memory for
  61. indexing operations only.  Yet many developers seem to be having
  62. problems with this.
  63.      The common suggestion that seems to be floating around is to
  64. issue the command SET CLIPPER=E000.  This tells Clipper programs
  65. to ignore any extra memory over and above 640 K.  If you are
  66. experiencing this sort of problem, please send me an Email letter
  67. detailing your system and the situation.  I am entitled to a free
  68. copy of Clipper 5.0 whenever they get around to releasing it and
  69. hopefully this problem will go away.
  70.  
  71. NOTATIONS
  72.  
  73.      From here on in, the software listing in SIMIBM.IDX which
  74. contains the data on each file archived on the SIMTEL20.ARPA
  75. system will referred to as the 'catalog'.  Because that is
  76. basically what it is.  A big IBM Public Domain and Shareware
  77. catalog.  NODESCR.IDX is a catalog lacking the description
  78. information but all other information is there.  You may
  79. optionally load this file in as well.
  80.  
  81. 2.   UPGRADING TO VERSION 3.5
  82.  
  83.      Upgrading is still simple.  Instead of telling you delete
  84. this, rename that, let's start fresh.  Save a copy of SIMIBM.IDX
  85. and NODESCR.IDX and delete everything else.  Then unarchive the
  86. file SIMTEL30.ARC in the directory you were using.  The program
  87. will create its own .DBF, .NTX and .DAT files by itself.  Then go
  88. ahead and do an Update and you are all set.
  89.  
  90. 3.   CATALOG FILES, SIZE AND SPEED
  91.  
  92.      The file SIMIBM.IDX is the main catalog file.  NODESCR.IDX is
  93. similar except that it lacks the descriptions of the programs.  It
  94. is a much smaller file and usually a good idea to load it in with
  95. the main catalog file when Updating.
  96.      The last catalog file I used had over 4000 records.  That is
  97. a lot of records to manipulate and hence the time required to
  98. process them is lengthy.  The larger the catalog grows, the longer
  99. the Updating function will need to perform its task.  You should
  100. expect this.  I have tried my best to make it work as fast as
  101. possible, but this is as fast as Clipper can handle it.  
  102.      Luckily, you only have to Update once for each new catalog. 
  103. You no longer have to sit and wait for it to finish after that
  104. first time.  I do not think it is all that bad either!
  105.      I have tried various disk-caching utilities and none of them
  106. seem to help the Updating task.  Some even lengthened the time by
  107. a few seconds, probably due to the extra CPU and memory to memory
  108. transfers.  They did seem to help during the Examine option
  109. though.  The choice is yours.  Your best bet is a RAM disk!
  110.  
  111. 4.   MENUS
  112.  
  113.      The menus are straight forward.  Choose your selection by
  114. positioning the lite-bar over your selection with the arrow keys
  115. and hitting return.  You may also type the first letter of your
  116. choice without return, which is much faster.  This also explains
  117. the somewhat badly named menu selections, since I wanted to keep
  118. uniqueness in the first character of each.
  119.      I moved the menu over to the right and made it vertical
  120. instead of vertical.  The reason was twofold.  First, it gave it a
  121. new look.  Second, there was not enough room for all the commands
  122. to fit horizontally on one line.
  123.      Please note that some on some of the command names I was
  124. really reaching to get a unique first character.  This was
  125. important since many power users prefer to hit the first character
  126. or hot key instead of moving the lite-bar.
  127.  
  128. 5.   FIRST - LAST - NEXT - BACK
  129.  
  130.      These are self-explanatory.  They move you to the first or
  131. last file in the catalog.  You can also move to the next or
  132. previous file.  These options are dependent on the current viewing
  133. order.  Next and Back are convenient in that their hot keys are
  134. located right next to each other on the keyboard.  I personally
  135. find this very handy.
  136.  
  137. 6.   UPDATE
  138.  
  139.      When you update, you are merely replacing the current
  140. database with a new one made up of the file you requested.  You
  141. should note that the current database is erased and then the new
  142. one loaded in.  So if you make a mistake and select a file other
  143. than the Simtel20 catalog file, you are out of luck!  So always
  144. keep a backup around just in case.
  145.      You may now optionally load in the NODESCR.IDX catalog file
  146. that lacks file descriptions.  If you do not want to load it in,
  147. simply hit ESC instead of selecting the file from the pop-up menu.
  148.      Updating will take some time, so be prepared for a wait.  All
  149. the internal processing and setup is done at this time.
  150.      Please note that the *.IDX files must be in MS-DOS <cr/lf>
  151. format.  A few people notified me that they had problems when
  152. trying to perform the Update on the SIMIBM.IDX file when they had
  153. it in UNIX <lf> form.  The *.IDX files are distributed in <cr/lf>
  154. format so unless you did anything with them on your UNIX system,
  155. you should not have to worry.
  156.      If you attempt to load in a file that is not one of the *.IDX
  157. files format, the program will do its best to load in whatever you
  158. tell it.  It will take much longer due to the necessary conversion
  159. time and may seem to make your system hang.  A LONG time may pass
  160. before you get to find out that you have only one entry because
  161. the file you specified was not of the right format.  CTRL-ALT-DEL
  162. if you do not feel like waiting.  I hate to wait!
  163.  
  164. 7.   TOPIC
  165.  
  166.      When you enter a topic, you are basically filtering out all
  167. the records that do not contain the topic (string) in the file
  168. description, file name or directory name.  Again, narrowing a
  169. database using a filter will slow it down.  In this case, with
  170. 4000 or so records, we are talking snails, or grass growing!  I
  171. added this function basically for reporting purposes and not
  172. really for heavy duty poking around.  But you can just browse or
  173. skip around.  Of course, expect to wait some too.  When you are
  174. done printing the reports, clear the topic so that you can resume
  175. normal speed.  A topic is similar to GREPing the file description
  176. for the topic entered.
  177.      As note earlier, disk-caching programs may help somewhat
  178. during this operation.  But you must try it for yourself and
  179. determine if there are any speed benefits to be had.
  180.  
  181. 8.   CLEAR
  182.  
  183.      This option merely clears the current topic back to no topic
  184. and speeds up the program to normal speed.
  185.  
  186. 9.   SEARCH
  187.  
  188.      You may search the database for a file name.  Say you are
  189. looking for the file ZMODEM.ARC.  Enter ZMODEM.ARC to find it, if
  190. it exists.  If you are not sure of the name, you can enter ZMOD*,
  191. for instance, and you will be placed at the first file that meets
  192. that specification.
  193.      Please note:  you may not use the ? wildcard or place the *
  194. wildcard anywhere other than the end of the file specification. 
  195. In other words ZMOD* is acceptable, while ZMOD*.ARC is not. 
  196. Sorry, but Clipper has no true wildcard searching.  This is sort
  197. of a work around and it gives you pseudo-wildcard file searching. 
  198. It is better than nothing though.
  199.  
  200. 10.  EXAMINE
  201.  
  202.      This function will allow you to observe the catalog file in a
  203. full-screen mode.  Since more data is contained for a file than
  204. will fit on a line, you can scroll left and right past the
  205. physical boundaries of the window.  You may also PgUp and PgDn for
  206. quick movement through the catalog.
  207.      The search option is also available within the Examine option
  208. by hitting the F3 key.  This only works inside the Examine option,
  209. the F3 key is disabled outside it.
  210.  
  211. 11.  ORDER
  212.  
  213.      How do you want to examine the files available on SIMTEL20? 
  214. You have 3 choices.  You may view them in order by file name,
  215. directory (default) or chronologically.  The last one is great for
  216. checking out the most recent additions to the SIMTEL20 archives. 
  217. The current file viewing order is displayed on the screen at all
  218. times.
  219.      The point was brought up to me, "Why three indexes?"  The
  220. answer is simply this, so that you can look at the files in the
  221. order that you chose.  Not the order that I have pre-determined
  222. for you in the code.  Sure, the .NTX files take up extra room on
  223. your hard drive, but you can erase them after each session if you
  224. like since they will be re-created automatically next time you run
  225. the program.
  226.  
  227.  
  228. 12.  REPORT
  229.  
  230.      You can print a report in either 80 column or 132 column
  231. format to your printer.  The 132 column report will allow more
  232. information to be displayed about each file.  You can also send
  233. the 132 column report to a disk file by choosing that option and
  234. entering a file name.  The report is affected by the current topic
  235. and order settings.
  236.  
  237. 13.  MANUAL
  238.  
  239.      This allows you to read the manual while using the program.
  240.  
  241. 14.  ADD F1
  242.  
  243.      This option is also triggered by the F1 key at any time
  244. during the program.  This will send some of the file information
  245. to the specified disk output file for later manipulation by you. 
  246. The output file must be open for this to work, otherwise no
  247. writing will take place and you will get a beep.
  248.  
  249. 15.  DISK F2
  250.  
  251.      This option allows you to open an output file for the above
  252. function given the file name you specify.  You may invoke this via
  253. the F2 key at any point in the program.  Specifying a new file for
  254. output will automatically close the old one.  This is an ASCII
  255. text file that will contain the important pieces of information on
  256. each line for each file that you select with Add F1.
  257.  
  258. 16.  JUMP
  259.  
  260.      This allows you to view the possible directories in the
  261. SIMTEL20 archives and optionally jump directly to the directory
  262. that you choose via the pop-up menu.  The catalog is placed in the
  263. directory order after selecting a directory to jump to, regardless
  264. of the previous order setting.
  265.  
  266.  
  267. 17.  INCLUDE F3
  268.  
  269.      This will take the currently viewed file and place it into a
  270. script file array.  After making at least one include, you may
  271. dump your selections to disk in AutoFTP script file format using
  272. the Generate command.  You are allowed up to 100 entries in the
  273. script file array.  All entries after that will be ignored.
  274.  
  275. 18.  GENERATE F4
  276.  
  277.      This command will prompt you for a file name and then dump
  278. your file selections from the script array to the disk file in
  279. AutoFTP script file format.  See the AutoFTP documentation README
  280. file for more information on this program.  For each file it will
  281. change to the needed directory on SIMTEL20 and then download that
  282. file using the -t (tenex) command.  If you want to change local
  283. directory or any of the other more fancy commands, you must edit
  284. the file and introduce those commands yourself.  As it stands now,
  285. you may make 100 file selections with the F3 key and then dump
  286. them to the disk in, say, INFILE.  I simply upload it to my UNIX
  287. system using Kermit in Procomm (takes a split second) and then run
  288. AutoFTP in the background using the following command line:
  289.  
  290.      % sh autoftp30.sh infile &
  291.  
  292. You may then proceed to do your other work or logout (might need
  293. nohup, varies on each system).  You files will be retrieved from
  294. SIMTEL20.ARPA quietly and in the background.  My downloading from
  295. the SIMTEL20 system is that easy!  A friend passed me a copy of
  296. the AutoFTP package.  Check around your system for someone who has
  297. it!
  298.  
  299. 19.  HOW TO CONTACT THE AUTHOR
  300.  
  301.      If you like the program and actually use it, let me know by
  302. Email at mkelly@galaxy.afit.af.mil.  Send me any comments,
  303. suggestions, hate mail, etc.  I will be leaving for Fort Hood, TX
  304. on 20 DEC 89 and cannot confirm whether or not I will be able to
  305. get an account there.  I can ALWAYS be reached on CompuServe at
  306. 73747,420 though.
  307.  
  308.  
  309. ************************** END OF HELP **************************