home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 7 / FreshFishVol7.bin / new / disk / moni / filex / docs / english / filexarexx.doc < prev    next >
Text File  |  1994-06-12  |  37KB  |  1,924 lines
  1.                                    
  2.               $VER: FileXARexxDocumentation 2.0 (29.5.94)
  3.  
  4.                                    
  5.                         FileX - A binary editor
  6.  
  7.                 © Copyright 1993-1994 by Klaas Hermanns
  8.  
  9.                     Shareware, all rights reserved.
  10.  
  11. Introduction
  12. ************
  13.  
  14.    FileX has an arexx port which is based on the Commodore Amiga User
  15. Interface Style Guide.
  16.  
  17.    If there is nothing different specified for the PORTNAME at the
  18. beginning, the port will be named `FILEX'. In case that this port name
  19. does already exist, a number is being added to the name and increased
  20. until a not already used name is found. (`NAME'->`NAME.1'->`NAME.2')
  21.  
  22.    The arguments will be evaluated in the way AmigaDOS does. If the
  23. different argument types are unknown, the following list can be used as
  24. a reference.
  25.  
  26. <arg>
  27.      A simple string. It's not necessary to specify the argument's name.
  28.  
  29. <arg>/S
  30.      Switch. Will be set through declaring an argument.
  31.  
  32. <arg>/K
  33.      Key word.  This argument must be given with an argument's name.
  34.      (`<arg> = value' oder `<arg> value'.
  35.  
  36. <arg>/N
  37.      Number.  This argument must be a decimal number.
  38.  
  39. <arg>/T
  40.      Changing switch.  Through specification of this argument a value
  41.      will change its condition.
  42.  
  43. <arg>/A
  44.      This argument must be given.
  45.  
  46. <arg>/F
  47.      The rest of the line will be understood as an argument, although if
  48.      there are some more keywords
  49.  
  50. <arg>/M
  51.      Serveral values are possible.
  52.  
  53.    For all commands that return something it's possible to set a
  54. variable to the return value by specifing the name of it with the
  55. argument VAR.  The same applies to the argument STEM and its
  56. stemvariables.
  57.  
  58.    All commands with an ID argument return rc = 5, if the ID is
  59. invalid. If there is no ID given the current file/view/window is used
  60. for the command.
  61.  
  62. Command overview
  63. ****************
  64.  
  65.      Name:             Arguments => Return codes:
  66.      --------------------------------------------
  67.      ACTIVATE
  68.      ACTIVATEVIEW     VIEWID=VID/K/N
  69.      ACTIVATEWINDOW   WINDOWID=WID/K/N
  70.      ADJUSTWINDOWSIZE WINDOWID=WID/K/N
  71.      APPEND           VIEWID=VID/K/N
  72.      ASSIGNCOMMAND    NUMBER/K/N,NAME/K
  73.      CHANGEWINDOW     LEFTEDGE/K/N,TOPEDGE/K/N,HEIGHT/K/N,WIDTH/K/N,WINDOWID=WID/K/N
  74.      CLEAR            FORCE/S,VIEWID=VID/K/N
  75.      CLOSE            VIEW/S,WINDOW/S,FORCE/S,VIEWID=VID=WINDOWID=WID/K/N
  76.      COLUMN           DELTA/N/A,VIEWID=VID/K/N
  77.      CURSOR           UP/S,DOWN/S,LEFT/S,RIGHT/S,VIEWID=VID/K/N
  78.      CUT              VIEWID=VID/K/N
  79.      DEACTIVATE
  80.      EXECUTECOMMAND   NUMBER/K/N,NAME/K
  81.      EXPANDVIEW       VIEWID=VID/K/N
  82.      FAULT            VAR/K,STEM/K,NUMBER/N/A => DESCRIPTION
  83.      FILL             VIEWID=VID/K/N
  84.      FIND             PROMPT/S,HEX/S,BACKWARDS/S,QUIET/S,TEXT/F,VIEWID=VID/K/N
  85.      FINDCHANGE       PROMPT/S,HEX/S,ALL/S,BACKWARDS/S,QUIET/S,FIND,CHANGE,VIEWID=VID/K/N
  86.      FINDNEXT         BACKWARDS/S,QUIET/S,VIEWID=VID/K/N
  87.      FONT             NAME/A,SIZE/N/A,WINDOWID=WID/K/N
  88.      GETATTR          OBJECT/A,FIELD,ID/K/N,STEM/K,VAR/K
  89.      GETBLOCK         VAR/K,STEM/K => BLOCK
  90.      GETBYTES         VAR/K,STEM/K,POS/N/A,NUMBER/N/A,FILEID=FID/K/N => HEXSTRING
  91.      GOTOBOOKMARK     NUMBER/N,VIEWID=VID/K/N
  92.      GOTOBYTE         POS/N/A,VIEWID=VID/K/N
  93.      GOTOCOLUMN       COLUMN/N/A,VIEWID=VID/K/N
  94.      GOTOLINE         LINE/N/A,VIEWID=VID/K/N
  95.      GRABMEMORY       START/N/A,END/N/A,FORCE/S,VIEWID=VID/K/N
  96.      GROWVIEW         VIEWID=VID/K/N
  97.      HELP             VAR/K,STEM/K,COMMAND => COMMANDDESC,COMMANDLIST/M
  98.      INSERT           VIEWID=VID/K/N
  99.      LINE             DELTA/N/A,VIEWID=VID/K/N
  100.      LOADBLOCK        NAME
  101.      LOADCOMMANDS     NAME
  102.      LOADDISPLAYTYP   NAME
  103.      LOADSETTINGS     NAME
  104.      LOCKGUI
  105.      MOVEWINDOW       LEFTEDGE/N,TOPEDGE/N,WINDOWID=WID/K/N
  106.      NEW              VIEW/S,WINDOW/S
  107.      NEXT             VIEW/S,WINDOW/S
  108.      NOP
  109.      OPEN             FILENAME,FORCE/S,VIEWID=VID/K/N
  110.      PASTE            VIEWID=VID/K/N
  111.      POSITION         SOF/S,EOF/S,SOL/S,EOL/S,VIEWID=VID/K/N
  112.      PREVIOUS         VIEW/S,WINDOW/S
  113.      PRINT            FILEID=FID/K/N
  114.      PRINTBLOCK
  115.      QUIT             FORCE/S
  116.      REDO             NUMBER/N,FILEID=FID/K/N
  117.      REQUESTFILE      VAR/K,STEM/K,TITLE/K,PATH/K,FILE/K,PATTERN/K => FILENAME
  118.      REQUESTNOTIFY    PROMPT
  119.      REQUESTRESPONSE  BUTTONS/K,PROMPT/K
  120.      REQUESTSTRING    VAR/K,STEM/K,PROMPT/K,DEFAULT/K => STRING
  121.      RX               VAR/K,STEM/K,CONSOLE/S,ASYNC/S,COMMAND/F => RC/N,RESULT
  122.      SAVE             FILEID=FID/K/N
  123.      SAVEAS           NAME,FILEID=FID/K/N
  124.      SAVEBLOCK        NAME
  125.      SAVECOMMANDS
  126.      SAVECOMMANDSAS   NAME
  127.      SAVESETTINGS
  128.      SAVESETTINGSAS   NAME
  129.      SETATTR          OBJECT/A,FIELD,ID/K/N,FROMSTEM/K,FROMVAR/K
  130.      SETBLOCK         BLOCK/A
  131.      SETBLOCKMARK     VIEWID=VID/K/N
  132.      SETBOOKMARK      NUMBER/N,VIEWID=VID/K/N
  133.      SETBYTES         POS/N/A,HEXSTRING/A,FILEID=FID/K/N
  134.      SETSCREEN        NAME/K,OWN/S
  135.      SHRINKVIEW       VIEWID=VID/K/N
  136.      SIZEWINDOW       HEIGHT/N,WIDTH/N,WINDOWID=WID/K/N
  137.      SPLIT            VIEW/S,WINDOW/S
  138.      UNDO             NUMBER/N,FILEID=FID/K/N
  139.      UNLOCKGUI
  140.      WINDOWTOBACK     WINDOWID=WID/K/N
  141.      WINDOWTOFRONT    WINDOWID=WID/K/N
  142.      ZIPWINDOW        WINDOWID=WID/K/N
  143.  
  144. Befehlsbeschreibungen
  145. *********************
  146.  
  147. ACTIVATE
  148. ========
  149.  
  150. Synopsis:
  151.      ACTIVATE
  152.  
  153. Function:
  154.      Reactivates FileX from iconify.
  155.  
  156. Example:
  157.           DEACTIVATE      /* Equivalent to menu: `Project/Iconify' */
  158.           
  159.           /* Now an icon will appear on the workbench. FileX `sleeps'. */
  160.           
  161.           ACTIVATE        /* Open FileX with all windows again */
  162.  
  163. See also:
  164.      DEACTIVATE
  165.  
  166. ACTIVATEVIEW
  167. ============
  168.  
  169. Synopsis:
  170.      ACTIVATEVIEW VIEWID=VID/K/N
  171.  
  172. Function:
  173.      Activates an view.
  174.  
  175. Arguments:
  176.     VIEWID=VID/K/N:
  177.           ID of a view that should be activated.
  178.  
  179. ACTIVATEWINDOW
  180. ==============
  181.  
  182. Synopsis:
  183.      ACTIVATEWINDOW WINDOWID=WID/K/N
  184.  
  185. Function:
  186.      Activates an edit window.
  187.  
  188. Arguments:
  189.     WINDOWID=WID/K/N:
  190.           ID of a edit window that should be activated.
  191.  
  192. ADJUSTWINDOWSIZE
  193. ================
  194.  
  195. Synopsis:
  196.      ADJUSTWINDOWSIZE WINDOWID=WID/K/N
  197.  
  198. Function:
  199.      Adjusts the window to the size of edit views.
  200.  
  201. Arguments:
  202.     WINDOWID=WID/K/N:
  203.           ID of a window.
  204.  
  205. See also:
  206.      Menu: `Settings/Adjust window size'
  207.  
  208. APPEND
  209. ======
  210.  
  211. Synopsis:
  212.      APPEND VIEWID=VID/K/N
  213.  
  214. Function:
  215.      Appends the current block to the end of a file.
  216.  
  217. Arguments:
  218.     VIEWID=VID/K/N:
  219.           ID of a view that belongs to the file.
  220.  
  221. See also:
  222.      Menu: `Edit/Append'
  223.  
  224. ASSIGNCOMMAND
  225. =============
  226.  
  227. Synopsis:
  228.      ASSIGNCOMMAND NUMBER/K/N,NAME/K
  229.  
  230. Function:
  231.      Set one of the commands in the arexx menu.
  232.  
  233. Arguments:
  234.     NUMBER/K/N:
  235.           Number between 0 and 10 which defines the command's position.
  236.           A requester will appear if no number has been specified.
  237.  
  238.     NAME/K:
  239.           Command's file name. If no name is given a file requester
  240.           will appear.
  241.  
  242. Example:
  243.      ASSIGNCOMMAND 0 'dh5:myarexxcommands/filexcommand'
  244.  
  245. See also:
  246.      Menu: `ARexx/Assign command', LOADCOMMANDS, SAVECOMMANDS,
  247.      SAVECOMMANDSAS
  248.  
  249. CHANGEWINDOW
  250. ============
  251.  
  252. Synopsis:
  253.      CHANGEWINDOW
  254.      LEFTEDGE/K/N,TOPEDGE/K/N,HEIGHT/K/N,WIDTH/K/N,WINDOWID=WID/K/N
  255.  
  256. Function:
  257.      Changes the position and/or size of a edit window.
  258.  
  259. Arguments:
  260.     LEFTEDGE/K/N:
  261.           New left offset.
  262.  
  263.     TOPEDGE/K/N:
  264.           New top offset.
  265.  
  266.     HEIGHT/K/N:
  267.           New height.
  268.  
  269.     WIDTH/K/N:
  270.           Neq width.
  271.  
  272.     WINDOWID=WID/K/N
  273.           ID of a edit window that should be changed.
  274.  
  275.      If one of these arguments is not given, it is not changed.
  276.  
  277. Example:
  278.              /* Window to maximum size */
  279.           CHANGEWINDOW LEFTEDGE 0 TOPEDGE 0 HEIGHT 4000 WIDTH 4000
  280.  
  281. See also:
  282.      ZIPWINDOW, MOVEWINDOW, SIZEWINDOW, Attributes: `WINDOW/#?'
  283.  
  284. CLEAR
  285. =====
  286.  
  287. Synopsis:
  288.      CLEAR FORCE/S,VIEWID=VID/K/N
  289.  
  290. Function:
  291.      Clears a view.
  292.  
  293. Arguments:
  294.     FORCE/S:
  295.           The changes requester will be suppressed.
  296.  
  297.     VIEWID=VID/K/N
  298.           ID of a view that sould be cleared.
  299.  
  300. Return codes:
  301.      rc = 5, if the requester is cancelled.
  302.  
  303. See also:
  304.      Menu: `Project/New'
  305.  
  306. CLOSE
  307. =====
  308.