Merge commit 'torbenh/master'
[calf.git] / calf.7
blob296565c62f4af9c49b027c081768f62113033e8d
1 .TH CALF 7 2008-02-09
2 .SH NAME
3 calf \- a audio plugin library
4 .SH SYNOPSIS
5 calfjackhost
6 plugin
7 .B  !
8 .IR [ \ plugin
9 .B !
10 .IR ]
11 .RI [ ... ]
12 .br
13 .SH DESCRIPTION
14  The Calf project aims at providing a set of high quality open source audio plugins for musicians, possibly in many different plugin formats, so that they can be used in as many hosts as possible and in standalone mode.
15 Currently available plugins:
17     * Flanger with linear interpolation. In case "zipper noise" of basic flanger effects was driving you mad, use this one!
18     * Simple reverb with basic controls and relatively neutral sound. No dreaded metal barrel sound, at expense of higher CPU use and less time density.
19     * Multimode filter (selectable 12dB/24dB/36dB rolloff, lowpass or highpass) with inertia/smoothing for cutoff for more "analog" sound when tweaking.
20     * Vintage delay - in other words, a very simple simulation of tape echo, with a filter in a feedback loop.
21     * Simple monophonic synthesizer with 2 oscillators, multimode filter and an envelope.
22     * Optional: electric organ synthesizer and rotary speaker emulation, best used together (use "configure --enable-experimental" to enable them)
23 The plugins are available in following formats:
25     * LADSPA (all effect plugins)
26     * DSSI (both synthesizers and effects), including DSSI GUI
27     * Standalone JACK client application with GTK+-based GUI (new: it is possible to run several plugins simultaneously in one JACK client, and connect them in chains using standard JACK facilities)
28     * LV2 (experimental, SVN only, some features may not work, host support for several features may vary)
29 .SH OPTIONS
30 .TP
31 .B \ How to use Calf plugins:
33 .TP
34 .B \ * LADSPA plugins
36 Calf is installed as calf.so library in your LADSPA directory (typically
37 /usr/lib/ladspa). It means that typical LADSPA host should be able to find
38 Calf's plugins.
40 .TP
41 .B \ * DSSI plugins
43 The calf.so module is also installed in your DSSI plugin directory, which
44 means your DSSI host (like jack-dssi-host or rosegarden) should find it and
45 include its plugins in the plugin list. 
47 .TP
48 .B \ * JACK client application
50 You can also use Calf plugins as one or more separate applications, connecting
51 to other applications using JACK Audio Connection Kit (version 0.103 or newer
52 is required). To run the client, type:
54         calfjackhost monosynth !
56 (! means "connect", last "!" means "connect to output")
58 Other examples:
60         calfjackhost monosynth ! vintagedelay ! flanger !
62 (runs monosynth into vintagedelay and vintagedelay into flanger, then to
63 output)
65         calfjackhost ! reverb !
67 (takes signal from system:capture_1 and _2, puts it through reverb, and then
68 sends to system:playback_1 and _2)
70 .SH ENVIRONMENT
71 .B LADSPA_PATH
72 Path to LADSPA plugins.
74 .SH BUGS
75 LV2 support is in infant stage. Some knobs may still cause clicks/zipper noise. Plugin versions (especially LADSPA) have very poor usability comparing to standalone versions, 
76 because of platform limitations. In case of other bugs, please send bug reports to <wdev@foltman.com>, they will be fixed in order of importance.
78 .SH SEE ALSO
79 calfjackhost(1)
81 .SH AUTHOR
82 Krzysztof Foltman. Man page by Hermann Meyer, edited by Krzysztof Foltman.
84 .br
85 http://calf.sourceforge.net/