home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / zsus / z3help / t.lbr / TXTALIAS.HZP / TXTALIAS.HLP
Encoding:
Text File  |  1991-11-18  |  5.0 KB  |  111 lines
  1. ;
  2.                                 TXTALIAS.COM                                  
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5.                4k (29)   88D1  1.00       Bruce Morgen 5/91        Z3COM21
  6.  
  7.   1- Syntax  2- Comments/Newlines  3- Error flags  4- Examples of Use         
  8.  
  9.  
  10.    TXTALIAS is a true  ZCPR3 tool  that  "compiles"  standalone  aliases  from
  11. standard ASCII "source" files.   TXTALIAS is  conceptually  similar to ACREATE
  12. and BA24, but it supports  assembler-style  comments and  multiple newlines in
  13. the source file,  has Joe Wright's latest ALIAS0  built-in rather than using a
  14. separate "alias template" file,  allows  VALIAS-style "recursive" aliases, and
  15. has Program Error Flag support for automation of alias "development."
  16. :1
  17.  Syntax   TXTALIAS [dir:]filename[.typ] [dir:][alias] [[/]R]
  18.  
  19.           Without an output alias specification, produces
  20.           the alias "filename.COM" in the current directory.
  21.           "R" option is for a VALIAS-style recursive alias.
  22.  
  23.  
  24.    Aside from some mild alias naming constraints,  TXTALIAS has no significant
  25. use limitations.  Command lines longer than the ZCPR3 Command Line Buffer will
  26. cause a warning prompt,  but  processing can  optionally  continue  until  the
  27. physical capacity of the ALIAS0  module itself is exceeded.   Source file size
  28. is limited to available  memory minus TXTALIAS itself.   If no RSX is present,
  29. TXTALIAS protects the CCP with  a full page to  spare.  Like ALIAS and SALIAS,
  30. TXTALIAS requires "wheel" privileges.
  31. :2
  32.  Comments and Newlines - 1/2 
  33.  
  34.    TXTALIAS supports source file comments in the familiar standard Intel/Zilog
  35. assembly language style.
  36.  
  37.    Full line comments must begin with a semicolon:
  38.  
  39.    ;This is a full line comment and
  40.    ; so is this.
  41.  
  42.    Inline comments must be preceded by one or more horizontal fixed  tab (09h)
  43. characters AND a semi-colon:
  44.  
  45.    dir   ;"dir" is a command, this is a comment.
  46.  Comments and Newlines - 2/2 
  47.  
  48.    Multiple consecutive newlines are  also  handled sensibly.   The  following
  49. source file...
  50. ---------------------------------------------|
  51. cls                                          |
  52.                                              |
  53. ;this is a comment                           |
  54. ;this is a comment                           |
  55. echo this is a test    ; This is a comment  |
  56.                                              |
  57. h                                            |
  58. ---------------------------------------------|
  59.  
  60. ...would "compile" into the following alias command line:
  61. ---------------------------------------------|
  62. cls;echo this is a test;h                    |
  63. ---------------------------------------------|
  64. :3
  65.  ZCPR3 Program Error Flag Values 
  66.  
  67. Condition                                        Decimal Value
  68. ---------                                        -------------
  69. No errors detected                               0
  70. Source file not found                            255
  71. Source file probably empty                       2
  72. Disk write error                                 1, 3, or 4
  73. Command Line Overflow                            89
  74. ALIAS0 overflow                                  99
  75. Source file error (no terminating newline)       100
  76. Not enough memory                                63 (ASCII "?")
  77. Help query only                                  No change from previous value
  78. :4
  79.  Examples of Use 
  80.  
  81.    a. TXTALIAS TEST.123   
  82.       -- Produces alias  TEST.COM from source  file TEST.123,  both in current
  83.          directory.
  84.  
  85.    b. TXTALIAS BASE:TEST.123  
  86.       -- Produces  alias  TEST.COM  in  current  directory  from  source  file
  87.          TEST.123 in the named directory "BASE."
  88.  
  89.    c. TXTALIAS TEST.123 BASE:NEWALIAS  
  90.       -- Produces alias NEWALIAS.COM in the named directory "BASE" from source
  91.          file TEST.123 in the current directory.
  92.  
  93.    d. TXTALIAS M0:TEST.123 BASE: R  
  94.       -- Produces recursive alias TEST.COM in the named directory  "BASE" from
  95.          the source file TEST.123 on drive M, user area 0.
  96.  
  97.    e. TXTALIAS M0:TEST.123 BASE: /R
  98.       -- Same result as in previous example.       
  99.  Examples of Use - 2/2 
  100.  
  101.    If you really want to try, you can confuse TXTALIAS by naming the alias "R"
  102. or "/R" -- this will not only force recursive mode,  but the destination file-
  103. name will be ignored and the alias will be named according to the source file.
  104. Getting around this "flaw" is a  simple  matter of  preceding  the destination
  105. filename with a colon (":R" or ":/R") under  current  versions of  Z-System or
  106. the current drive letter and a colon  ("A:R" or "A:/R") for  both  current and
  107. older Z3-compatible systems.  Use of the current named directory ("dir:") spec
  108. will also also work,  even on old  ZCPR3 systems that have the "DUOK" function
  109. disabled.   To make the  alias  recursive,  use  the  "opposite"  form  of the
  110. recursion option -- ":R /R" or ":/R R"....
  111.