Use proper package version in man page.
[jacksampler.git] / docs / jacksampler.1
1 .\" generator: doxer.py 0.6
2 .\" generation: 2010-06-16T13:49:32
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 corrsponds 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 There are two additional configuration parameters; one is the time
58 jacksampler uses to fade out the sample on note release in milliseconds.
59 A configuration entry could look like this:
60 .br
61
62 .br
63 release 100
64 .br
65
66 .br
67 Also there is the possibility to delay the release, so that after the
68 note off event is received, a delay occurs until the note is really
69 faded out, a sample entry looks like this:
70 .br
71
72 .br
73 release_delay 100
74 .br
75
76 .br
77 Lines starting with a # are ignored. JackSampler also interprets the
78 sustain pedal by not releasing notes if the sustain pedal is on,
79 postponing their release until its off again.
80 .SH
81 KEYBOARD
82
83
84 .PP
85
86
87
88
89 .TP
90 \fB1\fP, \fB2\fP, \fB3\fP, \fB...\fP 
91 .br
92 Switches to the corresponding instrument. The first command line argument
93 is used as configuration for instrument 1, the second command line
94 argument is used as configuration for instrument 2, and so on.
95
96 .TP
97 \fBs\fP, \fBstatus\fP 
98 .br
99 Show status information.
100
101 .TP
102 \fBr\fP, \fBreset\fP 
103 .br
104 Reset all voices (release all notes) - this command may click.
105
106 .TP
107 \fBq\fP, \fBquit\fP 
108 .br
109 Quit jacksampler.
110
111 .PP
112
113
114 .SH
115 SEE ALSO
116
117
118 .PP
119 jacksampler Website (http://space.twc.de/~stefan/jacksampler.php)