trunk/man/linuxsampler.1.in

.TH "linuxsampler" "1" "18 Jan 2014" "linuxsampler @VERSION@" "User Manuals"
.SH NAME
linuxsampler \- modular, streaming capable sampler
.SH SYNOPSIS
.B linuxsampler
[OPTIONS]
.SH DESCRIPTION
LinuxSampler is a modular, streaming capable sampler. Currently it supports the
sampler formats Gigasampler/GigaStudio (.gig), SoundFont v2 (.sf2) and SFZ v2
(.sfz).

The sampler is designed as
backend, that is server-like console application. You will need a frontend
application like QSampler or JSampler/Fantasia to control the sampler and manage
sampler sessions. Or you have to send LSCP commands manually to the sampler e.g.
by using telnet or netcat. You can find examples and detailed informations about
LinuxSampler's network protocol (LSCP) on
http://linuxsampler.org/documentation.html#lscp_spec

Various audio and MIDI driver systems are supported, like ALSA (audio & MIDI),
JACK (audio & MIDI), ASIO, CoreAudio, CoreMIDI, Arts, MidiShare and MME.
LinuxSampler can also be run as virtual instrument plugin. The following
instrument plugin formats are currently supported: AudioUnit (AU), DSSI, LV2
and VST. You can also load effect plugins into the sampler. Currently only the
LADSPA plugin format is supported for sampler internal effects.

