898aeb686ed72c3a04604d9f4179326a1c7e5a2d
[jacksampler.git] / docs / jacksampler.1.doxi
1 @doxer_dnl      # emacs: -*- mode: texinfo; texinfo-open-quote: "\""; texinfo-close-quote: "\""; -*-
2 @doxer_set{rvstamp,parse_date} $Date: 2006/04/19 00:50:37 $
3 @include "jacksamplerdefs.doxi"
4 @doxer_set{title}       jacksampler - A JACK based sampler
5 @doxer_set{man-title}   JackSampler
6 @doxer_set{man-date}    @doxer_get{rvstamp}
7 @doxer_set{man-source}  jacksampler-@doxer_get{BST_VERSION}
8 @doxer_set{man-manual}  JackSampler Manual Page
9
10 @heading NAME
11 jacksampler - A JACK based sampler
12
13 @heading SYNOPSIS
14         @manb{jacksampler} [@mani{ConfigFiles...}]
15
16 @heading DESCRIPTION
17         @manb{jacksampler} is a JACK based sampler, which plays sample files depending
18         on JACK midi input.
19
20 @heading CONFIGURATION
21         JackSampler supports playing multiple instruments; the user can switch
22         the active instrument using the keyboard while JackSampler runs. For
23         each instrument, an ascii based configuration file determines which
24         sample is played for which note. JackSampler chooses the nearest sample
25         if no exact match can be found, and plays that sample slower or faster
26         so that the sample will have the right frequency which corrsponds to the
27         midi note.
28
29         For each instrument, a configuration file can contain multiple entries
30         for samples, looking like this:
31
32         sample 24 grand-piano/c1a.wav @*
33         sample 31 grand-piano/g1b.wav @*
34         sample 36 grand-piano/c2.wav @*
35         ...
36
37         There are two additional configuration parameters; one is the time
38         jacksampler uses to fade out the sample on note release in milliseconds.
39         A configuration entry could look like this:
40
41         release 100
42
43         Also there is the possibility to delay the release, so that after the
44         note off event is received, a delay occurs until the note is really
45         faded out, a sample entry looks like this:
46
47         release_delay 100
48
49         Lines starting with a # are ignored. JackSampler also interprets the
50         sustain pedal by not releasing notes if the sustain pedal is on,
51         postponing their release until its off again.
52
53 @heading KEYBOARD
54
55 @itemize{none}
56 @item @manb{1}, @manb{2}, @manb{3}, @manb{...} @*
57         Switches to the corresponding instrument. The first command line argument
58         is used as configuration for instrument 1, the second command line
59         argument is used as configuration for instrument 2, and so on.
60 @item @manb{s}, @manb{status} @*
61         Show status information.
62 @item @manb{r}, @manb{reset} @*
63         Reset all voices (release all notes) - this command may click.
64 @item @manb{q}, @manb{quit} @*
65         Quit jacksampler.
66 @done
67
68 @heading SEE ALSO
69 @longuri{http://space.twc.de/~stefan/jacksampler.php, jacksampler Website}