home *** CD-ROM | disk | FTP | other *** search
/ World of A1200 / World_Of_A1200.iso / programs / system / filerexx / filerexx.doc < prev    next >
Text File  |  1995-02-27  |  9KB  |  274 lines
  1.  
  2. Documentation for FileRexx 1.3
  3. ==============================
  4. This program and the accompanying documentation are © Copyright 1993 by
  5. Michael 'Mick' Hohmann and hartmut Goebel.
  6.  
  7. IMPORT StdDisclaimer; (* short: use it at your own risk *)
  8. FileRexx has been tested carefully, but there is certainly plenty of room
  9. for bugs.
  10.  
  11. FileRexx v1.3 is freeware, non-commercial distribution is allowed as
  12. long as the following conditions are met:
  13.  
  14.   * Source, executable and documentation must be distributed together.
  15.  
  16.       FileRexx                   10732 ---arwed 16-May-93 23:49:42
  17.       FileRexx1.3.DisplayMe       1793 ----rw-d 22-Jun-93 22:57:10
  18.       FileRexx.doc                9247 ----rwed 22-Jun-93 22:20:21
  19.       FileRexx.doc.info            910 ----rw-d 22-Jun-93 22:42:34
  20.       FileRexx.dok                9622 ----rwed 22-Jun-93 22:05:24
  21.       FileRexx.dok.info            910 ----rw-d 22-Jun-93 22:42:34
  22.       FR-RexxStrings.dfn          2697 ---arwed 25-Apr-93 13:01:10
  23.       FR-RexxStrings.dfn.info      849 ----rw-d 22-Jun-93 22:42:34
  24.       FR-Test.rexx                 193 ---arwed 25-Apr-93 15:58:02
  25.       FR-Test.rexx.info            607 ----rw-d 22-Jun-93 22:42:34
  26.       RequestFile.ttx             3198 ---arwed 25-Apr-93 10:17:44
  27.       RequestFile.ttx.info         607 ----rw-d 22-Jun-93 22:42:34
  28.       TTX_Dragon.dfn             13822 ---arwed 16-May-93 23:20:50
  29.       TTX_Dragon.dfn.info          849 ----rw-d 22-Jun-93 22:42:34
  30.       FileRexx.mod               14582 ---arwed 16-May-93 21:15:08
  31.       FileRexx.mod.info            510 ---arw-d 22-Jun-93 23:20:12
  32.       MoreIntuition.mod           2475 ---arwed 16-May-93 23:26:16
  33.       MoreIntuition.mod.info       509 ---arw-d 22-Jun-93 23:20:12
  34.       SimpleRexx.mod              4432 ---arwed 30-Dec-92 02:55:02
  35.       SimpleRexx.mod.info          509 ---arw-d 22-Jun-93 23:20:12
  36.  
  37.     and these files must be intact and unmodified (you're _not_ allowed
  38.     to make any changes).
  39.  
  40.   * It is not allowed to make any changes to the distribution archive
  41.     (FileRexx-13.run). Nothing may be appended or removed from the archive
  42.     without written permission from the authors.
  43.  
  44.   * FD disk librarians: you must not charge more than the current
  45.     price of a single AmigaLibDisk from Fred Fish (for Germany: not more
  46.     than 8 DM / disk)
  47.  
  48.  
  49. FileRexx requires AmigaOS V37 or later (in other words, 2.04 or later).
  50.  
  51.  
  52. Purpose
  53. =======
  54.  
  55. FileRexx opens an ASL-filerequester on the frontmost PublicScreen, and
  56. prints the selected file/directory to StdOut, into an environment-variable
  57. (if choosen), or into an arexx-variable (if FileRexx has opened a
  58. rexx-host).
  59.  
  60. Quitting the filerequester will also quit the program (if NO rexx-host is
  61. open).  If the rexx-host is open, the program can be terminated in either
  62. of the following ways:
  63.    - sending the Rexx-Command 'Quit' to the rexx-host
  64.    - sending a CTRL-C to the FileRexx-Process
  65.    - starting FileRexx again with the same hostname as argument
  66.  
  67. The size of the filerequester will adjust automatically to the actual
  68. visible screensize if not affected from the given arguments.
  69.  
  70. The program was written because of my need to use the ASL-filerequester
  71. (and especially the MFR) in TurboText.  Therefore I included a TTX-makro
  72. and a TTX-definitionfile.  The TTX-makro may as well be an example for
  73. using FileRexx through ARexx.
  74.  
  75.  
  76. Contents
  77. ========
  78.  
  79. FileRexx           - the executable
  80. FileRexx.doc       - english documentation (this text ¦=)
  81. FileRexx.dok       - german documentation
  82. FR-RexxStrings.ttx - rexx-*strings* for use in TTX-Definitionfiles
  83.                      (faster than Makros, but FileRexx has to be started
  84.                      serpately *before* TTX)
  85. FR-Test.rexx       - a simple Test-Makro
  86. RequestFile.ttx    - the arexx-makro which is used in the
  87.                      TTX-definitionfile "TTX_Dragon.dfn" (this makro will
  88.                      load FileRexx if it is not already in memory)
  89. TTX_Dragon.dfn     - my TTX-definition, without rexx-strings, the
  90.                      makro "RequestFile.ttx" is used instead
  91. FileRexx.mod       - the source of the main-program
  92. MoreIntuition.mod  - a modul which handles the locking of (the frontmost)
  93.                      pubscreen(s)
  94. SimpleRexx.mod     - the main-part of the arexx-interface is defined in
  95.                      this modul
  96.  
  97.  
  98. Usage
  99. =====
  100. (from CLI):
  101.  
  102. FileRexx [FILE name] [PAT | PATTERN string ] [TITLE string] [TOP number]
  103.          [LEFT number] [WIDTH number] [HEIGHT number] [PS | PUBSCREEN
  104.          name] [ENVVAR name] [LOCAL] [SM | SAVEMODE] [DRAWERSONLY] [RX |
  105.          REXXHOST] [PORTNAME name] [HELP]
  106.  
  107. (through ARexx):
  108.  
  109. GETFILE,
  110. GETFILESAVE,
  111. GETDIR   [FILE name] [PAT | PATTERN string ] [TITLE string] [TOP number]
  112.          [LEFT number] [WIDTH number] [HEIGHT number] [PS | PUBSCREEN
  113.          name] [VAR name]
  114.  
  115. FILE name
  116. ---------
  117. "name" is a fully qualified AmigaDOS-name (e.g. "ENV:sys/palette.prefs").
  118. The filerequester displays the directory (if the name consists of any,
  119. else it displays the current dir) and the file is selected (shown in the
  120. stringgadget).
  121.  
  122. PAT | PATTERN string
  123. --------------------
  124. "string" is a normal AmigaDOS-pattern (e.g. "#?.prefs")
  125. The filerequester displays only the files which will fit the pattern. Also
  126. the filerequester will have a pattern-stringgadget, where you can change
  127. the pattern manually.
  128.  
  129. TITLE string
  130. ------------
  131. "string" should be in double-quotes (") if you want to use spaces in the
  132. string. Defines the window-title of the filerequester.
  133.  
  134. TOP number, LEFT number, WIDTH number, HEIGHT number
  135. ----------------------------------------------------
  136. The filerequester calculates the width/height-proportion automatically per
  137. default, depending on the actual "visible" screensize. In order to get
  138. an other size/topedge of the filerequester you can tell FileRexx which
  139. parameters it should use.  Only the given arguments are used, the
  140. remaining will still be calculated from the program.
  141.  
  142. PS | PUBSCREEN name
  143. -------------------
  144. "name" has to be a existing public-screen-name (e.g. TERM)
  145. ATTENTION: The name is case-sensitive.
  146. The filerequester will open on the frontmost public-screen per default,
  147. but it can be opened on any existing pubscreen by supplying a name after
  148. the keyword.
  149.  
  150. ENVVAR name
  151. -----------
  152. If this argument is supplied, FileRexx will store the output (the selected
  153. file with full path) in the given env-var (without the argument "LOCAL"
  154. FileRexx will use global envrionment-variables).
  155.  
  156. LOCAL
  157. -----
  158. If this switch is supplied, FileRexx will use a local env-var instead of
  159. a global.  You also have to supply a name for the environment-variable
  160. with the argument "ENVVAR name".
  161.  
  162. SM | SAVEMODE
  163. -------------
  164. The ASL-filerequester will be opened in the save-mode.  That means the
  165. file/dir-listview is inverted.
  166.  
  167. DRAWERSONLY
  168. -----------
  169. The filerequester will only display directories.
  170.  
  171. RX | REXXHOST
  172. -------------
  173. The program opens an rexx-host and the following arexx-commands can be
  174. sent to the port:
  175.  
  176.   GETFILE - the same as FileRexx has been started from the CLI
  177.  
  178.   GETFILESAVE - dito, but with the SAVEMODE option
  179.  
  180.   GETDIR - dito, but with the DRAWERSONLY option
  181.  
  182.   QUIT - removes the program (and the rexx-host) from memory
  183.  
  184. The first three commands could be supplied with the arguments listed
  185. above. The parameters are the same as for the CLI-arguments.
  186.  
  187. Please remember, that FileRexx has to be started with the "run" command,
  188. because it doesn't detaches itself.  It can be quited with CTRL-C if it is
  189. not run.
  190.  
  191. PORTNAME name
  192. -------------
  193. "name" has to be a *unique* portname.
  194. The default portname for the rexx-host is "FILEREXX".  If there is a need
  195. for an other portname (if you need to FileRexx with rexx-host's in
  196. memory), FileRexx will use the name supplied after the keyword.
  197.  
  198. HELP
  199. ----
  200. Sbows a short help-text, mainly with the rexx-commands.
  201.  
  202.  
  203. Example
  204. =======
  205.  
  206.  FileRexx ENV:sys/palette.prefs PAT=#?.prefs
  207.  
  208. This will open a filerequester which shows the contents of the directory
  209. "ENV:sys", but only files with the suffix ".prefs".  In the
  210. file-stringgadget the file "palette.prefs" is shown.
  211.  
  212. History
  213. =======
  214.  
  215. v1.3    First public Release
  216. v1.2    internal Release (BETA)
  217. v1.1    rexx-host included
  218. v1.0    First useable version :-) (BETA)
  219. v0.x    some attempts...
  220.  
  221.  
  222. Possible future enhancements
  223. ============================
  224.  
  225. - Should be callable from Workbench (in order to place FileRexx in WBStartup)
  226.  
  227.  
  228. Known Problems/Bugs
  229. ======================
  230. None so far...
  231.  
  232.  
  233. Author
  234. ======
  235.  
  236. You can contact me via usenet eMail at the following address:
  237.  
  238.    mickh@spice.franken.de
  239.  
  240. or via snail mail:
  241.  
  242.    Michael-W. Hohmann
  243.    Carl-Schilling-Str. 10
  244.    D-8701 Kirchheim
  245.    Germany
  246.  
  247. Have Fun !
  248.  
  249.  
  250. Acknowledgements
  251. ================
  252.  
  253. The rexx-host wouldn't have been possible so soon (maybe never ¦=)
  254. without the immense help from hartmut Goebel.  Also hartmut helped me
  255. a lot with debugging and programming.
  256.  
  257. The following people also have helped me a lot with enhancements and
  258. bug-reports:
  259.  
  260.     Kai Bolay
  261.     Bernhard Möllemann
  262.     Franz-Josef Reichert
  263.     Steffen Reith
  264.     Uwe Röhm
  265.     Fridtjof Siebert
  266.     Jürgen Weinelt
  267.  
  268. Special Thanks to
  269.  
  270.     Oliver Knorr for the delicious peanuts ...                 ¦=)
  271. and Holger Lubitz for correcting this documentation.
  272.  
  273. Many thanx to all of you.
  274.