home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / utils / dirutl / xdir3-12.lbr / XDIR3-12.HQP / XDIR3-12.HLP
Text File  |  1985-06-17  |  21KB  |  482 lines
  1. Overview of XDIR3
  2. Basic Use of XDIR3 under ZCPR2
  3. XDIR3 Output Control Options
  4. XDIR3 File Selection Options
  5. XDIR3 File Name Buffer Facility
  6. Use of XDIR3 on Secure Systems
  7. Installation and Sample XDIR3INS Session
  8. :Overview of XDIR3
  9.  
  10.      XDIR3  is an extended directory display utility designed  to 
  11. run  under CP/M 2.2 and support some of the extended features  of 
  12. ZCPR2 as well.  Any conventional CP/M 2.2 user may use XDIR3, but 
  13. he  should make sure he turns off the ZCPR2-specific features  by 
  14. running  the XDIR3 Installation Program,  XDIR3INS,  and manually 
  15. turning them off before using XDIR3.
  16.  
  17.      XDIR3  automatically  adapts to any Org-0 CP/M  2.2  system, 
  18. regardless of the size of its disks.  It reads the disk parameter 
  19. block information from the operating system to determine what the 
  20. attributes  of  the  disk it is working with  are,  and  it  then 
  21. presents its display information accordingly.
  22.  
  23.      XDIR3 runs in two basic modes:
  24.           . as a directory display utility
  25.           . as a file scanner utility (File Name Buffer Facility)
  26.  
  27.      XDIR3  is a ZCPR2 utility which supports the extended  ZCPR2 
  28. features, particularly named directories.
  29.  
  30.      As   a  directory  display  utility,   it  displays  to  you 
  31. information  about  the files on a particular disk in  all  or  a 
  32. particular user area.  It gives you the following information:
  33.           . Name of File
  34.           . Size of File (in K bytes)
  35.           . Attributes of File (R/O or System)
  36.           . Sum of Sizes of All Files Displayed
  37.           . Total Number of Files on Disk
  38.           . Amount of Space Remaining on Disk
  39.           . What Disk and What User Area you are looking at
  40.  
  41.      As a file scanner utility, it does the following:
  42.           . Logs a group of selected files to disk for later scan
  43.           . Prints the contents of such a log file
  44.           . Scans a log file and compares it with the files
  45.                selected by you, telling you what files are
  46.                missing and what files are additional
  47.  
  48.      XDIR3 is quite human-oriented,  with many built-in  features 
  49. which  provide  a  human-interface type of service to  the  user.  
  50. Some of these include:
  51.  
  52.           . Named Directories may be specified
  53.           . The file listing is alphabetized by file name and
  54.                type or file type and name, depending on user
  55.                preference
  56.           . The file listing is organized vertically or
  57.                horizontally, depending on user preference
  58.           . Output may also be send to disk or printer
  59.           . XDIR3 is designed to run quickly, having an optimum
  60.                design in its directory load and sort modules
  61.  
  62. :Basic Use of XDIR3 under ZCPR2
  63.  
  64.      XDIR3 is invoked by one of the following command lines:
  65.  
  66.           XDIR afn oooo... or XDIR afn /oooo...
  67. and
  68.           XDIR /oooo...
  69.  
  70. where all elements after the XDIR command are optional.
  71.  
  72.      'afn'  is an ambiguous file reference,  as described on  the 
  73. following frames.   'o' is an option letter, which is one or more 
  74. of  the options described on the next frame.   Note that since  a 
  75. slash denotes that an option follows, an afn may not begin with a 
  76. slash.   This  can be changed by an equate in the source code  of 
  77. XDIR3 if desired.
  78.  
  79.  
  80.           Aa - Set the attributes of the files to be displayed
  81.                a=S for System Files, a=N for Non-System Files
  82.                a=A for All Files (Non-System and System)
  83.           D  - Send Output to Disk
  84.           Ff - Engage File Name Buffer Facility
  85.                f=L to Log File Names to Disk
  86.                f=P to Print Names Logged to Disk
  87.                f=S to Scan Disk for File Names and Compare to
  88.                     Log
  89.           G  - Toggle Grouping (group files by name and type or
  90.                     type and name)
  91.           H  - Toggle Horizontal or Vertical display format
  92.           I  - Inspect files selected by FL option
  93.           N  - Negate Selection; select those files which do NOT
  94.                     match the ambiguous file name
  95.           P  - Send Output to Printer
  96.  
  97.  
  98.      'afn' is an ambiguous file reference, of the general form:
  99.  
  100.           dir:filename.typ
  101.  
  102. where
  103.      filename.typ   is a conventional CP/M ambiguous file name
  104.                          (wild card characters of ? and * are OK,
  105.                          but file name must NOT start with /)
  106.      dir:           is a ZCPR2 directory specification, which may
  107.                          be one of the following forms:
  108.           d:        where 'd' is a disk letter (A-P) to indicate
  109.                          the current user area on that disk
  110.           u:        where 'u' is a user number (0-31) to indicate
  111.                          that user on the current disk; 'u' may
  112.                          be a '?', in which case all user areas
  113.                          are selected
  114.           du:       where 'du' specifies both disk and user
  115.           name:     where 'name' is the name of a directory
  116.                          (disk/user area)
  117.  
  118.      Examples of an ambiguous file reference are:
  119.  
  120.           A:FILE.TXT          A4:FILE.TXT
  121.           ROOT:FILE.TXT       A?:*.COM
  122.           12:*.*              A12:SYSLIB*.*
  123.  
  124.      Examples of an XDIR3 command are:
  125.  
  126.           XDIR ROOT:*.COM AAN
  127.                -- Select All Files in directory ROOT which do
  128.                   NOT match *.COM
  129.           XDIR B10: ASD
  130.                -- Select the System Files in B10, and send
  131.                   output to disk as well as console
  132.           XDIR /AADP
  133.                -- Select All Files in current directory, and
  134.                   send output to disk and printer as well as
  135.                   console
  136. :XDIR3 Output Control Options
  137.  
  138.      These options are:
  139.  
  140.           D  - Send Output to Disk
  141.           G  - Toggle Grouping (group files by name and type or
  142.                     type and name)
  143.           H  - Toggle Horizontal or Vertical display format
  144.           P  - Send Output to Printer
  145.  
  146.      D and P are fairly obvious.   If P is specified,  the output 
  147. goes to your printer (CP/M LST:  device) as well as your console.  
  148. If  D is specified,  the output goes to your current directory as 
  149. the file XDIR.DIR.  If XDIR.DIR already exists, it is replaced.
  150.  
  151.  
  152.      G  and  H  are  toggled  options.    If,   via  XDIR3INS  at 
  153. installation time,  you selected alphabetization by file name and 
  154. type, the G option will flip this to alphabetize by file type and 
  155. name,  and vice-versa.  The same with the H option.
  156.  
  157.      G  allows you to select your display to be  alphabetized  by 
  158. file  name and type or type and name.   If by file name and type, 
  159. then AA.TXT comes before BB.COM.   If by file type and name, then 
  160. BB.COM  comes before AA.TXT.   Alphabetization by file  name  and 
  161. type groups files of the same name together (FN fields,  like all 
  162. XDIR3  files),  while  by file type and name groups files of  the 
  163. same type together (FT fields, like all *.TXT files).
  164.  
  165.      H allows you to select your alphabetized files to be  listed 
  166. down  the  screen (vertical) or across the  screen  (horizontal).  
  167. The screen is divided into three columns,  and a vertical listing 
  168. alphabetizes down the first column, then the second, and then the 
  169. third, while a horizontal listing alphabetizes first, second, and 
  170. third columns on the first line, and so on with each line.
  171. :XDIR3 File Selection Options
  172.  
  173.      The  following  options (and the DIR:  field)  control  file 
  174. selection:
  175.  
  176.           Aa - Set the attributes of the files to be displayed
  177.                a=S for System Files, a=N for Non-System Files
  178.                a=A for All Files (Non-System and System)
  179.           N  - Negate Selection; select those files which do NOT
  180.                     match the ambiguous file name
  181.  
  182.      The N option negates your ambiguous file name reference, but 
  183. it  stays  in the SAME set of system or  non-system  files.   For 
  184. instance,  XDIR  *.COM /NAS selects all SYSTEM files which do NOT 
  185. match *.COM.  If you have installed XDIR3 to automatically select 
  186. both SYSTEM and NON-SYSTEM files,  then XDIR *.COM /N will select 
  187. all non-COM files in your current directory.
  188.  
  189.  
  190.      The  A  option  sets  the attributes  of  the  files  to  be 
  191. displayed.   If AA is presented,  then both Non-System and System 
  192. files will be displayed.   If AS,  then just System files, and if 
  193. AN, then just Non-System.
  194.  
  195.      You  can  set  the  default file  attribute  display  to  be 
  196. whatever  you  desire.    Using  XDIR3INS,  you  can  have  XDIR3 
  197. automatically  select just the System files,  just the Non-System 
  198. files,  or  both Non-System and System files whenever you run  it 
  199. without using the A option.
  200.  
  201.  
  202. :XDIR3 File Name Buffer Facility
  203.  
  204.      The  options of XDIR3 which deal with the File  Name  Buffer 
  205. Facility are:
  206.  
  207.           Ff - Engage File Name Buffer Facility
  208.                f=L to Log File Names to Disk
  209.                f=P to Print Names Logged to Disk
  210.                f=S to Scan Disk for File Names and Compare to
  211.                     Log
  212.           I  - Inspect files selected by FL option
  213.  
  214.      The  file selection options come into play as well with  the 
  215. FL  option  to select the files to be placed into the  log  file, 
  216. FNAMES.DIR.
  217.  
  218.  
  219.      The  FL option writes the user numbers and file names of the 
  220. selected  files  to  disk into the  file  named  FNAMES.DIR.   If 
  221. FNAMES.DIR already exists,  then it is rewritten.  The FNAMES.DIR 
  222. files is used by the FP and FS options.
  223.  
  224.      The  I  option  (for inspect) allows the  user  to  manually 
  225. approve each file before its name is placed into FNAMES.DIR.
  226.  
  227.      The  FP option simply prints out the user numbers and  names 
  228. of all the files stored in FNAMES.DIR.   If FNAMES.DIR is not  in 
  229. the current directory,  FP will search along the ZCPR2 path until 
  230. it finds it or reaches the end of the path.
  231.  
  232.      The FS option scans FNAMES.DIR and the files selected by the 
  233. user  (or implied if no specific file selection option is  given) 
  234. and compares them.  If a file exists in FNAMES.DIR but not in the 
  235. selected files, its name is printed as a missing file.  If a file 
  236. exists  on disk but not in the FNAMES.DIR file,  then its name is 
  237. printed as an additional file.
  238.  
  239.      Note  that the user should keep in mind what he is  scanning 
  240. for when he uses the File Name Buffer Facility.  For instance, if 
  241. he  selects both Non-system and System files with the  FL  option 
  242. and then defaults to Non-System with the FS option,  then several 
  243. files will come up missing while this is not necessarily true.
  244.  
  245.      Using XDIR3INS,  the Installation Program for XDIR3, you can 
  246. create  two  different  versions of XDIR3  -- one  for  Directory 
  247. Display   operations  and  one  for  File  Name  Buffer  Facility 
  248. functions.  If you do this, then you could also set the Directory 
  249. Display version to work with Non-System files by  default,  while 
  250. you  could set the File Name Buffer Facility version to work with 
  251. both Non-System and System files.
  252.  
  253. :Use of XDIR3 on Secure Systems
  254.  
  255.      On Secure Systems, such as Remote CP/M Systems, XDIR3 may be 
  256. configured,  via XDIR3INS, to provide a secure directory utility.  
  257. Some ideas along this line include:
  258.  
  259.           . You can install XDIR3 so that it cannot look at any
  260.                directory other than the one it is in
  261.           . You can install XDIR3 so that you can look at the
  262.                current user area on any disk, but not in other
  263.                user areas
  264.           . You can install XDIR3 so that you can look at all
  265.                user areas on the current disk, but not on any
  266.                other disk
  267.           . You can install XDIR3 so that you cannot look at any
  268.                System files
  269.           . You can install XDIR3 so that none of the F options
  270.                are available
  271.           . You can install XDIR3 so that users may list the
  272.                files (FP) or scan the disk (FS), but not log
  273.                files to disk (FL)
  274.  
  275.      These are just some of the ways I have designed XDIR3 to  be 
  276. flexible in these types of environments.   In a more conventional 
  277. environment,  such  as  a software development  environment,  you 
  278. would  probably  want  XDIR3  to  give  you  complete  access  to 
  279. everything.
  280.  
  281.      See  the  next section on installation for more  details  on 
  282. setting XDIR3 capabilities and defaults.
  283.  
  284. :Installation and Sample XDIR3INS Session
  285.  
  286.      XDIR3INS is the installation program which comes along  with 
  287. XDIR3  and  allows the user to define the basic capabilities  and 
  288. default functions executed by a particular copy of XDIR3.
  289.  
  290.      When XDIR3INS is executed,  it asks the user for the name of 
  291. the  XDIR3 file.   The user may specify this file in  the  normal 
  292. ZCPR2 format:
  293.  
  294.           dir:filename.typ
  295.  
  296.      XDIR3INS  will  read  the first block of  this  file,  which 
  297. contains the customization information,  and then allow you to do 
  298. one of three things (its basic command prompt):
  299.  
  300.           . Display the Current Features
  301.           . Set the Features of XDIR3 to the user's liking
  302.           . Exit and optionally create a new XDIR3 COM file
  303.  
  304.      The  features  which may be set by the system manager  under 
  305. XDIR3INS are:
  306.           . Whether the user may specify a directory (disk/user)
  307.           . If directory specification is allowed, whether the
  308.                user may specify just disk or just user (but not
  309.                necessarily both)
  310.           . Whether the user may employ any of the F options
  311.           . If the F options may be used, if the user may employ
  312.                the FL option specificially
  313.           . Whether the user may employ the AS option
  314.           . Whether XDIR3 will perform a Directory Display
  315.                of File Name Buffer Facility function by default
  316.           . Whether XDIR3 will display Non-System or System files
  317.                (or both) by default
  318.           . Whether the alphabetization will be by file name and
  319.                type or type and name by default
  320.           . Whether the listing will be vertical or horizontal by
  321.                default
  322.           . Whether ZCPR2 External Paths are available, and, if
  323.                so, what the base path address is
  324.  
  325.      If  the  user is not running ZCPR2,  he should  be  sure  to 
  326. disable External Paths.
  327.  
  328.      The prompting by XDIR3INS is quite self-explanatory,  so the 
  329. following  frames  show  you an  actual  XDIR3INS  session,  with 
  330. comments marked off by <-- to explain what is going on.
  331.  
  332.  
  333.                      Sample XDIR3INS Session
  334.  
  335. B>xdir3ins          <-- Invocation Command
  336.  
  337. XDIR3INS -- Installation Program for XDIR3
  338. Name of XDIR3 File (<CR>=Abort)? xdir.com    <-- I enter the name
  339. Ready to Set Default Values
  340.  
  341.  
  342.         XDIR3INS Command (D=Display Values, S=Set Values, X=Exit)? D
  343.                     <-- Type D to Display Current Values
  344.  
  345. Enable Specification of User Number and Disk: Yes
  346. Specification of Disk Allowed: Yes
  347. Specification of User Allowed: Yes
  348. Alphabetize Listing by File Type and Name
  349. Vertical Listing
  350. Non-System  Files Are Selected
  351. Directory Display Default Function Selected
  352. Enable File Scanner Options: Yes
  353. Enable File Log Option: Yes
  354. Enable Attribute System Option: Yes
  355. Enable External Paths: Yes
  356. Address of External Path is 0040H
  357.  
  358.  
  359.         XDIR3INS Command (D=Display Values, S=Set Values, X=Exit)? S
  360.                     <-- Type S to Set New Values
  361.  
  362. Enable Specification of User Number and Disk: Yes <-- See Current
  363.   Do you want to Enable this Flag (Y or N, <CR>=No Change)?
  364.                <-- Select Change or No Change
  365.  
  366. Specification of Disk Allowed: Yes
  367.   Do you want to Enable this Flag (Y or N, <CR>=No Change)? 
  368.  
  369. Specification of User Allowed: Yes
  370.   Do you want to Enable this Flag (Y or N, <CR>=No Change)? 
  371.  
  372. Alphabetize Listing by File Type and Name
  373.   If the flag is enabled, Group by File Type and Name
  374.   If the flag is disabled, Group by Name and Type
  375.   Do you want to Enable this Flag (Y or N, <CR>=No Change)? N
  376.           <-- Change to Alphabetize by Name and Type
  377.  
  378.  
  379. Vertical Listing
  380.   If the flag is enabled, Format is Horizontal
  381.   If the flag is disabled, Format is Vertical
  382.   Do you want to Enable this Flag (Y or N, <CR>=No Change)? Y
  383.           <-- Change to Horizontal Listing
  384.  
  385. Non-System  Files Are Selected
  386.   Enable Non-System File Display (Y or N, <CR>=No Change)? Y
  387.  
  388.   Enable System File Display (Y or N, <CR>=No Change)? Y
  389.           <-- Select System Files as well
  390.  
  391. Directory Display Default Function Selected
  392.   If the flag is enabled, File Scan is Selected
  393.   If the flag is disabled, Directory Display is Selected
  394.   Do you want to Enable this Flag (Y or N, <CR>=No Change)? 
  395.  
  396.  
  397. Enable File Scanner Options: Yes
  398.   Do you want to Enable this Flag (Y or N, <CR>=No Change)? 
  399.  
  400. Enable File Log Option: Yes
  401.   Do you want to Enable this Flag (Y or N, <CR>=No Change)? 
  402.  
  403. Enable Attribute System Option: Yes
  404.   Do you want to Enable this Flag (Y or N, <CR>=No Change)? 
  405.  
  406. Enable External Paths: Yes
  407. Address of External Path is 0040H
  408.   Do you want to Enable this Flag (Y or N, <CR>=No Change)? 
  409.  
  410.  
  411.         XDIR3INS Command (D=Display Values, S=Set Values, X=Exit)? X
  412.                <-- X to Exit
  413.  
  414. Do you want to save changes (Y or N, <CR>=Y)? Y
  415.                <-- Yes, Save Changes
  416.  
  417. Provide Name of Output File
  418. Name of XDIR3 File (<CR>=Abort)? xdir3.com   <-- I Specified
  419.                          <-- XDIR3.COM, but I could have
  420.                          <-- specified XDIR.COM as well
  421.  
  422. Writing File to Disk --
  423. ............................................................
  424. ...................
  425.  
  426.  
  427. B>diff xdir.com xdir3.com     <-- Run difference pgm
  428. DIFF  Version 1.0             <-- to compare results
  429. Source 1 File Name -- B:XDIR    .COM
  430. Source 2 File Name -- B:XDIR3   .COM
  431.   Change Disks if Desired and Type ^C or A to Abort or <RETURN> to Continue -  
  432.  Rel Offset   B:XDIR    .COM      B:XDIR3   .COM   File Differences Listing
  433.  Hex    Dec    Hex  Dec Asc        Hex  Dec Asc
  434. 0005      5     FF  255  .          00    0  .
  435. 0006      6     00    0  .          FF  255  .
  436. 0007      7     80  128  .          C0  192  .
  437.  
  438.  
  439. B>xdir    <-- Run old XDIR3
  440.  
  441. XDIR III, Version 1.2    Vertical Listing by File Type and Name
  442.  Disk: B  User:   0, File Attributes:  Non-System
  443.  
  444. Filename.Typ Size K RS   Filename.Typ Size K RS   Filename.Typ Size K RS
  445. -------- --- ------ --   -------- --- ------ --   -------- --- ------ --
  446.  DD0    .-40      0 R    XDIR3   .COM     10      MLONGINT.MAC     10      
  447. FNDFILE .ASM      4      XDIR3INS.COM      4      XDIR3   .MAC     36      
  448. MCHECK  .ASM     12      LU      .DOC     24      XDIR3INS.MAC     12      
  449. LU      .COM     18      MCOPY   .MAC     22      
  450.    11 Files Occupying   152K,    15 Files on Disk and   412K Free
  451.  
  452.  
  453. B>xdir3   <-- Run New XDIR3; not Horizontal and Non-Sys/Sys now
  454.  
  455. XDIR III, Version 1.2    Horizontal Listing by File Name and Type
  456.  Disk: B  User:   0, File Attributes:  Non-System System
  457.  
  458. Filename.Typ Size K RS   Filename.Typ Size K RS   Filename.Typ Size K RS
  459. -------- --- ------ --   -------- --- ------ --   -------- --- ------ --
  460.  DD0    .-40      0 R    FNDFILE .ASM      4      GETSYS  .COM     10 RS   
  461. LU      .COM     18      LU      .DOC     24      MCHECK  .ASM     12      
  462. MCOPY   .COM      4 RS   MCOPY   .MAC     22      MLONGINT.MAC     10      
  463. PIP     .COM      8 RS   XDIR    .COM     10 RS   XDIR3   .COM     10      
  464. XDIR3   .MAC     36      XDIR3INS.COM      4      XDIR3INS.MAC     12      
  465.    15 Files Occupying   184K,    15 Files on Disk and   412K Free
  466.  
  467.  
  468. B>xdir3 /h          <-- Use new XDIR3, but toggle Horiz to Vert
  469.  
  470. XDIR III, Version 1.2    Vertical Listing by File Name and Type
  471.  Disk: B  User:   0, File Attributes:  Non-System System
  472.  
  473. Filename.Typ Size K RS   Filename.Typ Size K RS   Filename.Typ Size K RS
  474. -------- --- ------ --   -------- --- ------ --   -------- --- ------ --
  475.  DD0    .-40      0 R    MCHECK  .ASM     12      XDIR    .COM     10 RS   
  476. FNDFILE .ASM      4      MCOPY   .COM      4 RS   XDIR3   .COM     10      
  477. GETSYS  .COM     10 RS   MCOPY   .MAC     22      XDIR3   .MAC     36      
  478. LU      .COM     18      MLONGINT.MAC     10      XDIR3INS.COM      4      
  479. LU      .DOC     24      PIP     .COM      8 RS   XDIR3INS.MAC     12      
  480.    15 Files Occupying   184K,    15 Files on Disk and   412K Free
  481.  
  482.