Changeset 5764:2305386b07ad in roaraudio for doc

Timestamp:

11/21/12 15:57:16 (11 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

Added support to roar-config to check versions (Closes: #336)

File:

• doc/man1/roar-config.1 (modified) (2 diffs)

doc/man1/roar-config.1

@@ -10 +10 @@
 
 roar-config \-\-version
+
+roar-config \-\-compare-versions VERSIONA OPERATOR VERSIONB
 
 roar-config [{\-\-output-pc|\-\-output-normal}] [\-\-libs] [\-\-cflags] [LIB]
@@ -25 +27 @@
 \fB--version\fR
 Show version of library
+
+.TP
+\fB--compare-versions VERSIONA OPERATOR VERSIONB\fR
+Compares version VERSIONA against version VERSIONB using operator OPERATOR.
+Both versions must be in dotted format (e.g. 1.0.8) or the special keyword "current".
+This keyword represents the current used version.
+
+Operator may be "eq" (equal), "ne" (not equal), "gt" (greater than), "ge" (greater than or equal),
+"lt" (less than) or "le" (less than or equal).
+
+This function is mostly useful to check for minimum required or maximum supported versions of libroar
+in configure scripts.
 
 .TP