trunk/man/lscp.1.in

.TH "lscp" "1" "06 Feb 2014" "linuxsampler @VERSION@" "User Manuals"
.SH NAME
lscp \- the LinuxSampler Control Protocol (LSCP) shell
.SH SYNOPSIS
.B lscp
[OPTIONS]
.SH DESCRIPTION
The LSCP shell allows to control a running instance of
.BR linuxsampler (1)
from the command line. By default, the LSCP shell will assume LinuxSampler to
run on the local machine and accordingly will try to connect to LinuxSampler on
the local machine. You can however also connect to LinuxSampler instances
running on any another machine available on the network. Since LSCP is
essentially just a human readable text protocol, you can also control the
sampler simply by using
.BR telnet (1)
or
.BR netcat (1),
however since the LSCP shell is aware about the details of the LSCP protocol,
it has various advantages, i.e. it provides colored highlighting of correct,
incorrect and complete commands while typing them on the terminal, automatic
correction of obvious and trivial syntax errors, visual suggestion for
completing the current command and also supports auto completion by tab key.

You can find examples and detailed informations
about LinuxSampler's network protocol (LSCP) on
http://linuxsampler.org/documentation.html#lscp_spec

The LSCP shell is designed as thin client, that is it forwards the individual
key strokes to the sampler's LSCP server, which will actually perform all the
LSCP knowledge based operations like syntactical error checks and suggestions
for auto completions. The shell application then receives the generated
informations and handles only output formatting on the command line terminal.
This solution has one major advantage: one and the same LSCP shell can work
with multiple different LinuxSampler versions and accordingly will still handle
different LSCP versions correctly.
.SH OPTIONS
.IP "-h HOSTNAME or --host HOSTNAME"
Host name of LSCP server (default "localhost").
.IP "-p PORTNR or --port PORTNR"
TCP port number of LSCP server (default 8888).
.IP "--no-auto-correct"
Don't perform auto correction of obvious syntax errors.
.SH ENVIRONMENT VARIABLES
None (yet).
.SH "SEE ALSO"
.BR linuxsampler (1)
.SH "BUGS"
Report bugs to http://bugs.linuxsampler.org
.SH "Author"
Written by Christian Schoenebeck <cuse@users.sf.net>
1	schoenebeck	2516	.TH "lscp" "1" "06 Feb 2014" "linuxsampler @VERSION@" "User Manuals"
2	schoenebeck	2515	.SH NAME
3			lscp \- the LinuxSampler Control Protocol (LSCP) shell
4			.SH SYNOPSIS
5			.B lscp
6			[OPTIONS]
7			.SH DESCRIPTION
8			The LSCP shell allows to control a running instance of
9			.BR linuxsampler (1)
10			from the command line. By default, the LSCP shell will assume LinuxSampler to
11			run on the local machine and accordingly will try to connect to LinuxSampler on
12			the local machine. You can however also connect to LinuxSampler instances
13			running on any another machine available on the network. Since LSCP is
14			essentially just a human readable text protocol, you can also control the
15			sampler simply by using
16			.BR telnet (1)
17			or
18			.BR netcat (1),
19			however since the LSCP shell is aware about the details of the LSCP protocol,
20			it has various advantages, i.e. it provides colored highlighting of correct,
21	schoenebeck	2516	incorrect and complete commands while typing them on the terminal, automatic
22			correction of obvious and trivial syntax errors, visual suggestion for
23			completing the current command and also supports auto completion by tab key.
24	schoenebeck	2515
25			You can find examples and detailed informations
26			about LinuxSampler's network protocol (LSCP) on
27			http://linuxsampler.org/documentation.html#lscp_spec
28	schoenebeck	2516
29			The LSCP shell is designed as thin client, that is it forwards the individual
30			key strokes to the sampler's LSCP server, which will actually perform all the
31			LSCP knowledge based operations like syntactical error checks and suggestions
32			for auto completions. The shell application then receives the generated
33			informations and handles only output formatting on the command line terminal.
34			This solution has one major advantage: one and the same LSCP shell can work
35			with multiple different LinuxSampler versions and accordingly will still handle
36			different LSCP versions correctly.
37	schoenebeck	2515	.SH OPTIONS
38			.IP "-h HOSTNAME or --host HOSTNAME"
39			Host name of LSCP server (default "localhost").
40			.IP "-p PORTNR or --port PORTNR"
41			TCP port number of LSCP server (default 8888).
42	schoenebeck	2516	.IP "--no-auto-correct"
43			Don't perform auto correction of obvious syntax errors.
44	schoenebeck	2515	.SH ENVIRONMENT VARIABLES
45			None (yet).
46			.SH "SEE ALSO"
47			.BR linuxsampler (1)
48			.SH "BUGS"
49			Report bugs to http://bugs.linuxsampler.org
50			.SH "Author"
51			Written by Christian Schoenebeck <cuse@users.sf.net>