forwarding a radium compilation fix.
[AROS-Contrib.git] / fish / windowtool / windowtool.dok
blobf878f9a1acaa96d1ed3b7581b7cdf7750723ceb6
1 ******************************************************************************
2                        Anleitung zu WindowTool V1.0
3 ******************************************************************************
5 Was ist WindowTool für ein Programm ?
6 =====================================
7    WindowTool ist ein Programm, daß es ermöglicht mit der Tastatur zwischen
8    Windows umzuschalten, sie zu schließen und ihre Größe zu verändern.Außerdem
9    kann man eine neue Shell öffnen lassen und das Multitasking blockieren.
10    Das Programm ist ein standard Commodity und kann über das Exchangeprogramm
11    der Workbench gesteuert werden.
13 Der Vertrieb:
14 =============
15    Das Programm ist sogenannte Giftware. Dies bedeutet,daß jeder dieses
16    Programm kopieren darf.Ich erhebe keine weitern Ansprüche, würde mich
17    aber freuen, wenn jemandem das Programm gefällt von diesem ein kleines
18    Geschenk zu erhalten (eine PD-Disk,sein neues Programm,Schokolade (bitte
19    nur im Winter),Postkarte aus dem Urlaub,ein kleiner A600 ...).
20    Für Schäden, die das Programm verursacht (sehr unwahrscheinlich), wird
21    keine Haftung übernommen.Jeder benutzt das Programm auf eigenes Risiko.
22    Für das Filerequester und die normalen Requester wird die
23    'reqtools.library' gebraucht. ReqTools ist Copyright (c) von Nico Francois.
25 Starten des Programms:
26 ======================
27     Das Programm kann sowohl von der Workbench als auch von der Shell aus
28     gestartet werden.
30     Start von der Workbench:
31     ------------------------
32      Um das Programm zu starten, einfach das Icon doppelt anklicken.
33      Um die Einstellungen zu bestimmen existierten verschiedene Tooltypes,
34      die in der .Infodatei eingestellt werden können.
35   
36      Tooltypes:
37      ----------
38       -CX_PRIORITY:
39          Hiermit wird die Priorität des Brokers eingestellt (default = 21).  
40        
41       -CX_POPUP:
42        Hiermit wird eingestellt, ob das Einstellungswindow bei Programmstart
43        geöffnet werden soll.
44        Mit 'CX_POPUP=YES' wird es anfangs geöffnet,
45        mit 'CX_POPUP=NO' nicht.
47       -CX_SETTINGS:
48        Hiermit kann eine Konfigurationsdatei bestimmt werden, aus der die 
49        Tastaurkombinationen geladen werden.Die Einstellungen über die
50        Tooltypes werden nicht beachtet.
51        
52       Nun die Tastaturkombinationen:
53       Mit 'CX_???KEY = Kombination' werden diese eingestellt.
54       Die Namen der Tooltypes entsprechen den Gadgets:
55       -CX_STOPKEY
56       -CX_NEWSHELLKEY
57       -CX_QUITKEY
58       -CX_CYCLEKEY
59       -CX_WORKBENCHKEY
60       -CX_CLOSEWINDOW
61       -CX_FRONTKEY
62       -CX_MAKEBIGKEY
63       -CX_MAKESMALLKEY
64       -CX_ZIPKEY
65       -CX_POPKEY
66       -CX_ACTIVETOFRONT
68     Start von der Shell:
69     --------------------
70      Das Programm kann ganz normal gestartet werden, um das Shellfenster aber
71      schließen zu können empfiehlt sich der Start mittels 'runback WindowTool'.
72      
73      In der Commandline können die Einstellungen auch eingestellt werden 
74      mittels der folgenden Schlüsselwörter.Sie können auch durch die Eingabe
75      von 'WindowTool ?' aufgelistet werden:
76       
77      -CX_PRIORITY/N:
78       Priorität des Broker (default=21).
80      -CX_POPUP/S:
81       Muß gesetzt werden, falls das Einstellungswindow geöffnet werden soll.
82           
83      -SETTINGS/K:
84       Hiermit kann eine Konfigurationsdatei bestimmt werden, die bei
85       Programmstart geladen werden soll.
87       Nun folgen die Schlüsselwörter für die Tastaurkombinationen. Sie ent-
88       sprechen den Namen der Gadgets im Einstellungswindow:
90      -CX_STOPKEY/K
91      -CX_NEWSHELLKEY/K
92      -CX_QUITKEY/K
93      -CX_CYCLEKEY/K
94      -CX_WORKBENCHKEY/K
95      -CX_CLOSEWINDOW/K
96      -CX_FRONTKEY/K
97      -CX_MAKEBIGKEY/K
98      -CX_MAKESMALLKEY/K
99      -CX_ZIPKEY/K
100      -CX_POPKEY/K
101      -CX_ACTIVETOFRONT/K
102    
103 Das Einstellungswindow:
104 =======================
105    Im Einstellungswindow können alle Tastaurkombinationen eingegeben werden.
106         
107    Die Gadgets:
108    ------------
109     -Save:
110      Mit Save werden alle Kombinationen in der aktuellen Konfigurationsdatei
111      abgespeichert.
112      
113     -Hide:
114      Mit Hide wird das Window geschloßen.
116     -Cancel:
117      Mit Cancel werden die Tastaturkombinationen, die beim Öffnen des Windows
118      aktiv waren, wieder gesetzt und das Window wird geschloßen.
120     -Quit:
121      Mit Quit wird das Programm nach einer Sicherheitsabfrage beendet.
123    Die Menus:
124    ----------
125     -New:
126      New löscht alle Stringgadgets, die alten Tastaturkombinationen bleiben
127      aber noch so lange erhalten bis neue eingegeben worden sind.
128         
129     -Open...:
130      Open öffnet ein Filerequester zum Laden einer Konfigurationsdatei.Diese
131      wird geladen und falls keine Fehler entstanden, werden die Tastatur-
132      kombinationen gesetzt.
134     -Open .info:
135      Open .info läd die .infodatei ein und setzt die Einstellungen aus ihr.
137     -Save:
138      Save hat die gleiche Funktion wie das SaveGadget.Die aktuellen Einstell-
139      ungen werden in der aktuellen Konfigurationsdatei abgespeichert.
141     -Save as...:
142      Diese Funktion öffnet ein Filerequester und speichert die Konfiguration
143      in der gewählten datei ab.
145     -Save as .info:
146      Diese Funktion speichert die Konfiguration in der .infodatei ab. Falls
147      das Programm noch kein Icon hat, wird das standard CommodityIcon er-
148      zeugt.
150     -About...:
151      Ein paar Informationen über das Programm.
152           
153     -Hide:
154      Gleiche Funktion wie das HideGadget.Das Window wird geschloßen.
156     -Cancel:
157      Gleiche Funktion wie das CancelGadget.Die Einstellungen vor dem Öffnen
158      des Windows werden übernommen.
159   
160     -Quit:
161      Gleiche Funktion wie das QuitGadget.Nach einer Sicherheitsabfrage wird
162      das Programm beendet.
164    Aufbau einer Tastaurkombination (HotKey):
165    -----------------------------------------
166     Eine Tastaturkombination muß folgendermaßen aussehen:
167     
168     [<qualifier> [<qualifier>...]] <key>
170     Qualifier:
171     ----------
172      alt           eine Alt-Taste
173      ralt          rechte Alt-Taste
174      lalt          linke Alt-Taste
175      shift         eine Shift-Taste
176      rshift        rechte Shift-Taste
177      lshift        linke Shift-Taste
178      capslock      Caps Lock Taste
179      rcommand      rechte Amiga-Taste
180      lcommand      linke Amiga-Taste
181      control       Control-Taste
182      numericpad    Benutzung der Zehnertastatur
183      rbutton       Click der rechten Maus-Taste
184      midbutton     Click der mittleren Maus-Taste
185      leftbutton    Click der rechten Maustaste
186      newprefs      Preferences wurden geändert
187      diskremoved   Disk entfernt
188      diskinserted  Disk eingelegt
190     Tasten:
191     -------
192      a .. z, 0 .. 9, etc.   Normale Tasten
193      f1 .. f10              Funktions-Tasten
194      up, down, left, right  Cursor-Tasten
195      help                   Help-Taste
196      del                    Delete-Taste
197      return                 Return-Taste
198      enter                  Enter-Taste ('numericpad' muß gesetzt sein !)
199      backspace              Backspace-Taste
200      esc                    Escape-Taste
201      space                  Space-Taste
202      comma                  Comma-Taste
203      upstroke               Tilde-Taste
205     Beispiele:
206     ----------
207     
208     'rcommand shift alt esc'
209     'lshift rshift lalt ralt return'
210     'shift alt esc'
211     'control rshift numericpad enter'
212     'alt help' 
213      ...
215 Die Funktionen im einzelnen:
216 ============================
217    -Stop:
218     Mit der Funktion Stop bekommt der eigene Task eine höhere Priorität und
219     es wird in einer Dauerschleife auf Signale gewartet.Dies bedeutet für den
220     Benutzer, daß (fast) alle anderen Programm zum Stillstand kommen.Wenn die
221     Tastaturkombination noch mal gedrückt wird, läuft alles wieder normal.
222     Da manche Leser jetzt sicherlich nach dem Nutzen dieser Funktion fragen,
223     möchte ich erklären, wie sie entstanden ist: Ein Freund und ich saßen
224     öfter zusammen vor meinem Computer. Er wollte immer Dinge machen, wozu
225     ich keine Lust hatte(Bilder malen,Icons malen,Pointer verändern,Workbench-
226     farben ändern usw.). Eines Tages habe ich dann ein Programm geschrieben,
227     daß über eine Tastaturkombination den Computer blockierte. So konnte er
228     nichts mehr machen, ohne die Tastaturkombination zu kennen. Und wir
229     machten das ,wozu ich Lust hatte.
231    -MakeBig:
232     MakeBig vergrößert das aktive Window auf maximale Größe.
234    -MakeSmall:
235     MakeSmall verkleinert das aktuelle Fenster auf die minimale Größe. Manche
236     Fenster "verschwinden", da sie keine minimale Größe haben.Diese können
237     nicht mehr mit der Maus aktiviert werden und sollten mit MakeBig sofort
238     wieder vergrößert werden.
240    -Zip:
241     Zip aktiviert das ZipGadget.Das Window wird gezipt!!!
243    -Cycle:
244     Cycle bringt das aktuelle Window in den Hintergrund  und aktiviert das
245     Window, das nun im Vordergrund ist.
246     (ähnlich "linke AmigaTaste + m" für Screens)
248    -Workbench:
249     Diese Funktion aktiviert ein Workbenchwindow,d.h. ein Window mit den Menus
250     der Workbench.
252    -ActivateFront:
253     Diese Funktion aktiviert das vorderste Window auf dem vordersten Screen.
255    -ActiveToFront:
256     Diese Funktion bring das aktive Window nach vorne.
258    -CloseWindow:
259     Diese Funtion betätigt das CloseGadget des aktiven Windows.
260          
261    -Newshell:
262     Newshell öffnet eine Shell (Der Befehl "Newshell" wird aufgerufen).
264    -Show:
265     Diese Funktion öffnet das Einstellungswindow.
267    -Quit:
268     Beendet WindowTool (mit Sicherheitsabfrage).
270 Der Aufbau der Konfigurationsdatei:
271 ===================================
272     Die Konfigurationsdatei ist ein reiner ASCII-Text. Die 10 Tastaturkombi-
273     nationen müssen in Anführungszeichen in der Reihenfolge der Gadgets im 
274     Einstellungswindow angegeben werden. Es ist jedoch zu empfehlen sie im
275     Programm zu verändern und von dort abzuspeichern.
277 Der Sourcecode:
278 ===============
279     Das Programm wurde mit dem Lattice/Sas-C-Compiler geschrieben und läßt
280     sich durch die Eingabe von 'lmk' compilieren.Um den Sourcecode gut lesen
281     zu können sollte man eine Tabsize von 4 nehmen.
282     
283 Die Entwicklung:
284 ================
285     Version 1.0 (1.7.92):
286     ---------------------
287     Programm wurde fertiggestellt und es sind noch keine Fehler bekannt.
288     
289 Schluß der Anleitung:
290 =====================
291     Zum Schluß möchte ich ein paar Grüße an ein paar Freunde richten:
292      Benjamin Schörner für seine tolle Anregung (s.Stop-Funktion) und die
293                         englische Version der Anleitung.
294      Christian Flaccus für die tollen Grafiken (welche Grafik ?).
296     Falls jemand einen Fehler findet oder noch ein paar Ideen für das Programm
297     hat, der soll mir schreiben und wird umgehend eine verbesserte Version des
298     Programms erhalten(dies gilt auch für den, der mir kein Geschenk schickt).
299     Hier meine Adresse:
300     
301          Klaas Hermanns
302          Weberstraße 42
303          4190 Kleve
304          Deutschland