aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2012-04-19 22:16:25 +0000
committerDavid Robillard <d@drobilla.net>2012-04-19 22:16:25 +0000
commit5a9659e2c57bfe4fc9e3fc9575721ba85ac8f6d9 (patch)
tree4bff53c03ea8ff2044adc50591f4ddde2588c5a1 /doc
parentaf552307b17e7b029b75fd1fbd76544f00633c69 (diff)
downloadjalv-5a9659e2c57bfe4fc9e3fc9575721ba85ac8f6d9.tar.gz
jalv-5a9659e2c57bfe4fc9e3fc9575721ba85ac8f6d9.tar.bz2
jalv-5a9659e2c57bfe4fc9e3fc9575721ba85ac8f6d9.zip
Update man pages.
git-svn-id: http://svn.drobilla.net/lad/trunk/jalv@4208 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'doc')
-rw-r--r--doc/jalv.115
-rw-r--r--doc/jalv.gtk.142
-rw-r--r--doc/jalv.gtkmm.125
-rw-r--r--doc/jalv.qt.125
4 files changed, 101 insertions, 6 deletions
diff --git a/doc/jalv.1 b/doc/jalv.1
index bc44007..9cb4982 100644
--- a/doc/jalv.1
+++ b/doc/jalv.1
@@ -1,7 +1,7 @@
-.TH JALV "18 Feb 2012"
+.TH JALV 1 "19 Apr 2012"
.SH NAME
-.B jalv \- Run an LV2 plugin as a JACK application.
+.B jalv \- Run an LV2 plugin as a JACK application (console version).
.SH SYNOPSIS
.B jalv [OPTION]... PLUGIN_URI
@@ -9,22 +9,25 @@
.SH OPTIONS
.TP
-\fB\-h\fR
+\fB\-h\fR, \fB\-\-help\fR
Print the command line options.
.TP
-\fB\-u UUID\fR
+\fB\-u UUID\fR, \fB\-\-uuid UUID\fR
UUID for Jack session restoration.
.TP
-\fB\-l DIR\fR
+\fB\-l DIR\fR, \fB\-\-load DIR\fR
Load state from state directory.
.TP
-\fB\-d DIR\fR
+\fB\-d\fR, \fB\-\-dump\fR
Dump plugin <=> UI communication.
.SH SEE ALSO
+.BR jalv.gtk(1),
+.BR jalv.gtkmm(1),
+.BR jalv.qt(2),
.BR lv2ls(1),
.BR jackd(1)
diff --git a/doc/jalv.gtk.1 b/doc/jalv.gtk.1
new file mode 100644
index 0000000..5c8c4b5
--- /dev/null
+++ b/doc/jalv.gtk.1
@@ -0,0 +1,42 @@
+.TH JALV.GTK "19 Apr 2012"
+
+.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\-h\fR, \fB\-\-help\fR
+Print the command line options.
+
+.TP
+\fB\-u UUID\fR, \fB\-\-uuid UUID\fR
+UUID for Jack session restoration.
+
+.TP
+\fB\-l DIR\fR, \fB\-\-load DIR\fR
+Load state from state directory.
+
+.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
+
+.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..530c6b0
--- /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 versionm 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..86d3114
--- /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 versionm 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>