sc3ctrl/README

68 lines
2.1 KiB
Plaintext

sc3ctrl
=======
**************************************************************************
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
**************************************************************************
Introduction
============
sc3ctrl is a command line utility which uses OpenSoundControl to control
the SuperCollider3.app in OSX.
Source code/downloads: http://github.com/rfwatson/sc3ctrl
Installation
============
1) Drag the bundle into a suitable location on your machine
(such as /Application/Utilities/)
2) Double click "install.rb". (This will create an executable script in
/usr/local/lib. This allows sc3ctrl to be run from the command-line. It also
copies the required SuperCollider class file to ~/Application\
Support/SuperCollider/Extensions/).
3) Start SuperCollider.app
Usage
=====
sc3ctrl -x Execute the SC code in environment variable SC_INTERPRET_TEXT
sc3ctrl -x VARIABLE_NAME Execute the SC code in environment variable VARIABLE_NAME
sc3ctrl -d classname Open the help file for classname
sc3ctrl -j classname Open the class definition for classname
sc3ctrl -y methodname Examine implementations of methodname
sc3ctrl -Y methodname Examine references to methodname
sc3ctrl -s Stop server (CMD-PERIOD)
sc3ctrl -c Clear post window
sc3ctrl -p Post window to front
sc3ctrl -k Recompile class library (requires recent build)