editors/scvim/SCVim.scd

   1 SCVim   SuperCollider in the VIM editor.
   2
   3 created by Alex Norman, SuperCollider class created by Dan Stowell
   4 the webpage is here: http://www.x37v.info/projects/scvim/
   5 if you have improvements/suggestions email alex at x37v dot info
   6
   7 View the scvim README for installation instructions.
   8 ________________________________________________________________________________
   9
  10 Quick intro:
  11
  12 In order for syntax highlighting and class definition lookup to work you must
  13 run:
  14
  15 SCVim.updateCaches;
  16
  17 it is best to put this in your ~/.sclang.sc file.  But for now you can just
  18 put the cursor over that line and hit F6 to send it to the language.
  19 After you've done that you can update the syntax highlighting info by executing
  20 the following (in vim):
  21 runtime syntax/supercollider.vim
  22
  23 ________________________________________________________________________________
  24
  25 USAGE (inside vim):
  26
  27 defaults (most work in both command and insert mode):
  28
  29 :SClangStart starts/restarts the interpreter in an xterm
  30    (if you want to recompile the supercollider library just type :SClangStart
  31    and you'll kill the current interpreter, start up a new one and have a
  32    recompiled library)
  33 :SClangKill   kills the xterm/interpreter
  34 (exiting vim also kills the interpreter)
  35
  36 F5 sends a whole block (looks for the outermost parens and sends that data)
  37 F6 sends a single line (the line the cursor is currently on)
  38 F7 calls TempoClock.default.clear;
  39 F8 calls s.freeAll;
  40 F12 calls thisProcess.stop; (i.e. the same as cmd-. on Mac)
  41
  42 in visual mode F5 and F6 both send the whole visual block
  43
  44 use :SChelp to get to SC help topics, or use K on a word (in command mode)
  45    (this has tab completion)
  46 use :SCdef to see the class definitions for an object, or use ^k (in command or normal mode)
  47    on a word (this also has tab completion)
  48
  49 These key bindings can all be changed through editing your scvimrc file.
  50
  51 ________________________________________________________________________________
  52
  53 HELP DOCS:
  54
  55 scvim uses preprocessed versions of the help files (converted to plain-text),
  56 and to update these help files from the main files you can run the following
  57 line in sclang (put the cursor on line and hit F6):
  58
  59   SCVim.updateHelpCache