home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR8 / AURORA10.ZIP / AREF.DOC < prev    next >
Text File  |  1993-08-18  |  17KB  |  392 lines
  1.  
  2.  
  3.   T h e   A u r o r a   E d i t o r   Q u i c k   R e f e r e n c e
  4.   ─────────────────────────────────────────────────────────────────
  5.  
  6.   This Quick Reference briefly summarizes all The Aurora Editor library
  7.   functions documented in The Aurora Editor Users Guide (A.DOC). For
  8.   documentation on native macro language functions, see "The Aurora
  9.   Macro Language Guide".
  10.  
  11.   Library functions are listed by category. Each library function is
  12.   followed by the default key definition (if any), and a brief
  13.   description. User-specified arguments to library functions are
  14.   enclosed in [bracket] characters.
  15.  
  16.  
  17.   File
  18.   ────
  19.  
  20.     newf                   <Ctrl-N>          new edit window
  21.     askopen                <Alt-E>           open prompt
  22.     askopenins             <Alt-I>           insert file prompt
  23.     askopenb                                 open binary prompt
  24.     openlast               <Alt-Z>           open last window
  25.     wrdlod CSetB           <Ctrl-]>          open file at cursor
  26.     refresh                                  refresh file from disk
  27.     askname                <Alt-N>           rename prompt
  28.     name  [filename]                         rename filename
  29.     open [filespec] [options]                open filename/directory
  30.     loada [filename]                         open a .A file
  31.     save                   <F3>              save current file
  32.     save [filename]                          save filename
  33.     asksaveas                                save-as prompt
  34.  
  35.     fmgr                   <F4>              display file manager
  36.  
  37.     quit %p                <Alt-Q>           close window
  38.     gquit %p               <Alt-X>           close all windows
  39.     quit %f                <Ctrl-X>          save file and close windows
  40.     gquit %f                                 save file and close all windows
  41.  
  42.     about                                    display about box
  43.  
  44.     hlp [major] [minor]                      display User's Guide
  45.     qref                   <Shift-F1>        display Quick Reference
  46.  
  47.  
  48.   Window
  49.   ──────
  50.  
  51.     wlis                   <Alt-W>           window list
  52.     wres                                     restore window
  53.     wkey                   <Ctrl-F5>         move/size window
  54.     wkey %p                <Ctrl-F6>         pan video background
  55.     wmin                                     minimize window
  56.     wmax                   <Ctrl-Z>          maximize window
  57.     wnex                   <Ctrl-A>          next window
  58.     wpre                                     prev window
  59.  
  60.     wcopy                  <Ctrl-C>          copy window
  61.     wspl %h                <Alt-H>           split window horizontal
  62.     wspl %v                <Alt-V>           split window vertical
  63.  
  64.     wcasc                  <Shift-F5>        cascade windows
  65.     wtileh                 <Shift-F4>        tile windows horizontally
  66.     wtilev                 <Shift-F3>        tile windows vertically
  67.  
  68.     wtool                  <Ctrl-F8>         display tool bar
  69.     winsty                 <Ctrl-F7>         change window style
  70.     wppt                                     change prompt style
  71.  
  72.     wrtv %p                <cursorup>        retrieve prev prompt
  73.     wrtv %n                <cursordown>      retrieve next prompt
  74.  
  75.  
  76.   Menu
  77.   ────
  78.  
  79.     menb                   <Esc>, <F10>      to last menu bar item
  80.     men                    <Alt-F10>         to last pull-down menu
  81.     menh                   <F1>              help pull-down
  82.     men2                   <Alt-T>           to last tool bar control
  83.     mens [submenu]                           display submenu
  84.  
  85.  
  86.   Cursor Movement
  87.   ───────────────
  88.  
  89.     left                   <cursorleft>      move cursor left
  90.     right                  <cursorright>     move cursor right
  91.     up                     <cursorup>        move cursor up
  92.     down                   <cursordown>      move cursor down
  93.  
  94.     cptop                  <Ctrl-Home>       to page top
  95.     cpbot                  <Ctrl-End>        to page bottom
  96.     cgoto @ 1              <Ctrl-PgUp>       to file top
  97.     cgoto @ (qtexend)      <Ctrl-PgDn>       to file bottom
  98.     cgoto [x] [y]                            to [x], [y] (abs or rel)
  99.  
  100.     chome                  <Home>            to column one
  101.     ceol                   <End>             to end of line
  102.     clast                  <Ctrl-Hyphen>     to last cursor position
  103.     ctab                   <Tab>             tab right
  104.     ctab %l                <Shift-Tab>       tab left
  105.     cwrd %r CSet           <Ctrl-Left>       find left word
  106.     cwrd  @ CSet           <Ctrl-Right>      find right word
  107.  
  108.     ladj @ -1              <Keypad-5>        center cursor
  109.     ladj @  1              <Ctrl-F9>         scroll to page top
  110.     ladj @ (qwinp @ %y1d)  <Ctrl-F10>        scroll to page bottom
  111.  
  112.     askbset                                  set bookmark prompt
  113.     bset                   <Ctrl-2>          quick bookmark
  114.     bset [bookmark]                          set bookmark
  115.     askbget                                  go to bookmark prompt
  116.     bget                   <Ctrl-6>          to previous bookmark
  117.     bget [bookmark]                          go to bookmark
  118.  
  119.     askglin                <Ctrl-J>          go to line prompt
  120.     glin [line]                              go to line
  121.     askgcol                                  go to column prompt
  122.     gcol [column]                            go to column
  123.     mloc @ %t              <Ctrl-B>          find top of block
  124.     mloc @ %b                                find bottom of block
  125.     cfld                   <Alt-7>           go to next fold
  126.     cfld %r                                  go to prev fold
  127.  
  128.     finm                   <Alt-F3>          find matching char
  129.     finc                   <Alt-F7>          go to compiler error
  130.  
  131.  
  132.   Scrolling
  133.   ─────────
  134.  
  135.     scry (- (ypagsiz))     <PgUp>            scroll up
  136.     scry (ypagsiz)         <PgDn>            scroll down
  137.     scry (- (/ (ypagsiz) 2))                 scroll up 1/2 page
  138.     scry (/ (ypagsiz) 2)                     scroll down 1/2 page
  139.     scry -1                <Ctrl-Up>         scroll up one line
  140.     scry  1                <Ctrl-Down>       scroll down one line
  141.  
  142.     scrx (- (xpagsiz))     <F7>              scroll left
  143.     scrx (xpagsiz))        <F8>              scroll right
  144.  
  145.  
  146.   Modifying Text
  147.   ──────────────
  148.  
  149.     cmtog                  <Ins>             toggle insert mode
  150.     enteredit              <Enter>           enter key
  151.     delch                  <Del>             delete character
  152.     baksp                  <Backspace>       delete left character
  153.  
  154.     undo                   <Ctrl-U>          undo last change
  155.     undo %r                <Ctrl-Y>          redo last change
  156.  
  157.     lins %a                <Ctrl-Enter>      insert line w/autoindent
  158.     lins %c                                  insert line
  159.     ldel                   <Ctrl-Backspace>  delete line
  160.     lspl                   <Alt-S>           split line
  161.     ljoin                  <Alt-J>           join line
  162.  
  163.     leol                   <F6>              erase to end of line
  164.     leol %l                <Alt-F6>          erase to beginning of line
  165.     wrddel CSet            <Ctrl-T>          delete right word
  166.     wrdcas [options] [CSet]                  change case of a word
  167.     ldup                   <Alt-4>           duplicate line
  168.     lswp                   <Alt-5>           swap line
  169.     lcen                   <Alt-6>           center line
  170.  
  171.     lcom                   <Alt-F1>          comment/uncomment line (//)
  172.     lcom [string1] [string2]                 comment/uncomment line
  173.     lit                    <Ctrl-[>          enter literal character
  174.     wasc                   <Alt-=>           display ascii chart
  175.     stamp                  <Ctrl-K-T>        date/time stamp
  176.     exptab                 <Ctrl-K-X>        expand tabs
  177.  
  178.  
  179.   OS Commands
  180.   ───────────
  181.  
  182.     askoscmd %ck           <Alt-F9>          DOS command prompt
  183.     os [cmd] [options]                       execute DOS command
  184.     askoscap               <Alt-F8>          DOS capture prompt
  185.     oscap [cmd] [options]                    capture DOS command output
  186.     osshell                <F9>              exit to DOS
  187.  
  188.  
  189.   Marking
  190.   ───────
  191.  
  192.     mset %l                <Alt-L>           mark line
  193.     mset %r                <Alt-B>           mark column
  194.     mset %s                <Alt-A>           mark character
  195.     wrdmrk CSet            <Alt-1>           mark word
  196.     meol                   <Alt-2>           mark to end of line
  197.     mpgh %tb               <Alt-3>           mark paragraph
  198.  
  199.     mdes                   <Alt-U>           unmark
  200.  
  201.  
  202.   Block
  203.   ─────
  204.  
  205.     mcpy                   <Alt-C>           copy block
  206.     mcpyp                  <Alt-C>           copy block to prompt
  207.     mmov %o                <Alt-O>           overlay block
  208.     mmov                   <Alt-M>           move block
  209.     mmov %of               <Ctrl-M>          move block over
  210.     mdel                   <Alt-D>           delete block
  211.     mshf  1                <Shift-F8>        indent block
  212.     mshf -1                <Shift-F7>        unindent block
  213.  
  214.     askmfill               <Ctrl-K-F>        fill block prompt
  215.     mrfl %b                <Alt-R>           reflow block
  216.     mrfl %br               <Alt-Y>           reflow & right justify block
  217.     msave                  <Ctrl-K-S>        save block
  218.     msrt                   <Ctrl-K-O>        sort block
  219.     mcase %l                                 change block to lower case
  220.     mcase %u               <Ctrl-K-U>        change block to upper case
  221.     mcase %ul                                flip case of block
  222.  
  223.     mjust %l                                 left justify block
  224.     mjust %c               <Ctrl-K-C>        center block
  225.     mjust %r                                 right justify block
  226.  
  227.     print %m               <Alt-P>           print block
  228.  
  229.  
  230.   Clipboard
  231.   ─────────
  232.  
  233.     clpcpy %d              <Grey->           cut
  234.     clpcpy %ad             <Ctrl-Grey->      cut append
  235.     clpcpy                 <Grey+>           copy
  236.     clpcpy %a              <Ctrl-Grey+>      copy append
  237.  
  238.     clppst                 <Grey*>           paste
  239.     clppst %o              <Ctrl-Grey*>      paste over
  240.  
  241.     clpclr                 <Ctrl-Grey/>      clear clipboard
  242.     askclp                                   clipboard name prompt
  243.  
  244.  
  245.   Folding
  246.   ───────
  247.  
  248.     lfld %b                <Alt-8>           fold next line
  249.     lfld %t                                  fold prev line
  250.  
  251.     mfld %f                <Alt-F>           fold block
  252.     mfld %uaf                                fold block flat
  253.  
  254.     lfld %u                <Alt-G>           unfold line
  255.     lfld %ua                                 unfold line flat
  256.     lfld %bs               <Alt-9>           unfold next line
  257.     lfld %ts                                 unfold prev line
  258.  
  259.     mfld %u                                  unfold block
  260.     mfld %ua                                 unfold block flat
  261.     mflda %ua              <Alt-0>           unfold all
  262.  
  263.  
  264.   Search and Replace
  265.   ──────────────────
  266.  
  267.     askfind                <Ctrl-F>, <F5>    find prompt
  268.     askrpl                 <Ctrl-G>          replace prompt
  269.     search [string]                          find/replace
  270.     finl                   <Ctrl-L>          do last find/replace
  271.     askscan                <Ctrl-S>          scan prompt
  272.  
  273.  
  274.   Printing
  275.   ────────
  276.  
  277.     print                  <Ctrl-P>          print
  278.     print %d               <Ctrl-P>          print file mgr contents
  279.     print %m               <Alt-P>           print block
  280.     prtstr [string]                          print string
  281.     askprtset                                print settings prompt
  282.  
  283.     prtfil [filename]                        print filename
  284.  
  285.  
  286.   Settings
  287.   ────────
  288.  
  289.     wmwrap                 <Ctrl-W>          word wrap toggle
  290.     wmautoi                                  autoindent toggle
  291.     wmvtab                                   variable tabs toggle
  292.     wmsmtab                                  smart tabs toggle
  293.     wmmat                                    match character toggle
  294.     wmbak                                    file backup toggle
  295.     wmdraw                 <Ctrl-D>          line draw toggle
  296.     sdraws [0/1/2/3/4]                       line draw style
  297.  
  298.     asktabw                                  tab width prompt
  299.     asktabv                                  variable tabs prompt
  300.     asklmrg                                  left margin prompt
  301.     askrmrg                                  right margin prompt
  302.     askind                                   paragraph indent prompt
  303.     askdefx                                  file extensions prompt
  304.     askbin                                   binary line length prompt
  305.     askdlm                                   line delimiter prompt
  306.  
  307.     vfont %t               <Ctrl-F1>         toggle video mode
  308.     vfont [columns] [rows]                   change video mode
  309.  
  310.     setsav                                   save current settings
  311.     setres                                   restore settings
  312.  
  313.  
  314.   Key Macros
  315.   ──────────
  316.  
  317.     krec                   <Ctrl-R>          record key macro toggle
  318.     kplay                  <Ctrl-E>          play scrap key macro
  319.     kdel                   <Ctrl-I>          erase scrap key macro
  320.     kdel %a                                  erase all key macros
  321.     askkopen                                 key macro open prompt
  322.     kload [filename]                         open key macro file
  323.     askksav                                  key macro save prompt
  324.     ksav [filename]                          save key macros to filename
  325.     kcat                                     assign scrap key macro to key
  326.  
  327.  
  328.   Macros
  329.   ──────
  330.  
  331.     loada %acfg                              display configuration (ACFG.A)
  332.     loada %akbd                              display key defs (AKBD.A)
  333.     loada %amen                              display menu defs (AMEN.A)
  334.  
  335.     askmcmd                <Ctrl-V>          macro command prompt
  336.     askmrun                                  run macro prompt
  337.     askminc                                  include macro prompt
  338.     askmcom                                  compile macro prompt
  339.  
  340.     mcmd [expression]                        evaluate macro expression
  341.     mrun [filename]                          evaluate macro file
  342.     minc [filename]                          include macro file
  343.     mcom [filename]                          compile macro file
  344.  
  345.  
  346.   Miscellaneous Functions
  347.   ───────────────────────
  348.  
  349.     say [message] [options]                  display message on title bar
  350.     mbox [title] [message] [options]         display message box
  351.     ask [prompt] [title] [width]             user prompt for string
  352.     askbox [title] [options]                 menu box prompt
  353.     keyx [key prefix]                        define compound key prefix
  354.     dn                                       get fmgr filename at cursor
  355.  
  356.     moubegmrk [x] [y] [options]              begin mouse mark
  357.     moumovmrk [x] [y]                        extend mouse mark
  358.     mouendmrk [x] [y]                        end mouse mark
  359.  
  360.     winsizt [l] [t] [r] [b] [reps] [options]  resize current window
  361.     qwinmin                                  test if window is minimized
  362.     qwinmax                                  test if window is maximized
  363.     qtimdat                                  return date/time
  364.  
  365.  
  366.   File Manager
  367.   ────────────
  368.  
  369.     fpar                   <Ctrl-Backspace>  parent directory
  370.     fopen                  <Enter>, <o>, <z> open file/directory
  371.     fopen %b               <b>               open binary file
  372.     fopenk                 <k>               open key macro file
  373.     fmov                   <m>               move file
  374.     fcpy                   <c>               copy file
  375.     fdel                   <d>, <Del>        delete file
  376.     fren                   <n>               rename file
  377.     frun %c                <r>               run program/batch file
  378.     fprt                   <p>               print file
  379.     fatt                   <a>               change file attributes
  380.     ftch                   <t>               touch file
  381.     fcred                                    create new directory
  382.  
  383.     fmtog                  <Space Bar>       mark/unmark file
  384.     fmrk                   <Alt-M>           mark all files
  385.     fumrk                  <Alt-U>           unmark all
  386.  
  387.     fsrt %n                <Alt-N>           sort by name
  388.     fsrt %s                <Alt-S>           sort by size
  389.     fsrt %d                <Alt-D>           sort by date
  390.     fsrt %o                <Alt-O>           no sort (DOS order)
  391.  
  392.