+ ChangeLog: update (0.0.17 no longer "ongoing")
[calf.git] / calfjackhost.1
blob4b2df1f1b739ee7a51bb0b5fa3f250c7ab6d15f5
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\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--preset\fR \fIname\fR
31 when preceding a plugin name, starts a plugin with specified preset
32 .TP
33 \fB--version\fR
34 prints a version string (calf some.version.number)
35 .TP
36 \fB--help\fR
37 prints a help text
38 .PP
39 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
40 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
41 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
42 (first output pair). 
44 Plugin names (should be self-explanatory):
45  * flanger
46  * filter
47  * reverb
48  * vintagedelay
49  * monosynth
50  * organ (when enabled during compilation)
51  * rotaryspeaker (when enabled during compilation)
53 .SH BUGS
54 Please send bug reports to <wdev@foltman.com>.
56 .SH EXAMPLES
58 To start monosynth with automatic connection to first system audio output, and no automatic MIDI connection, use:
60         calfjackhost monosynth !
62 (! means "connect", last "!" means "connect to output")
64 Other examples:
66         calfjackhost monosynth ! vintagedelay ! flanger ! -M 2
68 (runs monosynth into vintagedelay and vintagedelay into flanger, then to
69 output; connects monosynth's MIDI input to JACK's system:midi_capture_2)
71         calfjackhost ! reverb !
73 (takes signal from system:capture_1 and _2, puts it through reverb, and then
74 sends to system:playback_1 and _2)
76 .SH "SEE ALSO"
77 calf(7)