Greatly simplify the man page handling.
[thirdparty/cups.git] / doc / help / man-cups-config.html
1 <!DOCTYPE HTML>
2 <html>
3 <!-- SECTION: Man Pages -->
4 <head>
5         <link rel="stylesheet" type="text/css" href="../cups-printable.css">
6         <title>cups-config(1)</title>
7 </head>
8 <body>
9 <h1 class="title">cups-config(1)</h1>
10 <h2 class="title"><a name="NAME">Name</a></h2>
11 cups-config - get cups api, compiler, directory, and link information.
12 <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
13 <b>cups-config</b>
14 <i>--api-version</i>
15 <br>
16 <b>cups-config</b>
17 <i>--build</i>
18 <br>
19 <b>cups-config</b>
20 <i>--cflags</i>
21 <br>
22 <b>cups-config</b>
23 <i>--datadir</i>
24 <br>
25 <b>cups-config</b>
26 <i>--help</i>
27 <br>
28 <b>cups-config</b>
29 <i>--ldflags</i>
30 <br>
31 <b>cups-config</b>
32 [
33 <i>--image</i>
34 ] [
35 <i>--static</i>
36 ]
37 <i>--libs</i>
38 <br>
39 <b>cups-config</b>
40 <i>--serverbin</i>
41 <br>
42 <b>cups-config</b>
43 <i>--serverroot</i>
44 <br>
45 <b>cups-config</b>
46 <i>--version</i>
47 <br>
48 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
49 The <b>cups-config</b> command allows application developers to determine the necessary command-line options for the compiler and linker, as well as the installation directories for filters, configuration files, and drivers.
50 All values are reported to the standard output.
51 <h2 class="title"><a name="OPTIONS">Options</a></h2>
52 The <b>cups-config</b> command accepts the following command-line options:
53 <dl class="man">
54 <dt><b>--api-version</b>
55 <dd style="margin-left: 5.0em">Reports the current API version (major.minor).
56 <dt><b>--build</b>
57 <dd style="margin-left: 5.0em">Reports a system-specific build number.
58 <dt><b>--cflags</b>
59 <dd style="margin-left: 5.0em">Reports the necessary compiler options.
60 <dt><b>--datadir</b>
61 <dd style="margin-left: 5.0em">Reports the default CUPS data directory.
62 <dt><b>--help</b>
63 <dd style="margin-left: 5.0em">Reports the program usage message.
64 <dt><b>--ldflags</b>
65 <dd style="margin-left: 5.0em">Reports the necessary linker options.
66 <dt><b>--libs</b>
67 <dd style="margin-left: 5.0em">Reports the necessary libraries to link to.
68 <dt><b>--serverbin</b>
69 <dd style="margin-left: 5.0em">Reports the default CUPS binary directory, where filters and backends are stored.
70 <dt><b>--serverroot</b>
71 <dd style="margin-left: 5.0em">Reports the default CUPS configuration file directory.
72 <dt><b>--static</b>
73 <dd style="margin-left: 5.0em">When used with <i>--libs</i>, reports the static libraries instead of the default (shared) libraries.
74 <dt><b>--version</b>
75 <dd style="margin-left: 5.0em">Reports the full version number of the CUPS installation (major.minor.patch).
76 </dl>
77 <h2 class="title"><a name="EXAMPLES">Examples</a></h2>
78 Show the currently installed version of CUPS:
79 <pre class="man">
80
81     cups-config --version
82
83 </pre>
84 Compile a simple one-file CUPS filter:
85 <pre class="man">
86
87     cc `cups-config --cflags --ldflags` -o filter filter.c \
88         `cups-config --libs`
89 </pre>
90 <h2 class="title"><a name="DEPRECATED_OPTIONS">Deprecated Options</a></h2>
91 The following options are deprecated but continue to work for backwards compatibility:
92 <dl class="man">
93 <dt><b>--image</b>
94 <dd style="margin-left: 5.0em">Formerly used to add the CUPS imaging library to the list of libraries.
95 </dl>
96 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
97 <b>cups</b>(1),
98 CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
99 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
100 Copyright &copy; 2007-2019 by Apple Inc.
101
102 </body>
103 </html>