home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #3 / amigamamagazinepolishissue1998.iso / blabla / mungfriend / mungfriend.doc < prev    next >
Text File  |  1998-01-24  |  6KB  |  257 lines
  1.                                Mungfriend 3.4
  2.                             © 1995-97 Szymon Pura
  3.                                    FREEWARE
  4.                                 BLABLA PRODUCT
  5.  
  6. ============
  7. INTRODUCTION
  8. ============
  9.  
  10.   MungFriend   is   a   tool   for  capturing  raw  serial  output  (done  via
  11.   exec/RawPutChar(),  kprintf).   It installs a resident (reset-proof) buffer,
  12.   so  it  can  survive  most  GURUs.   Especially  useful  for  debugging with
  13.   Mungwall, Enforcer etc.
  14.   Mungfriend is a replacement for Commodore's Sushi.
  15.  
  16. =====
  17. USAGE
  18. =====
  19.  
  20.   MungFriend <command> [<command args>] [options]
  21.  
  22.    <commands> are:          Shortcut:
  23.  
  24.   -  INFO                      I
  25.   -  INSTALL                   S
  26.   -  CLEAR                     C
  27.   -  REMOVE                    R
  28.   -  TYPE                      T
  29.   -  UPDATE                    U
  30.   -  WRITE                     W
  31.  
  32.   <command args> are:
  33.  
  34.   - SIZE <n>     where <n> is a decimal number (only for INSTALL)
  35.   - [TO] <f>       where <f> is a filename    (only for WRITE)
  36.  
  37.   <options> are:
  38.  
  39.   - FLASH / NOFLASH
  40.   - TRACE / NOTRACE
  41.   - SERIAL /  NOSERIAL
  42.   - BELLS / NOBELLS
  43.  
  44.  
  45.  (It seems complicated, but you'll be able to get hang of it in a second)
  46.  
  47.  
  48.  
  49. 1. CREATING MUNGFRIEND BUFFER
  50.  
  51.   MungFriend install size <n>  ; <n> - size of buffer (in bytes)
  52.  
  53.  Example:
  54.  
  55.   MungFriend install size 15000 ; allocate ~15 KB of a reset-proof buffer.
  56.  
  57.  Notes:
  58.  
  59.   You can't change size of buffer after installing - you must remove
  60.   previous buffer first.
  61.  
  62.   (New for V3.0): Size must be >= 10KB. This way MungFriend won't get stuck in low memory area.
  63.                   Yes, I know, there exists the MEMF_REVERSE flag but there are still some pro-
  64.                   blems about it.
  65.  
  66. 2. REMOVING MUNGFRIEND BUFFER
  67.  
  68.   MungFriend remove
  69.  
  70.  Removes the previously allocated buffer (see above).
  71.  
  72.  
  73.  
  74. 3. CLEARING BUFFER
  75.  
  76.   MungFriend clear
  77.  
  78.  Previous buffer contents are cleared.
  79.  
  80.  
  81.  
  82. 4. TYPE
  83.  
  84.   Mungfriend type
  85.  
  86.  Types contents of the current buffer on the screen.
  87.  
  88.  (New for V3.1): press CTRL-C to stop.
  89.  
  90.  
  91. 5. WRITE
  92.  
  93.   Mungfriend write [to] <f> ; <f> is a filename.
  94.  
  95.  Example:
  96.  
  97.   MungFriend write to Ram:MungFriendReport
  98.  
  99.  Creates a new file (called Ram:MungFriendReport) and copies current buffer
  100.  contents to it.
  101.  
  102.  
  103.  
  104. 6. UPDATE
  105.  
  106.   Mungfriend update <options>
  107.  
  108.  Examples:
  109.  
  110.   Mungfriend update FLASH TRACE NOSERIAL
  111.   Mungfriend update SERIAL NOTRACE BELLS FLASH
  112.  
  113.  Just updates the options specified.
  114.  
  115.  Note well:
  116.  
  117.   You can specify options with EVERY command, not only UPDATE.
  118.  
  119.  
  120.  
  121.  OPTIONS AVAILABLE:
  122.  
  123. 1. SERIAL/NOSERIAL
  124.  
  125.  If NOSERIAL is on, then all serial output (via exec/RawPutChar())
  126.  will be blocked.
  127.  
  128. 2. TRACE/NOTRACE
  129.  
  130.  Most important option. If TRACE is on, then MungFriend will catch serial
  131.  output into its buffer.
  132.  
  133.  NOTE WELL: THIS OPTION GETS DISABLED AFTER RESET !!
  134.  After every reset or GURU 'TRACE' gets disabled. To continoue tracing,
  135.  you have to turn it back on. Use something like: MungFriend update trace
  136.  
  137. 3. FLASH/NOFLASH
  138.  
  139.  If FLASH is on, then every byte going through the raw serial will cause
  140.  the screen to flash. This way you won't miss any debugging output.
  141.  
  142. 4. BELLS/NOBELLS
  143.  
  144.  If NOBELLS is on, then all console bells will be filtered out.
  145.  (Especially MungWall's report is full of those).
  146.  
  147. =======
  148. EXAMPLE
  149. =======
  150.  
  151.  Simple DOS script:
  152.  
  153.  MungFriend install size 15000 trace flash nobells noserial
  154.  Run Mungwall task all showfail nametag
  155.  Run Enforcer deadly showpc rawio buffersize 5000
  156.  
  157.  When the screen flashes, new characters were catched into the buffer.
  158.  Use the following command to check:
  159.  
  160.  MungFriend type
  161.  
  162.  
  163. =========
  164. TECHNICAL
  165. =========
  166.  
  167.  Kickstart V36+ (Release 2.0) required
  168.  
  169.  Assembler source included _ONLY_FOR_LEARNING_PURPOSES_
  170.  Source is meant to be an example (at least a bad one).
  171.  You are _NOT_ allowed to modify or re-assemble the source file.
  172.  
  173. =======
  174. CHANGES
  175. =======
  176.  
  177.  V3.4  -   18-Oct-97
  178.  --------------------
  179.  
  180.   o a major bug fixed - the WRITE command didn't check the buffer
  181.     correctly
  182.  
  183.  V3.3  -   02-Oct-97
  184.  --------------------
  185.  
  186.   o a litle bug removed
  187.   o syntax-info text changed
  188.  
  189.  V3.2  -   01-Sep-97
  190.  --------------------
  191.  
  192.   o some code cleanup
  193.   o a pesky bug removed
  194.  
  195.  V3.1a -   22-Feb-97
  196.  --------------------
  197.  
  198.   o problems with MEMF_KICK (under 2.0 and 2.04) fixed
  199.   o minor bugfix in INSTALL
  200.  
  201.  V3.1  -   20-Jan-97
  202.  --------------------
  203.  
  204.   o pressing CTRL-C during TYPE or WRITE will stop the command
  205.   o a tiny change in patch routine - should be slightly faster now
  206.   o added a trailing NULL to the ROMTag node structure
  207.   o now CPU caches are cleared during INSTALL
  208.  
  209.  V3.0  -  19-Nov-96
  210.  --------------------
  211.  
  212.   o totally redone memory allocation and KickMem/KickTag handling
  213.   o INFO improved
  214.   o some minor bugfixes and other minor changes
  215.  
  216.  V2.3  -  17-Nov-96
  217.  --------------------
  218.  
  219.   o major bug fixed in startup routine
  220.   o memory allocation was completely broken - changed to simple KickMem
  221.  
  222.  V2.2  -  26-Jun-96
  223.  --------------------
  224.  
  225.   o BELLS/NOBELLS option added
  226.  
  227.  V2.1  -  27-May-96
  228.  --------------------
  229.  
  230.   o LOADS of little bugs fixed
  231.  
  232.  V2.0  -  28-Feb-96
  233.  --------------------
  234.  
  235.   o now rewritten for OS 2.0+
  236.  
  237.  V1.0  -  19-Sep-95
  238.  --------------------
  239.  
  240.   o initial version
  241.  
  242.  
  243. ======
  244. AUTHOR
  245. ======
  246.  
  247.  MungFriend is FREEWARE. Use it at your own risk. It may be freely
  248.  distributed in its ORIGINAL, umodified form. Under NO CICRUMSTANCES
  249.  will the author be liable for any direct or indirect damage or data loss
  250.  resulting from the use or misuse of this software.
  251.  
  252.  All suggestions/bug reports/donations are welcome.
  253.  
  254.                                  Szymon Pura
  255.                                 szymp@friko.onet.pl
  256.                             friko.onet.pl/cz/szymp
  257.