summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2009-05-04 22:08:44 +0000
committerDavid Robillard <d@drobilla.net>2009-05-04 22:08:44 +0000
commitec45cbdf81af0308fa11d09c6c3ea79c3a8e792c (patch)
tree028d6e2af4e1498519d8a7c9dc20ffcb38f32b05
parent93f5c27fc747537cee263878bffb1c938e07d555 (diff)
downloadlilv-ec45cbdf81af0308fa11d09c6c3ea79c3a8e792c.tar.gz
lilv-ec45cbdf81af0308fa11d09c6c3ea79c3a8e792c.tar.bz2
lilv-ec45cbdf81af0308fa11d09c6c3ea79c3a8e792c.zip
Add man pages for included utilities.
git-svn-id: http://svn.drobilla.net/lad/trunk/slv2@1961 a436a847-0d15-0410-975c-d299462d15a1
-rw-r--r--doc/lv2_inspect.132
-rw-r--r--doc/lv2_jack_host.134
-rw-r--r--doc/lv2_list.133
-rw-r--r--doc/lv2_simple_jack_host.134
-rw-r--r--wscript1
5 files changed, 134 insertions, 0 deletions
diff --git a/doc/lv2_inspect.1 b/doc/lv2_inspect.1
new file mode 100644
index 0000000..582022b
--- /dev/null
+++ b/doc/lv2_inspect.1
@@ -0,0 +1,32 @@
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH LV2_INSPECT 1 "4 May 2009"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+.B lv2_inspect \- print information about an LV2 plugin in human-readable form.
+.SH SYNOPSIS
+.B lv2_inspect PLUGIN_URI
+
+.SH SEE ALSO
+.BR slv2(3),
+.BR lv2_list(1),
+.BR lv2_jack_host(1),
+.BR lv2_simple_jack_host(1)
+
+.SH AUTHOR
+lv2_inspect was written by Dave Robillard <dave@drobilla.net>
+.PP
+This manual page was written by Jaromír Mikes <mira.mikes@seznam.cz>
+and Dave Robillard <dave@drobilla.net>
diff --git a/doc/lv2_jack_host.1 b/doc/lv2_jack_host.1
new file mode 100644
index 0000000..06e3c71
--- /dev/null
+++ b/doc/lv2_jack_host.1
@@ -0,0 +1,34 @@
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH LV2_JACK_HOST 1 "4 May 2009"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+.B lv2_jack_host \- Run an LV2 plugin as a JACK application (with MIDI support).
+
+.SH SYNOPSIS
+.B lv2_jack_host PLUGIN_URI
+
+.SH SEE ALSO
+.BR slv2(3),
+.BR lv2_list(1),
+.BR lv2_jack_host(1),
+.BR lv2_simple_jack_host(1),
+.BR jackd(1)
+
+.SH AUTHOR
+lv2_inspect was written by Dave Robillard <dave@drobilla.net>
+.PP
+This manual page was written by Jaromír Mikes <mira.mikes@seznam.cz>
+and Dave Robillard <dave@drobilla.net>
diff --git a/doc/lv2_list.1 b/doc/lv2_list.1
new file mode 100644
index 0000000..9fddb43
--- /dev/null
+++ b/doc/lv2_list.1
@@ -0,0 +1,33 @@
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH LV2_LIST 1 "4 May 2009"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+.B lv2_list \- List all installed LV2 plugins.
+
+.SH SYNOPSIS
+.B lv2_list
+
+.SH SEE ALSO
+.BR slv2(3),
+.BR lv2_list(1),
+.BR lv2_jack_host(1),
+.BR lv2_simple_jack_host(1)
+
+.SH AUTHOR
+lv2_inspect was written by Dave Robillard <dave@drobilla.net>
+.PP
+This manual page was written by Jaromír Mikes <mira.mikes@seznam.cz>
+and Dave Robillard <dave@drobilla.net>
diff --git a/doc/lv2_simple_jack_host.1 b/doc/lv2_simple_jack_host.1
new file mode 100644
index 0000000..67dc995
--- /dev/null
+++ b/doc/lv2_simple_jack_host.1
@@ -0,0 +1,34 @@
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH LV2_SIMPLE_JACK_HOST 1 "4 May 2009"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+.B lv2_simple_jack_host \- Run an LV2 plugin as a JACK application (audio only).
+
+.SH SYNOPSIS
+.B lv2_simple_jack_host PLUGIN_URI
+
+.SH SEE ALSO
+.BR slv2(3),
+.BR lv2_list(1),
+.BR lv2_jack_host(1),
+.BR lv2_simple_jack_host(1),
+.BR jackd(1)
+
+.SH AUTHOR
+lv2_inspect was written by Dave Robillard <dave@drobilla.net>
+.PP
+This manual page was written by Jaromír Mikes <mira.mikes@seznam.cz>
+and Dave Robillard <dave@drobilla.net>
diff --git a/wscript b/wscript
index 2a94140..1fda195 100644
--- a/wscript
+++ b/wscript
@@ -142,6 +142,7 @@ def build(bld):
autowaf.build_dox(bld, 'SLV2', SLV2_VERSION, srcdir, blddir)
bld.install_files('${HTMLDIR}', blddir + '/default/doc/html/*')
bld.install_files('${MANDIR}/man3', blddir + '/default/doc/man/man3/*')
+ bld.install_files('${MANDIR}/man1', 'doc/*.1')
def shutdown():
autowaf.shutdown()