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, .udo) with Vim: syntax recognition and highlighting, folding, macros, on-line reference 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 and MacOS/OSX.

features

• syntax highlighting: opcodes and other lexical entities in Csound (variables, comments, etc.) are recognized an accordingly colorized.
• folding: folds are created from blocks of code (orchestra and score, instruments, user-defined opcodes and multiline comments) for easier navigation.
• 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: a Csound quick reference is formatted as a Vim help file for on-line reference.
• templates: every time a new .csd file is created, Vim loads a template.

These tools turn Vim, with all its editing power, into a simple but productive 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: a quick Csound Reference (opcode synopsis and syntax) formatted as a Vim help file.
• template.csd: a template .csd file.
• csoundft.vim: autocommands for detecting csound files and automatically loading syntax files and the rest of csound tools.

quick install

1. copy csound.vim and csound_opcodes.vim to $VIM/vimfiles/syntax/
   copy csound_macros to $VIM/vimfiles/macros/
   copy template.csd to $VIM/vimfiles/templates/
   copy csound.txt to $VIM/vimfiles/doc/
   copy csoundft.vim to $VIM/vimfiles/ftdetect/

   or, if you downloaded the compressed tarball, simply uncompress it in the $VIM/vimfiles directory.

   $VIM is normally set to /usr/share/vim (eventually /usr/local/share/vim) on linux, and C:\Program Files\Vim on Windows. Check the location on your system typing :echo $VIM from within Vim.

2. as root, run this command from within Vim:

   :helptags $VIM/vimfiles/doc

3. Read the readme file for further details.