/[svn]/linuxsampler/trunk/man/lscp.1.in
ViewVC logotype

Contents of /linuxsampler/trunk/man/lscp.1.in

Parent Directory Parent Directory | Revision Log Revision Log

Revision 2515 - (show annotations) (download)
Wed Feb 5 20:45:18 2014 UTC (10 years, 2 months ago) by schoenebeck
File size: 1435 byte(s) 
* WIP: Introducing the LSCP shell: for now, providing color
  highlighting while typing (indicating correct part bold white,
  incorrect part red, and turning green when the command is
  complete. The shell application is implemented as thin client,
  that is the parser work is performed on sampler side and the
  shell application is just providing output formatting.
* Bumped version (1.0.0.svn28).
1 .TH "lscp" "1" "05 Feb 2014" "linuxsampler @VERSION@" "User Manuals"
2 .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 incorrect and complete commands while typing them on the terminal.
22
23 You can find examples and detailed informations
24 about LinuxSampler's network protocol (LSCP) on
25 http://linuxsampler.org/documentation.html#lscp_spec
26 .SH OPTIONS
27 .IP "-h HOSTNAME or --host HOSTNAME"
28 Host name of LSCP server (default "localhost").
29 .IP "-p PORTNR or --port PORTNR"
30 TCP port number of LSCP server (default 8888).
31 .SH ENVIRONMENT VARIABLES
32 None (yet).
33 .SH "SEE ALSO"
34 .BR linuxsampler (1)
35 .SH "BUGS"
36 Report bugs to http://bugs.linuxsampler.org
37 .SH "Author"
38 Written by Christian Schoenebeck <cuse@users.sf.net>
  ViewVC Help
Powered by ViewVC