home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / dev / debug / decon / decon.doc < prev    next >
Text File  |  1995-02-07  |  4KB  |  117 lines
  1.  
  2.                                Debug Console 2.1
  3.  
  4.                  (c) 1995 Martin Mares, MJSoft System Software
  5.  
  6. ================================================================================
  7.  
  8.  
  9. Preface
  10. =======
  11.  
  12.    DeCon 2.1 and its documentation are Copyright (c) Martin Mares, MJSoft System
  13. Software, Prague, Czech Republic.
  14.  
  15.    This  archive  can  be  freely  redistributed as long as all of its files are
  16. included   in   their   original   form  without  any  additions,  deletions  or
  17. modifications  (excluding addition of other README-style files and icons) and no
  18. more  than a nominal fee is charged for its distribution.  All copyright notices
  19. in  the  programs and accompanying documentation files must remain intact.  It's
  20. especially  forbidden  to add various '.displayme' files and BBS advertisements.
  21. This style of distribution is generally known as FREEWARE.
  22.  
  23.    Source  text of this program is included in the distribution.  You can freely
  24. improve  it.   If  you  want  to  distribute your improved version, there're two
  25. possibilities:   (1)  Send  your  improvements  to  me  (the best form is a diff
  26. output)  and  I'll include them in the next release.  (2) Distribute them alone.
  27. In  this  case, you must mention the name of original author, change the name of
  28. the  product  (not  only  by  increasing  the  version),  and  obey  all  of the
  29. distribution rules mentioned above.
  30.  
  31.    Special  permission is given to Fred Fish to distribute this program on his
  32. "Fish Disks".
  33.  
  34.    This  software  is  provided  "AS  IS"  without  warranty of any kind, either
  35. expressed  or  implied.   The author is not responsible for any damage caused by
  36. it.
  37.  
  38.  
  39. Introduction
  40. ============
  41.  
  42.    Many debugging utilities send their output to serial port using simple
  43. communication mechanism embedded in the exec.library -- the RawPutChar function.
  44. This simple utility patches that function, opens a window screen and redirects
  45. whole debugging output to this window.
  46.  
  47.    Warning:  DeCon uses simple line buffering mechanism to increase speed which
  48. causes incomplete lines not to be displayed before a newline character (or any
  49. other character with code less than 32) is received.  NULs are not stored in the
  50. buffer, but they cause flushing, too (you can use NUL to empty the buffer).
  51.  
  52.    If  you're  debugging  a resident module, you can install DeCon as a resident
  53. module  by the AddModule utility (also included in this archive).  In this case,
  54. priority  of  DeCon module is set to 4 by default, therefore it gets initialized
  55. directly after the console device.
  56.  
  57.    DeCon is NOT pure and cannot be made resident (sorry, but if it were pure, it
  58. would be much larger and slower).  The resident module can be used multiple
  59. times, but it's self-modifying and some other tools allowing module installation
  60. could inform you about non-mathing checksums -- these warnings are usually false
  61. alarms and can be ignored.
  62.  
  63.  
  64. Requirements
  65. ============
  66.  
  67.    - Kickstart 2.04 or higher
  68.  
  69.    - ss.library 5.0 or higher (included in this archive)
  70.  
  71.    - 68000 or higher
  72.  
  73.  
  74. Command-line invocation
  75. =======================
  76.  
  77.    If started from CLI (that means not as a resident module), additional
  78. parameters can be specified according to this template:
  79.  
  80.    LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,TITLE,SCREEN
  81.  
  82.    First four parameters define window position, the next one allows to specify
  83. custom window title, the last one forces DeCon to use given public screen for
  84. its output.
  85.  
  86.  
  87. Other controls
  88. ==============
  89.  
  90.    (1) - Program termination - by clicking the close gadget of DeCon window
  91. or by sending a CTRL-C signal to it.
  92.  
  93.    (2) - Saving console buffer to T:Debug - press CTRL-W (OK will appear and
  94. last 16K of debug output will be saved).
  95.  
  96.    (3) - Stopping/restarting of console output - press CTRL-S to stop console
  97. output, use CTRL-Q to restart it.
  98.  
  99.    (4) - Clearing of console window and all information in the buffer - CTRL-L.
  100.  
  101.  
  102. History
  103. =======
  104.  
  105. 1.0 - Original debug console (release date unknown)
  106.  
  107. 2.0 (22.1.95) - Completely rewritten version (changes too numerous...)
  108.  
  109. 2.1 (7.2.95) - The console got a bit confused when it received a NUL character.
  110.  
  111.  
  112. Notes
  113. =====
  114.  
  115.    Send comments, suggestions and bug reports to mjsoft@k332.feld.cvut.cz
  116.  
  117.