[SCM] calf/master: + man pages: first attempt at (the general page by Hermann Meyer and me, the calfjackhost page by me)

Tue May 7 15:37:03 UTC 2013

The following commit has been merged in the master branch:
commit 7038d6fc9b89c8cc7e29fddad338c72add1398e7
Author: kfoltman <kfoltman at 78b06b96-2940-0410-b7fc-879d825d01d8>
Date:   Sat Feb 9 23:16:27 2008 +0000

    + man pages: first attempt at (the general page by Hermann Meyer and me, the calfjackhost page by me)
    
    
    
    git-svn-id: https://calf.svn.sourceforge.net/svnroot/calf/trunk@124 78b06b96-2940-0410-b7fc-879d825d01d8

diff --git a/Makefile.am b/Makefile.am
index d42eb25..34e93f3 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -4,7 +4,7 @@ SUBDIRS = $(SRCDIRS)
 
 distdir = $(PACKAGE)-$(VERSION)
 
-EXTRA_DIST = COPYING.GPL TODO autogen.sh calf.glade presets.xml knob.png
+EXTRA_DIST = COPYING.GPL TODO autogen.sh calf.glade presets.xml knob.png calf.7 calfjackhost.1
 
 clean-local:
 	rm -f *~ *.old *.bak
diff --git a/calf.7 b/calf.7
new file mode 100644
index 0000000..296565c
--- /dev/null
+++ b/calf.7
@@ -0,0 +1,85 @@
+.TH CALF 7 2008-02-09
+.SH NAME
+calf \- a audio plugin library
+.SH SYNOPSIS
+calfjackhost
+plugin
+.B  !
+.IR [ \ plugin
+.B !
+.IR ]
+.RI [ ... ]
+.br
+.SH DESCRIPTION
+ 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.
+Currently available plugins:
+
+    * Flanger with linear interpolation. In case "zipper noise" of basic flanger effects was driving you mad, use this one!
+    * Simple reverb with basic controls and relatively neutral sound. No dreaded metal barrel sound, at expense of higher CPU use and less time density.
+    * Multimode filter (selectable 12dB/24dB/36dB rolloff, lowpass or highpass) with inertia/smoothing for cutoff for more "analog" sound when tweaking.
+    * Vintage delay - in other words, a very simple simulation of tape echo, with a filter in a feedback loop.
+    * Simple monophonic synthesizer with 2 oscillators, multimode filter and an envelope.
+    * Optional: electric organ synthesizer and rotary speaker emulation, best used together (use "configure --enable-experimental" to enable them)
+The plugins are available in following formats:
+
+    * LADSPA (all effect plugins)
+    * DSSI (both synthesizers and effects), including DSSI GUI
+    * 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)
+    * LV2 (experimental, SVN only, some features may not work, host support for several features may vary)
+.SH OPTIONS
+.TP
+.B \ How to use Calf plugins:
+
+.TP
+.B \ * LADSPA plugins
+
+Calf is installed as calf.so library in your LADSPA directory (typically
+/usr/lib/ladspa). It means that typical LADSPA host should be able to find
+Calf's plugins.
+
+.TP
+.B \ * DSSI plugins
+
+The calf.so module is also installed in your DSSI plugin directory, which
+means your DSSI host (like jack-dssi-host or rosegarden) should find it and
+include its plugins in the plugin list. 
+
+.TP
+.B \ * JACK client application
+
+You can also use Calf plugins as one or more separate applications, connecting
+to other applications using JACK Audio Connection Kit (version 0.103 or newer
+is required). To run the client, type:
+
+        calfjackhost monosynth !
+
+(! means "connect", last "!" means "connect to output")
+
+Other examples:
+
+        calfjackhost monosynth ! vintagedelay ! flanger !
+
+(runs monosynth into vintagedelay and vintagedelay into flanger, then to
+output)
+
+        calfjackhost ! reverb !
+
+(takes signal from system:capture_1 and _2, puts it through reverb, and then
+sends to system:playback_1 and _2)
+
+.SH ENVIRONMENT
+.B LADSPA_PATH
+Path to LADSPA plugins.
+
+.SH BUGS
+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, 
+because of platform limitations. In case of other bugs, please send bug reports to <wdev at foltman.com>, they will be fixed in order of importance.
+
+.SH SEE ALSO
+calfjackhost(1)
+
+.SH AUTHOR
+Krzysztof Foltman. Man page by Hermann Meyer, edited by Krzysztof Foltman.
+
+.br
+http://calf.sourceforge.net/
diff --git a/calfjackhost.1 b/calfjackhost.1
new file mode 100644
index 0000000..81b0333
--- /dev/null
+++ b/calfjackhost.1
@@ -0,0 +1,71 @@
+.TH calfjackhost 1 2008-01-29
+.SH NAME
+calfjackhost \- JACK wrapper for Calf plugins
+.SH SYNOPSIS
+.B calfjackhost [\fIoptions\fR] \fIplugin\fR [\fB!\fR] ...
+.br
+.SH DESCRIPTION
+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.
+
+.SH OPTIONS
+.TP
+\fB--client\fR \fIname\fR
+sets JACK client name (the name calfjackhost uses when registering in JACK)
+.TP
+\fB--input\fR \fIname\fR
+name prefix for audio inputs
+.TP
+\fB--output\fR \fIname\fR
+name prefix for audio outputs
+.TP
+\fB--midi\fR \fIname\fR
+name prefix for MIDI inputs
+.TP
+\fB--connect-midi\fR \fIclient:port\fR
+automatically connect all MIDI ports to \fIclient:port\fR
+.TP
+\fB--connect-midi\fR \fB!\fIn\fR
+automatically connect all MIDI ports to \fBsystem:midi_capture_\fIn\fR
+.TP
+\fB--preset\fR \fIname\fR
+when preceding a plugin name, starts a plugin with specified preset
+.PP
+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
+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
+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
+(first output pair). 
+
+Plugin names (should be self-explanatory):
+ * flanger
+ * filter
+ * reverb
+ * vintagedelay
+ * monosynth
+ * organ (when enabled during compilation)
+ * rotaryspeaker (when enabled during compilation)
+
+.SH BUGS
+Please send bug reports to <wdev at foltman.com>.
+
+.SH EXAMPLES
+
+To start monosynth with automatic connection to first system audio output, and no automatic MIDI connection, use:
+
+        calfjackhost monosynth !
+
+(! means "connect", last "!" means "connect to output")
+
+Other examples:
+
+        calfjackhost monosynth ! vintagedelay ! flanger ! -M 2
+
+(runs monosynth into vintagedelay and vintagedelay into flanger, then to
+output; connects monosynth's MIDI input to JACK's system:midi_capture_2)
+
+        calfjackhost ! reverb !
+
+(takes signal from system:capture_1 and _2, puts it through reverb, and then
+sends to system:playback_1 and _2)
+
+.SH "SEE ALSO"
+calf(7)

-- 
calf audio plugins packaging

