home *** CD-ROM | disk | FTP | other *** search
/ The Pier Shareware 6 / The_Pier_Shareware_Number_6_(The_Pier_Exchange)_(1995).iso / 035 / b_dir111.zip / B_DOC.TXT < prev    next >
Text File  |  1994-12-05  |  7KB  |  108 lines

  1. B.EXE directory lister for OS/2 and DOS
  2. Version 1.11  December 5, 1994
  3. Dohn Arms
  4.  
  5. Copyright (C) 1994 Dohn Arms
  6.  
  7. Permission to use, copy and distribute this software and its documentation for any purpose and without 
  8. charging more than a nominal fee for copying is hereby granted, provided that the above copyright notice 
  9. appear in all copies and that both that copyright notice and this permission notice appear in supporting
  10. documentation.  This software is provided "as is" without express or implied warranty.
  11.  
  12. This program is "freeware" which means that you do not have to pay for it.  It is not public domain, which 
  13. means that I own the program and no one is allowed to alter the program before redistributing it.
  14.  
  15. The only thing that I ask of anyone that actually uses my program is that if they have access to email, that 
  16. they send me a message telling me if my program is particularly useful or not.  I just want to see if people 
  17. actually use this or not.  My email address is: dohnarms@uiuc.edu .
  18.  
  19.  
  20. What is this program?
  21.         This is a command line program that is to be used to view the contents of a directory.  This 
  22. program is designed to be an enhancement of DIR.  I don't say that it is a replacement of DIR because 
  23. that my program does not do everything DIR does, such as recursively searching subdirectories.  
  24. However, DIR does not find the total size of directory trees either, which B does.  B is made to easily view 
  25. the information contained in a directory.  B will only show file names if asked, or it can show just file 
  26. names and file sizes.  Finding the free space on a hard drive has been relegated to a switch, since finding 
  27. the free space can halt the program momentarily.  B highlights file names with certain extensions for easy 
  28. finding, and the extensions can be changed with an environment variable.  For convenience, I included 
  29. both a DOS and OS/2 executable, so that it can be used in either environment.
  30.  
  31. What's with the name?
  32.         The name was simply a convenience for me due to the fact that I like one letter names for 
  33. programs that I use a lot.  I already had programs named C, D, and E, so I named it B.  If you don't like 
  34. this (which I would probably think true), rename it to whatever you like.  The program is written with 
  35. renaming it in mind.  The help text text (seen with /? switch) will reflect the new name, as will the 
  36. environment variable.  The only condition is that you must keep the .EXE extension in the new name 
  37. (there are ways to run EXE programs after dropping the .EXE extensions).  So change B.EXE to 
  38. BDIR.EXE if you like, and look at the help screen.  The environment variable would then be BDIR, also.
  39.  
  40. Description:
  41.         When run, you will see all the files and subdirectories in a directory.  The uppercase brown 
  42. names are the subdirectories.  The gray names are files that do not have an extension that is being 
  43. searched for.  Anything of another color is a file of a searched-for extension; the colors are yellow, light 
  44. green, red, cyan, and light cyan (these are the official names for these colors).  By default, the extensions 
  45. for OS/2 are EXE, COM, CMD, DOC, and TXT.  For DOS, they are EXE, COM, BAT, DOC, and TXT.  If 
  46. there is an asterisk next to a subdirectory or a file, that means that the file or subdirectory is hidden (from 
  47. normal view, anyway).  If the name of a file is uppercase, that means the file is either read-only or is a 
  48. system file or both (if the file is composed of characters with no cases (such as numbers), you won't be 
  49. able to tell).  In the normal view (/N), there will be a size in bytes next to each file, and a "<DIR>" next to 
  50. each subdirectory.  In the date-time view (/D), there will be the time and date of the last write of each file.
  51. If the file or subdirectory name is longer than 13 characters, in the OS/2 version of B, there will be a ">>" 
  52. character at the end showing that the file name has been cut off.  To view the full name, you must use the 
  53. /L switch, which allows the full name to be shown.
  54.         Under the listing of files and subdirectories, the directory being shown is displayed.  Under that is 
  55. the total number of files shown, with the total size of the files (I haven't fixed B to add EA's yet).  Also, to 
  56. the side of this is the total number of subdirectories shown, also.  
  57.         If all the files can't fit onto the screen, the scrolling stops when the maximum number per screen 
  58. has scrolled by.  If you don't want to see any more of the files, you can stop the scrolling by merely 
  59. pressing the Escape key ("Esc").  All the files that were visible remain visible on the screen.  
  60.         If you use the environment variable to set default switches (described later), and if you want to 
  61. override certain switches, except for the switches controlling the number of columns (/N, /W, /D, and /L) 
  62. and the switch for changing highlighting extensions (/C), the switches will toggle.  So if you have it 
  63. defined to show the free space every time with /F, you can turn it off on the command line by using /F 
  64. again.
  65.  
  66. Form of Command:
  67. B.EXE [path][wildcard] [/?] [/W | /N | /D | /L] [/Z] [/O | /S] [/F] [/E] [/C [ext 1] [ext 2] [ext 3] [ext 4] [ext 5]]
  68.  
  69. Switches:
  70. /? (or /H) is the help screen.  This will give a brief description of the switches.  It also shows exactly what 
  71. environment variable a renamed B looks for in order to replace the default file highlighting extensions.
  72. /W is the wide view with the names of the files and subdirectories only.   Five columns are shown on the 
  73. screen.  This switch will show the maximum number of names.
  74. /N is the normal (and default) view, with the sizes and the names  of the files and subdirectories shown.  
  75. Three columns are used.
  76. /D is the detail view with the times, dates, sizes, and names shown for the files and subdirectories.  Two 
  77. columns
  78. /L is the long view.  It is the same as /D except the full name is shown (OS/2 only) and only one column is 
  79. used.
  80. /O shows only the names of files, and no subdirectory names.
  81. /S shows only the names of subdirectories, and no file names.
  82. /F shows the amount of free space left on the drive which holds the directory being looked at.
  83. /E shows the extensions used to highlight files.
  84. /C changes the extensions used to highlight files, with up to 5 extensions being specified.  Just specify up 
  85. to three letters or numbers comprising the extension, for each.
  86.  
  87. Environment Variable
  88. The B environment variable changes the way B behaves by default.  If you like to see different extensions 
  89. by default, you specify them here.  
  90. The form of the command to do this is:
  91.         SET B=(command line switches)
  92. Do this in your CONFIG.SYS in OS/2, your AUTOEXEC.BAT in DOS, or your command line for either.
  93. NOTE:  If you changed the name of B to something else, the environment variable will also be changed 
  94. from B.  If you renamed B.EXE to BDIR.EXE, the variable would be BDIR. 
  95.  
  96. Contacting the Author:
  97.         If you have any comments about my program, feel free to email me or write me.  I actually want 
  98. to hear from you if you actually use this, so I know my work in putting this on the Internet has not been in 
  99. vain.  I hope you find this useful.
  100. E-Mail:      dohnarms@uiuc.edu
  101. Mail:         Dohn Arms
  102.                Loomis Laboratory of Physics
  103.                1110 West Green Street
  104.                Urbana, IL  61801-3080
  105.  
  106.  
  107.  
  108.