Frozen Fish 2: PC/frozenfish_august_1995.bin/bbs/d07xx/d0741.lha/ShowI/ShowI.doc

Text File | 1992-10-11 | 6KB | 200 lines

                         Documentation ShowI Version 1.9


                                written 1992

                                   by H.P.G

                               FREEWARE VERSION



INDEX:

            Index
            General Description
            System
            Legal Stuff
            Start Parameters
            Functions of ShowI
            Using ShowI
            Technical
            Last
            Address
            List of files




General Description:


    ShowI ( = ShowIcon ) is a cli program which simply  displays  icons.
    You can specify as many icon names as you want.  If  ShowI  finds  a
    given icon, it opens a little window and displays it.



System:

    To use ShowI you need at minimum Kichstart Kickstart 2.0 Version 37.

    Because of the use of many new OS 2.xx features  ShowI  doesn`t  run
    under Kickstart 1.2 und 1.3.


Legal Stuff:


        This  program áand  all files come with it, also the docfiles, are
        released as FREEWARE.

        this means:

            everybody may use ShowI,

            everybody may copy ShowI, if:

                1. You copy all included files, see list at the end of the
                   doc file.
                2. No changes are made,  this ámeans áthe áprogram and all
                   included files must stay in the original form.
                   Exception: you  may  archieve  it; but in this case you
                              must also archieve the whole package.
                3. If  you  recompile  it, you have to include a notice to
                   the original author. If you also want to (re)distribute
                   in any new form you have to send me a copy.
                4. You may not sell ShowI.
                   Execption: you`re  allowed  to  take  a  small copy fee
                              which should not extend 5US$.
                5. If you want to include ShowI
                   or one of the  included files as a part of a commercial
                   package,  you  must  have  written  permission  of  the
                   author (address see below).


        I take no warranty or garanty for the function of this program.
        The whole risk of using ShowI stays only by the user.



Start Parameters:

    ShowI has the following Cli-Syntax:

    SYNOPSIS:    ShowI [IconName/M/A]

    the Flag M (multiple) means: you can specify as many Iconnames as you
    want. ShowI displayes them in the right order.
    You have to specify at minimum one Iconname.
    You must not put an '.info' to the Iconname.


Funktionen von ShowI:

    After specifying one ore more Iconnames ShowI opens a window, on which
    it displayes the given Icon(s).
    If you klick on this Icon it toggles as if it would be klicked on the
    WBench. If you klick it again it got its first state.

    Under the Icon the following texts will appear:

    n = next
    c = cancel

    If you press the 'n' Key or klick on the CloseGadget of the  Window,
    ShowI displayes the next specifyied  Icon,  assuming  you  specified
    more than one. If you had only specify one Icon,  ShowI  terminates.

    If you specified multiple Icons and you don`t want ShowI to  display
    the whole list, you can press the 'c'  key  and  ShowI  will  break.

    The size of the window depends on the size of the Icon you  want  to
    display.

    The window will always appear centered in the middle of the  screen.

    ShowI is  able  to  display  Icons  with  a  width  of  the  current
    screenwidth and the height of the current screenheight - 30  pixels.

    All displaying Icons have the original WB 2.0 design.




Using ShowI:


    Who doesn`t know the problem, you want to copy an Icon, but you don`t
    know at the moment where it is. Maybe it is in the subdir of a subdir
    of a sub... Now you could open thousands of window to get the  icon,
    to realize that its not the one you want.
    Or, you use ShowI gives it the name of the Icon and you`ll see if its
    the right on or not.

    Because of using at the moment the Csh-Shell, I decided  to  include
    the ability of multiples Iconnames instead of a PatternMatching call.
    CSH has included a short fast and very good PatternMatching routine,
    so you can just type:

    e.g.
          ShowI sys:*

    and get all Icons in the sys:-Dir.

    If you are still using the  standart  Shell  there  are  some  other
    PatternMatching programs you can use instead, such as For, ForEach
    etc. .



Technical:

     ShowI is compiled with the Manx Aztec V5.2a Compiler.

     It is  because  of  its  many  functions  (such  as  ErrorMessages,
     Checking  of  variables  ,  changing   the    windowsizes    etc.),
     relativly   small.  This  is  because  I   use   the   'good   old'
     Intuition  functions  instead   of   using   the   GadTools.Library
     to   create   and   handle   the    Window    and    the    Gadget.

     For only one Window with on lonely Gadget is not  useful  to  first
     try to get the Lock of the DefPubScreen then to  get  a  VisualInfo
     then to call CreateContext, then to initialize a NewGadgetStructure,
     then ....



Last:

     I hope many people use this program.

     If you find any bugs please let me know.

     Also serious critic and/or ideas are wellcomed.


Address:

     Send all messages to:

               Hans-Peter Guenther
               Gruener Weg 5
               W-3501 Fuldatal 2
               GERMANY


List of files:

ShowI           : the binary
ShowI.info
ShowI.doc       : english manual
ShowI.doc.info
ShowI.dok.info  : germal manual
ShowI.dok