]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - man/cups-config.man
More man page modernization.
[thirdparty/cups.git] / man / cups-config.man
index 69bad3c2e7568e81580ade4c2ef034e50121536f..c020d4acc48b18cf51fcd448ca48a12435f62f46 100644 (file)
 .\"
 .\" "$Id$"
 .\"
-.\"   cups-config man page for CUPS.
+.\" cups-config man page for CUPS.
 .\"
-.\"   Copyright 2007-2013 by Apple Inc.
-.\"   Copyright 1997-2006 by Easy Software Products.
+.\" Copyright 2007-2014 by Apple Inc.
+.\" Copyright 1997-2006 by Easy Software Products.
 .\"
-.\"   These coded instructions, statements, and computer programs are the
-.\"   property of Apple Inc. and are protected by Federal copyright
-.\"   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
-.\"   which should have been included with this file.  If this file is
-.\"   file is missing or damaged, see the license at "http://www.cups.org/".
+.\" These coded instructions, statements, and computer programs are the
+.\" property of Apple Inc. and are protected by Federal copyright
+.\" law.  Distribution and use rights are outlined in the file "LICENSE.txt"
+.\" which should have been included with this file.  If this file is
+.\" file is missing or damaged, see the license at "http://www.cups.org/".
 .\"
-.TH cups-config 1 "CUPS" "23 October 2008" "Apple Inc."
+.TH cups-config 1 "CUPS" "15 April 2014" "Apple Inc."
 .SH NAME
-cups-config \- get cups api, compiler, directory, and link information.
+cups\-config \- get cups api, compiler, directory, and link information.
 .SH SYNOPSIS
-.B cups-config
---api-version
+.B cups\-config
+.I \-\-api\-version
 .br
-.B cups-config
---build
+.B cups\-config
+.I \-\-build
 .br
-.B cups-config
---cflags
+.B cups\-config
+.I \-\-cflags
 .br
-.B cups-config
---datadir
+.B cups\-config
+.I \-\-datadir
 .br
-.B cups-config
---help
+.B cups\-config
+.I \-\-help
 .br
-.B cups-config
---ldflags
+.B cups\-config
+.I \-\-ldflags
 .br
-.B cups-config
+.B cups\-config
 [
-.I --image
+.I \-\-image
 ] [
-.I --static
-] --libs
+.I \-\-static
+]
+.I \-\-libs
 .br
-.B cups-config
---serverbin
+.B cups\-config
+.I \-\-serverbin
 .br
-.B cups-config
---serverroot
+.B cups\-config
+.I \-\-serverroot
 .br
 .B cups-config
---version
+.I \-\-version
 .br
 .SH DESCRIPTION
-\fBcups-config\fR 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 \fBcups-config\fR 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.
 .SH OPTIONS
+The \fBcups-config\fR command accepts the following command-line options:
 .TP 5
---api-version
-.br
-Displays the current API version (major.minor).
+.B \-\-api-version
+Reports the current API version (major.minor).
 .TP 5
---build
-.br
-Displays a system-specific build number.
+.B \-\-build
+Reports a system-specific build number.
 .TP 5
---cflags
-.br
-Displays the necessary compiler options.
+.B \-\-cflags
+Reports the necessary compiler options.
 .TP 5
---datadir
-.br
-Displays the default CUPS data directory.
+.B \-\-datadir
+Reports the default CUPS data directory.
 .TP 5
---help
-.br
-Displays the program usage message.
+.B \-\-help
+Reports the program usage message.
 .TP 5
---image
-.br
-When used with \fI--libs\fR, adds the CUPS imaging library to the
-list of displayed libraries.
+.B \-\-image
+When used with \fI\-\-libs\fR, adds the CUPS imaging library to the
+list of libraries.
 .TP 5
---ldflags
-.br
-Displays the necessary linker options.
+.B \-\-ldflags
+Reports the necessary linker options.
 .TP 5
---libs
-.br
-Displays the necessary librarys to link to.
+.B \-\-libs
+Reports the necessary libraries to link to.
 .TP 5
---serverbin
-.br
-Displays the default CUPS binary directory,
-where filters and backends are stored.
+.B \-\-serverbin
+Reports the default CUPS binary directory, where filters and backends are stored.
 .TP 5
---serverroot
-.br
-Displays the default CUPS configuration file directory.
+.B \-\-serverroot
+Reports the default CUPS configuration file directory.
 .TP 5
---static
-.br
-When used with \fI--libs\fR, shows the static libraries instead
-of the default (shared) libraries.
+.B \-\-static
+When used with \fI\-\-libs\fR, reports the static libraries instead of the default (shared) libraries.
 .TP 5
---version
-.br
-Displays the full version number of the CUPS installation
-(major.minor.patch).
+.B \-\-version
+Reports the full version number of the CUPS installation (major.minor.patch).
+.SH EXAMPLES
+Show the currently installed version of CUPS:
+.nf
+
+    cups-config \-\-version
+
+.fi
+Compile a simple one-file CUPS filter:
+.nf
+
+    cc `cups\-config \-\-cflags \-\-ldflags` \-o filter filter.c \\
+        `cups\-config \-\-libs`
+.fi
 .SH SEE ALSO
-http://localhost:631/help
+.BR cups (1),
+CUPS Online Help (http://localhost:631/help)
 .SH COPYRIGHT
-Copyright 2007-2013 by Apple Inc.
+Copyright \[co] 2007-2014 by Apple Inc.
 .\"
 .\" End of "$Id$".
 .\"