source: roaraudio/doc/man1/roar-config.1 @ 5764:2305386b07ad

Last change on this file since 5764:2305386b07ad was 5764:2305386b07ad, checked in by phi, 11 years ago

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

File size: 1.8 KB
Line 
1.\" roar-config.1:
2
3.TH "roar-config" "1" "January 2010" "RoarAudio" "System User's Manual: roar-config"
4
5.SH NAME
6
7roar-config \- get information of installed RoarAudio librarys
8
9.SH SYNOPSIS
10
11roar-config \-\-version
12
13roar-config \-\-compare-versions VERSIONA OPERATOR VERSIONB
14
15roar-config [{\-\-output-pc|\-\-output-normal}] [\-\-libs] [\-\-cflags] [LIB]
16
17roar-config [\-\-product PRODUCT] [\-\-provider PROVIDER] [\-\-universal] \-\-path PATH
18
19.SH DESCRIPTION
20
21This small tool prints information about installed versions and needed flags to work
22with the RoarAudio librarys.
23
24.SH "OPTIONS"
25
26.TP
27\fB--version\fR
28Show version of library
29
30.TP
31\fB--compare-versions VERSIONA OPERATOR VERSIONB\fR
32Compares version VERSIONA against version VERSIONB using operator OPERATOR.
33Both versions must be in dotted format (e.g. 1.0.8) or the special keyword "current".
34This keyword represents the current used version.
35
36Operator may be "eq" (equal), "ne" (not equal), "gt" (greater than), "ge" (greater than or equal),
37"lt" (less than) or "le" (less than or equal).
38
39This function is mostly useful to check for minimum required or maximum supported versions of libroar
40in configure scripts.
41
42.TP
43\fB--path NAME\fR
44Print path NAME. Examples for NAME include prefix-plugins.
45
46.TP
47\fB--product PRODUCT\fR
48Product string for --path.
49
50.TP
51\fB--provider PROVIDER\fR
52Provider string for --path.
53
54.TP
55\fB--universal\fR
56Use universal path for --path.
57
58.TP
59\fB--libs\fR
60Show linker flags (\-lxxx) needed to link library
61
62.TP
63\fB--cflags\fR
64Show compiler flags needed to link library
65
66.TP
67\fB--output-pc\fR
68Output in PC format.
69
70.TP
71\fB--output-normal\fR
72Output in "classical" format.
73
74.SH "SEE ALSO"
75\fBroartips\fR(7),
76\fBlibroar\fR(7),
77\fBRoarAudio\fR(7).
78
79.SH "HISTORY"
80
81For history information see \fBRoarAudio\fR(7).
82
83.\" ll
Note: See TracBrowser for help on using the repository browser.