Skip to content

Latest commit

 

History

History
124 lines (79 loc) · 3.08 KB

README.md

File metadata and controls

124 lines (79 loc) · 3.08 KB
Raw

This is a syntax file for the rc shell scripting language.

Compatibility

For unix (not plan9) users, there are two slightly different versions of rc available.

One is plan9port and 9base's version and the other is Byron Rakitzis' (as packaged by Debian and other *nix software distribution).

This syntax file is compatible with both versions.

This syntax is comptible with Vim 5.7-6.4.

Install

If you use Vundle, add the following line to your ~/.vimrc:

Plugin 'weakish/rcshell.vim'

Then run inside Vim:

:so ~/.vimrc
:PluginInstall

If you use Pathogen, do this:

cd ~/.vim/bundle
git clone https://github.com/weakish/rcshell.vim.git

If you are not using any package manager, download the tarball and do this:

cd ~/.vim
tar --strip=1 -zxf path/to/master.tar.gz

Configuration

By default, .rcrc*, rcrc and files starting with an rc shebang (#!/something/.../rc) will be highlighted.

Add rc shell syntax to other file extensions

If you want to add other file extensions, you can add the following lines in .vimrc:

au BufRead,BufNewFile *.your_extension set filetype=rcshell

For example, you could write

au BufRead,BufNewFile *.rc set filetype=rcshell

to catch all files with an .rc extension.

Use another syntax for files which this extension detects.

If you want to use .rcrc*, rcrc or *.rc for another file type, you can specify the file type in .vimrc.

For example, if you want to use .rc for M$ Resource file:

au BufRead,BufNewFile *.rc set filetype=rc

(Confusingly, rc is the name of the default filetype in vim.)

Other

You can also use setfiletype (without a space) to set the filetype if it has not already been set:

au BufRead,BufNewFile *.your_extension setfiletype rcshell

See :help filetype and :help setfiletype for more information.

Disable this syntax file.

If you want to disable this syntax file, add the following line in your .vimrc:

let g:loaded_rcshell = 1

Repository

Credit

This is based on Andy Spencer's work for the plan9 rc shell. There is a minor trade off for maintain compatibility with two versions of rc mentioned above: less powerful (ba)sh like substitution syntax error detection.

License

Public domain.

Tips

This is not related to the syntax directly, but I think users who code with the rc shell script in Vim may be interested:

If you want to use rc as the embedded shell in vim, add the following lines to your .vimrc:

set shell=/usr/bin/rc\ -l
"  or /bin/rc or /usr/local/bin/rc or /opt/local /bin/rc, etc
set shellcmdflag=-c
set shellpipe=>[2=1]\|\ tee
set shellredir=>%s\ >[2=1]