editors/scel/README

   1 -*- text -*-
   2 ------------------------------------------------------------------------
   3 SCEL -- SuperCollider/Emacs interface
   4 ------------------------------------------------------------------------
   5 $Id"
   6 ------------------------------------------------------------------------
   7
   8 installation (requirements)
   9 ---------------------------
  10
  11 For the HTML help system, you will need emacs-w3m support.
  12
  13 installation (default)
  14 -----------------------
  15
  16 by default emacs-lisp files are installed in
  17
  18     $prefix/share/emacs/site-lisp
  19
  20 SuperCollider files are put in
  21
  22     $prefix/share/SuperCollider/Extensions/scel
  23
  24 the only thing you need to do is loading the sclang interface in your
  25 ~/.emacs:
  26
  27     (require 'sclang)
  28
  29 for the HTML help system to fully function also add
  30         (require 'w3m)
  31
  32 installation (detailed)
  33 ------------------------
  34
  35 put all *.el files in emacs' load-path. e.g. if you put them in
  36 ~/emacs/, add the following lines to ~/.emacs (or whatever your init
  37 file is called):
  38
  39 (add-to-list 'load-path "~/emacs")
  40
  41 and then load the library:
  42
  43 (require 'sclang)
  44
  45 for the HTML help system to fully function also add
  46         (require 'w3m)
  47
  48 now put all *.sc files in sclang's library path, e.g. if you put them
  49 in a non-standard location, such as ~/SuperCollider/Emacs/, add the
  50 following to ~/.sclang.cfg:
  51
  52 +~/SuperCollider/Emacs
  53
  54 (note normally this is not needed as they are put into sclang's library
  55 path during installation with scons).
  56
  57
  58 usage
  59 ------
  60
  61 in order to automatically start sclang when invoking emacs, use the
  62 following command line:
  63
  64 $ emacs -sclang
  65
  66 you're now ready to edit, inspect and execute sclang code!
  67
  68 getting help
  69 -------------
  70
  71 inside an sclang-mode buffer (e.g. by editing a .sc file), execute
  72
  73 C-h m
  74
  75 a window with key bindings in sclang-mode will pop up.
  76
  77 C-x C-h lets you search for a help file
  78
  79 C-M-h opens or switches to the Help browser (if no Help file has been opened, the default Help file will be opened)
  80
  81 E copies the buffer, puts it in text mode and sclang-minor-mode, to enable you to edit the code parts to try out variations of the provided code in the help file. With C-M-h you can then return to the Help browser and browse further from the Help file.
  82
  83 C-c C-e allows you to edit the source of the HTML file, for example if you want to improve it and commit it to the repository.
  84
  85 To enable moving around in the help file with arrow keys add the following
  86 in your ~/.emacs:
  87
  88 (eval-after-load "w3m"
  89  '(progn
  90  (define-key w3m-mode-map [left] 'backward-char)
  91  (define-key w3m-mode-map [right] 'forward-char)
  92  (define-key w3m-mode-map [up] 'previous-line)
  93  (define-key w3m-mode-map [down] 'next-line)))
  94
  95 This ensures that the arrow keys are just for moving through the document,
  96 and not from hyperlink to hyperlink, which is the default in w3m-mode.
  97
  98
  99 customization
 100 --------------
 101
 102 to fine-tune the installation from within emacs' graphical
 103 customization interface, type
 104
 105 M-x sclang-customize
 106
 107 in particular, you will have to customize `sclang-runtime-directory'.
 108
 109 server control
 110 ---------------
 111
 112 in the post buffer window, right-click on the server name; by default
 113 the two servers 'internal' and 'localhost' are available. you will get
 114 a menu with common server control operations.
 115
 116 to select another server, step through the server list by
 117 left-clicking on the server name.
 118
 119 servers instantiated from the language will automatically be available
 120 in the mode line.
 121