If you are using sounds in the Gigasampler/GigaStudio format, then you may also
want to install the graphical instrument editor application called "gigedit",
which can directly be launched by LinuxSampler, allowing to edit instruments in
real-time (changes immediately being audible, without needing to reload the
sound files in the sampler).
.SH OPTIONS
.IP "--help"
Print command line help and exit.
.IP "--version"
Print version information and exit.
.IP "--profile"
This option is currently not supported anymore, since the respective
profiling code is currently broken. Original behavior:
Output benchmark messages on the console. This reflects the current
efficiency as abstract BogoVoice count which is something like a
theoretical limit of the amount of voices which can be rendered in the given
scenario. It does not include all aspects of the sampler, that's why this
value is usually higher than what you really can achieve on your box. Also
note that this value is as well dependant on what instrument patch you are
using and what you are playing.
For a compact synthesis core benchmark, independent from drivers and
instrument files, you might want to use the one coming with the sampler's
source files instead (directory "benchmarks" of the source files).
.IP "--no-tune"
Disable assembly optimizations. Usually the sampler will detect CPU specific
features like MMX and SSE at runtime and use an appropriate assembly
optimized code in that case. With that switch you can disable this feature
and force the sampler to skip the assembly optimizations at runtime.
.IP "--statistics"
Output voice and disk stream count periodically on the console.
.IP "--lscp-addr IPADDRESS"
Defines IP address on which the LSCP server should listen to (default: any).
.IP "--lscp-port NUMBER"
Defines TCP port on which the LSCP server should listen to (default: 8888).
.IP "--create-instruments-db FILE"
Creates a database file with the given filename which can be used by the
sampler's instruments database system to maintain the user's collection of
instrument libraries. When this argument is given, the sampler will just
create the instruments DB file and exit.
.IP "--instruments-db-location FILE"
Overrides the location of the database file, which the sampler shall use for
its instruments database system
(default: @config_default_instruments_db_file@).
.SH ENVIRONMENT VARIABLES
.IP "LINUXSAMPLER_PLUGIN_DIR"
Allows to override the directory where LinuxSampler shall look for instrument
editor plugins.
.IP "LADSPA_PATH"
Allows to override the directory where LinuxSampler shall look for LADSPA
effect plugins. Multiple paths may be given, separated by colon (":") character
on POSIX systems (i.e. Linux and Mac), or separated by semi-colon (";")
character on Windows systems.
.SH "SEE ALSO"
qsampler(1)
.SH "BUGS"
Report bugs to http://bugs.linuxsampler.org
.SH "Author"
Written by Christian Schoenebeck <cuse@users.sf.net>
1	schoenebeck	2509	.TH "linuxsampler" "1" "18 Jan 2014" "linuxsampler @VERSION@" "User Manuals"
2	schoenebeck	579	.SH NAME
3			linuxsampler \- modular, streaming capable sampler
4			.SH SYNOPSIS
5			.B linuxsampler
6			[OPTIONS]
7			.SH DESCRIPTION
8	schoenebeck	2509	LinuxSampler is a modular, streaming capable sampler. Currently it supports the
9			sampler formats Gigasampler/GigaStudio (.gig), SoundFont v2 (.sf2) and SFZ v2
10			(.sfz).
11
12			The sampler is designed as
13	schoenebeck	579	backend, that is server-like console application. You will need a frontend
14	schoenebeck	2509	application like QSampler or JSampler/Fantasia to control the sampler and manage
15			sampler sessions. Or you have to send LSCP commands manually to the sampler e.g.
16			by using telnet or netcat. You can find examples and detailed informations about
17			LinuxSampler's network protocol (LSCP) on
18			http://linuxsampler.org/documentation.html#lscp_spec
19
20			Various audio and MIDI driver systems are supported, like ALSA (audio & MIDI),
21			JACK (audio & MIDI), ASIO, CoreAudio, CoreMIDI, Arts, MidiShare and MME.
22			LinuxSampler can also be run as virtual instrument plugin. The following
23			instrument plugin formats are currently supported: AudioUnit (AU), DSSI, LV2
24			and VST. You can also load effect plugins into the sampler. Currently only the
25			LADSPA plugin format is supported for sampler internal effects.
26
27			If you are using sounds in the Gigasampler/GigaStudio format, then you may also
28			want to install the graphical instrument editor application called "gigedit",
29			which can directly be launched by LinuxSampler, allowing to edit instruments in
30			real-time (changes immediately being audible, without needing to reload the
31			sound files in the sampler).
32	schoenebeck	579	.SH OPTIONS
33	schoenebeck	1432	.IP "--help"
34	schoenebeck	689	Print command line help and exit.
35	schoenebeck	1432	.IP "--version"
36			Print version information and exit.
37			.IP "--profile"
38	schoenebeck	2047	This option is currently not supported anymore, since the respective
39			profiling code is currently broken. Original behavior:
40	schoenebeck	689	Output benchmark messages on the console. This reflects the current
41			efficiency as abstract BogoVoice count which is something like a
42			theoretical limit of the amount of voices which can be rendered in the given
43	schoenebeck	691	scenario. It does not include all aspects of the sampler, that's why this
44			value is usually higher than what you really can achieve on your box. Also
45	schoenebeck	689	note that this value is as well dependant on what instrument patch you are
46			using and what you are playing.
47	schoenebeck	1432	For a compact synthesis core benchmark, independent from drivers and
48			instrument files, you might want to use the one coming with the sampler's
49			source files instead (directory "benchmarks" of the source files).
50			.IP "--no-tune"
51	schoenebeck	691	Disable assembly optimizations. Usually the sampler will detect CPU specific
52			features like MMX and SSE at runtime and use an appropriate assembly
53			optimized code in that case. With that switch you can disable this feature
54			and force the sampler to skip the assembly optimizations at runtime.
55	schoenebeck	1432	.IP "--statistics"
56	schoenebeck	689	Output voice and disk stream count periodically on the console.
57	schoenebeck	1432	.IP "--lscp-addr IPADDRESS"
58	schoenebeck	689	Defines IP address on which the LSCP server should listen to (default: any).
59	schoenebeck	1432	.IP "--lscp-port NUMBER"
60	schoenebeck	689	Defines TCP port on which the LSCP server should listen to (default: 8888).
61	schoenebeck	1432	.IP "--create-instruments-db FILE"
62			Creates a database file with the given filename which can be used by the
63			sampler's instruments database system to maintain the user's collection of
64			instrument libraries. When this argument is given, the sampler will just
65			create the instruments DB file and exit.
66			.IP "--instruments-db-location FILE"
67			Overrides the location of the database file, which the sampler shall use for
68			its instruments database system
69			(default: @config_default_instruments_db_file@).
70	schoenebeck	2053	.SH ENVIRONMENT VARIABLES
71			.IP "LINUXSAMPLER_PLUGIN_DIR"
72			Allows to override the directory where LinuxSampler shall look for instrument
73			editor plugins.
74	schoenebeck	2137	.IP "LADSPA_PATH"
75			Allows to override the directory where LinuxSampler shall look for LADSPA
76	schoenebeck	2509	effect plugins. Multiple paths may be given, separated by colon (":") character
77			on POSIX systems (i.e. Linux and Mac), or separated by semi-colon (";")
78			character on Windows systems.
79	schoenebeck	579	.SH "SEE ALSO"
80			qsampler(1)
81			.SH "BUGS"
82			Report bugs to http://bugs.linuxsampler.org
83			.SH "Author"
84			Written by Christian Schoenebeck <cuse@users.sf.net>