source: roaraudio/doc/man1/roar-config.1 @ 5765:d0e2788a0e0a

Last change on this file since 5765:d0e2788a0e0a was 5765:d0e2788a0e0a, checked in by phi, 11 years ago

small updates to help and use of static keyword for roar-config.

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--help\fR
28Show a brief help.
29
30.TP
31\fB--version\fR
32Show version of library
33
34.TP
35\fB--compare-versions VERSIONA OPERATOR VERSIONB\fR
36Compares version VERSIONA against version VERSIONB using operator OPERATOR.
37Both versions must be in dotted format (e.g. 1.0.8) or the special keyword "current".
38This keyword represents the current used version.
39
40Operator may be "eq" (equal), "ne" (not equal), "gt" (greater than), "ge" (greater than or equal),
41"lt" (less than) or "le" (less than or equal).
42
43This function is mostly useful to check for minimum required or maximum supported versions of libroar
44in configure scripts.
45
46.TP
47\fB--path NAME\fR
48Print path NAME. Examples for NAME include prefix-plugins.
49
50.TP
51\fB--product PRODUCT\fR
52Product string for --path.
53
54.TP
55\fB--provider PROVIDER\fR
56Provider string for --path.
57
58.TP
59\fB--universal\fR
60Use universal path for --path.
61
62.TP
63\fB--libs\fR
64Show linker flags (\-lxxx) needed to link library
65
66.TP
67\fB--cflags\fR
68Show compiler flags needed to link library
69
70.TP
71\fB--output-pc\fR
72Output in PC format.
73
74.TP
75\fB--output-normal\fR
76Output in "classical" format.
77
78.SH "SEE ALSO"
79\fBroartips\fR(7),
80\fBlibroar\fR(7),
81\fBRoarAudio\fR(7).
82
83.SH "HISTORY"
84
85For history information see \fBRoarAudio\fR(7).
86
87.\" ll
Note: See TracBrowser for help on using the repository browser.