Annotation of /jlscp/trunk/README


jlscp - A java LinuxSampler control protocol API

by Grigor Iliev <gr.iliev@gmail.com>


This library provides client API for retrieving information and
configuring running LinuxSampler instance according to the LinuxSampler
control protocol version 1.0 as specified in the LSCP specification written
by Christian Schoenebeck (http://www.linuxsampler.org/api/lscp-1.0.html).

For more information about LinuxSampler visit http://www.linuxsampler.org


Requirements
============

To use jlscp you need java version 1.5.0 or higher.

To build the library, the documentation or the examples you need
JDK version 1.5.0 or higher and the Ant tool (http://ant.apache.org/).


Compilation
===========

Notice that the package contains both the source and the binary files.
So you can skip this section unless you want to rebuild the library or
you are using version downloaded from cvs.
 
To build the library, examples or documentation follow the next steps.

  1. Set the JAVA_HOME environment variable to point to your JDK directory.
     If the JDK is installed in /opt/jdk1.5.0 directory, this can be done
     with the following command:

     export JAVA_HOME=/opt/jdk1.5.0

     (Windows users must do something like `set JAVA_HOME=c:\jdk1.5.0')

  2. Choose one or more of the following options.

     - Building the library (jlscp.jar): `ant build-lib'

     - Building the documentation: `ant build-doc'

     - Building the examples: `ant build-examples'

     - Building all (library, examples, documentation): `ant build-all'

     Also you may specify more then one target: `ant build-lib build-examples'


Installation
============

To install jlscp as an extension just copy jlscp.jar in the following directory:

<JDK-home>/jre/lib/ext

If you don't want to install jlscp as an extension, you may use the following
option when compiling or running an application that depends on it:

-cp .:/path/to/jlscp/jlscp.jar


Documentation
=============

The documentation is located in the doc directory. Also you can look at the
examples directory.


Running examples
================

To run the examples `cd' to examples/build directory
and use one of the following commands:

java -cp /path/to/jlscp/jlscp.jar:. Poll
java -cp /path/to/jlscp/jlscp.jar:. Events
java -cp /path/to/jlscp/jlscp.jar:. CreateChannel

Notice that on Windows platforms class path entries are separated by
semicolons (;) instead of colons (:).

1	iliev	596
2			jlscp - A java LinuxSampler control protocol API
3
4			by Grigor Iliev <gr.iliev@gmail.com>
5
6
7			This library provides client API for retrieving information and
8			configuring running LinuxSampler instance according to the LinuxSampler
9	iliev	671	control protocol version 1.0 as specified in the LSCP specification written
10			by Christian Schoenebeck (http://www.linuxsampler.org/api/lscp-1.0.html).
11	iliev	596
12			For more information about LinuxSampler visit http://www.linuxsampler.org
13
14
15			Requirements
16	iliev	671	============
17	iliev	596
18			To use jlscp you need java version 1.5.0 or higher.
19
20	iliev	671	To build the library, the documentation or the examples you need
21			JDK version 1.5.0 or higher and the Ant tool (http://ant.apache.org/).
22	iliev	596
23	iliev	671
24	iliev	596	Compilation
25	iliev	671	===========
26	iliev	596
27	iliev	671	Notice that the package contains both the source and the binary files.
28			So you can skip this section unless you want to rebuild the library or
29			you are using version downloaded from cvs.
30
31			To build the library, examples or documentation follow the next steps.
32	iliev	596
33	iliev	671	1. Set the JAVA_HOME environment variable to point to your JDK directory.
34			If the JDK is installed in /opt/jdk1.5.0 directory, this can be done
35			with the following command:
36	iliev	596
37	iliev	671	export JAVA_HOME=/opt/jdk1.5.0
38	iliev	596
39	iliev	671	(Windows users must do something like `set JAVA_HOME=c:\jdk1.5.0')
40	iliev	596
41	iliev	671	2. Choose one or more of the following options.
42	iliev	596
43	iliev	671	- Building the library (jlscp.jar): `ant build-lib'
44
45			- Building the documentation: `ant build-doc'
46
47			- Building the examples: `ant build-examples'
48
49			- Building all (library, examples, documentation): `ant build-all'
50
51			Also you may specify more then one target: `ant build-lib build-examples'
52
53
54	iliev	596	Installation
55	iliev	671	============
56	iliev	596
57			To install jlscp as an extension just copy jlscp.jar in the following directory:
58
59			<JDK-home>/jre/lib/ext
60
61			If you don't want to install jlscp as an extension, you may use the following
62			option when compiling or running an application that depends on it:
63
64			-cp .:/path/to/jlscp/jlscp.jar
65
66
67			Documentation
68	iliev	671	=============
69	iliev	596
70			The documentation is located in the doc directory. Also you can look at the
71			examples directory.
72
73
74			Running examples
75	iliev	671	================
76	iliev	596
77	iliev	671	To run the examples `cd' to examples/build directory
78	iliev	596	and use one of the following commands:
79
80			java -cp /path/to/jlscp/jlscp.jar:. Poll
81			java -cp /path/to/jlscp/jlscp.jar:. Events
82			java -cp /path/to/jlscp/jlscp.jar:. CreateChannel
83
84			Notice that on Windows platforms class path entries are separated by
85			semicolons (;) instead of colons (:).
86