aboutsummaryrefslogtreecommitdiffstats
path: root/doc/jalv.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/jalv.1')
-rw-r--r--doc/jalv.172
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/jalv.1 b/doc/jalv.1
new file mode 100644
index 0000000..02ae649
--- /dev/null
+++ b/doc/jalv.1
@@ -0,0 +1,72 @@
+.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 "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>