home *** CD-ROM | disk | FTP | other *** search
/ Collection of Hack-Phreak Scene Programs / cleanhpvac.zip / cleanhpvac / SOURC455.ZIP / TESTYN.REM < prev   
Text File  |  1992-07-07  |  5KB  |  111 lines
  1.  
  2.  
  3.                    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  4.                       SOURCER REMARKS FILE - SAMPLE REMARKS
  5.                    ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  6.  
  7.  
  8.  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ DATA REMARKS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  9.  
  10.         Remarks in this section are linked to the .def  file,  section  3
  11.         relating to data items.    Remarks  will  appear  in  the  source
  12.         code output to the right of the data reference  definition.   Each
  13.         remark can encompass as many lines as needed, up to 34 characters
  14.         per line.  Each line starts with the 3 digit hex reference number
  15.         starting at 001 to a maximum of 3FFh (1023 entries).   The number
  16.         is also entered in the .def file for the particular data item(s).
  17.  
  18.  
  19.     --------- Data Remarks -----------  -------- comments ignored here --------
  20. 001 This is the remark number 1 
  21. 002 This is another remark
  22. 003 This is the next data remark
  23.      note how it continues onto three
  24.      lines ! (indents allowed)
  25. 004 █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█
  26.     █ Lines starting with a graphics █
  27.     █ character will be placed prior █
  28.     █ to the line that the data item █
  29.     █ comment appears on.            █
  30.     █                                █
  31.     █ A line feed will automatically █
  32.     █ be place prior  to  and  after █
  33.     █ the graphics character area.   █
  34.     █▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█
  35.     this line is left of data item 4
  36. 005 This is the last data comment !
  37. 006 █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█          Highlight information prior
  38.     █ Values  For  Beeper  Operation █          to a data item with graphics
  39.     █▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█          characters !
  40.     Port to toggle speaker on & off
  41. 007 total number of cycles                      (on_off_time)
  42. 008 duration for each cycle on or off
  43. end
  44.  
  45.  
  46.  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ LOCATION REMARKS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  47.  
  48.         Remarks in this section are linked to the .def  file,  section  3
  49.         relating to location references.   Remarks  will  appear  in  the 
  50.         source code output as lines prior to  the  location  item.   Each
  51.         remark can encompass as many lines as needed, up to 76 characters
  52.         per line.  Each line starts with the 2 digit hex reference number
  53.         starting at 01 up to a maximum of FEh (254 entries).   The number
  54.         is entered in the .def file for the particular location item(s).
  55.  
  56.  
  57.     ----------------------- Location Reference Remarks ------------------------
  58. 01  This is a location reference remark
  59.  
  60. 02  ═════════════════════════════════════════════╡ GRAPHICS ╞═════════════
  61.  
  62.       ■  All graphics characters are allowed for special highlighting
  63.  
  64.       ■  Line feeds can be inserted for extra clarity
  65.  
  66. 03  Text of each remark begins at column 5 in this file
  67.  
  68. 04  ───── TESTYN OPERATION ───────────────────────────────────────────────
  69.      
  70.     Testyn waits for a keystroke "n" or "y", or beeps if any other key has
  71.     been entered.    When "n" or "y" is entered,  the program exits with a
  72.     return code 0 for "n", and 1 for "y".
  73.     
  74.     It is intended to be used in a batch file when a  yes/no  question  is
  75.     asked, the errorlevel command can be used to read the return code.
  76.  
  77. 05
  78.     Line feeds can be placed at the beginning for more separation from  the
  79.         previous section of code (1 line feed is automatically placed 
  80.         prior to the remark).  No linefeeds are placed after the remark 
  81.         unless explicitly done as in these examples.
  82.  
  83. end
  84.    
  85.  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ SUBROUTINE REMARKS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  86.  
  87.         Remarks in this section are linked to the .def  file,  section  3
  88.         relating to subroutine references.   Remarks will appear  in  the 
  89.         source code output as lines prior to the subroutine  item.   Each
  90.         remark can encompass as many lines as needed, up to 76 characters
  91.         per line.  Each line starts with the 2 digit hex reference number
  92.         starting at 01 up to a maximum of FFh (255 entries).   The number
  93.         is entered in the .def file for a particular subroutine item(s).
  94.  
  95.  
  96.     ---------------------- Subroutine Reference Remarks -----------------------
  97. 01  This is a subroutine reference remark
  98. 02                               BEEPER SUBROUTINE
  99.          
  100.         This subroutine generates a short beep.   Note that the sound and
  101.         duration are uP speed dependent.
  102.            
  103.         Regisisters used:   al,bx,cx,dx,ds
  104. end 
  105.  
  106.  
  107.         NOTES:  1)  Entries must be in consecutive sequential order.
  108.                 2)  Remark characters ";" are automatically inserted.
  109.                 3)  Up to 64,000 lines per remark, 32M max file size.
  110.  
  111.