Support config-file relative sample paths.
[jacksampler.git] / docs / jacksampler.1
1 .\" generator: doxer.py 0.6
2 .\" generation: 2010\-11\-26T19:13:58
3 .TH "JackSampler" "1" "Wed Apr 19 00:50:37 2006" "jacksampler\-0.0.2" "JackSampler Manual Page"
4
5 .SH
6 NAME
7
8
9 .PP
10 jacksampler \- A JACK based sampler
11 .SH
12 SYNOPSIS
13
14
15 .PP
16 \fBjacksampler\fP [\fIConfigFiles...\fP]
17 .SH
18 DESCRIPTION
19
20
21 .PP
22 \fBjacksampler\fP is a JACK based sampler, which plays sample files depending
23 on JACK midi input.
24 .SH
25 CONFIGURATION
26
27
28 .PP
29 JackSampler supports playing multiple instruments; the user can switch
30 the active instrument using the keyboard while JackSampler runs. For
31 each instrument, an ascii based configuration file determines which
32 sample is played for which note. JackSampler chooses the nearest sample
33 if no exact match can be found, and plays that sample slower or faster
34 so that the sample will have the right frequency which corresponds to the
35 midi note.
36 .br
37
38 .br
39 For each instrument, a configuration file can contain multiple entries
40 for samples, looking like this:
41 .br
42
43 .br
44 sample 24 grand\-piano/c1a.wav
45 .br
46
47 sample 31 grand\-piano/g1b.wav
48 .br
49
50 sample 36 grand\-piano/c2.wav
51 .br
52
53 ...
54 .br
55
56 .br
57 For relative paths, files are assumed to be in the same directory the
58 config file is stored in; for absolute paths, the full path is used
59 for loading the sample.
60 .br
61
62 .br
63 There are two additional configuration parameters; one is the time
64 jacksampler uses to fade out the sample on note release in milliseconds.
65 A configuration entry could look like this:
66 .br
67
68 .br
69 release 100
70 .br
71
72 .br
73 Also there is the possibility to delay the release, so that after the
74 note off event is received, a delay occurs until the note is really
75 faded out, a sample entry looks like this:
76 .br
77
78 .br
79 release_delay 100
80 .br
81
82 .br
83 Lines starting with a # are ignored. JackSampler also interprets the
84 sustain pedal by not releasing notes if the sustain pedal is on,
85 postponing their release until its off again.
86 .SH
87 KEYBOARD
88
89
90 .PP
91
92
93
94
95 .TP
96 \fB1\fP, \fB2\fP, \fB3\fP, \fB...\fP 
97 .br
98 Switches to the corresponding instrument. The first command line argument
99 is used as configuration for instrument 1, the second command line
100 argument is used as configuration for instrument 2, and so on.
101
102 .TP
103 \fBs\fP, \fBstatus\fP 
104 .br
105 Show status information.
106
107 .TP
108 \fBr\fP, \fBreset\fP 
109 .br
110 Reset all voices (release all notes) \- this command may click.
111
112 .TP
113 \fBq\fP, \fBquit\fP 
114 .br
115 Quit jacksampler.
116
117 .PP
118
119
120 .SH
121 SEE ALSO
122
123
124 .PP
125 jacksampler Website (http://space.twc.de/~stefan/jacksampler.php)