home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / vrac / autont20.zip / SIMDIR22.ZIP / SIMDIR.DOC < prev    next >
Text File  |  1992-10-18  |  11KB  |  267 lines
  1.                                 SIMDIR
  2.  
  3.              Version 2.2 (C) 1991-1992 Christopher Schmidt
  4.  
  5.                     cschmidt@lynx.northeastern.edu
  6.  
  7.  
  8.  
  9. PROGRAM DESCRIPTION
  10.  
  11. The program SIMDIR displays the file SIMIBM.IDX, which contains a list
  12. of the files in the MSDOS directories in the SIMTEL20 archive.  You
  13. can browse through the list by moving a highlight bar and by pressing
  14. function keys.
  15.  
  16. The file is displayed as a two-level hierarchy.  The upper (initial)
  17. level consists of a list of directories, and the lower level consists
  18. of a list of files within a single directory.  At the lower level, you
  19. can move directly to the next or previous directory by pressing a
  20. single key, and you can search across directory for strings of text,
  21. and you can copy selected entries to a "log" file.  At either level,
  22. you can exclude all files that were uploaded before a specified date.
  23.  
  24.  
  25.  
  26. PROGRAM INSTALLATION
  27.  
  28. The file SIMIBM.IDX is stored in compressed format in a file named
  29. SIMIBM.ZIP, which is stored in the SIMTEL20 archive in the directory
  30. PD1:<MSDOS.FILEDOCS>.  You must download and un-compress this file
  31. before you can use the SIMDIR program.
  32.  
  33. The SIMDIR program can display other data files that have the same
  34. format as SIMIBM.IDX.  The file name SIMIBM.IDX is simply the default
  35. value for an optional command line parameter.
  36.  
  37. The SIMDIR installation package includes a file named COLOR.CON, which
  38. defines an alternate color scheme.  If you have a color monitor and
  39. you want to try the alternate color scheme, which is more festive than
  40. the default color scheme, rename the file COLOR.CON to SIMDIR.CON
  41. before running the program.  If you choose not to use COLOR.CON, you
  42. can delete that file from your installation.  In any case, you can
  43. modify all colors from inside the program.
  44.  
  45.  
  46.  
  47. PROGRAM EXECUTION
  48.  
  49. You can execute the program just by typing SIMDIR at the DOS prompt,
  50. providing that the data file SIMIBM.IDX is in the current DOS default
  51. directory.  You can use optional command line parameters to override
  52. the default directories and file names.  If you intend to use the
  53. defaults, you can skip reading the rest of this section, which is a
  54. bit thick with detail.
  55.  
  56. The SIMDIR program takes three optional command line parameters
  57. (described below).  Here is what the command line would look like if
  58. you typed the default values for all parameters:
  59.  
  60.         SIMDIR  SIMIBM.IDX  SIMIBM.X  SIMDIR.CON
  61.  
  62. Methods for specifying the program file name parameters:
  63.  
  64.     o   If you prefer not to set the default directory or type any
  65.         command line parameters every time you execute the program,
  66.         you can create a batch file that executes the program.
  67.  
  68.     o   To specify just the file locations, you need only type the
  69.         location (drive and directory) portion of the first file name;
  70.         the locations of the other files would default to that.  For
  71.         instance, if all three files are located in C:\SIMTEL\, then
  72.         you could execute the program from any directory by typing:
  73.  
  74.                 SIMDIR C:\SIMTEL\
  75.  
  76.     o   Instead of typing the file name parameters on the command
  77.         line, you can specify any or all file names by defining DOS
  78.         environment symbols.  Example:
  79.  
  80.                 SET SIMDAT=C:\SIMTEL\SIMIBM.IDX
  81.                 SET SIMDEX=C:\SIMTEL\SIMIBM.X
  82.                 SET SIMCON=C:\SIMTEL\SIMDIR.CON
  83.  
  84.         To specify just the file locations, you need only define
  85.         SIMDAT; the locations of the other files would default to
  86.         that.  Command line parameters override environment symbols.
  87.  
  88. Command line parameter descriptions:
  89.  
  90.    (1)  Data file specification.
  91.  
  92.         You may type any portion of the complete file specification,
  93.         including the drive, directory, name, and extension.  The
  94.         defaults for drive and directory are the current DOS system
  95.         defaults.  The default name is SIMIBM and the default
  96.         extension is IDX.
  97.  
  98.    (2)  Index file specification.
  99.  
  100.         You may type any portion of the complete file specification,
  101.         including the drive, directory, name, and extension.  The
  102.         defaults for drive, directory, and name are those of the data
  103.         file, and the default extension is X.
  104.  
  105.         The program uses the index file to locate the start of each
  106.         directory in the data file.  The program creates the index
  107.         file if it does not exist, or if its signature does not match
  108.         that of the data file.  It takes about one minute to create
  109.         the index file.  The index file is about 8000 bytes in size
  110.         for the current version of the data file SIMIBM.IDX, which
  111.         itself is about 800,000 bytes in size.
  112.  
  113.    (3)  Configuration file specification.
  114.  
  115.         You may type any portion of the complete file specification,
  116.         including the drive, directory, name, and extension.  The
  117.         defaults for drive and directory are those of the index file.
  118.         The default name is SIMDIR and the default extension is CON.
  119.  
  120.         The configuation file contains your screen color selections.
  121.         If you do not change the colors, then there is no need for a
  122.         configuration file.  It is not an error if the program cannot
  123.         not find the configuration file.  If the configuration file
  124.         does not exist, the program will create the configuration file
  125.         when you instruct the program to "save" your color selections.
  126.  
  127.  
  128.  
  129. INDEX FILE SIGNATURES
  130.  
  131. This section is somewhat technical.
  132.  
  133. When you download a new version of the data file after having used
  134. this program with a previous version of the data file, this program
  135. usually detects that the index file is out of date.  It does this by
  136. comparing a "signature" stored in the index file with the proper
  137. signature for the data file.  The signature contains the data file's
  138. size and time stamp.
  139.  
  140. When the program opens an existing index file, it reads the signature
  141. stored there; if the signature is unrecognized, or if its time and
  142. size components do not match those of the data file, then the program
  143. concludes that the index file should be rewritten.  Before overwriting
  144. an old index file, the program asks for confirmation, to avoid
  145. destroying something valuable.
  146.  
  147. If you should notice that the program does not create a new index file
  148. when accessing a new version of the data file, you should terminate
  149. the program, delete the index file, and start the program again.
  150.  
  151.  
  152.  
  153. LOGICAL NAMES
  154.  
  155. This program supports the use of "logical names" in place of actual
  156. directory names and file names.  The following description of logical
  157. names is rather technical; however, using logical names is entirely
  158. optional, so you can skip this section if you like.
  159.  
  160. Logical names are DOS environment symbols.  (You create and display
  161. DOS environment symbols using the SET command in the DOS command
  162. interpreter.)  When a logical name is used in a file specification,
  163. the logical name must be followed by a colon if you want this program
  164. to replace the logical name with its associated string from the DOS
  165. environment.  You can use logical names in this program's command line
  166. parameters and in output log file names.
  167.  
  168. For example, suppose you define a DOS environment symbol like this:
  169.  
  170.         SET SMF=C:\SIMTEL\MSDOS\FILEDOCS\
  171.  
  172. You can then invoke this program with a command line like this:
  173.  
  174.         SIMDIR SMF:
  175.  
  176. The effect would be exactly as though you had typed this:
  177.  
  178.         SIMDIR C:\SIMTEL\MSDOS\FILEDOCS\
  179.  
  180. Wherever a colon appears in a file specification, if the token to the
  181. left of the colon is a DOS environment symbol, then the symbol and the
  182. colon are replaced by the translation; otherwise, the symbol and the
  183. colon remain in place, so actual drive names are not affected.  This
  184. works much like a macro processor.  The colon can be followed by the
  185. remaining portion of a complete directory specification or file
  186. specification.  Syntactically, the logical name is identical to the
  187. drive name portion of a complete DOS file specification, except that
  188. logical names are not limited to single letters.
  189.  
  190.  
  191.  
  192. AUTHORSHIP AND OWNERSHIP
  193.  
  194. This program is not public domain, but it is free of charge and it may
  195. be freely distributed, provided (a) this document is included, (b) the
  196. program and document are not modified in any way, and (c) no profit is
  197. made from the distribution.  The program was written by me, it is my
  198. property, and I retain all rights.  No warranties are implied or
  199. expressed, and so on.  It would please me very much to hear any
  200. comments you have regarding this program.
  201.  
  202. Christopher Schmidt
  203. cschmidt@lynx.northeastern.edu
  204. Waltham, Massachusetts, USA
  205.  
  206.  
  207.  
  208. REVISIONS
  209.  
  210. Version 2.0 July 1991
  211.  
  212.     This was the first version.  I changed the version number of the
  213.     first version from 1.0 to 2.0 when I realized that in the file
  214.     name SIMDIR10.ZIP, the numeral "1" might be confused with the
  215.     letter "I".  The fact that the name SIMDIR20 is similar to the
  216.     name SIMTEL20 is a nice coincidence.
  217.  
  218. Version 2.1 February 1992
  219.  
  220.     o   The program now displays file sizes greater than one megabyte.
  221.         One of my correspondents kindly informed me that the BIBLE
  222.         directory in SIMIBM.IDX has two files whose sizes exceed one
  223.         megabyte.
  224.  
  225.     o   The program now stores a "signature" in the index file to help
  226.         ensure that the index file is valid and that it matches the
  227.         current data file.  One of my correspondents generously helped
  228.         me to understand that the previous method for ensuring index
  229.         file integrity was inadequate.
  230.  
  231.     o   The program now supports the use of DOS environment symbols as
  232.         logical names in file specifications.
  233.  
  234. Version 2.2 October 1992
  235.  
  236.     o   You can now modify the screen colors.  Your screen color
  237.         selections are stored in a program configuration file.
  238.  
  239.     o   I moved the command descriptions from the program document
  240.         into the program itself.  I hope the online help now contains
  241.         all the information you need (date formats and the like) to
  242.         type appropriate command parameters.
  243.  
  244.     o   You can now use DOS environment symbols to specify the program
  245.         file name parameters, without having to type any parameters on
  246.         the command line.
  247.  
  248.     o   When you use the Select command (which excludes files older
  249.         than a specified date) at file-list level, the date
  250.         restriction now applies to directory-list level as well.  In
  251.         previous versions, the program applied the date restriction
  252.         only to the current directory.
  253.  
  254.     o   At the file-list level, if either of the search commands
  255.         cannot find the specified string within the current directory,
  256.         the program now asks whether you want to search the remaining
  257.         directories.  In previous versions, the program searched
  258.         remaining directories without asking.
  259.  
  260.     o   When the program prompts for a command parameter, you can
  261.         press the up and down arrow keys to scroll through a list of
  262.         your previous responses.
  263.  
  264.     o   The behavior of the program in response to the PGUP and PGDN
  265.         keys is a little different.  I hope this new version is more
  266.         convenient.
  267.