aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/jalv.185
-rw-r--r--doc/jalv.gtk.158
-rw-r--r--doc/jalv.gtkmm.125
-rw-r--r--doc/jalv.qt.125
4 files changed, 193 insertions, 0 deletions
diff --git a/doc/jalv.1 b/doc/jalv.1
new file mode 100644
index 0000000..9f65001
--- /dev/null
+++ b/doc/jalv.1
@@ -0,0 +1,85 @@
+.TH JALV 1 "18 Feb 2017"
+
+.SH NAME
+.B jalv \- Run an LV2 plugin as a JACK application (console version).
+
+.SH SYNOPSIS
+.B jalv [OPTION]... PLUGIN_URI
+
+.SH OPTIONS
+
+.TP
+\fB\-b SIZE\fR
+Buffer size for plugin <=> UI communication.
+
+.TP
+\fB\-c SYM=VAL\fR
+Set control value (e.g. "vol=1.4").
+
+.TP
+\fB\-d\fR
+Dump plugin <=> UI communication.
+
+.TP
+\fB\-h\fR
+Print the command line options.
+
+.TP
+\fB\-i\fR
+Ignore input on stdin (for background use).
+
+.TP
+\fB\-l DIR\fR
+Load state from state directory.
+
+.TP
+\fB\-n NAME\fR
+Jack client name
+
+.TP
+\fB\-p\fR
+Print control output changes to stdout.
+
+.TP
+\fB\-s\fR
+Show plugin UI if possible.
+
+This option only works when plugins provide a UI that is usable via the non-embeddable showHide interface. For other, embeddable UIs, use jalv.gtk(1) or jalv.qt(1).
+
+.TP
+\fB\-t\fR
+Print trace messages from plugin
+
+.TP
+\fB\-u UUID\fR
+UUID for Jack session restoration.
+
+.TP
+\fB\-x\fR
+Use only exact Jack client name, and exit if it is taken
+
+.SH COMMANDS
+
+The Jalv prompt supports several commands for interactive control:
+
+ \fBhelp\fR Display help message
+ \fBcontrols\fR Print settable control values
+ \fBmonitors\fR Print output control values
+ \fBpresets\fR Print available presets
+ \fBpreset URI\fR Set preset
+ \fBset INDEX VALUE\fR Set control value by port index
+ \fBset SYMBOL VALUE\fR Set control value by symbol
+ \fBSYMBOL = VALUE\fR Set control value by symbol
+
+.SH "SEE ALSO"
+.BR jalv.gtk(1),
+.BR jalv.gtkmm(1),
+.BR jalv.qt(2),
+.BR lv2ls(1),
+.BR jackd(1)
+
+.SH AUTHOR
+jalv was written by David Robillard <d@drobilla.net>
+.PP
+This manual page was written by Jaromír Mikes <mira.mikes@seznam.cz>
+and David Robillard <d@drobilla.net>
diff --git a/doc/jalv.gtk.1 b/doc/jalv.gtk.1
new file mode 100644
index 0000000..5177e1d
--- /dev/null
+++ b/doc/jalv.gtk.1
@@ -0,0 +1,58 @@
+.TH JALV.GTK "18 Feb 2017"
+
+.SH NAME
+.B jalv.gtk \- Run an LV2 plugin as a JACK application (Gtk version).
+
+.SH SYNOPSIS
+.B jalv.gtk [OPTION]... PLUGIN_URI
+
+.SH OPTIONS
+
+.TP
+\fB\-b SIZE\fR
+Buffer size for plugin <=> UI communication.
+
+.TP
+\fB\-c SYM=VAL\fR
+Set control value (e.g. "vol=1.4").
+
+.TP
+\fB\-d\fR, \fB\-\-dump\fR
+Dump plugin <=> UI communication.
+
+.TP
+\fB\-g\fR, \fB\-\-generic\-ui\fR
+Use Jalv generic UI and not the plugin UI.
+
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print the command line options.
+
+.TP
+\fB\-l DIR\fR, \fB\-\-load DIR\fR
+Load state from state directory.
+
+.TP
+\fB\-p\fR, \fB\-\-print\-controls\fR
+Print control output changes to stdout.
+
+.TP
+\fB\-t\fR, \fB\-\-trace\fR
+Print trace messages from plugin.
+
+.TP
+\fB\-u UUID\fR, \fB\-\-uuid UUID\fR
+UUID for Jack session restoration.
+
+.SH "SEE ALSO"
+.BR jalv(1),
+.BR jalv.gtkmm(1),
+.BR jalv.qt(2),
+.BR lv2ls(1),
+.BR jackd(1)
+
+.SH AUTHOR
+jalv was written by David Robillard <d@drobilla.net>
+.PP
+This manual page was written by Jaromír Mikes <mira.mikes@seznam.cz>
+and David Robillard <d@drobilla.net>
diff --git a/doc/jalv.gtkmm.1 b/doc/jalv.gtkmm.1
new file mode 100644
index 0000000..2a6ce01
--- /dev/null
+++ b/doc/jalv.gtkmm.1
@@ -0,0 +1,25 @@
+.TH JALV.GTKMM 1 "19 Apr 2012"
+
+.SH NAME
+.B jalv.gtkmm \- Run an LV2 plugin as a JACK application (Gtkmm version).
+
+.SH SYNOPSIS
+.B jalv.gtkmm PLUGIN_URI
+
+.SH DESCRIPTION
+
+This is a version of Jalv with a GUI implemented in Gtkmm. It is mainly for
+developer testing purposes, for a production ready program use jalv.gtk.
+
+.SH "SEE ALSO"
+.BR jalv(1),
+.BR jalv.gtk(1),
+.BR jalv.qt(2),
+.BR lv2ls(1),
+.BR jackd(1)
+
+.SH AUTHOR
+jalv was written by David Robillard <d@drobilla.net>
+.PP
+This manual page was written by Jaromír Mikes <mira.mikes@seznam.cz>
+and David Robillard <d@drobilla.net>
diff --git a/doc/jalv.qt.1 b/doc/jalv.qt.1
new file mode 100644
index 0000000..352835d
--- /dev/null
+++ b/doc/jalv.qt.1
@@ -0,0 +1,25 @@
+.TH JALV.QT 1 "19 Apr 2012"
+
+.SH NAME
+.B jalv.qt \- Run an LV2 plugin as a JACK application (Qt version).
+
+.SH SYNOPSIS
+.B jalv.qt PLUGIN_URI
+
+.SH DESCRIPTION
+
+This is a version of Jalv with a GUI implemented in Qt. It is mainly for
+developer testing purposes, for a production ready program use jalv.gtk.
+
+.SH "SEE ALSO"
+.BR jalv(1),
+.BR jalv.gtkmm(1),
+.BR jalv.qt(2),
+.BR lv2ls(1),
+.BR jackd(1)
+
+.SH AUTHOR
+jalv was written by David Robillard <d@drobilla.net>
+.PP
+This manual page was written by Jaromír Mikes <mira.mikes@seznam.cz>
+and David Robillard <d@drobilla.net>