home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / CPM / UTILS / DIRUTL / AKA13.LBR / AKA13.DQC / AKA13.DOC
Text File  |  2000-06-30  |  4KB  |  110 lines
  1.                        DOCUMENTATION FILE
  2.                              FOR AKA
  3.  
  4. ============================================================================
  5.  
  6. AKA.ASM version 1.3 by Michael Conley and Larry Davis is released to the
  7.                     public domain 6/02/86.  Questions or comments should
  8.                     be left on the Charlatan's Cabin BBS (213) 656-4192.
  9.  
  10. The name AKA is taken from the expression "ALSO KNOWN AS" ... because this
  11. program can "be" several other programs!  
  12.  
  13. This is a simple aliasing program for use with ZCMD or ZCPRx which allows
  14. execution of a sequence of commands from a single file.  It depends upon
  15. multiple command execution being enabled in your CCP.  If any of the programs
  16. ends with a warmboot, subsequent commands will not be executed.  Its key
  17. advantage is that NO SUBMIT FILE IS CREATED, and thus the commands themselves
  18. are never seen by the user, and execution time is much faster.
  19.  
  20. ============================================================================
  21. EXAMPLE: 
  22. ========
  23.  
  24. Run AKA.  It asks for a command line.  You type:
  25.  
  26.     A0:;DIR *.BAK;ERA *.BAK;STAT A:
  27.  
  28. The program responds with instructions to type SAVE 4 newname.COM, 
  29. so you type:
  30.  
  31.     SAVE 4 CLEANUP.COM
  32.  
  33. When you run CLEANUP, it logs you into A0:, performs a DIRECTORY of all
  34. files named *.BAK and then erases them, then runs STAT.
  35.  
  36. CHANGING COMMANDS:
  37. ==================
  38.  
  39. You don't need the original AKA to create a new file.  Using our example
  40. from before, you could use the CLEANUP program by simply adding a 'C' to
  41. the command line:
  42.  
  43.     CLEANUP C
  44.  
  45. This would make the program behave exactly like the "virgin" AKA program,
  46. asking for a new command line, and then instructing you to use the CP/M
  47. SAVE command.  You could then write over cleanup, or create a new file
  48. depending upon the filename chosen.
  49.  
  50. Because of the hazards of leaving such an option available on a public system,
  51. the SECURE equate may be changed to TRUE to defeat cloning by copies other 
  52. than the original AKA.
  53.  
  54. INSTALLATION:
  55. =============
  56.  
  57. You probably will not need to reassemble the source code, which is provided
  58. in the AKA library.  There are 3 exceptions:
  59.  
  60.     1)  You have an odd-length CCP (not 2k)  This would make the
  61.         automatic CCP locator produce an incorrect result.
  62.         In this case, enter the location of your CCP base in the
  63.            appropriate equate.  Make sure you use the correct equate
  64.         to specify the internal buffer.   There are adequate notes
  65.         to guide you.
  66.  
  67.     2)  You are using an external command buffer.  This requires
  68.         setting the EXCBUF equate TRUE and manually inserting the
  69.         address of your external buffer at the appropriate equate.
  70.         Refer to notes in the program to locate these equates.
  71.  
  72.     3)  You are using an AKA cloned program on a public system, and
  73.         wish to disable the CHANGE feature.   Locate the SECURE equate
  74.         and set it to TRUE to disable this feature.  AKA will work
  75.         normally, but once a command is inserted into the clone, it
  76.         will ignore the 'C' switch on the command line.  See above.
  77.  
  78. Once the source code is edited, use ASM or MAC to build the program and
  79. LOAD or MLOAD to make the .COM file.
  80.  
  81. THE GOTCHAS:
  82. ============
  83.  
  84. These are things that must be considered when using AKA:
  85.  
  86.  
  87. 1.  Your CCP must be capable of executing multiple commands from its
  88.     internal or external buffer.  Unlike some other programs, AKA will 
  89.     correctly initialize the NXTCHR pointer in the CCP so that the entire 
  90.     command string will execute.
  91.  
  92. 2.  WARMBOOT blues:  If any program in your string of commands exits
  93.     via a warmboot, the rest of the command string will be wiped out
  94.     and will not execute.
  95.  
  96. HISTORY:
  97. ========
  98.  
  99. version 1.3 adds conditional assembly for external command line buffer,
  100.             and adds 'C' option for revising ANY copy of the program.
  101.          Special thanks to Russ Pencin of the Dallas Connection RCP/M
  102.          for his help and suggestions for this version.
  103.                             06/03/86 [MAC]
  104. version 1.2 adds an input function to get the command line
  105.                             05/26/86  Larry Davis
  106. version 1.1 adds automatic calculation of CCP address and buffer length
  107.                             05/19/86 [MAC]
  108. version 1.0 initial release of AKA
  109.                             05/12/86 [MAC]
  110.