source: roaraudio/doc/man1/roar-config.1 @ 5828:d981716ace28

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

added a way to list all known paths

File size: 2.2 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 libraries
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|\-\-list\-path}
18
19roar-config \-\-render\-path PATH
20
21.SH DESCRIPTION
22
23This small tool prints information about installed versions and needed flags to work
24with the RoarAudio libraries.
25
26.SH "OPTIONS"
27
28.TP
29\fB--help\fR
30Show a brief help.
31
32.TP
33\fB--version\fR
34Show version of library
35
36.TP
37\fB--compare-versions VERSIONA OPERATOR VERSIONB\fR
38Compares version VERSIONA against version VERSIONB using operator OPERATOR.
39Both versions must be in dotted format (e.g. 1.0.8) or the special keyword "current".
40This keyword represents the current used version.
41
42Operator may be "eq" (equal), "ne" (not equal), "gt" (greater than), "ge" (greater than or equal),
43"lt" (less than) or "le" (less than or equal).
44
45This function is mostly useful to check for minimum required or maximum supported versions of libroar
46in configure scripts.
47
48.TP
49\fB--path NAME\fR
50Print path NAME. Examples for NAME include prefix-plugins.
51
52.TP
53\fB--list-path\fR
54List all known paths with corresponding values.
55
56.TP
57\fB--product PRODUCT\fR
58Product string for \-\-path and \-\-list\-path.
59
60.TP
61\fB--provider PROVIDER\fR
62Provider string for \-\-path and \-\-list\-path.
63
64.TP
65\fB--universal\fR
66Use universal path for \-\-path and \-\-list\-path.
67
68.TP
69\fB--render-path PATH\fR
70Render the given path. The path can be any absolute path, a path relative to the user's home directory
71(prefixed with ~/) or a path relative to a path as used by --path (prefixed with $ and path name).
72
73.TP
74\fB--libs\fR
75Show linker flags (\-lxxx) needed to link library
76
77.TP
78\fB--cflags\fR
79Show compiler flags needed to link library
80
81.TP
82\fB--output-pc\fR
83Output in PC format.
84
85.TP
86\fB--output-normal\fR
87Output in "classical" format.
88
89.SH "SEE ALSO"
90\fBroartips\fR(7),
91\fBlibroar\fR(7),
92\fBRoarAudio\fR(7).
93
94.SH "HISTORY"
95
96For history information see \fBRoarAudio\fR(7).
97
98.\" ll
Note: See TracBrowser for help on using the repository browser.