home *** CD-ROM | disk | FTP | other *** search
/ Oakland CPM Archive / oakcpm.iso / cpm / dirutl / synonym3.lbr / SYNONYM2.DQC / SYNONYM2.DOC
Text File  |  1985-06-16  |  4KB  |  134 lines
  1.  
  2. SYNONYM  Version 2.0  by: Bill Allen Sep 1981          Page 1
  3.  
  4.  
  5.      SYNONYM is a program that generates a program. This
  6. generated  program  when executed, will invoke    another CP/M
  7. command. It's really not as complex as it sounds. Here is an
  8. example: You would like to  invoke Microsoft basic by typing
  9. only the letter "B" instead of typing  "MBASIC".  You  could
  10. just  rename MBASIC.COM to B.COM but you could no longer use
  11. "MBASIC" to invoke basic.
  12.  
  13.      SYNONYM  can     create  a  "B.COM"  file  that when
  14. invoked will modify the CCP input  buffer  to  "MBASIC"  and
  15. then  jump  to    the CCP. The new .COM file is very small  (1
  16. block)    and is saved  with  the  $SYS indicator set (in CP/M
  17. 2.x )  so it won't clutter up your DIRectory. Then to invoke
  18. basic you would only have to type: "B". You could also    pass
  19. basic  a  program  name  to  execute  just as with MBASIC by
  20. typing: "B BASPGM" (where  BASPGM  is  the name of the basic
  21. program).
  22.  
  23.     You can also create a SYNONYM with a fixed parameter
  24. string. For example you might like to run  a  basic  program
  25. called    STARTREK.BAS    by typing "ST". SYNONYM can create a
  26. file ("ST.COM") that will invoke  MBASIC and pass it a fixed
  27. string "STARTREK". If you do create a SYNONYM with  a  fixed
  28. paramater  string any paramaters entered on the command line
  29. invoking  the  SYNONYM    will   be   appended  to  the  fixed
  30. paramaters. This could be used to invoke the SUBMIT program,
  31. pass it the name of the .SUB file as a fixed paramater,  and
  32. then any other variable paramaters.
  33.  
  34.  
  35.  
  36.            SYNONYM COMMAND SYNTAX
  37.            ______________________
  38.  
  39. SYNONYM  newname  oldname  [parameter string]
  40.  
  41.     where:
  42.  
  43.     newname
  44.             is    the name to be used as a synonym. It
  45.             can be anything acceptable    to CP/M as a
  46.             file name.
  47.  
  48.     oldname
  49.             is the actual name of the command to  be
  50.             executed and may include a disk letter.
  51.  
  52.     parameter string
  53.             is    a  fixed  string to be passed to the
  54.             command.   It   is     optional   and  any
  55.             paramaters entered when the  synonym  is
  56.             invoked will be appended.
  57.  
  58.  
  59.  
  60. SYNONYM  Version 2.0  by: Bill Allen Sep 1981          Page 2
  61.  
  62.  
  63.              SYNONYM EXAMPLES:
  64.              _________________
  65.  
  66.     Create    a  synonym "B" to invoke "MBASIC" (microsoft
  67. basic). The paramater  string  entered    on  the command line
  68. will be passed to MBASIC.
  69.  
  70.     A>SYNONYM  B  MBASIC<cr>
  71.     example of use:  Invoke MBASIC and run "MYPROG"
  72.     A>B MYPROG<cr>
  73.  
  74.  
  75.     Create a synonym "ST" to invoke "MBASIC" from the A:
  76. disk and pass it the fixed string "STARTREK".
  77.  
  78.     A>SYNONYM  ST  A:MBASIC STARTREK<cr>
  79.     example of use:  Invoke MBASIC and run "STARTREK"
  80.     A>ST<cr>
  81.  
  82.  
  83.     Create a synonym "T" to  invoke  the  built-in    CP/M
  84. command "TYPE".
  85.  
  86.     A>SYNONYM  T  TYPE<cr>
  87.     example of use:  Type this file.
  88.     A>T SYNONYM.DOC<cr>
  89.  
  90.  
  91.     Create    a synonym "M" to invoke a SUB file (MAC.SUB)
  92. and pass it the  paramater  string  entered with the new "M"
  93. command.
  94.  
  95.     A>SYNONYM  M  A:SUBMIT A:MAC<cr>
  96.     example of use:  Submit MAC and pass "ASMPROG $SZ"
  97.     A>M ASMPROG $SZ<cr>
  98.  
  99.  
  100.     Obtain HELP with the SYNONYM command similar to  the
  101. SYNONYM command syntax shown above.
  102.  
  103.        A>SYNONYM ?<cr>       or     A>SYNONYM<cr>
  104.  
  105.  
  106.  
  107. SYNONYM  Version 2.0  by: Bill Allen Sep 1981          Page 3
  108.  
  109.  
  110.             NOTES ON SYNONYM.ASM
  111.             ____________________
  112.  
  113. 1. The program can be assembled with MAC or ASM.
  114.  
  115. 2. The    program has been tested on both CP/M version 1.4 and
  116.    version 2.x (The $SYS attribute is set only on 2.x).
  117.  
  118. 3. The subroutine  "XCTL"  could  easily  be  used  in other
  119.    programs that you would like to have transfer control  to
  120.    another CP/M command. It is self-contained except for the
  121.    call to VARMOV.
  122.  
  123.  
  124.  
  125.     If  you have any problems, questions, suggestions or
  126. modifications; please leave a  message on the TCBBS Dearborn
  127. (313) 846-6127 or call me during business  hours  at:  (313)
  128. 357-4800.
  129.  
  130.  
  131.                   Enjoy,
  132.  
  133.                   Bill Allen - 09/01/81
  134.