home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / znode3 / z3util / queue.lbr / QUEUE.DQC / QUEUE.DOC
Encoding:
Text File  |  1993-06-07  |  5.8 KB  |  124 lines
  1.              DOCUMENTATION FOR ZCPR3 FILE QUEUE MANAGEMENT
  2.  
  3. Using  a number of ZCPR3's utilities, it is possible to build a list, or
  4. queue, of filenames on disk and then access the names in this  queue  in
  5. order  to  process  them. The process is very similar to 'tagging' files
  6. with VFILER or SWEEP, but  a  much  greater  range  of  actions  can  be
  7. performed  on  the  files than either of these utilities allows. Several
  8. examples are provided with this distribution, but it is possible to  add
  9. any  other  manipulations of the queued files that you may wish. Whether
  10. or not you find this scheme of  file  manipulation  useful,  it  may  at
  11. least serve as a demonstration of the power of ZCPR3. 
  12.  
  13.  
  14. Many  of the fancy features of ZCPR3 are used by the distributed system,
  15. although some are found only in the 'applications' which use  the  queue
  16. after  it  has  been  built. In order to use the system, your version of
  17. ZCPR3 must support, at the minimum: 
  18.      A shell stack allowing at least two entries
  19.      VFILER.COM
  20.      SH.COM
  21.      SHVAR.COM
  22.      ZEX.COM
  23.      IF.COM
  24.      GOTO.COM
  25.      REG           ; Either RCP-resident or transient
  26.      ERA           ;    "    "     "      "    "
  27.  
  28. In addition, the following are very desirable: 
  29.      ALIAS.COM
  30.      SHCTRL.COM
  31.      SHDEFINE.COM
  32.      ECHO          ; Either RCP-resident or transient
  33.  
  34. The following files are provided in this distribution: 
  35.           Q.COM
  36.           MENU.VMN
  37.           ADDQ.ZEX
  38.           QVIEW.ZEX
  39.           QTYPE.ZEX
  40.           QM80.ZEX
  41.           QRUN.ZEX
  42.           DOMULT.ZEX
  43.           QSPECIAL.COM
  44.  
  45. Both Q.COM and QSPECIAL.COM are aliases, and you  may  have  to  rewrite
  46. them (with ALIAS.COM) in order for them to run on your system. 
  47.  
  48. The  system  is controlled from VMENU, using MENU.VMN. The ordinary (and
  49. recommended) entry point is via Q.COM, which does some  housekeeping  in
  50. preparation  for  running the system and then invokes VMENU. You will be
  51. presented with the  ordinary  sort  of  VMENU  display:  disk  directory
  52. across  the top and a list of options below. A pointer can be moved from
  53. filename to filename with your arrow keys (if you have any  and  have  a
  54. Z3TCAP  installed)  or  the  Wordstar  cursor diamond. If there are more
  55. directory entries than will fit on the  screen  at  one  time,  you  can
  56. toggle  the  display  with  the '-' key. From the menu, single-keystroke
  57. selections can be made to add to the queue, erase the  queue,  view  the
  58. queue, or perform certain 'application' operations on it. 
  59.  
  60. Typically,  a  menu  selection  will  invoke ZEX, and within the command
  61. file being processed, SH will be loaded on top of  VMENU.  Most  of  the
  62. ZEX  files  contain  some  comments  pertaining  to  their use, and both
  63. comments and commands should be read in  order  to  understand  how  the
  64. queueing  scheme  works.  All of the 'application' files (those that use
  65. the queue rather than modifying it) have a similar  structure;  you  can
  66. use this structure as a template for constructing new menu selections. 
  67.  
  68.  
  69.                               Limitations
  70.  
  71. There  are  a  couple  of  considerations  affecting  the  use  of  this
  72. file-queueing scheme. 
  73.  
  74. Variable Length 
  75.      Because the variable files used by  SH,  SHVAR,  and  SHDEFINE  can
  76.      contain  variable  names  of  no  more  than  8  characters  it  is
  77.      impossible to store  an  entire  filename.  Only  the  first  eight
  78.      characters  are stored -- the extent is lost. As a consequence, you
  79.      cannot put in the queue two different files with the same name  but
  80.      different  extents.  Nor,  of  course, can you put the same name in
  81.      twice. If the process you want to perform requires that  the  names
  82.      have  extents,  then  the  ZEX file for that particular application
  83.      will have to supply the extents in some way. See the  comments  and
  84.      code  in  the  QTYPE.ZEX  and  DOMULT.ZEX files for examples of the
  85.      ways in which this can be handled. 
  86.      
  87. Speed 
  88.      Because accessing the queue involves manipulating  files  on  disk,
  89.      adding  a file to the queue is not comparable (in speed) to tagging
  90.      a file with VFILER or SWEEP. The  speed  difference  will  probably
  91.      not  be  too  bad if your utilities are on a RAM-disk or hard disk,
  92.      but on a floppy-based system you will have to wait several  seconds
  93.      for  each  operation to be completed. One quirk is worth mentioning
  94.      here. SH, SHVAR, and SHDEFINE should, according to the  help  files
  95.      I  have,  look  for  the  SH.VAR  file  in  the  ROOT directory. My
  96.      versions do not: they always look in user area  0  of  the  current
  97.      drive.  Hence  both  Q.COM  and  the  'X' option on the menu try to
  98.      erase it from user area 0. If  there  are,  in  fact,  versions  of
  99.      these  utilities that go to ROOT: for SH.VAR, you will want to make
  100.      the appropriate changes. 
  101.  
  102.  
  103.                              Alternatives
  104.  
  105. For some applications it may be more useful to have filenames  assembled
  106. into  a single text string with each name delimited by spaces or commas.
  107. Such a scheme can be implemented by instructing SHVAR appropriately. 
  108.  
  109. Yet another data structure that can be imposed on  the  SH.VAR  file  is
  110. that  of a stack, with the last name in the first one out. Although less
  111. useful for  operations  on  files  than  a  queue,  there  may  be  some
  112. applications for which it would be appropriate. 
  113.  
  114. One  option  not  implemented  in  the  system as distributed is that of
  115. deleting a name in the middle of the queue. This has  been  left  as  an
  116. exercise for the reader. 
  117.  
  118.  
  119.  
  120.                     Dreas Nielsen
  121.                     234 NW 30th St.
  122.                     Corvallis, OR   97330
  123.                     (503) 754-6539
  124.