home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d8xx / d827 / aztecerr.lha / AztecErr / AztecErr.doc < prev    next >
Text File  |  2001-02-25  |  10KB  |  287 lines
  1.  
  2.  
  3.                                Documentation
  4.  
  5.                      AztecErr Version 1.25 © 1993 by H.P.G
  6.  
  7.                                    FreeWare
  8.  
  9. Index:
  10.  
  11.         Index
  12.         History
  13.         General Description
  14.         System Reqirements
  15.         Legal Stuff
  16.         Installation
  17.         Commandline
  18.         Using AztecErr
  19.         Arexx-Commands
  20.         Technical
  21.         BUGS
  22.         Last
  23.         Address
  24.  
  25.  
  26. History:
  27.  
  28.     Version 0.90  First binary version. Previous versions are rexx scripts.
  29.  
  30.     Version 0.95  Added ARexx Support Routins.
  31.  
  32.     Version 1.00  Better design. First general release.
  33.  
  34.     Version 1.10  Removed some enforcer hits.
  35.  
  36.     Version 1.25  Font independent window and gadgets. Second general
  37.                   release.
  38.  
  39.  
  40.  
  41. General Description:
  42.  
  43.  
  44.     AztecErr is a programmer-tool.
  45.     It supports the quickfix-option of the Manx Aztec C Compiler system
  46.     version 5.xx. It has a full gadtools user interface.
  47.  
  48.     AztecErr is a OS 2.xx only tool. It doesn`t run under Kickstart 1.3.
  49.  
  50.     AztecErr [AE] reads the AztecC.Err file and displays the contained
  51.     errors on its window.
  52.     On this window there are several gadgets. By pressing the gadgets you
  53.     may simply scroll through the error list to the next, previous, first
  54.     or last error. Alternatively you can press a key for each gadget.
  55.  
  56.     AztecErr has full env support. It sets up two variables with the line
  57.     and column number of the current displayed error. You can examine these
  58.     variables and i.e. call your editor to jump to the given position.
  59.     (see  below).
  60.  
  61.     If you have RexxHost.Library, AE will try to open an AREXX-Port. So you
  62.     may send rexx messages to AE with the same meaning than the Gadgets.
  63.  
  64.  
  65. System Requirements:
  66.  
  67.     You need at minimum OS 2.xx. Version 36L  may  have  some  problems
  68.     too, because some functions had not been implemented  in  this beta
  69.     version.
  70.  
  71.     AztecErr is mainly interrested if you have installed the Manx AztecC
  72.     system version 5.xx.
  73.  
  74.     To use AE automatically you should set the env variable  CCEDIT  via
  75.     MSet (support program of Manx) to AztecErr. Also  you  must  compile
  76.     with  option -qf for QuickFix.
  77.  
  78.     If you want to use AE in another  way,  you  can  use  a  batchfile.
  79.  
  80.     No Requirements but recommendments:
  81.     ===================================
  82.  
  83.     If you are using an editor which  has  an  ARexx port  or  supports
  84.     ARexx  or the best, your editor has also the  ability   of   macro-
  85.     definitions  (i.e.  DMe,  Ced,  TTX  etc...), so  you  can  use  AE
  86.     automatically.
  87.     E.g.
  88.     if you create an ARexx script,  which  examines  the  env  variables
  89.     'AztecErrLastLine' and 'AztevErrLastColumn', you will be able to jump
  90.     directly to the place in your text where the error has been occured.
  91.     If you call this script after compiling, you can easily examine all
  92.     errors and recompile it again, after correcting the last error.
  93.  
  94.     An example Script for DMe and TTX is included.
  95.  
  96.     Warning: You  can  use  this  abilities  of  AE  only  if  you  have
  97.              the RexxHost.Library and loads it in memory, like explained
  98.              above.
  99.  
  100.  
  101. Legal Stuff:
  102.  
  103.  
  104.         This  program  and  all files come with it, also the docfiles, are
  105.         released as FREEWARE.
  106.  
  107.         this means:
  108.  
  109.             everybody may use AztecErr,
  110.  
  111.             everybody may copy AztecErr, if:
  112.  
  113.                 1. You copy all included files, see list at the end of the
  114.                    doc file.
  115.                 2. No changes are made,  this  means  the  program and all
  116.                    included files must stay in the original form.
  117.                    Exception: you  may  archieve  it; but in this case you
  118.                               must also archieve the whole package.
  119.                 3. If  you  recompile  it, you have to include a notice to
  120.                    the original author. If you also want to (re)distribute
  121.                    in any new form you have to send me a copy.
  122.                 4. You may not sell AztecErr.
  123.                    Execption: you`re  allowed  to  take  a  small copy fee
  124.                               which should not extend 5US$.
  125.                 5. If you want to include AztecErr
  126.                    or one of the  included files as a part of a commercial
  127.                    package,  you  must  have  written  permission  of  the
  128.                    author (address see below).
  129.  
  130.  
  131.         I take no warranty or garanty for the function of this program.
  132.         The whole risk of using AztecErr stays only by the user.
  133.  
  134.  
  135. Installation:
  136.  
  137.     The best is to copy AztecErr in the same directory in which are  cc,
  138.     as and ln located.
  139.     But it must be in the current AmigaDOS searchpath
  140.  
  141. Commandline:
  142.  
  143.     AE supports currently only three commandline parameters which are all
  144.     optional:
  145.  
  146.     TopEdge/N   This is the topedge where the window should appear.
  147.                 Default is 0.
  148.  
  149.     PortName=P  This is the name of the ARexx port AE will open.
  150.                 Default is AZTEC_ERROR_PORT.
  151.  
  152.     Screen=S/K  If you want AztecErr  to  appear  on  another  than  the
  153.                 wbench screen you may specify here the name  of  another
  154.                 PublicScreen. Notice: The name is case dependent.
  155.  
  156. Usage:
  157.  
  158.     AE  supports the  quickfix-option  of  the  Manx  Aztec  C  Compiler
  159.     version 5.xx. By compilisation if an error occures, cc will call the
  160.     program which is the content of the env variable CCEDIT.
  161.     If you set CCEDIT to  AztecErr  [options]  ,  so  AztecErr  will  be
  162.     started.  AztecErr  reads  the  file  'AztecC.Err'  of  the  current
  163.     directory and opens a window.
  164.     If you quits AztecErr, the compiler starts again.
  165.     If you quits AztecErr by using the Break  Gadget  ,  AztecErr  exits
  166.     with return code 5 (WARN), which can  be  examined in batch files or
  167.     scripts etc.
  168.  
  169.     In the second line are a lot of gadgets which initially displays the
  170.     first error from the AztecC.Err file.
  171.  
  172.     Gadget list From left to right:
  173.  
  174.     Below Err:          This is the currently displayed error.
  175.     Below Sum:          This is the total number of errors.
  176.     Below Kind:         This is the kind of the error, either ERROR or
  177.                         WARNING
  178.     Below SourceFile:   This is the name of the source file in which the
  179.                         errors has been detected.
  180.     Ln:                 The line number of the error.
  181.     Col:                The column number of the error.
  182.     EC:                 The code of the error.
  183.  
  184.     Below               This is the description of the error
  185.  
  186.     Next Line:
  187.  
  188.     First         [f]   Activating this gadget or pressing 'f', AE displays
  189.                         the first error.
  190.     Previous      [p]   AE displayes the previous error.
  191.     Next          [n]   AE displayes the next available error. If there are
  192.                         no more errors the following text will be displayed
  193.                         ----- No More Errors ------.
  194.                         Activating next gadget again, closes the window and
  195.                         leaves the program.
  196.     Last          [l]   AE displays the last error.
  197.     Quit          [q]   AE quits.
  198.     Break         [b]   AE quits with return code 5 (WARN).
  199.  
  200.     You can type also the following keys:
  201.  
  202.     [i]                 Is the same than clicking the zip gadget of the
  203.                         window. AE will be iconified.
  204.                         WARNING: all functions are  still  available also
  205.                         in this state. By pressing 'i' again, the window
  206.                         will resizes to the old size and position.
  207.  
  208. ARexx Commands:
  209.  
  210.     This commands are equivalent to the gadgets above.
  211.  
  212.     FIRST
  213.     PREVIOUS
  214.     NEXT
  215.     LAST
  216.     BREAK
  217.  
  218.     QUIT
  219.     CANCEL        CANCEL is a synonym for QUIT and is only supported for
  220.     EXIT          compatibility with other rexx commands and libraries.
  221.  
  222.  
  223. Technical:
  224.  
  225.     AE uses mainly OS 2.xx only functions.
  226.     AE uses DOS-, Intuition- and GadTools.Library
  227.  
  228.     Because of the codesize there are no extra error- and  break-handling
  229.     routines supported.
  230.  
  231.     So its yours, to take  care  that  AE  don`t  try  to  read  a wrong
  232.     AztecC.Err file with a wrong format. If this happens AE may crash.
  233.     Also you should not try to quit AE whith a ^C, because there is no ^C
  234.     support. Maybe the window  stays  still  open  and  the  program has
  235.     been terminated.
  236.  
  237.     If you don`t have RexxHost.Library , so AE is also fully functionable,
  238.     but of course with the restriction that there is no ARexx port   and
  239.     the env variables AztecErrLastLine and AztecErrLastColumn  will  not
  240.     be set.
  241.  
  242.     You can call AE also with the command  'rxsend'  of  the  Csh-Shell.
  243.     You doesn`t need an editor which owns an AREXX-Port, its also ok  to
  244.     have an editor which is able to start DOS-commands ( MEmacs etc.  ).
  245.     But its a little more tricky.
  246.  
  247. Last:
  248.  
  249.     I hope many people will use AE to program faster and easier and with
  250.     a less amount of errors.
  251.  
  252.     If you find any bug of AE, please let me know.
  253.  
  254.  
  255.     have fun ..
  256.  
  257.  
  258. Address:
  259.  
  260.    Hans-Peter Guenther
  261.    Gruener Weg 5
  262.    D-3501 Fuldatal 2
  263.    B.R.D (Germnany)
  264.  
  265. List Of Files:
  266.  
  267.  (If you miss one of the following files you release is incomplete)
  268.  
  269.     AztecErr                    : The binary
  270.     AztecErr.info
  271.     AztecErr.doc                : English manual
  272.     AztecErr.doc.info
  273.     AztecErr.dok                : German manual
  274.     AztecErr.dok.info
  275.     AztecC.Err                  : Example error file
  276.  
  277.     rexx  (dir)                 : Rexx scripts
  278.         DME_AztecError.dme      : Script for use with DMe
  279.         DME_AztecError.dme.info
  280.         TTX_AztecError.ttx      : Script for use with TTX
  281.         TTX_AztecError.ttx.info
  282.     rexx.info
  283.  
  284.  
  285. ----END
  286.  
  287.