home *** CD-ROM | disk | FTP | other *** search
/ World of A1200 / World_Of_A1200.iso / programs / system / filerexx / filerexx.dok < prev    next >
Text File  |  1995-02-27  |  10KB  |  270 lines
  1.  
  2. Dokumentation zu FileRexx 1.3
  3. =============================
  4.  
  5. Programm und Dokumentation sind © Copyright 1993 by Michael 'Mick' Hohmann
  6. und hartmut Goebel.
  7.  
  8. IMPORT StdDisclaimer; (* kurz: Benutzung auf eigene Gefahr *)
  9. FileRexx wurde sorgfältig getestet, aber es können natürlich trotzdem noch
  10. diverse Fehler auftreten.
  11.  
  12. FileRexx v1.3 ist Freeware. Es ist aber nicht erlaubt, es zu kommerziellen
  13. Zwecken ohne unsere schriftliche Erlaubnis zu benutzen. Änderungen müssen
  14. dokumentiert werden. Dabei müssen unser Name und unser Copyright erhalten
  15. bleiben. Es darf auf nicht-kommerziellem Weg weitergegeben werden, solange
  16. die folgenden Bedingungen erfüllt sind:
  17.  
  18.   * Quelltext, ausführbares Programm und Dokumentation müssen zusammen
  19.     weitergegeben werden. Dies sind folgende Dateien:
  20.  
  21.       FileRexx                   10732 ---arwed 16-May-93 23:49:42
  22.       FileRexx1.3.DisplayMe       1793 ----rw-d 22-Jun-93 22:57:10
  23.       FileRexx.doc                9247 ----rwed 22-Jun-93 22:20:21
  24.       FileRexx.doc.info            910 ----rw-d 22-Jun-93 22:42:34
  25.       FileRexx.dok                9622 ----rwed 22-Jun-93 22:05:24
  26.       FileRexx.dok.info            910 ----rw-d 22-Jun-93 22:42:34
  27.       FR-RexxStrings.dfn          2697 ---arwed 25-Apr-93 13:01:10
  28.       FR-RexxStrings.dfn.info      847 ----rw-d 22-Jun-93 22:42:34
  29.       FR-Test.rexx                 193 ---arwed 25-Apr-93 15:58:02
  30.       FR-Test.rexx.info            607 ----rw-d 22-Jun-93 22:42:34
  31.       RequestFile.ttx             3198 ---arwed 25-Apr-93 10:17:44
  32.       RequestFile.ttx.info         607 ----rw-d 22-Jun-93 22:42:34
  33.       TTX_Dragon.dfn             13822 ---arwed 16-May-93 23:20:50
  34.       TTX_Dragon.dfn.info          847 ----rw-d 22-Jun-93 22:42:34
  35.       FileRexx.mod               14582 ---arwed 16-May-93 21:15:08
  36.       FileRexx.mod.info            510 ---arw-d 22-Jun-93 23:20:12
  37.       MoreIntuition.mod           2475 ---arwed 16-May-93 23:26:16
  38.       MoreIntuition.mod.info       509 ---arw-d 22-Jun-93 23:20:12
  39.       SimpleRexx.mod              4432 ---arwed 30-Dec-92 02:55:02
  40.       SimpleRexx.mod.info          509 ---arw-d 22-Jun-93 23:20:12
  41.  
  42.     Diese Dateien müssen unverändert weitergegeben werden!
  43.  
  44.   * Der Inhalt des Archives (FileRexx-13.run) in dem sich die
  45.     obengenannten Dateien befinden darf auf *keinen* Fall geändert werden.
  46.     D.h. es darf keine Datei entfernt und auch keine Datei dem Archiv
  47.     hinzugefügt werden, ohne die schriftliche Erlaubnis des Authors.
  48.  
  49.   * PD-Serien: Die Disketten, die FileRexx enthalten, dürfen in Deutschland
  50.     nicht mehr als 5 DM kosten.
  51.     Ansonsten darf der Preis, den Fred Fish für eine einzelne seiner
  52.     AmigaLibDisks verlangt, nicht überschritten werden.
  53.  
  54.  
  55. FileRexx läuft nur mit AmigaOS V37 oder höher (das ist 2.04 oder höher).
  56.  
  57.  
  58. Zusammenfassung
  59. ===============
  60. FileRexx öffnet einen ASL-FileRequester auf dem vordersten PubScreen, und
  61. schreibt die/das ausgewählte Datei/Verzeichniss nach StdOut, in eine
  62. Env-Var (falls angegeben), oder in eine ARexx-Variable (falls FileRexx
  63. einen Rexx-Host geöffnet hat.
  64.  
  65. Beendet wird das Programm (falls kein Rexx-Host geöffnet wurde) einfach
  66. dadurch, daß der FileRequester mit "CANCEL" beantwortet wird. Falls ein
  67. Rexx-Host geöffnet wurde, kann das Programm durch folgendes beendet
  68. werden:
  69.    - den ARexx-Befehl 'Quit' an den Rexx-Host schicken
  70.    - ein CTRL-C an FileRexx senden
  71.    - FileRexx nochmal mit dem gleichen PortNamen als Argument aufrufen
  72.  
  73. Die Größe des FileRequesters passt sich, falls nicht durch Argumente
  74. anders angegeben automatisch an die aktuelle "visible Size" des Screens an.
  75.  
  76. Geschrieben habe ich dieses Programm hauptsächlich um von TurboText aus
  77. den ASL-Requester (und dadurch auch MagicFilerRequester, ReqTools)
  78. benutzen zu können. Deshalb ist auch ein Makro und eine Definition-Datei
  79. für TurboText dabei. Das Makro für TurboText mag auch als Beispiel dafür
  80. dienen, wie man FileRexx von ARexx aus anspricht.
  81.  
  82.  
  83. Inhalt
  84. ======
  85.  
  86. FileRexx           - Das eigentliche Programm
  87. FileRexx.doc       - Die englische Anleitung
  88. FileRexx.dok       - Die Anleitung (naja, halt dieser Text ¦=)
  89. FR-RexxStrings.ttx - Eine Sammlung von ARexx-*Strings* für die
  90.                      TurboText-Definitiondatei (ist schneller als Makros,
  91.                      aber FileRexx _muß_ vorher gestartet werden
  92. FR-Test.rexx       - Ein simples Test-Makro
  93. RequestFile.ttx    - ARexx-Makro, welches für dir TTX-Definitonsdatei
  94.                      "TTX_Dragon.dfn" benötigt wird. (FileRexx wird
  95.                      geladen, falls es sich noch nicht im Speicher
  96.                      befindet)
  97. TTX_Dragon.dfn     - Meine TurboText-Definitiondatei, noch ohne
  98.                      Rexx-Strings, deshalb wird RequestFile benötigt
  99. FileRexx.mod       - Der Quelltext des Hauptprogrammes
  100. MoreIntuition.mod  - Ein Zusatzmodul welches sich um das Locking des
  101.                      PubScreens kümmert
  102. SimpleRexx.mod     - Der Hauptteil der ARexx-Schnittstelle befindet sich
  103.                      in diesem Modul
  104.  
  105.  
  106. Aufruf
  107. ======
  108. (vom CLI aus):
  109.  
  110. FileRexx [FILE name] [PAT | PATTERN string ] [TITLE string] [TOP number]
  111.          [LEFT number] [WIDTH number] [HEIGHT number] [PS | PUBSCREEN
  112.          name] [ENVVAR name] [LOCAL] [SM | SAVEMODE] [DRAWERSONLY] [RX |
  113.          REXXHOST] [PORTNAME name] [HELP]
  114.  
  115. (von ARexx aus):
  116.  
  117. GETFILE,
  118. GETFILESAVE,
  119. GETDIR   [FILE name] [PAT | PATTERN string ] [TITLE string] [TOP number]
  120.          [LEFT number] [WIDTH number] [HEIGHT number] [PS | PUBSCREEN
  121.          name] [VAR name]
  122.  
  123. FILE name
  124. ---------
  125. Dient als Voreinstellung für den Datei- und Verzeichnisnamen.
  126.  
  127. PAT | PATTERN string
  128. --------------------
  129. Wird hier ein Pattern angegeben, wird der FileRequester mit einem
  130. Pattern-Gadget geöffnet, und es werden nur die Dateien angezeigt die zu
  131. dem Pattern passen.
  132.  
  133. TITLE string
  134. ------------
  135. Hiermit wird der Fenster-Titel des FileRequesters angegeben.
  136.  
  137. TOP number, LEFT number, WIDTH number, HEIGHT number
  138. ----------------------------------------------------
  139. Normalerweise öffnet wird der FileRequester mit einem Seiten- und
  140. Höhenverhältnis geöffnet, die zu der aktuellen "visible Size" des Screens
  141. passen. Falls dies nicht gewünscht ist, kann durch diese Argumente eine
  142. andere Größe und Position bestimmt werden. Nur durch WIDTH oder HEIGHT
  143. wird die Größe des FileRequesters beeinflusst. Wenn nur eine von diesen
  144. zwei Argumenten angegeben wird, wird die jeweils andere vom Programm
  145. berechnet.
  146.  
  147. PS | PUBSCREEN name
  148. -------------------
  149. Der FileRequester öffnet sich normalerweise automatisch auf dem vordersten
  150. PubScreen. Da es aber manchmal sinnvoll sein kann, wenn sich der
  151. FileRequester nur auf einem bestimmten Screen öffnet, kann hiermit der
  152. Name des PubScreens angegeben werden.
  153.  
  154. ENVVAR name
  155. -----------
  156. Wenn hier ein Name angegeben wurde, legt FileRexx den ausgewählten
  157. Filenamen in eine Environment-Variable ab.
  158.  
  159. LOCAL
  160. -----
  161. Wenn dieser Schalter und ein Environment-Name angegeben werden, legt
  162. FileRexx eine lokale Environment-Variable an. Ansonsten wird eine globale
  163. Environment-Variable erzeugt.
  164.  
  165. SM | SAVEMODE
  166. -------------
  167. Der ASL-Filerequester wird im "SaveMode" geöffnet. D.h. der
  168. Dateiauswahlbereich wird invertiert dargestellt.
  169.  
  170. DRAWERSONLY
  171. -----------
  172. Es werden nur Verzeichnisse zur Auswahl angeboten.
  173.  
  174. RX | REXXHOST
  175. -------------
  176. Das Programm öffnet einen Rexx-Host, und kann darüber angesprochen werden.
  177. Folgende ARexx-Commandos stehen zur Verfügung:
  178.  
  179.   GETFILE - genauso wie der normale Aufruf vom CLI aus
  180.  
  181.   GETFILESAVE - genauso wie der Aufruf vom CLI mit der Option SAVEMODE
  182.  
  183.   GETDIR - genauso wie der Aufruf vom CLI mit der Option DRAWERSONLY
  184.  
  185.   QUIT - entfernt das Programm (und den Host) aus dem Speicher
  186.  
  187. Den ersten drei Befehlen können obenstehende Argumente übergeben werden.
  188. Die Parameter der Argumente entsprechen denen des CLI-Aufrufes.
  189.  
  190. PORTNAME name
  191. -------------
  192. Normalerweise heißt der Rexx-Host, den FileRexx öffnet, "FILEREXX". Falls
  193. dies nicht erwünscht ist, oder FileRexx einen zweiten Rexx-Host öffnen
  194. soll, dann kann/muß man mit diesem Argument eine Namen für den Rexx-Host
  195. angeben. Jedoch muß der Name des Rexx-Hosts eindeutig sein, d.h. es darf
  196. kein anderer Port mit dem angegebenen Namen existieren.
  197.  
  198. HELP
  199. ----
  200. Zeigt einen kurzen Hilfstext an.
  201.  
  202.  
  203. Beispiel
  204. ========
  205.  
  206.  FileRexx ENV:sys/palette.prefs PAT=#?.prefs
  207.  
  208. Mit diesem Aufruf wird ein FileRequester geöffnet, in dem der Inhalt des
  209. Verzeichnisses ENV:sys angezeigt wird.  Es werden aber nur die Dateien mit
  210. der Endung ".prefs" angzeigt. Als Dateiauswahl wird außerdem die Datei
  211. "palette.prefs" angeboten.
  212.  
  213.  
  214. History
  215. =======
  216. v1.3    Erste Veröffentlichung
  217. v1.2    Interne Release
  218. v1.1    Rexx-Host eingebaut
  219. v1.0    Erste verwendbare Version :-)
  220. v0.x    diverse Versuche...
  221.  
  222.  
  223. Zukunft
  224. =======
  225. - Von der Workbench aus aufrufbar (weiß nicht, ob das sinnvoll ist, wenn
  226.   es jemand unbedingt benötigt, soll er/sie sich einfach mit mir in
  227.   Verbindung setzen...)
  228.  
  229.  
  230. Bekannte Probleme/Bugs
  231. ======================
  232. Bis jetzt keine...
  233.  
  234.  
  235. Author
  236. ======
  237. Im Usenet erreicht man mich unter:
  238.  
  239.    mickh@spice.franken.de
  240.  
  241. Oder mit der Bundesp*st (Rückporto bitte!):
  242.  
  243.    Michael-W. Hohmann
  244.    Carl-Schilling-Str. 10
  245.    D-8701 Kirchheim
  246.  
  247. Viel Spaß!
  248.  
  249.  
  250. Danksagung
  251. ==========
  252. Der ARexx-Host wäre ohne Hilfe von hartmut Goebel nicht so schnell
  253. entstanden (wahrscheinlich sogar gar nicht !=). Auch sonst hat mir Harmut
  254. sehr viel beim Debuggen geholfen.
  255.  
  256. Die folgenden Leute haben mich mit diversen Anregungen und Bug-Reports
  257. unterstützt:
  258.  
  259.   Kai Bolay
  260.   Bernhard Möllemann
  261.   Franz-Josef Reichert
  262.   Steffen Reith
  263.   Uwe Röhm
  264.   Fridtjof Siebert
  265.   Jürgen Weinelt
  266.  
  267. und Oliver Knorr für die leckeren Erdnüsse ...                       ¦=)
  268.  
  269. Vielen Dank Euch allen.
  270.