]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - doc/help/man-cups-config.html
Update .gitignore to ignore compressed man pages.
[thirdparty/cups.git] / doc / help / man-cups-config.html
index 5275386efad13e615f0273fa3e4b78915bfd6e85..821ade72311991feb265fe9a9edf06c659887ec6 100644 (file)
 cups-config - get cups api, compiler, directory, and link information.
 <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
 <b>cups-config</b>
---api-version
+<i>--api-version</i>
 <br>
 <b>cups-config</b>
---build
+<i>--build</i>
 <br>
 <b>cups-config</b>
---cflags
+<i>--cflags</i>
 <br>
 <b>cups-config</b>
---datadir
+<i>--datadir</i>
 <br>
 <b>cups-config</b>
---help
+<i>--help</i>
 <br>
 <b>cups-config</b>
---ldflags
+<i>--ldflags</i>
 <br>
 <b>cups-config</b>
 [
 <i>--image</i>
 ] [
 <i>--static</i>
-] --libs
+]
+<i>--libs</i>
 <br>
 <b>cups-config</b>
---serverbin
+<i>--serverbin</i>
 <br>
 <b>cups-config</b>
---serverroot
+<i>--serverroot</i>
 <br>
 <b>cups-config</b>
---version
+<i>--version</i>
 <br>
 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
-<b>cups-config</b> is the CUPS program configuration utility. It should be
-used by application developers to determine the necessary command-line
-options for the compiler and linker, as well as determining installation
-directories for filters, configuration files, and drivers.
+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.
+All values are reported to the standard output.
 <h2 class="title"><a name="OPTIONS">Options</a></h2>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--api-version
-<br>
-<br>
-Displays the current API version (major.minor).
-<p style="margin-left: 5.0em; text-indent: -5.0em">--build
-<br>
-<br>
-Displays a system-specific build number.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--cflags
-<br>
-<br>
-Displays the necessary compiler options.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--datadir
-<br>
-<br>
-Displays the default CUPS data directory.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--help
-<br>
-<br>
-Displays the program usage message.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--image
-<br>
-<br>
-When used with <i>--libs</i>, adds the CUPS imaging library to the
-list of displayed libraries.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--ldflags
-<br>
-<br>
-Displays the necessary linker options.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--libs
-<br>
-<br>
-Displays the necessary librarys to link to.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--serverbin
-<br>
-<br>
-Displays the default CUPS binary directory,
-where filters and backends are stored.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--serverroot
-<br>
-<br>
-Displays the default CUPS configuration file directory.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--static
-<br>
-<br>
-When used with <i>--libs</i>, shows the static libraries instead
-of the default (shared) libraries.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--version
-<br>
-<br>
-Displays the full version number of the CUPS installation
-(major.minor.patch).
+The <b>cups-config</b> command accepts the following command-line options:
+<dl class="man">
+<dt><b>--api-version</b>
+<dd style="margin-left: 5.0em">Reports the current API version (major.minor).
+<dt><b>--build</b>
+<dd style="margin-left: 5.0em">Reports a system-specific build number.
+<dt><b>--cflags</b>
+<dd style="margin-left: 5.0em">Reports the necessary compiler options.
+<dt><b>--datadir</b>
+<dd style="margin-left: 5.0em">Reports the default CUPS data directory.
+<dt><b>--help</b>
+<dd style="margin-left: 5.0em">Reports the program usage message.
+<dt><b>--image</b>
+<dd style="margin-left: 5.0em">When used with <i>--libs</i>, adds the CUPS imaging library to the
+list of libraries.
+<dt><b>--ldflags</b>
+<dd style="margin-left: 5.0em">Reports the necessary linker options.
+<dt><b>--libs</b>
+<dd style="margin-left: 5.0em">Reports the necessary libraries to link to.
+<dt><b>--serverbin</b>
+<dd style="margin-left: 5.0em">Reports the default CUPS binary directory, where filters and backends are stored.
+<dt><b>--serverroot</b>
+<dd style="margin-left: 5.0em">Reports the default CUPS configuration file directory.
+<dt><b>--static</b>
+<dd style="margin-left: 5.0em">When used with <i>--libs</i>, reports the static libraries instead of the default (shared) libraries.
+<dt><b>--version</b>
+<dd style="margin-left: 5.0em">Reports the full version number of the CUPS installation (major.minor.patch).
+</dl>
+<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
+Show the currently installed version of CUPS:
+<pre class="man">
+
+    cups-config --version
+
+</pre>
+Compile a simple one-file CUPS filter:
+<pre class="man">
+
+    cc `cups-config --cflags --ldflags` -o filter filter.c \
+        `cups-config --libs`
+</pre>
 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<a href="http://localhost:631/help">http://localhost:631/help</a>
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
+CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
-Copyright 2007-2013 by Apple Inc.
+Copyright &copy; 2007-2018 by Apple Inc.
 
 </body>
 </html>