diff options
authorDavid Robillard <d@drobilla.net>2011-03-26 18:41:59 +0000
committerDavid Robillard <d@drobilla.net>2011-03-26 18:41:59 +0000
commit07180744e7ae0ce883f17d080fb0f736161f175e (patch)
parent334c0b1cf094c4a706723a01aac18f4de14758ca (diff)
Add man page for lv2config.
3 files changed, 70 insertions, 2 deletions
diff --git a/core.lv2/lv2config.1 b/core.lv2/lv2config.1
new file mode 100644
index 0000000..dec75cb
--- /dev/null
+++ b/core.lv2/lv2config.1
@@ -0,0 +1,64 @@
+.TH LV2CONFIG 1 "March 20, 2011"
+\fBlv2config\fP \- build an LV2 #include directory tree
+.B lv2config
+.B lv2config
+.B lv2config
+.B lv2config
+is a utility to build an LV2 #include directory tree for a set of LV2
+extensions (and the "core" specification), which must be run after
+installing extensions to allow compiling code that uses those extensions.
+This allows code to use a universal #include style based directly on
+the URI of the extension.
+For example, the
+.IR #include
+statement for the LV2 core specification which has URI
+.I http://lv2plug.in/ns/ext/lv2core
+.RS 5
+\fB#include "lv2/lv2plug.in/ns/ext/lv2core/lv2.h"\fR
+(lv2.h is simply a file that resides in the lv2core bundle, there may be
+several such files).
+.B lv2config
+can be used to build an include directory tree for all installed LV2
+extensions, or used to build a local include directory tree for projects
+that wish to include extensions in their source trees rather than use
+the system installed versions.
+.B lv2config
+must be run after an extension is installed to enable compiling against
+that extension. Its name is deliberately analogous to \fBldconfig\fP
+since the concept is similar: to use an installed extension/library,
+you must first run \fBlv2config/ldconfig\fP.
+When running without options, lv2config builds the default system
+LV2 include directories.
+If only INCLUDE_DIR is set, it builds an LV2 include directory tree
+at INCLUDE_DIR for all extensions found in $LV2_PATH.
+When both INCLUDE_DIR and BUNDLES_DIR parameters are set, it builds
+an LV2 include directory tree at INCLUDE_DIR for all extensions found
+in bundles under BUNDLES_DIR.
+\fB\-h\fR, \fB\-\-help\fR
+show usage and exit
+lv2config was written by David Robillard <d@drobilla.net>.
+This manual page was written by Jaromír Mikeš <mira.mikes@seznam.cz>,
+Alessio Treglia <alessio@debian.org>, and David Robillard <d@drobilla.net>.
diff --git a/core.lv2/manifest.ttl b/core.lv2/manifest.ttl
index e6e2ab1..08ed8d1 100644
--- a/core.lv2/manifest.ttl
+++ b/core.lv2/manifest.ttl
@@ -6,5 +6,5 @@
a doap:Project , lv2:Specification , owl:Ontology ;
lv2:minorVersion 4 ;
- lv2:microVersion 0 ;
+ lv2:microVersion 1 ;
rdfs:seeAlso <lv2.ttl> .
diff --git a/core.lv2/wscript b/core.lv2/wscript
index 0b3eb1e..2680664 100644
--- a/core.lv2/wscript
+++ b/core.lv2/wscript
@@ -5,7 +5,7 @@ from waflib.extras import autowaf as autowaf
import waflib.Options as Options
# Version of this package (even if built as a child)
# Variables for 'waf dist'
APPNAME = 'lv2core'
@@ -76,12 +76,16 @@ def build(bld):
# Bundle (data)
bld.install_files('${LV2DIR}/lv2core.lv2', 'lv2.ttl manifest.ttl')
+ # lv2config program
obj = bld(features = 'c cprogram',
source = 'lv2config.c serd-0.1.0.c',
target = 'lv2config',
install_path = '${BINDIR}',
cflags = '-std=c99')
+ # Man page
+ bld.install_files('${MANDIR}/man1', 'lv2config.1')
def dist():
import Scripting
Scripting.g_gz = 'gz'