home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / fish / libraries / cclib / utils / utils.doc < prev    next >
Text File  |  1990-11-02  |  12KB  |  330 lines
  1.             UTILITY PROGRAM DOCUMENTATION
  2.  
  3.     Copyright (C) 1989,1990 by Robert W. Albrecht, All Rights Reserved
  4.  
  5. --------------------------------------------------------------------------
  6.              CONTENTS
  7.  
  8. I)    CCLIB.LIBRARY
  9. II)   BITES
  10. III)  EXEC
  11. IV)   IFFCheck
  12. V)    LOC
  13. VI)   NOIBM
  14. VII)  NOW
  15. VIII) NUKELIB
  16. IX)   SETPRI
  17. X)    XWAIT
  18. XI)   CREDITS
  19. XII)  LICENSE AND DISCLAIMER
  20.  
  21. ---------------------------------------------------------------------------
  22. I) CCLIB.LIBRARY
  23.  
  24.    All of these utilities use CClib.library which you need to put in your
  25.    LIBS: directory. The reason the programs are so small is that the
  26.    overhead for the C library is all in one place.
  27.    I don't know about you but I need every last bit of disk space on
  28.    my system. The Amiga community should DEMAND that C programmers use this
  29.    library for all their programs, this will eventually save you from
  30.    having to upgrade your system because you are out disk space or RAM.
  31.    You certainly don't need multiple copies of the Aztec and Lattice C
  32.    libraries imbedded in your programs.
  33.  
  34.    The binary version of CClib.library is available in the form of
  35.    USRCCLIB.lzh found on many BBS's including Compuserve and Codename:
  36.    Lorraine BBS (805-648-7833). If you wish to write PD C programs that
  37.    use CClib.library look for the full version of CClib.library in the
  38.    form of CCLIB.lzh which contains everything you need to write programs
  39.    for CClib.library. If you are a commercial software developer you will
  40.    need pay the one license fee of $50 to distribute CClib.library with
  41.    your software, however I urge you to get the non-commercial version
  42.    and evaluate it first.
  43.  
  44. ---------------------------------------------------------------------------
  45. II) BITES
  46.  
  47.        Documentation For 'Bites' Version 1.3
  48.          It's smaller, and better.
  49.  
  50.              Introduction
  51.  
  52.    Bites is a program written at the request of "MIKE VDS"
  53.    by Robert W. Albrecht. It is designed to display disk space
  54.    available on all mounted volumes.
  55.  
  56.  
  57.              How to use Bites...
  58.  
  59.    Run the program by double clicking on it's icon or typing:
  60.    'RUN Bites' from the CLI prompt.
  61.  
  62.    Bites needs at least a 2500 byte stack.
  63.  
  64.    A small window will appear in the title bar with the Bites icon at the
  65.    left. When you click on the Bites icon the program terminates. The
  66.    window can be dragged around like any other intuition window. The
  67.    standard 'to back' and 'to front' system gadgets appear at the right of
  68.    the window. There are two other gadgets to the left of the system
  69.    gadgets that control the behaviour of Bites.
  70.  
  71.    When Bites first comes up it will cycle through all of the mounted
  72.    volumes and display the number of bytes available on each volume every
  73.    three seconds. To stop cycling through the volumes click on the 'up and
  74.    down arrow' gadget. The next time you click on the 'up and down arrow'
  75.    gadget the next volume in the list will be displayed. To return to
  76.    cycling mode click on the 'circle arrow' gadget.
  77.  
  78.    The Bites window can be 'iconified' by clicking the right mouse button
  79.    while it's window is active. The window will reduce to a 24x10 Bites
  80.    icon that takes a minimum amount of screen space. To 'un-iconify' the
  81.    Bites window just activate the window by clicking on the icon with the
  82.    left mouse button, then click the right mouse button.
  83.  
  84.    Bites can also be terminated by use of the Amiga DOS Break command.
  85.    First type 'Status' at the CLI and get the Process ID of Bites then type
  86.    'Break <Process ID>'.
  87.  
  88.  
  89.           Enhancements Made for Version 1.1
  90.  
  91.    You can now control the position and size of the Bites window through
  92.    command line switches or icon 'Tool Types'. You may also display free
  93.    'blocks' instead of free bytes.
  94.  
  95.    CLI command line switches:
  96.  
  97.    -l<Left Edge>    Left edge of Bites window in pixels
  98.  
  99.    -t<Top Edge>     Top Edge of Bites window in pixels
  100.  
  101.    -w<Width>        Width of Bites window in pixels
  102.  
  103.    -b            Displays 'blocks' instead of bytes
  104.  
  105.      EXAMPLE: RUN BITES -l0 -t20 -w640 -b
  106.  
  107.    Icon Tool Types:
  108.  
  109.    LEFTEDGE=<Left Edge>  Left Edge of Bites window in pixels
  110.  
  111.    TOPEDGE=<Top Edge>     Top Edge of Bites window in pixels
  112.  
  113.    WIDTH=<Width>     Width of Bites window in pixels
  114.  
  115.    SHOWBLOCKS=ON     Displays 'blocks' instead of bytes
  116.  
  117.      EXAMPLE:
  118.  
  119.      LEFTEDGE=0
  120.      TOPEDGE=20
  121.      WIDTH=640
  122.      SHOWBLOCKS=ON
  123.  
  124.  
  125.            Bug Fixes Made for Version 1.1
  126.  
  127.    There was a bug where if you had an 'ASSIGN' to a disk that was no
  128.    longer in the drive a system requester would come up and not go away.
  129.    This has been fixed. Now when this situation exists the volume name will
  130.    be given and instead of bytes free or blocks free the message 'Not
  131.    Installed' will be displayed. This way you will be clued into assigns
  132.    that are just flopping around.
  133.  
  134.            Bug Fixes made for version 1.2
  135.  
  136.    The command line arguments for width and left-edge and top-edge are now
  137.    checked for correctness. The width has to be greater than 24, and the
  138.    left-edge and top-edge have to be greater than zero.
  139.  
  140.            Enhancements for version 1.3
  141.  
  142.    Bites now uses CClib.library which is a shareable C library. This has
  143.    reduced the size of the executable to 5288 from 6420 bytes. For bites
  144.    version 1.3 to work you MUST have CClib.library installed in your LIBS:
  145.    directory. You can find the binary only version of CClib.library under
  146.    the name USRCCLIB.lzh on many BSS's.
  147.  
  148. ---------------------------------------------------------------------------
  149. III) EXEC
  150.  
  151.    SYNTAX: Exec
  152.  
  153.    Exec displays a list of the data structures used by the Amiga OS. This
  154.    includes a list of; memory, resources, devices, interrupt handlers,
  155.    libraries, message ports, and tasks.
  156.  
  157. ---------------------------------------------------------------------------
  158. IV) IFFCheck
  159.  
  160.    SYNTAX: IFFCheck <iff file name>
  161.  
  162.    IFFCheck checks the integrity of any IFF file.
  163.  
  164.    A typical listing looks like this:
  165.  
  166. --- Checking file "pic:life/pumpkin"---
  167.  FORM 6194 ILBM
  168. . BMHD 20
  169. . CMAP 96
  170. . CRNG 8
  171. . CRNG 8
  172. . CRNG 8
  173. . CRNG 8
  174. . BODY 5985
  175. --- (IFF_OKAY) A good IFF file.
  176.  
  177. ---------------------------------------------------------------------------
  178. V) LOC
  179.  
  180.    SYNTAX: LOC [-Q] <files1> <files2> ...
  181.  
  182.    The -Q switch turns off the file-by-file listing of files and only
  183.    prints the totals.
  184.  
  185.    The file name arguments can contain the '*' and '?' wild card characters.
  186.  
  187.    Loc counts lines of C code and gives other statistics.
  188.    Here is an example of it's output:
  189.  
  190.    Lines Of C (LOC) by Robert W. Albrecht
  191.  
  192.  
  193.    The file loc.c contains...
  194.    157 lines of code, 20 blank lines, 2387 bytes of code,
  195.    1032 bytes of whitespace, and 479 bytes of comments.
  196.    The average code line has 15 bytes.
  197.    The code content is 61%, 69% without comments.
  198.  
  199. ---------------------------------------------------------------------------
  200. VI) NOIBM
  201.  
  202.    SYNTAX: NoIBM [>outfile] infile
  203.  
  204.    Noibm will strip the carriage returns from a file. Typically text files
  205.    from an IBM PC will have <CR><LF> at the end of each line, where on Amiga
  206.    DOS and UNIX lines are terminated only with <LF>. By default output
  207.    is directed to the console, but you can redirect it to a file.
  208.  
  209. ---------------------------------------------------------------------------
  210. VII) NOW
  211.  
  212.    SYNTAX: now
  213.  
  214.    Now will display the date in a more American fasion. Here is some
  215.    example output:
  216.  
  217.    Saturday October, 07 1989 02:24 AM
  218.  
  219. ---------------------------------------------------------------------------
  220. VIII) NUKELIB
  221.  
  222.    SYNTAX: NukeLib <lib1.library> <lib2.library> ...
  223.  
  224.    NukeLib removes un-needed libraries from memory. For example:
  225.  
  226.    NukeLib CClib.library
  227.  
  228.    removes CClib.library if no programs are using it. This is really
  229.    not necessacary because Amiga OS will attempt to remove libraries
  230.    when it needs the memory. To find out the names of the libraries in
  231.    memory use the exec program.
  232.  
  233. ---------------------------------------------------------------------------
  234. IX) SETPRI
  235.  
  236.    SYNTAX: SetPri
  237.  
  238.    SetPri will allow you set the priority of any task in the system, even
  239.    while it is running. This is very useful for controlling your multi-
  240.    tasking computer. After you type SetPri you will be shown a list of the
  241.    currently running tasks in the system and be asked for the number
  242.    of the task to change the priority of. You can then enter the
  243.    priority of the task.
  244. ---------------------------------------------------------------------------
  245.  
  246. X) XWAIT
  247.  
  248. SYNTAX:
  249.  
  250.    XWAIT HH:MM[:SS] [[MM-DD-YY] TOMORROW,SUN,MON,TUE,WED,THU,FRI,SAT]
  251.  
  252.  Waits until a specified time, or a key is pressed. If ^C is pressed a code
  253.  of 20 is returned, if ^D ^E or ^F is pressed a code of 10 is returned, if
  254.  the time arrives to stop waiting then a 0 is returned. If an error occurs
  255.  30 is returned.
  256.  
  257.  The command line arguments are given as a time and a date. XWAIT will stop
  258.  waiting when the time is greater than or equal to that given.
  259.  
  260.  
  261. ---------------------------------------------------------------------------
  262. XI) CREDITS
  263.            Software and Documentation Written by:
  264.  
  265.               Robert W. Albrecht
  266.               1457 Zion Way
  267.               Ventura CA 93003
  268.  
  269. ---------------------------------------------------------------------------
  270. XII) LICENSE AND DISCLAIMER
  271.  
  272.  
  273.                 LICENSE
  274.  
  275.       Robert W. Albrecht is the exclusive owner of the enclosed Software
  276.       and Documentation. You are granted non-exclusive license to use the
  277.       Software and Documentation, but you are not the owner of them.
  278.      Your right to use the Software and Documentation under this
  279.       agreement is the "License". "You" means the individual or legal
  280.       entity whose agent uploads this software and accepts this Agreement.
  281.       "Software" means the computer program recorded on the floppy-disk or
  282.       other media, any update to them Robert W. Albrecht may later provide
  283.       you, and any back-up copies made. "Documentation" means the user
  284.       manual and other materials packaged with this Software.
  285.  
  286.                 Transfer
  287.  
  288.       You may transfer the license for the use of the Software or
  289.       Documentation to another person without limitation, except that
  290.       no license fee may be charged.
  291.  
  292.               Backup Copies
  293.  
  294.          Make as many copies as you want.
  295.  
  296.                   Term
  297.  
  298.       The license is effective for twenty (20) years from the time you
  299.       upload the software. You may terminate the license at any time.
  300.  
  301.             Robert W. Albrecht's rights.
  302.  
  303.       The Bites Software and Documentation is protected by copyright, trade
  304.       secret and trademark laws. You may not disclose the Software or
  305.       Documentation to others, except as allowed in this license agreement,
  306.       or remove or alter ownership, trademark and copyright notices on
  307.       Documentation. YOU MUST MAKE A GOOD FAITH EFFORT TO PREVENT ANY
  308.       UNAUTHORIZED USE, COPYING, OR DISCLOSURE OF THE SOFTWARE OR
  309.       DOCUMENTATION. THESE OBLIGATIONS WILL SURVIVE ANY TERMINATION OF THE
  310.       LICENSE AGREEMENT.
  311.  
  312.          Disclaimer of other Warranties, and Liabilities.
  313.  
  314.       THERE ARE NO WARRANTIES, EITHER EXPRESSED OR IMPLIED, FOR THE
  315.       SOFTWARE OR DOCUMENTATION, WHICH ARE BOTH LICENSED TO YOU "AS IS".
  316.       ROBERT W. ALBRECHT EXPRESSLY DISCLAIMS ANY WARRANTY AS TO THE
  317.       PERFORMANCE OF THE SOFTWARE, OR DOCUMENTATION. HE ALSO DISCLAIMS ALL
  318.       OTHER WARRANTIES, INCLUDING (WITHOUT LIMITATION) IMPLIED WARRANTIES
  319.       OF MERCANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  320.       SHALL ANYONE INVOLVED IN THE CREATION, PRODUCTION, OR DISTRIBUTION,
  321.       OF THE SOFTWARE OR DOCUMENTATION BE LIABLE FOR ANY INDIRECT, SPECIAL,
  322.       INCEDENTAL, OR CONSEQUENTIAL DAMAGES RESULTING FROM THE USE OF THE
  323.       SOFTWARE OR DOCUMENTATION OR ARISING FROM ANY BREACH OF ANY WARRANTY.
  324.       Some states do not allow the exclusion or limitation of implied
  325.       warranties or liability for incedental or consequential damages so
  326.       the above exclusion and limitation may not apply to you. IN ADDITON
  327.       TO THE ABOVE LIMITATION, OUR LIABILITY TO YOU OR TO ANYONE ELSE FOR
  328.       DAMAGES SHALL NOT EXCEED THE LICENSE FEE PAID BY YOU FOR THE SOFTWARE
  329.       AND DOCUMENTATION (NOTHING).
  330.