+ VU Meter: fix pixel off-by-ones
[calf.git] / calfjackhost.1
blobc2d35ebf1ccb5d24e433dd3c267f360c25c8a464
1 .TH calfjackhost 1 2008-01-29
2 .SH NAME
3 calfjackhost \- JACK wrapper for Calf plugins
4 .SH SYNOPSIS
5 .B calfjackhost [\fIoptions\fR] \fIplugin[:preset]\fR [\fB!\fR] ...
6 .br
7 .SH DESCRIPTION
8 Calf JACK host application provides a way to use Calf plugins directly, without need for any external host application. It also offers best GUI functionality (using GTK+ 2 widget set), as there is no restrictive plugin standard getting in a way between GUI and audio processing code.
10 .SH OPTIONS
11 .TP
12 \fB--client\fR \fIname\fR
13 sets JACK client name (the name calfjackhost uses when registering in JACK)
14 .TP
15 \fB--input\fR \fIname\fR
16 name prefix for audio inputs
17 .TP
18 \fB--output\fR \fIname\fR
19 name prefix for audio outputs
20 .TP
21 \fB--midi\fR \fIname\fR
22 name prefix for MIDI inputs
23 .TP
24 \fB--connect-midi\fR \fIclient:port\fR
25 automatically connect all MIDI ports to \fIclient:port\fR
26 .TP
27 \fB--connect-midi\fR \fB!\fIn\fR
28 automatically connect all MIDI ports to \fBsystem:midi_capture_\fIn\fR
29 .TP
30 \fB--version\fR
31 prints a version string (calf some.version.number)
32 .TP
33 \fB--help\fR
34 prints a help text
35 .PP
36 An exclamation mark (!) in place of plugin name means automatic connection. If "!" is placed before the first plugin name, the first plugin has its inputs connected to \fBsystem:capture_1\fR
37 and \fBsystem:capture_2\fR. If it's placed between plugin names, those plugins are connected together (first plugin's output is connected to second
38 plugin's input). If it's placed after last plugin name, that plugin's audio outputs are connected to \fBsystem:playback_1\fR and \fBsystem:playback_2\fR
39 (first output pair). 
41 Plugin names (should be self-explanatory):
42  * flanger
43  * filter
44  * reverb
45  * vintagedelay
46  * monosynth
47  * multichorus (chorus effect with multiple voices)
48  * compressor (Thor Harald Johansen's dynamic compressor)
49  * organ (polyphonic synthesizer emulating tonewheel or solid state organs)
50  * rotaryspeaker (not a faithful emulation, not even close)
52 .SH BUGS
53 Please send bug reports to <wdev@foltman.com>.
55 .SH EXAMPLES
57 To start monosynth with automatic connection to first system audio output, and no automatic MIDI connection, use:
59         calfjackhost monosynth !
61 (! means "connect", last "!" means "connect to output")
63 Other examples:
65         calfjackhost monosynth ! vintagedelay ! flanger ! -M 2
67 (runs monosynth into vintagedelay and vintagedelay into flanger, then to
68 output; connects monosynth's MIDI input to JACK's system:midi_capture_2)
70         calfjackhost "monosynth:Fat Bass"
72 (runs monosynth with a Fat Bass preset into monosynth, does not autoconnect)
74         calfjackhost ! reverb !
76 (takes signal from system:capture_1 and _2, puts it through reverb, and then
77 sends to system:playback_1 and _2)
79 .SH "SEE ALSO"
80 calf(7)