c s o u n d   v i m   t o o l s

set of tools for editing Csound files with Vim
author: luis jure
e-mail: lj @ eumus . edu . uy
homepage: http://www.eumus.edu.uy/docentes/jure/

Set of tools for editing Csound files (.orc, .sco, .csd) with Vim: syntax recognition and highlighting, macros, on-line manual and templates.

Vim is a much improved clone of the traditional "vi" editor, with lots of added features. Vim is free, very powerful and highly configurable, and runs on almost any operating system, including GNU/Linux and other Unixes, DOS/Windows, MacOS, and BeOS.

features

• syntax highlighting: opcodes and other lexical entities in Csound (variables, comments, etc.) are recognized an accordingly colorized.
• macros: function-keys are mapped to macros that can be used to compile your Csound files and listen to the output, without leaving Vim.
• on-line help: the Csound manual is formatted as a Vim help file for on-line reference.
• templates: every time a new .csd or .orc file is created, Vim loads a template.

These tools turn Vim, with all its editing power, into a Csound frontend.

Read the readme file for further details.

the files

All the files listed below are available in a compressed tarball.

• csound.vim: the file with the syntax definitions for highlighting lexical elements of Csound.
• csound_opcodes.vim: file with a list of all opcodes in Csound, used by csound.vim.
• csound_macros.vim: file with macros to compile Csound files from within Vim.
• csound.txt: (1.8 Mb, compressed, 384 Kb) the Alternative Csound Reference Manual formatted as a Vim help file.
• template.csd: a template .csd file.
• template.orc: a template .orc file.

quick install

1. copy csound.vim, csound_opcodes.vim to $VIMRUNTIME/syntax/
   copy csound_macros to $VIMRUNTIME/macros/
   copy template.orc and template.csd to $VIMRUNTIME/templates/
   uncompress csound.txt and copy it to $VIMRUNTIME/doc/

   or, if you downloaded the compressed tarball, simply uncompress it in the $VIMRUNTIME directory.

2. add the following lines either to your personal configuration file ($HOME/.vimrc), or to the global vimrc file (either /etc/vimrc or $VIM/vimrc):

   au BufNewFile,BufRead *.orc,*.sco,*.csd   so $VIMRUNTIME/syntax/csound.vim
   au BufNewFile,BufRead *.csd               so $VIMRUNTIME/macros/csound_macros.vim
   au BufNewFile *.csd                       0r $VIMRUNTIME/templates/template.csd
   au BufNewFile *.orc                       0r $VIMRUNTIME/templates/template.orc

3. as root, run from within Vim:

   :helptags $VIMRUNTIME/doc

4. Read the readme file for further details.