summaryrefslogtreecommitdiff
path: root/man/xft-config.1.in
blob: 904c2439ac6090f4059066c6095f1987e2fdc9c4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
.\" Copyright 2005 Branden Robinson
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a copy
.\" of this document (the "Document"), to deal in the Document without
.\" restriction, including without limitation the rights to use, copy, modify,
.\" merge, publish, distribute, sublicense, and/or sell copies of the Document,
.\" and to permit persons to whom the Document is furnished to do so, subject to
.\" the following conditions:
.\"
.\" The above copyright notice and this permission notice shall be included in
.\" all copies or substantial portions of the Document.
.\"
.\" THE DOCUMENT IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
.\" THE AUTHOR(S) OR COPYRIGHT HOLDER(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE DOCUMENT OR THE USE OR OTHER
.\" DEALINGS IN THE DOCUMENT.
.TH xft-config 1 "Version @VERSION@" "Xft"
.SH NAME
xft\-config \- report Xft version, compiler, linker, and/or installation \
directory information
.SH SYNOPSIS
.B xft\-config
{
.BR \-\-exec\-prefix [ =\fIlocal_prefix\fR ]
|
.BR \-\-prefix [ =\fIlocal_prefix\fR ]
|
.B \-\-cflags
|
.B \-\-libs
} ...
.PP
.B xft\-config \-\-version
.SH DESCRIPTION
.B xft\-config
reports information of interest to users and developers about the installed
version of the X FreeType library,
.BR Xft (3).
Depending on how it is invoked,
.B xft\-config
reports the installed version of Xft, the compiler and linker flags
that are required to successfully compile and link C (or C-compatible) code
that uses the library, and/or the directories used by the GNU Autotools to
install its files.
Note that if the system's installed version of Xft came from an OS vendor
or other third party, the actual location of its files may differ from
those reported by
.BR xft\-config .
The system adminstrator can also relocate Xft's files.
.PP
If invoked without any arguments,
.B xft\-config
will print a usage message on standard error and exit.
.SH OPTIONS
.TP
.B \-\-cflags
Report the compiler flags that are required to compile code that uses Xft
symbols.
.TP
.BR \-\-exec\-prefix [ =\fIlocal_prefix\fR ]
If specified without the parameter
.IR local_prefix ,
report the file specification prefix that Xft uses for installation of
executable files.
If
.I local_prefix
is specified, it is used instead of the file specification prefix used for
installation of executable files by Xft and the value of the option
argument specified with
.BR \-\-prefix ,
if any, when compile and linker flags are reported (with
.B \-\-cflags
and
.BR \-\-libs ,
respectively).
.TP
.B \-\-libs
Report the linker flags that are required to link code that uses Xft
symbols.
.TP
.BR \-\-prefix [ =\fIlocal_prefix\fR ]
If specified without the parameter
.IR local_prefix ,
report the file specification prefix that Xft uses for installation of
files.
If
.I local_prefix
is specified, it is used instead of the file specification prefix used for
installation of files by Xft when compile and linker flags are reported
(with
.B \-\-cflags
and
.BR \-\-libs ,
respectively); also see
.BR \-\-exec\-prefix .
.TP
.B \-\-version
Report the version of the Xft library installed on the system and exit.
.SH OPERANDS
.B xft\-config
does not recognize any non-option arguments.
At least one option must be specified.
.SH "EXIT STATUS"
.TP
0
Information was successfully reported.
.TP
1
.B xft\-config
was invoked with invalid arguments, or no arguments at all.
.SH AUTHOR
.B xft\-config
was written by Keith Packard.
This manual page was written by Branden Robinson.
.SH "SEE ALSO"
.BR Xft (3)
.\" vim:set et tw=80