home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / INFO / TURBOPAS / PIBCAT14.ZIP / PIBCAT.DOC < prev    next >
Encoding:
Text File  |  1988-05-29  |  6.7 KB  |  213 lines
  1. Introduction
  2. ============
  3.  
  4. PIBCAT.COM is a disk-cataloguing program.  It lists all files in all
  5. subdirectories on a given disk, and also lists the entries in .ARC and
  6. .LBR files.  You may indicate a match criterion for files, and you may
  7. suppress the .ARC/.LBR expansion listing.
  8.  
  9.  
  10. Restrictions on use
  11. ===================
  12.  
  13. None.  However, I ask that you give me credit if you use any part of
  14. this code in developing other software, and I STRONGLY urge you to
  15. release the source code for such projects so all of us can benefit.
  16. If you make any nifty changes or enhancements to PibCat itself, PLEASE
  17. upload the changes so all of us can profit by them.
  18.  
  19.  
  20. Usage
  21. =====
  22.  
  23.     PIBCAT v /f=filespec /i=indent /m=margin /o=filename /p=pagesize /x /n
  24.  
  25.        v               volume (drive letter) to catalog
  26.                        (default is current drive)
  27.                        If given as ?, this text is displayed.
  28.  
  29. |      /e=filespec     DOS file spec to match for entries contained
  30. |                      in .ARC/.LBR files (default is *.* -- list
  31. |                      all .ARC/.LBR entries).
  32.  
  33.        /f=filespec     DOS file spec to match when listing
  34.                        (default is *.* -- list all files)
  35.  
  36.        /i=indent       # columns to space for .ARC/.LBR entries
  37.                        (default is 0)
  38.  
  39.        /m=margin       left margin to leave (default is 0)
  40.  
  41.  |     /n              expand .ARC/.LBR file contents after displaying
  42.  |                     subdirectory contents rather than immediately
  43.  |                     following the .LBR/.ARC file name.
  44.  |                     (default is to list contents immediately.)
  45.  
  46.        /o=filename     write catalog listing to file "filename"
  47.                        (default is "CATALOG.LIS")
  48.  
  49.        /p=pagesize     paginate listing using "pagesize" lines
  50.                        (default is no pagination)
  51.  
  52.        /x              don't list .ARC/.LBR file contents
  53.                        (default is to list .ARC/.LBR contents)
  54.  
  55.  
  56. Aborting
  57. ========
  58.  
  59. Hit <CTRL>Break to abort catalog listing.
  60.  
  61.  
  62. Output
  63. ======
  64.  
  65. For each selected file, the file name, size in bytes, and time
  66. and date of creation are displayed.  The files are displayed in
  67. sorted order by name.  All subdirectories of each directory
  68. are searched and listed automatically.  By default, a non-paginated
  69. listing is written to CATALOG.LIS.  Use /p= to get a paginated
  70. listing (each page has a page number and is separated from the
  71. previous page by an Ascii form-feed character  (^L) ).
  72.  
  73. The same file name, size, and time/date information is presented
  74. for members of .ARC or .LBR files.  The file names within .ARC or
  75. .LBR files are NOT sorted.  However, most .ARC files are created
  76. with names in sorted order anyway.
  77.  
  78. For .LBR files, the time and date of the last update for each member,
  79. not the original creation time and date, are displayed.  Some .LBR
  80. files do not record creation or update times, and in that case, the
  81. time/date fields are not displayed.
  82.  
  83.  
  84. System requirements
  85. ===================
  86.  
  87. IBM PC or compatible under MS DOS or PC DOS v2.0 or higher with
  88. at least 128K of RAM.
  89.  
  90.  
  91. Examples
  92. ========
  93.  
  94. To get abbreviated help:
  95.  
  96.    PIBCAT ?
  97.  
  98. To catalog the currently logged disk:
  99.  
  100.    PIBCAT
  101.  
  102. To catalog disk C:
  103.  
  104.    PIBCAT C
  105.  
  106. The output goes to file CATALOG.LIS by default.  To specify an alternate
  107. output file called MYDIR.LIS:
  108.  
  109.    PIBCAT C /O=MYDIR.LIS
  110.  
  111. To select a match criterion:
  112.  
  113.    PIBCAT C /F=*.bat         ==> only list .BAT files
  114.    PIBCAT C /F=\bozo         ==> only list files in C:\bozo\ and its
  115.                                  subdirectories
  116. |  PIBCAT /F=*.ARC /E=*.PAS  ==> List only .ARC files and any .PAS files
  117. |                                contained in those .ARC files
  118. |  PIBCAT /E=*.C?M           ==> List all files, but only entries like
  119. |                                *.C?M (*.COM, *.CQM, etc.) in .ARC and .LBR
  120.  
  121. To get a paginated listing:
  122.  
  123.    PIBCAT /P=60              ==> Paginated listing assuming 60 lines per page
  124.                                  (Form feeds separate pages)
  125.  
  126. To get the listing indented (perhaps for binding):
  127.  
  128.    PIBCAT /M=10              ==> Indent listing file by 10 columns
  129.  
  130. To indent the .ARC/.LBR listings further than the directory listings:
  131.  
  132.    PIBCAT /I=5               ==> Indent .ARC/.LBR listings 5 columns further
  133.                                  to right than directory listings
  134.  
  135. To prevent .ARC/.LBR contents listing:
  136.  
  137.    PIBCAT /X                 ==> No expansion of .ARC/.LBR
  138.  
  139. To get .ARC/.LBR contents listing after displaying the subdirectory
  140. entries (as in PibCat v1.0):
  141.  
  142.    PIBCAT /N                 ==> List contents of .ARC/.LBR after all
  143.                                  file names for a given subdirectory
  144.  
  145. Of course the various parameters can be used together.
  146.  
  147.  
  148. Acknowledgments
  149. ===============
  150.  
  151. V1.0
  152. ====
  153.  
  154. The archive search code is based in part on TPARCV.PAS by Michael Quinlan
  155. and ARCV.ASM by Vern Buerg.  The library search code is based in part upon
  156. LU.PAS by Steve Freeman.  Bob Blacher was very helpful in testing PibCat.
  157.  
  158. V1.1
  159. ====
  160.  
  161. The idea and code for implementing the '/n'-style expansion of .LBR and
  162. .ARC files was provided by Stephen Falatko.  Thank you Stephen!  I have
  163. altered the .ARC/.LBR contents display so that .ARC/.LBR entries stand out
  164. better when the contents are displayed as part of the main listing.
  165.  
  166. Dave Seidman pointed out that MS DOS 2.x bugs prevented proper display
  167. of volume labels.  He provided a routine to obtain the correct
  168. volume label for DOS 2.x versions.  (Regrettably, the date and time for
  169. labels appears inaccessible using any of the standard functions under
  170. MS DOS 2.x.)  I have altered the volume display code to check for the DOS
  171. version, and use Dave's method for obtaining the volume label under DOS 2.x.
  172. The date and time for the label are NOT printed under DOS 2.x.
  173.  
  174. Several people complained that the /f= match criterion didn't extend to
  175. members of .ARC/.LBR files.  I've added the /e= match criterion in response.
  176.  
  177. -- Phil Burns
  178.    January 30, 1987
  179.  
  180. V1.2
  181. ====
  182.  
  183. Convert to Turbo v4.0.  No specification changes.  The new version is
  184. an EXE file, i.e., PIBCAT.EXE.
  185.  
  186. -- Phil Burns
  187.    September 1, 1987
  188.  
  189. V1.3
  190. ====
  191.  
  192. Minor code revisions to work better with TP4.  No specification changes.
  193.  
  194. -- Phil Burns
  195.    April 27, 1988
  196.  
  197. V1.4
  198. ====
  199.  
  200. Lewis Paper pointed out a couple of bugs in v1.3:
  201.  
  202.    (1)  Archives or libraries marked as "read only" could not be
  203.         read.
  204.  
  205.    (2)  A formatting bug caused by a bad call to DUPL caused
  206.         occasional system crashes.
  207.  
  208. My thanks to Lewis for pointing out the problems.  These bugs are
  209. fixed in v1.4.
  210.  
  211. -- Phil Burns
  212.    May 29, 1988
  213.