Greatly simplify the man page handling.
[thirdparty/cups.git] / doc / help / man-cups-config.html
CommitLineData
c277f98c 1<!DOCTYPE HTML>
94436c5a
MS
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>
11cups-config - get cups api, compiler, directory, and link information.
12<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
c277f98c 13<b>cups-config</b>
c390f212 14<i>--api-version</i>
94436c5a 15<br>
c277f98c 16<b>cups-config</b>
c390f212 17<i>--build</i>
94436c5a 18<br>
c277f98c 19<b>cups-config</b>
c390f212 20<i>--cflags</i>
94436c5a 21<br>
c277f98c 22<b>cups-config</b>
c390f212 23<i>--datadir</i>
94436c5a 24<br>
c277f98c 25<b>cups-config</b>
c390f212 26<i>--help</i>
94436c5a 27<br>
c277f98c 28<b>cups-config</b>
c390f212 29<i>--ldflags</i>
94436c5a 30<br>
c277f98c
MS
31<b>cups-config</b>
32[
33<i>--image</i>
34] [
35<i>--static</i>
c390f212
MS
36]
37<i>--libs</i>
94436c5a 38<br>
c277f98c 39<b>cups-config</b>
c390f212 40<i>--serverbin</i>
94436c5a 41<br>
c277f98c 42<b>cups-config</b>
c390f212 43<i>--serverroot</i>
94436c5a 44<br>
c277f98c 45<b>cups-config</b>
c390f212 46<i>--version</i>
94436c5a
MS
47<br>
48<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
c390f212
MS
49The <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.
50All values are reported to the standard output.
94436c5a 51<h2 class="title"><a name="OPTIONS">Options</a></h2>
c390f212 52The <b>cups-config</b> command accepts the following command-line options:
2909c66c 53<dl class="man">
c390f212
MS
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.
c390f212
MS
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).
2909c66c 76</dl>
c390f212
MS
77<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
78Show the currently installed version of CUPS:
79<pre class="man">
80
81 cups-config --version
82
83</pre>
84Compile 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>
87030afb
MS
90<h2 class="title"><a name="DEPRECATED_OPTIONS">Deprecated Options</a></h2>
91The 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>
94436c5a 96<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
87030afb 97<b>cups</b>(1),
c390f212 98CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
94436c5a 99<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
87030afb 100Copyright &copy; 2007-2019 by Apple Inc.
94436c5a
MS
101
102</body>
103</html>