Amiga MA Magazine 1997 #3/amigamamagazinepolishissue03-1/polski_aminet/michal_letowski/debuglib/debuglib.guide

Amigaguide Document | 1996-05-11 | 7KB | 161 lines

@database DebugLib
@$VER: DebugLib.guide 37.1 (11.5.96)
@(C) Michal Letowski
@author Michal Letowski
@index Index
@node Main "DebugLib 1.0"
@prev Main
@next Main
                                 @{b}@{u}DebugLib 1.0@{uu}@{ub}
            @{b}DebugLib@{ub} package is Copyright
 1996 @{"Michal Letowski" link Author}.
                             All rights reserved.
      The author's native language is Polish, so please forgive bad spelling,
  grammar mistakes etc. Or better - correct them.
  @{"Copyright notice" link Copyright} - legal informations.
  @{"  Introduction  " link Introduction} - what it is useful for.
  @{"  Requirements  " link Requirements} - what you need to run.
  @{"  Installation  " link Installation} - how to install.
  @{"      Notes     " link Notes} - some notes and comments.
  @{"     History    " link History} - what have changed since last release.
  @{"      To do     " link ToDo} - what needs to be done.
  @{"    debug_lib   " link AutoDocs/debug_lib.doc/main} - programmer's documentation.
@endnode
@node Copyright "DebugLib Copyright"
@prev Copyright
  @{b}@{u}Copyright@{uu}@{ub}
  @{b}DebugLib@{ub} package is Copyright
 1996 @{"Michal Letowski" link Author}.
  @{b}DebugLib@{ub} is freely distributable under the following conditions:
 no more than a reasonable fee is charged for copying/downloading;
 this distribution is not a part of other non-free distribution;
 the distribution is complete - it contains all the files (full list
      at the end of this chapter);
 no file in the distribution is changed.
      Distribution without meeting conditions specified above requires
  written permission from me.
      "Amiga Shopper" have a special permission to distribute this package
  on their coverdisks.
      The library from the package works, but no guarantee is given nor
  implied. In no case will I be liable for any results of using supplied
  library.
      The source code is also under copyright, but can be recompiled for
  private use.
      This documentation is based on @{i}CatEdit.guide@{ui}, which is Copyright
  1993 Rafael D'Halleweyn.
  List of all files in the distribution:
    @{i}Install DebugLib.info
    Install DebugLib
    DebugLib.guide.info
    DebugLib.guide
    AutoDocs (dir)
      debug_lib.doc
    Include (dir)
      clib (dir)
        debug_protos.h
    Lib (dir)
      debug.lib
    Src (dir)
      debug.gst.c
      debug.gst.h
      debug.rev.h
      init.c
      kcmpstr.a
      kgetchar.a
      kmaygetchar.a
      kputchar.a
      kputstr.a
      kdofmt.a
      kprintf.a
      SCOptions
      SMakeFile@{ui}
@endnode
@node Introduction "Introduction to DebugLib"
  @{b}@{u}Introduction@{uu}@{ub}
      @{b}DebugLib@{ub} was written to replace Commodore's @{i}debug.lib@{ui}. It contains
  all but one functions from original @{i}debug.lib@{ui}, yet it is smaller and
  easier to use (e.g. does not contain any external references).
@endnode
@node Requirements "Requirements for DebugLib"
  @{b}@{u}Requirements@{uu}@{ub}
      @{b}DebugLib@{ub} can be used with any linker that accepts SAS/C format link
  libraries. No particular version of operating system is required. A special
  tool like @{i}Sushi @{ui}is necessary for those, whoe don't have serial terminals.
@endnode
@node Installation "Installation of DebugLib"
  @{b}@{u}Installation@{uu}@{ub}
      Use supplied @{i}Installer @{ui}script to copy AutoDoc, library and a header
  file or manually place the files in their respective directories.
      Source files will not be copied by @{i}Installer@{ui}.
