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