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

Diff of /linuxsampler/trunk/man/linuxsampler.1.in

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 579 by schoenebeck, Tue May 24 19:20:20 2005 UTC revision 2515 by schoenebeck, Wed Feb 5 20:45:18 2014 UTC
# Line 1  Line 1 
1  .TH "linuxsampler" "1" "24 May 2005" "linuxsampler @VERSION@" "User Manuals"  .TH "linuxsampler" "1" "05 Feb 2014" "linuxsampler @VERSION@" "User Manuals"
2  .SH NAME  .SH NAME
3  linuxsampler \- modular, streaming capable sampler  linuxsampler \- modular, streaming capable sampler
4  .SH SYNOPSIS  .SH SYNOPSIS
5  .B linuxsampler  .B linuxsampler
6  [OPTIONS]  [OPTIONS]
7  .SH DESCRIPTION  .SH DESCRIPTION
8  LinuxSampler is a modular, streaming capable sampler. The sampler is designed as  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  backend, that is server-like console application. You will need a frontend
14  application like QSampler to control the sampler and manage sampler sessions. Or  application like QSampler or JSampler/Fantasia, which provide a graphical user
15  you have to send LSCP commands manually to the sampler e.g. by using telnet or  interface (GUI) to control the sampler and manage sampler sessions conveniently.
16  netcat.  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  .SH OPTIONS
44  .IP \ --help  .IP "--help"
45  print command line help and exit  Print command line help and exit.
46  .TP  .IP "--version"
47  .IP \ --version  Print version information and exit.
48  print version and exit  .IP "--profile"
49  .TP  This option is currently not supported anymore, since the respective
50  .IP \ --profile  profiling code is currently broken. Original behavior:
51  output benchmark messages on the console  Output benchmark messages on the console. This reflects the current
52  .TP  efficiency as abstract BogoVoice count which is something like a
53  .IP \ --no-tune  theoretical limit of the amount of voices which can be rendered in the given
54  disable assembly optimizations  scenario. It does not include all aspects of the sampler, that's why this
55  .TP  value is usually higher than what you really can achieve on your box. Also
56  .IP \ --statistics  note that this value is as well dependant on what instrument patch you are
57  output voice and disk stream count periodically on the console  using and what you are playing.
58    For a compact synthesis core benchmark, independent from drivers and
59    instrument files, you might want to use the one coming with the sampler's
60    source files instead (directory "benchmarks" of the source files).
61    .IP "--no-tune"
62    Disable assembly optimizations. Usually the sampler will detect CPU specific
63    features like MMX and SSE at runtime and use an appropriate assembly
64    optimized code in that case. With that switch you can disable this feature
65    and force the sampler to skip the assembly optimizations at runtime.
66    .IP "--statistics"
67    Output voice and disk stream count periodically on the console.
68    .IP "--lscp-addr IPADDRESS"
69    Defines IP address on which the LSCP server should listen to (default: any).
70    .IP "--lscp-port NUMBER"
71    Defines TCP port on which the LSCP server should listen to (default: 8888).
72    .IP "--create-instruments-db FILE"
73    Creates a database file with the given filename which can be used by the
74    sampler's instruments database system to maintain the user's collection of
75    instrument libraries. When this argument is given, the sampler will just
76    create the instruments DB file and exit.
77    .IP "--instruments-db-location FILE"
78    Overrides the location of the database file, which the sampler shall use for
79    its instruments database system
80    (default: @config_default_instruments_db_file@).
81    .SH ENVIRONMENT VARIABLES
82    .IP "LINUXSAMPLER_PLUGIN_DIR"
83    Allows to override the directory where LinuxSampler shall look for instrument
84    editor plugins.
85    .IP "LADSPA_PATH"
86    Allows to override the directory where LinuxSampler shall look for LADSPA
87    effect plugins. Multiple paths may be given, separated by colon (":") character
88    on POSIX systems (i.e. Linux and Mac), or separated by semi-colon (";")
89    character on Windows systems.
90  .SH "SEE ALSO"  .SH "SEE ALSO"
91  qsampler(1)  .BR lscp (1),
92    .BR qsampler (1)
93  .SH "BUGS"  .SH "BUGS"
94  Report bugs to http://bugs.linuxsampler.org  Report bugs to http://bugs.linuxsampler.org
95  .SH "Author"  .SH "Author"
Legend:
Removed from v.579  
changed lines
  Added in v.2515
  ViewVC Help
Powered by ViewVC