fish/windowtool/windowtool.doc

   1 ****************************************************************************
   2                     Instructions for WindowTool V1.0
   3 ****************************************************************************
   4
   5 What is WindowTool ?
   6 ====================
   7     WindowTool is a program that allows you to switch between windows, to
   8     close them and to change their size by keyboard. You can also open a
   9     new Shell and stop the multitasking. The program is a standard Com-
  10     modity and can be controled with the Exchangeprogram of the Workbench.
  11
  12 The distribution :
  13 ==================
  14     The program is so-called giftware. This means everyone is allowed to
  15     copy it. I haven't any other demands but would be glad if someone who
  16     likes my program could send me a little gift (e.g. a PD-disk, his (or
  17     her) new program, sweets, a holidaypostcard, a little A600 ...).
  18     I'm not responsible for any damages caused by the program (anyhow it's
  19     very improbable). The utilization of the program is on own risk !
  20     I use the 'reqtools.library' for the filerequester and the normal
  21     requesters. ReqTools is Copyright (c) by Nico François.
  22
  23 How to start the program:
  24 =========================
  25     The program can be started as well from the Workbench as from the Shell.
  26
  27     Starting from the workbench:
  28     ----------------------------
  29      To start the program from the workbench, simply doubleclick the icon.
  30      There are different tooltypes to define the settings, that can be
  31      set in the .infofile.
  32
  33      Tooltypes:
  34      ----------
  35       -CX_PRIORITY:
  36        Sets the brokers priority (default = 21).
  37
  38       -CX_POPUP:
  39        Defines if the configurationwindow will be opened at programstart.
  40        'CX_POPUP=YES' means the window will be opened,
  41        'CX_POPUP=NO' means it won't.
  42
  43       -CX_SETTINGS:
  44        Here you can define the configurationfile the hotkeys will be loaded
  45        from. The Tooltype-settings won't be noticed.
  46
  47       The hotkeys:
  48       'CX_???KEY = combination' defines them. The names of the tooltypes
  49       correspond to the appropriating gadgets:
  50       -CX_STOPKEY
  51       -CX_NEWSHELLKEY
  52       -CX_QUITKEY
  53       -CX_CYCLEKEY
  54       -CX_WORKBENCHKEY
  55       -CX_CLOSEWINDOW
  56       -CX_FRONTKEY
  57       -CX_MAKEBIGKEY
  58       -CX_MAKESMALLKEY
  59       -CX_ZIPKEY
  60       -CX_POPKEY
  61       -CX_ACTIVETOFRONT
  62
  63     Starting from the Shell:
  64     ------------------------
  65      The program can be started as usually, but for closing the Shell
  66      afterwards I suggest to use 'runback WindowTool'.
  67
  68      You can also set the settings in the commandline by using the following
  69      keywords. They can be listed by 'WindowTool ?':
  70
  71      -CX_PRIORITY/N:
  72       Priority of the Broker (default=21).
  73
  74      -CX_POPUP/S:
  75       Has to be set if you want the configurationwindow to be opened.
  76
  77      -SETTINGS/K:
  78       Here you can define the configurationfile that you want to be loaded
  79       at programstart.
  80
  81       And now the keywords for the hotkeys. They correspond to the names
  82       of the gadgets in the configurationwindow:
  83
  84      -CX_STOPKEY/K
  85      -CX_NEWSHELLKEY/K
  86      -CX_QUITKEY/K
  87      -CX_CYCLEKEY/K
  88      -CX_WORKBENCHKEY/K
  89      -CX_CLOSEWINDOW/K
  90      -CX_FRONTKEY/K
  91      -CX_MAKEBIGKEY/K
  92      -CX_MAKESMALLKEY/K
  93      -CX_ZIPKEY/K
  94      -CX_POPKEY/K
  95      -CX_ACTIVETOFRONT/K
  96
  97 The configurationwindow:
  98 ========================
  99    Here you can enter all hotkeys.
 100
 101    The gadgets:
 102    ------------
 103     -Save:
 104      Saves all combinations to the current configurationfile.
 105
 106     -Hide:
 107      Closes the window.
 108
 109     -Cancel:
 110      Sets the old hotkeys and closes the window.
 111
 112     -Quit:
 113      Ends the program after a security-request.
 114
 115    The menus:
 116    ----------
 117     -New:
 118      Clears all stringgadgets. The old hotkeys stay still alive as long as
 119      you enter new ones.
 120
 121     -Open...:
 122      Opens a filerequester to load a configuartionfile. This will be loaded
 123      and if there;s no error, the new hotkeys will be set.
 124
 125     -Open .info:
 126      Opens the .infofile and sets its hotkeys.
 127
 128     -Save:
 129      Has the same function as the save-gadget.
 130
 131     -Save as...:
 132      Opens a filerequester and saves the configuration to the chosen file.
 133
 134     -Save as .info:
 135      Saves the configuration to the .infofile. If ther's no .infofile, the
 136      standard commodityicon will be created.
 137
 138     -About...:
 139      Some information about the program.
 140
 141     -Hide:
 142      Same function as the hidegadget.
 143
 144     -Cancel:
 145      Same function as the cancel-gadget.
 146
 147     -Quit:
 148      Same function as the quit-gadget.
 149
 150    How to build a hotkey:
 151    ----------------------
 152     A hotkey has to look like this:
 153
 154     [<qualifier> [<qualifier>...]] <key>
 155
 156     Qualifier:
 157     ----------
 158      alt           any alt-key
 159      ralt          right alt-key
 160      lalt          left alt-key
 161      shift         any shift-key
 162      rshift        right shift-key
 163      lshift        left shift-key
 164      capslock      caps lock key
 165      rcommand      right amiga-key
 166      lcommand      left amiga-key
 167      control       control-key
 168      numericpad    enables the use of the numeric pad
 169      rbutton       right mouse-button
 170      midbutton     middle mouse-button
 171      leftbutton    left mouse-buuton
 172      newprefs      preferences have been changed
 173      diskremoved   disk removed
 174      diskinserted  disk inserted
 175
 176     keys:
 177     -------
 178      a .. z, 0 .. 9, etc.   normal keys
 179      f1 .. f10              funktion-keys
 180      up, down, left, right  cursor-keys
 181      help                   help-key
 182      del                    delete-key
 183      return                 return-key
 184      enter                  enter-key ('numericpad' has to be set !)
 185      backspace              backspace-key
 186      esc                    escape-key
 187      space                  space-key
 188      comma                  comma-key
 189      upstroke               ~-key
 190
 191     Examples:
 192     ----------
 193
 194     'rcommand shift alt esc'
 195     'lshift rshift lalt ralt return'
 196     'shift alt esc'
 197     'control rshift numericpad enter'
 198     'alt help'
 199      ...
 200
 201 The functions:
 202 ==============
 203    -Stop:
 204     This gives the own task a higher priority and the program waits for a
 205     signal. This means that (nearly) all programs stop. If the hotkey is
 206     pressed again, everything will go on as normal.
 207     I think some readers might ask what the reason for such a function is,
 208     so let me tell you, why I decided to code such a routine: A friend of
 209     mine and me often sat together in front of my computer. He always
 210     wanted to do things I didn't want to do (e.g. draw pictures, draw icons,
 211     draw pointers, adjust colors ...). One day I coded a routine that
 212     blocked my computer so he couldn't do anything because he didn't know
 213          the hotkey and we did what I wanted to do.
 214
 215    -MakeBig:
 216     Increases a window to maximum size.
 217
 218    -MakeSmall:
 219     Decreases a window to minimum size. Attention ! Some windows disappear
 220     because they don'have a minimum size and can't be activated per mouse
 221     anymore. So it's better to make them immediatly big again.
 222
 223    -Zip:
 224     Activates the zip-gadget.The window will be zipped !
 225
 226    -Cycle:
 227     Puts the current window in the back and activates the window that's now
 228     in the foreground.  (like 'Left Amiga + m' for screens)
 229
 230    -Workbench:
 231     This activates the workbenchwindow or better the window with the
 232     workbennch menus.
 233
 234    -ActivateFront:
 235     Activates the foremost window.
 236
 237    -ActiveToFront:
 238     Brings the active window to front.
 239
 240    -CloseWindow:
 241     Activates the closegadget of the active window.
 242
 243    -Newshell:
 244     Opens a new Shell. ('NewShell' is started)
 245
 246    -Show:
 247     Opens the Configuratiowindow.
 248
 249    -Quit:
 250     Quits Windowtool (with securityrequest).
 251
 252 How the configurationfile is built:
 253 ===================================
 254     The Configurationfile is a pure ASCII-Text. The 10 Hotkeys have to be
 255     specified in order of the gadgets in the configurationwindow. But I
 256     think it's better to set them in the configurationwindow and to save
 257     them from there out.
 258
 259 The sourcecode:
 260 ===============
 261     The program was coded with the Lattice/Sas-C-Compiler. You can compile
 262     it by entering 'lmk'. Do read the sourcecode I suggest a Tabsize of 4.
 263
 264 The developement:
 265 =================
 266     Version 1.0 (Wednesday,1st July,1992):
 267     ---------------------
 268     Program is ready and no error is known yet ...
 269
 270 End of documentation:
 271 =====================
 272     At the end I want to greet (and thank) some friends:
 273      Benjamin Schörner for his great ideas (e.g. stop-function) and for
 274                         the English translation of the documentation.
 275      Christian Flaccus for his wonderful grafix (what grafix ???).
 276
 277     If somebody finds a mistake or if he's got some new ideas, he should
 278     write me and he will immediatly get a new update of the program. (This
 279     is ment to the people who didn't send me a present,too).
 280     Here's my address:
 281
 282          Klaas Hermanns
 283          Weberstraße 42
 284          4190 Kleve
 285          GERMANY
 286