home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR4 / THEDIR.ZIP / THEDIR.DOC < prev    next >
Text File  |  1994-01-31  |  8KB  |  248 lines

  1.  
  2.  
  3. ═══════════════════════════════════════════════════════════════════════════════
  4.         TheDir Version 1.00  By Gil Gomes DXP Computer Services LTD
  5. ═══════════════════════════════════════════════════════════════════════════════
  6.  
  7.  
  8. This ZIPPED Archive should include...
  9.  
  10.  
  11. THEDIR.EXE ----------------------  The Executable program itself
  12. THEDIR.CFG ----------------------  The Default Configuration file.
  13. THEDIR.DOC ----------------------  This Documentation.
  14. D.BAT      ----------------------  Sample Batch file.
  15. DD.BAT     ----------------------  Sample Batch for date sort.
  16. DDN.BAT    ----------------------  Sample Batch for date sort, two column.
  17. DE.BAT     ----------------------  Sample Batch for extension sort.
  18. DEN.BAT    ----------------------  Sample Batch for extension sort, two column.
  19. DS.BAT     ----------------------  Sample Batch for size sort.
  20. DSN.BAT    ----------------------  Sample Batch for size sort, two column.
  21.  
  22.  
  23. ═══════════════════════════════════════════════════════════════════════════════
  24. *** I M P O R T A N T ***  P L E A S E    R E A D   T H E   F O L L O W I N G
  25. ═══════════════════════════════════════════════════════════════════════════════
  26. ═══════════════════════════════════════════════════════════════════════════════
  27. ═══════════════════════════════════════════════════════════════════════════════
  28. ═══════════════════════════════════════════════════════════════════════════════
  29. ═══════════════════════════════════════════════════════════════════════════════
  30.  
  31.         In order for this program to work properly, THEDIR.EXE has only to
  32. be in your path.  THEDIR.CFG, however, can be anywhere you wish to place it.
  33.  
  34. BUT...
  35.  
  36.         You must first have this statement in your AUTOEXEC.BAT file, or
  37. type it at the command line, before using TheDir...
  38.  
  39.  
  40. SET THEDIR=DRIVE:\DIRECTORY\
  41.  
  42. Example  SET THEDIR=C:\THEDIR\CONFIG\
  43.  
  44.  
  45. ***  NOTE ***  That there are no spaces in the string, and that the final
  46.                character is a backslash.
  47.  
  48.         When you type SET from the DOS prompt, there should be a line
  49. that shows in the DOS environment display that includes SET THEDIR= followed
  50. by the location of your configuration file.
  51.  
  52.  
  53. ═══════════════════════════════════════════════════════════════════════════════
  54. ═══════════════════════════════════════════════════════════════════════════════
  55. ═══════════════════════════════════════════════════════════════════════════════
  56. ═══════════════════════════════════════════════════════════════════════════════
  57. ═══════════════════════════════════════════════════════════════════════════════
  58.  
  59.  
  60.         The Dir is a utility that displays a wide directory listing that
  61. can be color coded, by extension, to the user's taste.  It can be configured
  62. for two column or three column displays as well.  What follows is a brief
  63. over-view of TheDir's capabilities and the rules of the game.  Enjoy...
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71. ═══════════════════════════════════════════════════════════════════════════════
  72. Command line switches.
  73. ═══════════════════════════════════════════════════════════════════════════════
  74.  
  75. THEDIR
  76.  
  77.         Will display the current directory in three column mode, sorted by
  78. file name.
  79.  
  80. ═══════════════════════════════════════════════════════════════════════════════
  81.  
  82. THEDIR DRIVE:\SUBDIR\FILENAME.EXT
  83.  
  84.         Will display the filespec that you select on the command line.  Any DOS
  85. legal DIR command line, including wildcards will work.  Such as THEDIR *.PRG,
  86. or THEDIR D:\QMPRO\*.
  87.  
  88. ═══════════════════════════════════════════════════════════════════════════════
  89. /S /D /E /F  ***  Line One  ***
  90. /N /W        ***  Line Two  ***
  91.  
  92.         These command line switches can be either the first, second or third
  93. command line parameter.  The first line of switches are sort switches.
  94.  
  95.         /S ===  Sort by File Size
  96.         /D ===  Sort by Date and Time
  97.         /E ===  Sort by Extension
  98.         /F ===  Sort by Filename >>>*** Default ***<<<
  99.  
  100.         The second line of switches designate the number of colums with which
  101. to display data to the screen.
  102.  
  103.         /N ===  Display in Narrow mode (Two Columns)
  104.         /W ===  Display in Wide mode (Three Columns) >>>*** Default ***<<<
  105.  
  106.         If two such switches are used, the first switch MUST be the display
  107. switch.  For instance... /S /N
  108.  
  109.         If you were to reverse these switches at the command line, you
  110. would invoke an error message.  If there is only one switch at the command
  111. line, then any switch is a legal switch.  Just keep in mind that when using
  112. two switches, the sort switch must be the first switch.  And, of course, you
  113. cannot specify two sort switches, or two display switches on the same command
  114. line.  There are batch files included with the program to show you how this
  115. system works.
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123. ═══════════════════════════════════════════════════════════════════════════════
  124.                The Configuration File...  THEDIR.CFG
  125. ═══════════════════════════════════════════════════════════════════════════════
  126.  
  127.         The first line of the configuration file should include the word
  128. YES, if you wish to have lines seperating the files in the display.  If you
  129. replace YES with NO, or leave the line totally blank, the lines will not
  130. be displayed.  This speeds things up a bit, but isn't quite as attractive.
  131. YES MUST be the first three characters on the first line.
  132.  
  133.         The second user configurable item in the CFG file is the ability
  134. to change the color of the informational headings, such as Current View.
  135. This section will also allow you to modify the color of the Border, the
  136. color of the directory names, the color of the file size column and the
  137. color of the word << DIR >>, that is used to denote a directory.  The following
  138. is taken from the default THEDIR.CFG file and is shown as an example.
  139.  
  140.  
  141. BORDER: BG+/N
  142. SIZE: GR+/N
  143. DIRECT: BR+/N
  144. HEADER: BG+/N
  145. DATA: GR+/N
  146. << DIR >>: B+/N
  147. END
  148.  
  149.  
  150.         The rules are fairly simple.  The selections must remain as you see
  151. them here, and as provided in the default THEDIR.CFG file.  The ":" must be
  152. directly after the selection.  One space must follow the ":".  The color
  153. selection itself MUST be provided and follow on the same line, as shown.
  154.  
  155.  
  156. Legal Foreground colors are as follows
  157.  
  158. R   ------  RED
  159. GR  -----   BROWN
  160. G   ------  GREEN
  161. B   ------  BLUE
  162. BG  -----   CYAN
  163. BR  -----   PURPLE
  164. R+  -----   LIGHT PURPLE
  165. GR+ ----    YELLOW
  166. G+  -----   LIGHT GREEN
  167. B+  -----   LIGHT BLUE
  168. BG+ ----    LIGHT CYAN
  169. BR+ ----    LIGHT PURPLE
  170. *   ----    BLINKING
  171.  
  172. Legal Background colors are as follows
  173.  
  174.  
  175. R   ------  RED
  176. GR  -----   BROWN
  177. G   ------  GREEN
  178. B   ------  BLUE
  179. BG  -----   CYAN
  180. BR  -----   PURPLE
  181.  
  182.  
  183. ═══════════════════════════════════════════════════════════════════════════════
  184.  
  185.         The final user configurable color selection is the EXTENSION
  186. configuration.
  187.  
  188.         These lines must consist of 10 characters.  Not 9.  Not 11.  It is
  189. extremely important to remember this when modifying this section.  Any one,
  190. two or three character extension is valid.  The following is taken from the
  191. default configuration file itself, and is shown here as an example.
  192.  
  193.  
  194. EXE=GR+ /N  < *** Note that all lines are ten characters long.
  195. COM=G+  /N
  196. BAT=R  /GB
  197. BAK=R+* /N
  198. TXT=BG+ /B
  199. DOC=BG+ /N
  200. PRG=W+  /R
  201. ARC=R+  /N  < Any spacing that you find easy to understand may be utilized
  202. ZIP=GR+ /B    as long as the color values are legitimate.
  203. LZH=W+  /B
  204. DBF=W+  /B
  205. DOC=W+  /R
  206. GIF=GR+ /R
  207. ICO=N   /W
  208. INI=B   /W
  209. C=B+    /R
  210. ACT=B+  /B
  211. SAV=W+* /B
  212. GR=GR+* /B
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220. ═══════════════════════════════════════════════════════════════════════════════
  221.  
  222.         Gil Gomes
  223.         DXP Computer Services LTD
  224.         23 Wynne Street
  225.         Seekonk, MA
  226.         02771
  227.         DATA (508)336-3868
  228.         FAX  (508)643-1367
  229.         FIDO 1:323/108
  230.  
  231.         We hope you enjoy this utility and feel free to feed us back any
  232. information or critique.  The source is available to interested parties
  233. who may wish to enhance or modify the product to their taste.
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241. ═══════════════════════════════════════════════════════════════════════════════
  242. This program is public domain and written in Clipper 5.2 with various assists
  243. from Borland's C++, and many Clipper third party tools.
  244.  
  245. Copyright  DXP Computer Services LTD 1994
  246.  
  247. ═══════════════════════════════════════════════════════════════════════════════
  248.