home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / Editor / FILEX20.LHA / FileX / Docs / English / FileXARexx.doc < prev    next >
Encoding:
Text File  |  1994-06-12  |  35.8 KB  |  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.  
  309. Synopsis:
  310.      VIEW/S,WINDOW/S,FORCE/S,VIEWID=VID=WINDOWID=WID/K/N
  311.  
  312. Function:
  313.      Closes a view or a window.
  314.  
  315. Arguments:
  316.     VIEW/S:
  317.           The ID is an view ID.
  318.  
  319.     WINDOW/S:
  320.           The ID is an window ID.
  321.  
  322.     FORCE/S:
  323.           The changes requester will be suppressed.
  324.  
  325.     VIEWID=VID=WINDOWID=WID/K/N:
  326.           ID of a view resp. window that should be closed.
  327.  
  328. See also:
  329.      QUIT
  330.  
  331. COLUMN
  332. ======
  333.  
  334. Synopsis:
  335.      COLUMN DELTA/N/A,VIEWID=VID/K/N
  336.  
  337. Function:
  338.      Moves the cursor to the left or to the right.
  339.  
  340. Arguments:
  341.     DELTA/N/A:
  342.           Number of steps. Positive numbers move the cursor to the
  343.           right.
  344.  
  345.     VIEWID=VID/K/N
  346.           ID of a view.
  347.  
  348. See also:
  349.      GOTOBYTE, GOTOCOLUMN, GOTOLINE, LINE
  350.  
  351. COPY
  352. ====
  353.  
  354. Synopsis:
  355.      COPY VIEWID=VID/K/N
  356.  
  357. Function:
  358.      Copies the current marked block to the block buffer.
  359.  
  360. Arguments:
  361.     VIEWID=VID/K/N
  362.           ID of a view.
  363.  
  364. See also:
  365.      Menu: `Edit/Copy', SETBLOCKMARK
  366.  
  367. CURSOR
  368. ======
  369.  
  370. Synopsis:
  371.      CURSOR UP/S,DOWN/S,LEFT/S,RIGHT/S,VIEWID=VID/K/N
  372.  
  373. Function:
  374.      Move the cursor.
  375.  
  376. Arguments:
  377.     UP/S:
  378.           Moves the cursor one step up.
  379.  
  380.     DOWN/S:
  381.           Moves the cursor one step down.
  382.  
  383.     LEFT/S:
  384.           Moves the cursor one step to the left.
  385.  
  386.     RIGHT/S:
  387.           Moves the cursor one step to the right.
  388.  
  389.     VIEWID=VID/K/N:
  390.           ID of a view.
  391.  
  392.      UP and DOWN as well as LEFT and RIGHT exclude each other.
  393.  
  394. See also:
  395.      GOTOBYTE, LINE, COLUMN
  396.  
  397. CUT
  398. ===
  399.  
  400. Synopsis:
  401.      CUT VIEWID=VID/K/N
  402.  
  403. Function:
  404.      Cuts the current marked block out.
  405.  
  406. Arguments:
  407.     VIEWID=VID/K/N:
  408.           ID of a view.
  409.  
  410. See also:
  411.      Menu: `Edit/Cut', SETBLOCKMARK
  412.  
  413. DEACTIVATE
  414. ==========
  415.  
  416. Synopsis:
  417.      DEACTIVATE
  418.  
  419. Function:
  420.      Iconifies FileX. The window will be closed and an icon will appear
  421.      on the workbench.
  422.  
  423.      ATTENTION!: All arexx comannds which output something in an edit
  424.      window or change an edit window in any way, can lead to a crash
  425.      during the iconify.
  426.  
  427. See also:
  428.      ACTIVATE
  429.  
  430. EXECUTECOMMAND
  431. ==============
  432.  
  433. Synopsis:
  434.      EXECUTECOMMAND NUMBER/K/N,NAME/K
  435.  
  436. Function:
  437.      Executes an arexx command.
  438.  
  439. Arguments:
  440.     NUMBER/K/N:
  441.           Number between 0 and 9 of an with ASSIGNCOMMAND installed
  442.           command.
  443.  
  444.     NAME/K:
  445.           Name of an arexx script.  Both arguments exclude each other.
  446.  
  447. See also:
  448.      ASSIGNCOMMAND
  449.  
  450. EXPANDVIEW
  451. ==========
  452.  
  453. Synopsis:
  454.      EXPANDVIEW VIEWID=VID/K/N
  455.  
  456. Function:
  457.      Expands the current view to its maximum size. All other views in
  458.      the window will become one line height.
  459.  
  460. Arguments:
  461.     VIEWID=VID/K/N:
  462.           ID of a view.
  463.  
  464. See also:
  465.      SHRINKVIEW, GROWVIEW
  466.  
  467. FAULT
  468. =====
  469.  
  470. Synopsis:
  471.      FAULT VAR/K,STEM/K,NUMBER/N/A => DESCRIPTION
  472.  
  473. Function:
  474.      Determines the text belonging to an dos error code.
  475.  
  476. Arguments:
  477.     NUMBER/N/A:
  478.           Dos error code.
  479.  
  480. Return codes:
  481.     DESCRIPTION:
  482.           The error text.
  483.  
  484. Example:
  485.           FAULT 114
  486.           
  487.           /* Result value using localized workbench: */
  488.           /* `: Falsches Namensmuster' */
  489.  
  490. FILL
  491. ====
  492.  
  493. Synopsis:
  494.      FILL VIEWID=VID/K/N
  495.  
  496. Function:
  497.      Fills the current marked block with the curent fill string.
  498.  
  499. Arguments:
  500.     VIEWID=VID/K/N:
  501.           ID of a view.
  502.  
  503. Example:
  504.              /* If there is a block already marked, */
  505.              /* then neutralize it. */
  506.           
  507.           GETATTR VIEW MARK
  508.           if result=TRUE then SETBLOCKMARK
  509.           
  510.              /* Set fillstring to `Fill fillaround!' */
  511.           
  512.           SETATTR APPLICATION FILLSTRING FROMVAR '"Fill fillaround!"'
  513.           
  514.              /* Set cursor to the fill-area's beginning */
  515.           GOTOBYTE 10
  516.           
  517.              /* Set block mark */
  518.           SETBLOCKMARK
  519.           
  520.              /* Move cursor */
  521.           GOTOBYTE 100
  522.           
  523.              /* Fill the area */
  524.           FILL
  525.           
  526.              /* Remove block marking */
  527.           SETBLOCKMARK
  528.  
  529. See also:
  530.      Menu: `Edit/Fill', SETBLOCKMARK, SETATTR
  531.  
  532. FIND
  533. ====
  534.  
  535. Synopsis:
  536.      FIND PROMPT/S,HEX/S,BACKWARDS/S,QUIET/S,TEXT/F,VIEWID=VID/K/N
  537.  
  538. Function:
  539.      Searches a string or a hex string within the current file. By
  540.      success, the cursor is being positioned at the string's beginning.
  541.      The search begins at the current cursor position.
  542.  
  543. Arguments:
  544.     PROMPT/S:
  545.           Opens the searchrequester. BACKWARDS and QUIET will be
  546.           ignored.
  547.  
  548.     HEX/S:
  549.           Hex search.
  550.  
  551.     BACKWARDS/S:
  552.           Search backwards.
  553.  
  554.     QUIET/S:
  555.           No requester if the search fails.
  556.  
  557.     TEXT/F:
  558.           The search string or the hex search string.
  559.  
  560.     VIEWID=VID/K/N:
  561.           ID of a view.
  562.  
  563. Return codes:
  564.      rc = 5, if the search fails.
  565.  
  566. Example:
  567.              /* Search the string `$VER:' without opening */
  568.              /* a requester by failure */
  569.           FIND QUIET TEXT '$VER:'
  570.  
  571. See also:
  572.      Attributes: `APPLICATION/#?SEARCH', FINDNEXT, FINDCHANGE, Menu:
  573.      `Search&Replace/#?'
  574.  
  575. FINDCHANGE
  576. ==========
  577.  
  578. Synopsis:
  579.      FINDCHANGE
  580.      PROMPT/S,HEX/S,ALL/S,BACKWARDS/S,QUIET/S,FIND,CHANGE,VIEWID=VID/K/N
  581.  
  582. Function:
  583.      Searches a string or a hexstring within a file and replaces it
  584.      throgh a new one. Maybe a requester appears to verify the
  585.      replacement.  The search will start from the current
  586.      cursorposition.
  587.  
  588. Arguments:
  589.     PROMPT/S:
  590.           Opens the search requester.  ALL, BACKWARDS and QUIET will be
  591.           ignored.  ignoriert.
  592.  
  593.     HEX/S:
  594.           Hex search.
  595.  
  596.     ALL/S:
  597.           All found positions will be replaced without requester each
  598.           time.
  599.  
  600.     BACKWARDS/S:
  601.           Search backwards.
  602.  
  603.     QUIET/S:
  604.           No reqeuster if the search fails.
  605.  
  606.     FIND:
  607.           Search text or hex string.
  608.  
  609.     CHANGE:
  610.           Replace text or hex string.
  611.  
  612.     VIEWID=VID/K/N:
  613.           ID of a view.
  614.  
  615. Return codes:
  616.      rc = 5, if the search fails.
  617.  
  618. Example:
  619.              /* Replaces `Claas' by `Klaas' */
  620.           FINDCHANGE QUIET ALL 'Claas' 'Klaas'
  621.           FINDCHANGE BACKWARDS QUIET ALL 'Claas' 'Klaas'
  622.  
  623. See also:
  624.      FINDNEXT, FIND, Menu: `Search&Replace/#?'
  625.  
  626. FINDNEXT
  627. ========
  628.  
  629. Synopsis:
  630.      FINDNEXT BACKWARDS/S,QUIET/S,VIEWID=VID/K/N
  631.  
  632. Function:
  633.      Continues the last search operation, i.e. either search or
  634.      search&replace.
  635.  
  636. Arguments:
  637.     BACKWARDS/S:
  638.           Coninue search backwards.
  639.  
  640.     QUIET/S:
  641.           No requester if the search fails.
  642.  
  643.     VIEWID=VID/K/N:
  644.           ID of a view.
  645.  
  646. Return codes:
  647.      rc = 5, if search fails.
  648.  
  649. See also:
  650.      FIND, FINDCHANGE
  651.  
  652. FONT
  653. ====
  654.  
  655. Synopsis:
  656.      FONT NAME/A,SIZE/N/A,WINDOWID=WID/K/N
  657.  
  658. Function:
  659.      Sets the font of an edit window.
  660.  
  661. Arguments:
  662.     NAME/A:
  663.           Font name.
  664.  
  665.     SIZE/N/A:
  666.           Font size.
  667.  
  668.     WINDOWID=WID/K/N:
  669.           ID of a window.
  670.  
  671. Example:
  672.      FONT 'horror.font' 8
  673.  
  674. GETATTR
  675. =======
  676.  
  677. Synopsis:
  678.      GETATTR OBJECT/A,FIELD,ID/K/N,STEM/K,VAR/K
  679.  
  680. Function:
  681.      Gets the value of one or more variables used in the program.
  682.  
  683. Arguments:
  684.     OBJECT/A:
  685.           Name of the object.
  686.  
  687.     FIELD:
  688.           Name of the field.
  689.  
  690.     ID/K/N:
  691.           Possible with the objects WINDOW, VIEW and FILE. If not given,
  692.           the current view/window/file is used to determine the value.
  693.  
  694.      If FIELD is not given, a STEM variable must be specified which
  695.      will be filled with all values of the object.
  696.  
  697. Example:
  698.           GETATTR WINDOW TITLE
  699.           
  700.              /* Result contains now the titel of the window */
  701.              /* Not very interesting, but who cares :-) */
  702.  
  703. See also:
  704.      Attributes, SETATTR
  705.  
  706. GETBLOCK
  707. ========
  708.  
  709. Synopsis:
  710.      GETBLOCK VAR/K,STEM/K => BLOCK
  711.  
  712. Function:
  713.      Determines the contents of the block buffer, i.e. the contents
  714.      clipboard.
  715.  
  716. Return codes:
  717.     BLOCK:
  718.           The block buffer as a hex string.
  719.  
  720. See also:
  721.      SETBLOCK
  722.  
  723. GETBYTES
  724. ========
  725.  
  726. Synopsis:
  727.      GETBYTES VAR/K,STEM/K,POS/N/A,NUMBER/N/A,FILEID=FID/K/N =>
  728.      HEXSTRING
  729.  
  730. Function:
  731.      Determines the value of a number of bytes at a position in the
  732.      file.
  733.  
  734. Arguments:
  735.     POS/N/A:
  736.           Start of the block.
  737.  
  738.     NUMBER/N/A:
  739.           Number of bytes to get.
  740.  
  741. Return codes:
  742.     HEXSTRING:
  743.           Block as a hex string.
  744.  
  745.     FILEID=FID/K/N:
  746.           ID of a file.
  747.  
  748. See also:
  749.      SETBYTES
  750.  
  751. GOTOBOOKMARK
  752. ============
  753.  
  754. Synopsis:
  755.      GOTOBOOKMARK NUMBER/N,VIEWID=VID/K/N
  756.  
  757. Function:
  758.      Sets the cursor to a position previously marked with SETBOOKMARK.
  759.  
  760. Arguments:
  761.     NUMBER/N/A:
  762.           Number between 1 and 10.
  763.  
  764.     VIEWID=VID/K/N:
  765.           ID of a view.
  766.  
  767. See also:
  768.      SETBOOKMARK
  769.  
  770. GOTOBYTE
  771. ========
  772.  
  773. Synopsis:
  774.      GOTOBYTE POS/N/A,VIEWID=VID/K/N
  775.  
  776. Function:
  777.      Set the cursor to a specified position.
  778.  
  779. Arguments:
  780.     POS/N/A:
  781.           Offset to the start of the file.
  782.  
  783.     VIEWID=VID/K/N:
  784.           ID of a view.
  785.  
  786. See also:
  787.      COLUMN, GOTOCOLUMN, GOTOLINE, LINE
  788.  
  789. GOTOCOLUMN
  790. ==========
  791.  
  792. Synopsis:
  793.      GOTOCOLUMN COLUMN/N/A,VIEWID=VID/K/N
  794.  
  795. Function:
  796.      Sets the cursor to a specified column.
  797.  
  798. Arguments:
  799.     COLUMN/N/A:
  800.           Column number.
  801.  
  802.     VIEWID=VID/K/N:
  803.           ID of a view.
  804.  
  805. See also:
  806.      COLUMN, GOTOBYTE, GOTOLINE, LINE
  807.  
  808. GOTOLINE
  809. ========
  810.  
  811. Synopsis:
  812.      GOTOLINE LINE/N/A,VIEWID=VID/K/N
  813.  
  814. Function:
  815.      Sets the cursor to a specified line.
  816.  
  817. Arguments:
  818.     LINE/N/A:
  819.           Line number.
  820.  
  821.     VIEWID=VID/K/N:
  822.           ID of a view.
  823.  
  824. See also:
  825.      COLUMN, GOTOBYTE, GOTOCOLUMN, LINE
  826.  
  827. GRABMEMORY
  828. ==========
  829.  
  830. Synopsis:
  831.      GRABMEMORY START/N/A,END/N/A,FORCE/S,VIEWID=VID/K/N
  832.  
  833. Function:
  834.      Displays a memory area instead of a file.
  835.  
  836. Arguments:
  837.     START/N/A:
  838.           Start of the memory area.
  839.  
  840.     END/N/A:
  841.           End of the memory area.
  842.  
  843.     FORCE/S:
  844.           If the current file is changed, the requester will be
  845.           suppressed.
  846.  
  847. Return codes:
  848.      rc = 5, if the requester is cancelled.
  849.  
  850. Example:
  851.      GRABMEMORY 200000 280000 FORCE
  852.  
  853. See also:
  854.      Menu: `Project/Grab memory'
  855.  
  856. GROWVIEW
  857. ========
  858.  
  859. Synopsis:
  860.      GROWVIEW VIEWID=VID/K/N
  861.  
  862. Function:
  863.      If possible the the view grows one line.
  864.  
  865. Arguments:
  866.     VIEWID=VID/K/N:
  867.           ID of a view.
  868.  
  869. See also:
  870.      SHRINKVIEW, EXPANDVIEW
  871.  
  872. HELP
  873. ====
  874.  
  875. Synopsis:
  876.      HELP VAR/K,STEM/K,COMMAND => COMMANDDESC,COMMANDLIST/M
  877.  
  878. Function:
  879.      Finds out either an overview of all specified arexx commands or the
  880.      synopsis of a command.
  881.  
  882. Arguments:
  883.     COMMAND:
  884.           Commands name, whose synopsis shall be determined.
  885.  
  886.      If COMMAND is not specified, a command overview will be returned.
  887.  
  888. Return codes:
  889.      If COMMAND is given:
  890.     COMMANDDESC:
  891.           Synopsis of the command.  Else:
  892.     COMMANDLIST/M:
  893.           Number of commands and overview of all commands.
  894.  
  895. INSERT
  896. ======
  897.  
  898. Synopsis:
  899.      INSERT VIEWID=VID/K/N
  900.  
  901. Function:
  902.      Insert the current block of the block buffer at the current cursor
  903.      position.
  904.  
  905. Arguments:
  906.     VIEWID=VID/K/N:
  907.           ID of a view.
  908.  
  909. See also:
  910.      Menu: `Edit/Insert', SETBLOCKMARK
  911.  
  912. LINE
  913. ====
  914.  
  915. Synopsis:
  916.      LINE DELTA/N/A,VIEWID=VID/K/N
  917.  
  918. Function:
  919.      Moves the cursor a specified number of lines up or down.
  920.  
  921. Arguments:
  922.     LINE/N/A:
  923.           Number of lines. Positive numbers move the cursor down.
  924.  
  925.     VIEWID=VID/K/N:
  926.           ID of a view.
  927.  
  928. See also:
  929.      COLUMN, GOTOBYTE, GOTOCOLUMN, GOTOLINE
  930.  
  931. LOADBLOCK
  932. =========
  933.  
  934. Synopsis:
  935.      LOADBLOCK NAME
  936.  
  937. Function:
  938.      Loads a block into the block buffer(clipboard).
  939.  
  940. Arguments:
  941.     NAME:
  942.           Block name. If not given, a file requester will pop up.
  943.  
  944. Return codes:
  945.      rc = 5, if the block couldn't be loaded.
  946.  
  947. See also:
  948.      SAVEBLOCK
  949.  
  950. LOADCOMMANDS
  951. ============
  952.  
  953. Synopsis:
  954.      LOADCOMMANDS NAME
  955.  
  956. Function:
  957.      Loads a set of arexx comannds.
  958.  
  959. Arguments:
  960.     NAME:
  961.           If not given, a file requester pops up.
  962.  
  963. Return codes:
  964.      rc = 5, if the file couldn't be loaded.
  965.  
  966. See also:
  967.      Menu: `ARexx/Load commands', SAVECOMMANDS, SAVECOMMANDSAS
  968.  
  969. LOADDISPLAYTYP
  970. ==============
  971.  
  972. Synopsis:
  973.      LOADDISPLAYTYP NAME
  974.  
  975. Function:
  976.      Loads the user display typ.
  977.  
  978. Arguments:
  979.     NAME:
  980.           If not given, a file requester will pop up.
  981.  
  982. Return codes:
  983.      rc = 5, if the file couldn't be loaded.
  984.  
  985. See also:
  986.      Menu: `Settings/Display/#?'
  987.  
  988. LOADSETTINGS
  989. ============
  990.  
  991. Synopsis:
  992.      LOADSETTINGS NAME
  993.  
  994. Function:
  995.      Loads a settings file.
  996.  
  997. Arguments:
  998.     NAME:
  999.           If not given, a file requester will pop up.
  1000.  
  1001. Return codes:
  1002.      rc = 5, if the file couldn't be loaded.
  1003.  
  1004. See also:
  1005.      Menu: `Settings/Load Settings...'
  1006.  
  1007. LOCKGUI
  1008. =======
  1009.  
  1010. Synopsis:
  1011.      LOCKGUI
  1012.  
  1013. Function:
  1014.      Locks all edit windows. The user can't make any input. Just size
  1015.      and position of the windows can be modified.
  1016.  
  1017. Return codes:
  1018.      rc = 5, if the windows cannot be locked. This is possible when
  1019.      there's still a requester open.
  1020.  
  1021. See also:
  1022.      LOCKGUI
  1023.  
  1024. MOVEWINDOW
  1025. ==========
  1026.  
  1027. Synopsis:
  1028.      MOVEWINDOW LEFTEDGE/N,TOPEDGE/N,WINDOWID=WID/K/N
  1029.  
  1030. Function:
  1031.      Moves the edit window.
  1032.  
  1033. Arguments:
  1034.     LEFTEDGE/N:
  1035.           New left offset.
  1036.  
  1037.     TOPEDGE/N:
  1038.           New top offset.
  1039.  
  1040.     WINDOWID=WID/K/N:
  1041.           ID of a window.
  1042.  
  1043. NEW
  1044. ===
  1045.  
  1046. Synopsis:
  1047.      NEW VIEW/S,WINDOW/S
  1048.  
  1049. Function:
  1050.      Opens a new view(and window).
  1051.  
  1052. Arguments:
  1053.     VIEW/S:
  1054.           The current view is divided into two new views.
  1055.  
  1056.     WINDOW/S:
  1057.           Opens a new edit window.
  1058.  
  1059. See also:
  1060.      Menu: `Project/(View|Window)/New', SPLIT
  1061.  
  1062. NEXT
  1063. ====
  1064.  
  1065. Synopsis:
  1066.      NEXT VIEW/S,WINDOW/S
  1067.  
  1068. Function:
  1069.      Activates the next view/window.
  1070.  
  1071. Arguments:
  1072.     VIEW/S:
  1073.           The next view in the current window is activated.
  1074.  
  1075.     WINDOW/S:
  1076.           The next window is activated.
  1077.  
  1078. See also:
  1079.      PREVIOUS
  1080.  
  1081. NOP
  1082. ===
  1083.  
  1084. Synopsis:
  1085.      NOP
  1086.  
  1087. Function:
  1088.      This command does nothing.
  1089.  
  1090. OPEN
  1091. ====
  1092.  
  1093. Synopsis:
  1094.      OPEN FILENAME,FORCE/S,VIEWID=VID/K/N
  1095.  
  1096. Function:
  1097.      Opens a file.
  1098.  
  1099. Arguments:
  1100.     FILENAME:
  1101.           If not given, a file requester will pop up.  Auswahl.
  1102.  
  1103.     FORCE/S:
  1104.           The changes requester will be suppressed.
  1105.  
  1106.     VIEWID=VID/K/N:
  1107.           ID of a view.
  1108.  
  1109. Return codes:
  1110.      rc = 5, if the file can't be loaded.
  1111.  
  1112. See also:
  1113.      CLEAR, SAVE, SAVEAS
  1114.  
  1115. PASTE
  1116. =====
  1117.  
  1118. Synopsis:
  1119.      PASTE VIEWID=VID/K/N
  1120.  
  1121. Function:
  1122.      Pastes the current block into the file at the current cursor
  1123.      position.
  1124.  
  1125. Arguments:
  1126.     VIEWID=VID/K/N:
  1127.           ID of a view.
  1128.  
  1129. See also:
  1130.      Menu: `Edit/Paste', SETBLOCKMARK
  1131.  
  1132. POSITION
  1133. ========
  1134.  
  1135. Synopsis:
  1136.      POSITION SOF/S,EOF/S,SOL/S,EOL/S,VIEWID=VID/K/N
  1137.  
  1138. Function:
  1139.      Sets the cursor.
  1140.  
  1141. Arguments:
  1142.     SOF/S:
  1143.           Start of file.
  1144.  
  1145.     EOF/S:
  1146.           End of file.
  1147.  
  1148.     SOL/S:
  1149.           Start of line.
  1150.  
  1151.     EOL/S:
  1152.           End of line.
  1153.  
  1154.     VIEWID=VID/K/N:
  1155.           ID of a view.
  1156.  
  1157.      As well SOF and EOF as SOL and EOL exclude each other.
  1158.  
  1159. PREVIOUS
  1160. ========
  1161.  
  1162. Synopsis:
  1163.      PREVIOUS VIEW/S,WINDOW/S
  1164.  
  1165. Function:
  1166.      Activate the previous view resp. edit window.
  1167.  
  1168. Arguments:
  1169.     VIEW/S:
  1170.           The previous view should be activated.
  1171.  
  1172.     WINDOW/S:
  1173.           The previous window should be activated.
  1174.  
  1175. See also:
  1176.      NEXT
  1177.  
  1178. PRINT
  1179. =====
  1180.  
  1181. Synopsis:
  1182.      PRINT FILEID=FID/K/N
  1183.  
  1184. Function:
  1185.      Prints the whole file.
  1186.  
  1187. Arguments:
  1188.           ID of a file.
  1189.  
  1190. PRINTBLOCK
  1191. ==========
  1192.  
  1193. Synopsis:
  1194.      PRINTBLOCK
  1195.     Synopsis:
  1196.           PRINTBLOCK
  1197.  
  1198.     Function:
  1199.           Prints the contents of the block buffer(clipboard).
  1200.  
  1201. QUIT
  1202. ====
  1203.  
  1204. Synopsis:
  1205.      QUIT FORCE/S
  1206.  
  1207. Function:
  1208.      Quits FileX.
  1209.  
  1210. Arguments:
  1211.     FORCE/S:
  1212.           The changes requester is suppressed.
  1213.  
  1214. See also:
  1215.      CLOSE
  1216.  
  1217. REDO
  1218. ====
  1219.  
  1220. Synopsis:
  1221.      REDO NUMBER/N,FILEID=FID/K/N
  1222.  
  1223. Function:
  1224.      Redos a number of `undos'.
  1225.  
  1226. Arguments:
  1227.     NUMBER/N:
  1228.           Number of steps. If not given, just the last `undo' is redone.
  1229.  
  1230.     FILEID=FID/K/N:
  1231.           ID of a file.
  1232.  
  1233. REQUESTFILE
  1234. ===========
  1235.  
  1236. Synopsis:
  1237.      REQUESTFILE VAR/K,STEM/K,TITLE/K,PATH/K,FILE/K,PATTERN/K =>
  1238.      FILENAME
  1239.  
  1240. Function:
  1241.      Opens a file requester and returns a file name.
  1242.  
  1243. Arguments:
  1244.     TITLE/K:
  1245.           Title of the file requester.
  1246.  
  1247.     PATH/K:
  1248.           Default path.
  1249.  
  1250.     FILE/K:
  1251.           Default file.
  1252.  
  1253.     PATTERN/K:
  1254.           A pattern.
  1255.  
  1256. Return codes:
  1257.      Falls rc = 5, if the requester was cancelled.
  1258.  
  1259.      Sonst:
  1260.     FILENAME:
  1261.           Select file with path.
  1262.  
  1263. Example:
  1264.      REQUESTFILE TITLE '"Select a script:"' PATTERN '#?.filex'
  1265.  
  1266. REQUESTNOTIFY
  1267. =============
  1268.  
  1269. Synopsis:
  1270.      REQUESTNOTIFY PROMPT
  1271.  
  1272. Function:
  1273.      Opens a simple notify requester with just one lonely gadget.
  1274.  
  1275. Arguments:
  1276.     PROMPT:
  1277.           Title of the requester.
  1278.  
  1279. REQUESTRESPONSE
  1280. ===============
  1281.  
  1282. Synopsis:
  1283.      REQUESTRESPONSE BUTTONS/K,PROMPT/K
  1284.  
  1285. Function:
  1286.      Opens a Requester with several gadgets.
  1287.  
  1288. Arguments:
  1289.     BUTTONS/K:
  1290.           A string that defines the gadgets(see example).
  1291.  
  1292.     PROMPT/K:
  1293.           Title.
  1294.  
  1295. Return codes:
  1296.      rc contains the number of the selected gadgets. The right most
  1297.      gadget has got the nuber 0. All others are enumerated from left to
  1298.      right beginning with 1.
  1299.  
  1300. Example:
  1301.              /* Requester with four gadgets */
  1302.           REQUESTRESPONSE BUTTONS `"Gadget 1|Gadget2|Gadget 3|Gadget 0"'
  1303.           
  1304.           say '"You''ve chosen gadget number"' rc '.'
  1305.  
  1306. REQUESTSTRING
  1307. =============
  1308.  
  1309. Synopsis:
  1310.      REQUESTSTRING VAR/K,STEM/K,PROMPT/K,DEFAULT/K => STRING
  1311.  
  1312. Function:
  1313.      Opens a requester to enter a string.
  1314.  
  1315. Arguments:
  1316.     PROMPT/K:
  1317.           Title.
  1318.  
  1319.     DEFAULT/K:
  1320.           Default string.
  1321.  
  1322. Return codes:
  1323.      rc = 5, if the requester was cancelled.
  1324.  
  1325.      Else:
  1326.     STRING
  1327.           Entered string.
  1328.  
  1329. RX
  1330. ==
  1331.  
  1332. Synopsis:
  1333.      RX VAR/K,STEM/K,CONSOLE/S,ASYNC/S,COMMAND/F => RC/N,RESULT
  1334.  
  1335. Function:
  1336.      Executes an arexx script.
  1337.  
  1338. Arguments:
  1339.     CONSOLE/S:
  1340.           If set, a console window for input and output will be opened.
  1341.  
  1342.     ASYNC/S:
  1343.           Start the script asyncron.
  1344.  
  1345.     COMMAND/F:
  1346.           Name of the arexx script.
  1347.  
  1348. Return codes:
  1349.      If executed synchronous.
  1350.     RC/N,RESULT:
  1351.           Return codes of the script.
  1352.  
  1353. SAVE
  1354. ====
  1355.  
  1356. Synopsis:
  1357.      SAVE FILEID=FID/K/N
  1358.  
  1359. Function:
  1360.      Saves the file. If the file does not have a name, a file requester
  1361.      will pop up.
  1362.  
  1363. Arguments:
  1364.     FILEID=FID/K/N:
  1365.           ID of a file.
  1366.  
  1367. Return codes:
  1368.      rc = 5, if saving failed.
  1369.  
  1370. SAVEAS
  1371. ======
  1372.  
  1373. Synopsis:
  1374.      SAVEAS NAME,FILEID=FID/K/N
  1375.  
  1376. Function:
  1377.      Saves the file under a new name.
  1378.  
  1379. Arguments:
  1380.     NAME:
  1381.           New name of the file. If not given, a file requester will pop
  1382.           up.
  1383.  
  1384.     FILEID=FID/K/N:
  1385.           ID of a file.
  1386.  
  1387. Return codes:
  1388.      rc = 5, if saving failed.
  1389.  
  1390. SAVEBLOCK
  1391. =========
  1392.  
  1393. Synopsis:
  1394.      SAVEBLOCK NAME
  1395.  
  1396. Function:
  1397.      Saves the current contents of the block buffer(clipboard).
  1398.  
  1399. Arguments:
  1400.     NAME:
  1401.           If not given, a file requester will pop up.
  1402.  
  1403. Return codes:
  1404.      rc = 5, if saving failed.
  1405.  
  1406. SAVECOMMANDS
  1407. ============
  1408.  
  1409. Synopsis:
  1410.      SAVECOMMANDS
  1411.  
  1412. Function:
  1413.      Saves the arexx command list from the menu under the current name.
  1414.  
  1415. Return codes:
  1416.      rc = 5, if saving failed.
  1417.  
  1418. SAVECOMMANDSAS
  1419. ==============
  1420.  
  1421. Synopsis:
  1422.      SAVECOMMANDSAS NAME
  1423.  
  1424. Function:
  1425.      Saves the arexx command list from the menu under a new name.
  1426.  
  1427. Arguments:
  1428.     NAME:
  1429.           If not given, a file requester will pop up.
  1430.  
  1431. Return codes:
  1432.      rc = 5, if saving failed.
  1433.  
  1434. SAVESETTINGS
  1435. ============
  1436.  
  1437. Synopsis:
  1438.      SAVESETTINGS
  1439.  
  1440. Function:
  1441.      Saves the current settings under their current name.
  1442.  
  1443. Return codes:
  1444.      rc = 5, if saving failed.
  1445.  
  1446. SAVESETTINGSAS
  1447. ==============
  1448.  
  1449. Synopsis:
  1450.      SAVESETTINGSAS NAME
  1451.  
  1452. Function:
  1453.      Saves the current settings under a new name.
  1454.  
  1455. Arguments:
  1456.     NAME:
  1457.           If not given, a ... ehh, what do you guess? ... file
  1458.           requester will pop up.
  1459.  
  1460. Return codes:
  1461.      rc = 5, if saving failed.
  1462.  
  1463. SETATTR
  1464. =======
  1465.  
  1466. Synopsis:
  1467.      SETATTR          OBJECT/A,FIELD,ID/K/N,FROMSTEM/K,FROMVAR/K
  1468.  
  1469. Function:
  1470.      Set one or more variables of the program to a new value.
  1471.  
  1472. Arguments:
  1473.     OBJECT/A:
  1474.           Object name.
  1475.  
  1476.     FIELD:
  1477.           Field name.
  1478.  
  1479.     ID/K/N:
  1480.           Possible with the objects WINDOW, VIEW and FILE. If not given,
  1481.           the variable of the current view/window/file is set.
  1482.  
  1483.     FROMSTEM/K:
  1484.           Name of a stem variable containing the values.
  1485.  
  1486.     FROMVAR/K:
  1487.           Name of a variable containing the value.
  1488.  
  1489.      If FIELD is not specified, a FROMSTEM-variable must be specified.
  1490.      In this variable, several values of the object can be stored.
  1491.  
  1492. Example:
  1493.           meinestemvariable.STRINGFILL = TRUE
  1494.           meinestemvariable.FILLSTRING = 'Klaas ist stupid!'
  1495.           
  1496.           SETATTR APPLICATION FROMSTEM meinestemvariable
  1497.  
  1498. See also:
  1499.      Attributes, GETATTR
  1500.  
  1501. SETBLOCK
  1502. ========
  1503.  
  1504. Synopsis:
  1505.      SETBLOCK BLOCK/A
  1506.  
  1507. Function:
  1508.      Puts a number of bytes in the block buffer(clipboard).
  1509.  
  1510. Arguments:
  1511.     BLOCK/A:
  1512.           Hex string.
  1513.  
  1514. Example:
  1515.      SETBLOCK '"0071 12feee de"'
  1516.  
  1517. SETBLOCKMARK
  1518. ============
  1519.  
  1520. Synopsis:
  1521.      SETBLOCKMARK VIEWID=VID/K/N
  1522.  
  1523. Function:
  1524.      Switches between block mark mode and normal mode.
  1525.  
  1526. Arguments:
  1527.     VIEWID=VID/K/N:
  1528.           ID of a view.
  1529.  
  1530. See also:
  1531.      Menu: `Edit/Mark', Attributes: `PROJECT/MARK', COPY, CUT, FILL
  1532.  
  1533. SETBOOKMARK
  1534. ===========
  1535.  
  1536. Synopsis:
  1537.      SETBOOKMARK NUMBER/N,VIEWID=VID/K/N
  1538.  
  1539. Function:
  1540.      Sets a mark at the current cursorposition. By using GOTOBOOKMARK,
  1541.      this mark can be jumped at.
  1542.  
  1543. Arguments:
  1544.     NUMBER/N:
  1545.           Number between 1 and 10, which defines the mark's number.
  1546.  
  1547.     VIEWID=VID/K/N:
  1548.           ID of a view.
  1549.  
  1550. See also:
  1551.      GOTOBOOKMARK
  1552.  
  1553. SETBYTES
  1554. ========
  1555.  
  1556. Synopsis:
  1557.      SETBYTES POS/N/A,HEXSTRING/A,FILEID=FID/K/N
  1558.  
  1559. Function:
  1560.      Sets a defined number of bytes at a specified position.
  1561.  
  1562. Arguments:
  1563.     POS/N/A:
  1564.           Position, the bytes shall be set to.
  1565.  
  1566.     HEXSTRING/A:
  1567.           Hex string containing the bytes.
  1568.  
  1569.     FILEID=FID/K/N:
  1570.           ID of a file.
  1571.  
  1572. Example:
  1573.           SETBYTES        200 '"4b6c 6161 73"'
  1574.  
  1575. See also:
  1576.      GETBYTES
  1577.  
  1578. SETSCREEN
  1579. =========
  1580.  
  1581. Synopsis:
  1582.      SETSCREEN NAME/K,OWN/S
  1583.  
  1584. Function:
  1585.      Definition of the screen FileX shall be opened on.
  1586.  
  1587. Arguments:
  1588.     NAME/K:
  1589.           Name of an public screen.
  1590.  
  1591.     OWN/S:
  1592.           An own screen shall be opened. A screen mode requester will
  1593.           pop up.
  1594.  
  1595. SHRINKVIEW
  1596. ==========
  1597.  
  1598. Synopsis:
  1599.      SHRINKVIEW VIEWID=VID/K/N
  1600.  
  1601. Function:
  1602.      Shrinks a view by one line.
  1603.  
  1604. Arguments:
  1605.     VIEWID=VID/K/N:
  1606.           ID of a view.
  1607.  
  1608. See also:
  1609.      EXPANDVIEW, GROWVIEW
  1610.  
  1611. SIZEWINDOW
  1612. ==========
  1613.  
  1614. Synopsis:
  1615.      SIZEWINDOW HEIGHT/N,WIDTH/N,WINDOWID=WID/K/N
  1616.  
  1617. Function:
  1618.      The FileX window height and width may be modified.
  1619.  
  1620. Arguments:
  1621.     HEIGHT/N:
  1622.           New height.
  1623.  
  1624.     WIDTH/N:
  1625.           New width.
  1626.  
  1627.     WINDOWID=WID/K/N:
  1628.           ID of a window.
  1629.  
  1630. SPLIT
  1631. =====
  1632.  
  1633. Synopsis:
  1634.      SPLIT VIEW/S,WINDOW/S
  1635.  
  1636. Function:
  1637.      Opens a new view with the same file as the current one.
  1638.  
  1639. Arguments:
  1640.     VIEW/S:
  1641.           The current view is divided into two new views.
  1642.  
  1643.     WINDOW/S:
  1644.           Opens a new edit window.
  1645.  
  1646. See also:
  1647.      Menu: `Project/(View|Window)/Split', NEW
  1648.  
  1649. UNDO
  1650. ====
  1651.  
  1652. Synopsis:
  1653.      UNDO NUMBER/N,FILEID=FID/K/N
  1654.  
  1655. Function:
  1656.      A defined number of changes made to the file will be undone.
  1657.  
  1658. Arguments:
  1659.     NUMBER/N:
  1660.           Number of changes which shall be possible to be undone.  If
  1661.           not specified, only the last change will be undone.
  1662.  
  1663.     FILEID=FID/K/N:
  1664.           ID of a file.
  1665.  
  1666. UNLOCKGUI
  1667. =========
  1668.  
  1669. Synopsis:
  1670.      UNLOCKGUI
  1671.  
  1672. Function:
  1673.      If the GUI was locked, it will be unlocked.
  1674.  
  1675. See also:
  1676.      LOCKGUI
  1677.  
  1678. WINDOWTOBACK
  1679. ============
  1680.  
  1681. Synopsis:
  1682.      WINDOWTOBACK WINDOWID=WID/K/N
  1683.  
  1684. Function:
  1685.      The window will be moved to the back.
  1686.  
  1687. Arguments:
  1688.     WINDOWID=WID/K/N:
  1689.           ID of a window.
  1690.  
  1691. WINDOWTOFRONT
  1692. =============
  1693.  
  1694. Synopsis:
  1695.      WINDOWTOFRONT WINDOWID=WID/K/N
  1696.  
  1697. Function:
  1698.      The window will be moved to the front.
  1699.  
  1700. Arguments:
  1701.     WINDOWID=WID/K/N:
  1702.           ID of a window.
  1703.  
  1704. ZIPWINDOW
  1705. =========
  1706.  
  1707. Synopsis:
  1708.      ZIPWINDOW WINDOWID=WID/K/N
  1709.  
  1710. Function:
  1711.      Same function as the zip gadget of the FileX window has got.
  1712.  
  1713. Arguments:
  1714.     WINDOWID=WID/K/N:
  1715.           ID of a window.
  1716.  
  1717. Attributes
  1718. **********
  1719.  
  1720.    Some variables of FileX can be read by the option GETATTR. Probably
  1721. they may also be modified through SETATTR.  Both commands require at
  1722. least the objectname and maybe a fieldname or an ID, too.
  1723.  
  1724.    There are three different fieldtypes: Strings, numbers and boolean
  1725. values (`TRUE' or `FALSE').
  1726.  
  1727.    Following are all objects and their belonging fields. For every
  1728. field, its name and the type will be displayed, moreover if it can only
  1729. be read. After that, a contents description follows.
  1730.  
  1731. APPLICATION-Objekt:
  1732. ===================
  1733.  
  1734. "SCREEN", String, read only:
  1735.      Name of the public screen FileX is opened on.
  1736.  
  1737. "VERSION", String, read only:
  1738.      Versionnumber of FileX.
  1739.  
  1740. "REGNUMBER", Number, read only:
  1741.      Registration number. 0 statnds for the unregistered version.
  1742.  
  1743. "REGNAME", String, read only:
  1744.      Name of registered user.
  1745.  
  1746. "AREXX", String, read only:
  1747.      Name of the arexx port.
  1748.  
  1749. "MAXUNDOMEMSIZE", Number:
  1750.      Maximum size of the undo memory.
  1751.  
  1752. "MAXUNDOLEVEL", Number:
  1753.      Maximum number of undo levels.
  1754.  
  1755. "ALTJUMP", Number:
  1756.      Jump width in lines for Alt-CURSORUP/DOWN.
  1757.  
  1758. "SCROLLBORDER", Number:
  1759.      Distance in lines to the upper/lower limit from where on the window
  1760.      shall be scrolled.
  1761.  
  1762. "CLIPBOARDUNIT", Number:
  1763.      Unit that should be used for the block buffer.
  1764.  
  1765. "COMMANDSHELLWINDOW", String:
  1766.      Description of the command shell window.
  1767.  
  1768. "COMMANDWINDOW", String:
  1769.      Description of the shell window for arexx scripts.
  1770.  
  1771. "OVERWRITE", Bool:
  1772.      TRUE, if no requester before saving an already existing file shall
  1773.      appear.
  1774.  
  1775. "USEASL", Bool:
  1776.      TRUE, if the Asl library and the Intuition library should be used
  1777.      instead of the Reqtools library.
  1778.  
  1779. "PRIORITY", Number:
  1780.      Taskpriority of FileX.
  1781.  
  1782. "SEARCHSTRING", String:
  1783.      Search string.
  1784.  
  1785. "REPLACESTRING", String:
  1786.      Replace string.
  1787.  
  1788. "STRINGSEARCH", Bool:
  1789.      TRUE for string search, FALSE for hex search.
  1790.  
  1791. "CASESENSITIVSEARCH", Bool:
  1792.      TRUE for casesensitiv searching.
  1793.  
  1794. "WILDSEARCH", Bool:
  1795.      TRUE to use the question mark(`?') as a wildcard.
  1796.  
  1797. "FILLSTRING", String:
  1798.      Fill string.
  1799.  
  1800. "STRINGFILL", Bool:
  1801.      TRUE for stringfill, FALSE for hex fill.
  1802.  
  1803. "WINDOWS"-Objekt:
  1804. =================
  1805.  
  1806. 1..n
  1807.      ID of a window.
  1808.  
  1809. "COUNT", Number, read only:
  1810.      Number of IDs, i.e. the number of opened edit windows.
  1811.  
  1812. "WINDOW"-Objekt:
  1813. ================
  1814.  
  1815. "LEFT", Number, read only:
  1816.      Window offset to the left border.
  1817.  
  1818. "TOP", Number, read only:
  1819.      Window offset to the right border.
  1820.  
  1821. "WIDTH", Number, read only:
  1822.      Width of the window.
  1823.  
  1824. "HEIGHT", Number, read only:
  1825.      Height of the window.
  1826.  
  1827. "TITLE", String, read only:
  1828.      Current title of the window.
  1829.  
  1830. "MIN_WIDTH", Number, read only:
  1831.      Minimun width of the window.
  1832.  
  1833. "MIN_HEIGHT", Number, read only:
  1834.      Minimum height of tht window.
  1835.  
  1836. "MAX_WIDTH", Number, read only:
  1837.      Maximum width of the window.
  1838.  
  1839. "MAX_HEIGHT", Number, read only:
  1840.      Minimun height of the window.
  1841.  
  1842. "VIEWCOUNT", Number, read only:
  1843.      Number of views.
  1844.  
  1845. "VIEWS", String, read only:
  1846.      IDs of all views in this window. Separated by a space.
  1847.  
  1848. "FILES"-Objekt:
  1849. ===============
  1850.  
  1851. 1..n
  1852.      ID of a file.
  1853.  
  1854. "COUNT", Number, read only:
  1855.      Number of IDs, i.e. the number of opened files.
  1856.  
  1857. "FILE"-Objekt:
  1858. ==============
  1859.  
  1860. "FULLNAME", String:
  1861.      Full file name with path.
  1862.  
  1863. "PATH", String:
  1864.      Path of the file name.
  1865.  
  1866. "NAME", String:
  1867.      Name without path.
  1868.  
  1869. "CHANGES", Number, read only:
  1870.      Number of changes.
  1871.  
  1872. "FILELEN", Number, read only:
  1873.      Length of the file.
  1874.  
  1875. "MEMPOS", Number, read only:
  1876.      Start address of the file in the memory. If the lenght of the file
  1877.      is changed, the start address might change, too.
  1878.  
  1879. "VIEWCOUNT", Number, read only:
  1880.      Number of views showing the file.
  1881.  
  1882. "VIEWS", String, read only:
  1883.      IDs of all views showing the file. Separated by a space.
  1884.  
  1885. "VIEW"-Objekt:
  1886. ==============
  1887.  
  1888. "LINES", Number, read only:
  1889.      Number of lines.
  1890.  
  1891. "BYTESPERLINE", Number, read only:
  1892.      Number of bytes per line.
  1893.  
  1894. "DISPLAYTYP", Number:
  1895.      Current display type.
  1896.  
  1897. "DISPLAY", Number:
  1898.      Defines in which form the file shall be displayed: 1 = only
  1899.      hexddisplay, 2 = only Asciidisplay, 3 = Hex-ASCII mixed display.
  1900.  
  1901. "DISPLAYSPACES", Number:
  1902.      Defines how many Bytes shall be grouped to a block in the
  1903.      hexdisplay: 3 = no blocks, 0 = one byte blocks, 1 = word blocks, 2
  1904.      = long word blocks.
  1905.  
  1906. "CURSORPOS", Number, read only:
  1907.      Current cursor position.
  1908.  
  1909. "MARKPOS", Number, read only:
  1910.      Position of the mark's beginning.
  1911.  
  1912. "EDITASCII", Bool:
  1913.      TRUE, when the active cursor is in the ascii area.
  1914.  
  1915. "MARK", Bool, read only:
  1916.      TRUE, if a block is being marked at the moment.
  1917.  
  1918. "FILE", Number, read only:
  1919.      ID of the displayed file.
  1920.  
  1921. "WINDOW", Number, read only:
  1922.      ID of the belonging edit window.
  1923.  
  1924.