@endnode
@node Notes "DebugLib Notes"
  @{b}@{u}Notes@{uu}@{ub}
      @{"debug_lib" link AutoDocs/debug_lib.doc/main} does not provide KGetNum() function which I can't test
  without a serial terminal connected (and I don't have such terminal).
      Most of the functions have multiple names (for details, see @{"debug_lib" link AutoDocs/debug_lib.doc/main}).
@endnode
@node History "DebugLib History"
  @{b}@{u}History@{uu}@{ub}
      @{b}Version 1.0 (11.5.96)@{ub} - initial release.
@endnode
@node ToDo "To do in DebugLib"
@next ToDo
  @{b}@{u}To do@{uu}@{ub}
      Eventually, KGetNum() will be implemented. Parallel routines from
  @{i}ddebug.lib @{ui}may also be included, since it makes more sense to have just
  one library for debugging.
      Of course, you can suggest something!
@endnode
@node Author "About the Author"
@prev Author
@next Author
  @{b}@{u}About the Author@{uu}@{ub}
      My name is @{b}Michal Letowski@{ub} and I hold Master degree in Computer
  Science. I live in Wroclaw, Poland where I work as a information science
  teacher in XXIV Secondary School.
      If you have something to say me (questions, remarks, suggestions,
  wishes, bug reports) please contact me (I like receiving mail!):
    by E-Mail (preferred way):
      @{b}[e-mail]@{ub} (valid until 1.7.96)
    by normal mail:
      @{b}Michal Letowski
      Przyjazni 51/17
      53-030 Wroclaw
      POLAND@{ub}
      You can get the following free software written by me:
   @{"  BYTEmark " beep} - Amiga port of @{i}BYTE @{ui}magazine portable benchmarks
      (@{i}Aminet://util/moni/BYTEmark-2.1.lha@{ui});
   @{"  DebugLib " beep} - link library for serial debugging
      (@{i}Aminet://dev/debug/DebugLib-1.0.lha@{ui});
   @{"   MakeDT  " beep} - create DataTypes recog files easily
      (@{i}Aminet://dev/misc/MakeDT-1.3.lha@{ui});
   @{" MCommands " beep} - 8 useful AmigaDOS CLI commands
      (@{i}Aminet://util/cli/MComms-1.4.lha@{ui});
   @{"    MCEd   " beep} - 8 great ARexx scripts for @{i}CygnusEd @{ui}users
      (@{i}Aminet://text/edit/MCEd-1.0.lha@{ui});
   @{"    MSys   " beep} - 4 AmigaDOS replacement commands
      (@{i}Aminet://util/sys/MSys-1.0.lha@{ui});
   @{"ClipHandler" beep} - easily exchange data between AmigaDOS and applications
      (@{i}Aminet://util/misc/ClipHan-1.0.lha@{ui});
   @{"   DebugLib  " beep} - DataType for Amiga fonts
      (@{i}Aminet://util/dtype/DebugLib-1.0.lha@{ui});
   @{"   MREKO   " beep} - DataType for viewing @{i}REKO @{ui}cardsets
      (@{i}Aminet://util/dtype/MREKO-1.0.lha@{ui});
   @{"   XPKDT   " beep} - DataType for XPK packed files
      (@{i}Aminet://util/dtype/XPKDT-1.0B.lha@{ui}).
@endnode
@node Index "DebugLib Index"
@prev Index
@next Index
  @{b}@{u}Index@{uu}@{ub}
  @{"     Author     " link Author}
  @{"Copyright notice" link Copyright}
  @{"     History    " link History}
  @{"  Installation  " link Installation}
  @{"  Introduction  " link Introduction}
  @{"      Notes     " link Notes}
  @{"  Requirements  " link Requirements}
  @{"      To do     " link ToDo}
  @{"    debug_lib   " link AutoDocs/debug_lib.doc/main}
@endnode