home *** CD-ROM | disk | FTP | other *** search
/ Games Tips & Tricks / GAMESTIPSUNDTRICKS.mdf / utility / capture / cap2gif.doc next >
Text File  |  1994-11-29  |  8KB  |  188 lines
  1. -----------------------------------------------------------------------------
  2.  
  3.                                 C A P 2 G I F
  4.                                ~~~~~~~~~~~~~~~
  5.    Copyright (c) 1993 by TBH-Softworx --- All Rights Reserved
  6.                  Oliver Fromme, Leibnizstr. 18-61, 38678 Clausthal, Germany
  7.                  Internet email:  fromme@rz.tu-clausthal.de
  8.  
  9. -----------------------------------------------------------------------------
  10.  
  11. Contents
  12. ~~~~~~~~
  13.    1. What is CAP2GIF?
  14.    2. How to use CAP2GIF
  15.    3. Information for Programmers
  16.    4. Bugs, Problems, Wishes
  17.    5. License, Copying, etc
  18.    6. Disclaimer
  19.    7. Thanks
  20.  
  21.  
  22. 1. What is CAP2GIF?
  23. ~~~~~~~~~~~~~~~~~~~
  24.    CAP2GIF is a tool that converts graphic screen shots from CAP format to
  25.    GIF format. CAP files are produced by "Capture it!", a great utility
  26.    by Henrique Avila Vianna.
  27.  
  28.    Minimum requirements:
  29.     - 286 PC/AT (a version for 8086 PC/XT is available, but it's slow)
  30.     - approx. 300 Kb of free DOS memory
  31.     - MS-DOS 3.2
  32.  
  33.    CAP2GIF does not need any special graphics hardware for the conversion,
  34.    since it isn't displaying anything. In fact you don't need any graphics
  35.    card at all to convert a file captured from any graphics card.
  36.  
  37.    You don't need a harddrive, CAP2GIF works well (and reasonably fast)
  38.    on floppy disks, too.
  39.  
  40.  
  41. 2. How to use CAP2GIF
  42. ~~~~~~~~~~~~~~~~~~~~~
  43.    Syntax:
  44.               CAP2GIF [options] input[.CAP] [output[.GIF]]
  45.  
  46.    Square brackets [] denote optional parts:
  47.     - If no extension for the input file is specified, .CAP is assumed.
  48.     - If no extension for the output file is specified, .GIF is assumed.
  49.     - If no output file is specified, the output file will have the same
  50.       name as the input file, except for the extension .GIF.
  51.  
  52.    You can use wildcards ("?" and "*") in the input file name.
  53.    For example, you can simply type
  54.          CAP2GIF *
  55.    to convert all .CAP files in the current directory.
  56.    If you're using wildcards, you must not specify an output file.
  57.  
  58.    Please note that input and output files must be different. CAP2GIF checks
  59.    for this case.
  60.    If the output file already exists, CAP2GIF asks you if the file can be
  61.    overwritten, even if the /Q (quiet) option is specified. If you don't
  62.    like this, you have to check before if the output file exists, and delete
  63.    it if necessary.
  64.  
  65.    Options may be specified anywhere on the commandline, either in uppercase
  66.    or lowercase letters.
  67.    Currently the following options can be used:
  68.  
  69.     /Q   Quiet, i.e. no output during conversion, except for error messages
  70.          and the overwrite prompt.
  71.  
  72.     /G   Grey scale, i.e. perform a grey scale summing of the color palette.
  73.  
  74.     /?   Display a short help text.
  75.  
  76.  
  77. 3. Information for Programmers
  78. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  79.    CAP2GIF can be called from within other programs. There must be at least
  80.    300 Kb free memory (I can provide a version that needs only 200 Kb, but
  81.    it's somewhat slower).
  82.  
  83.    CAP2GIF returns the following error codes:
  84.        0 - Successful conversion has taken place, no errors.
  85.        5 - Help text has been displayed. No output file produced.
  86.       10 - Output file already exists, and the user has decided
  87.            not to overwrite it. No output file produced.
  88.       20 - An error occured (e.g. unknown option, user hit Ctrl-Break,
  89.            input file not found, I/O error etc). In this case no output
  90.            file is produced. If the file has been partially created before
  91.            the error occured, it is deleted. With multiple files (i.e. when
  92.            using wildcards) only the current output file is deleted.
  93.  
  94.    CAP2GIF checks for Ctrl-C and Ctrl-Break regularly. If the user hits one
  95.    of these key combinations, CAP2GIF stops, deletes the partially created
  96.    GIF file, and returns error code 20.
  97.  
  98.    A few remarks about CAP2GIF programming:
  99.  
  100.    The GIF encoding routine is my own development, I didn't use anyone
  101.    else's code. The core functions are written in 80286 assembly language,
  102.    using a hybrid tree hashing algorithm. It's extremely fast.
  103.  
  104.    I'm using a two level buffering for both file reading and writing,
  105.    resulting in a considerable I/O speed up. In fact, it doesn't matter much
  106.    if you use a cache or not!
  107.  
  108.    The surrounding routines (command line parsing, checking for file
  109.    existance, searching for matching files, error output etc) are written
  110.    in Borland Pascal 7.0. The whole thing consists of approx. 2500 lines
  111.    of source code.
  112.  
  113.  
  114. 4. Bugs, Problems, Wishes
  115. ~~~~~~~~~~~~~~~~~~~~~~~~~
  116.    I have tested CAP2GIF with all kinds of files produced by "Capture it!"
  117.    version 2.1, and it worked well for all of them.
  118.  
  119.    However, there is no existing "completely bugfree" software.
  120.    If you find a bug, any kind of misbehaviour, incompatibility,
  121.    inconsistency etc, please tell me about it, and I will try to fix it.
  122.    This includes spelling/grammar errors in the documentation, too.
  123.  
  124.    Also, if you would like to have any additional features:
  125.    They won't be implemented if you don't tell me!
  126.  
  127.    Please no phone calls, my above address is only a post address, I can not
  128.    be reached by phone there. If you want me to send you any software (e.g.
  129.    an update of CAP2GIF), I prefer internet email. Otherwise I can send it
  130.    to you on disk, but please send me US$ 10 or DM 10 to cover my expenses.
  131.  
  132.  
  133. 5. License, Copying, etc
  134. ~~~~~~~~~~~~~~~~~~~~~~~~
  135.    CAP2GIF is provided as Freeware, the same way as "Capture it!".
  136.    You may freely distribute it, use it, etc, but:
  137.     - you are not allowed to take money for it,
  138.     - you are not allowed to modify the program or the documentation,
  139.     - you are not allowed to include CAP2GIF in a commercial or
  140.       Shareware package without my written permission (I usually
  141.       grant permission if I get a free copy of the package).
  142.  
  143.    You may upload CAP2GIF to a BBS, FTP server etc, provided that it can be
  144.    downloaded free.
  145.  
  146.    You needn't my permission for including CAP2GIF in a Public Domain
  147.    or Freeware package, but please drop me a short note (mail or email),
  148.    and tell me how I can obtain the package.
  149.  
  150.    CAP2GIF is intended to be part of the "Capture it!" package.
  151.  
  152.  
  153. 6. Disclaimer
  154. ~~~~~~~~~~~~~
  155.    Normally a conversion program like this can not cause any damage.
  156.    However, just to be prepared for the (nearly impossible) worst case:
  157.  
  158.    IN NO EVENT WILL I BE LIABLE FOR ANY DAMAGES WHATSOEVER (INCLUDING
  159.    WITHOUT LIMITATION DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS
  160.    INTERRUPTION, LOSS OF BUSINESS INFORMATION OR THE LIKE) ARISING OUT OF
  161.    THE USE OF, INTERRUPTION IN THE USE OF, OR INABILITY TO USE THIS
  162.    SOFTWARE (EVEN IF I HAVE BEEN ADVISED OF ANY POSSIBILITY OR LIKELYHOOD
  163.    OF SUCH DAMAGES), OR FOR ANY CLAIM BY ANY OTHER PARTY.
  164.  
  165.    In other words: CAP2GIF is provided "as is", and you use CAP2GIF
  166.    on your own risk.
  167.    
  168.    By using CAP2GIF you agree to everything written above.
  169.  
  170.  
  171. 7. Thanks
  172. ~~~~~~~~~
  173.    Thanks to Henrique Avila Vianna for providing comprehensive documentation
  174.    of the CAP file format, and of course thanks for the great "Capture it!"
  175.    utility.
  176.  
  177.    The Graphics Interchange Format(c) is the Copyright property of
  178.    CompuServe Incorporated.
  179.    GIF(sm) is a Service Mark property of CompuServe Incorporated.
  180.    IBM, PC, and AT are registered trademarks of International Business
  181.    Machines Corporation.
  182.    MS-DOS, MS, and Microsoft are registered trademarks of Microsoft
  183.    Corporation.
  184.    Borland Pascal is a registered trademark of Borland International, Inc.
  185.  
  186. This documentation fits on three printer pages (11 inch, 6 lpi, 80 cpl).
  187. -----------------------------------------------------------------------------
  188.