]> git.ipfire.org Git - thirdparty/cups.git/blob - man/cups-config.1
Update .gitignore to ignore compressed man pages.
[thirdparty/cups.git] / man / cups-config.1
1 .\"
2 .\" cups-config man page for CUPS.
3 .\"
4 .\" Copyright © 2007-2019 by Apple Inc.
5 .\" Copyright © 1997-2006 by Easy Software Products.
6 .\"
7 .\" Licensed under Apache License v2.0. See the file "LICENSE" for more
8 .\" information.
9 .\"
10 .TH cups-config 1 "CUPS" "26 April 2019" "Apple Inc."
11 .SH NAME
12 cups\-config \- get cups api, compiler, directory, and link information.
13 .SH SYNOPSIS
14 .B cups\-config
15 .I \-\-api\-version
16 .br
17 .B cups\-config
18 .I \-\-build
19 .br
20 .B cups\-config
21 .I \-\-cflags
22 .br
23 .B cups\-config
24 .I \-\-datadir
25 .br
26 .B cups\-config
27 .I \-\-help
28 .br
29 .B cups\-config
30 .I \-\-ldflags
31 .br
32 .B cups\-config
33 [
34 .I \-\-image
35 ] [
36 .I \-\-static
37 ]
38 .I \-\-libs
39 .br
40 .B cups\-config
41 .I \-\-serverbin
42 .br
43 .B cups\-config
44 .I \-\-serverroot
45 .br
46 .B cups-config
47 .I \-\-version
48 .br
49 .SH DESCRIPTION
50 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.
51 All values are reported to the standard output.
52 .SH OPTIONS
53 The \fBcups-config\fR command accepts the following command-line options:
54 .TP 5
55 .B \-\-api-version
56 Reports the current API version (major.minor).
57 .TP 5
58 .B \-\-build
59 Reports a system-specific build number.
60 .TP 5
61 .B \-\-cflags
62 Reports the necessary compiler options.
63 .TP 5
64 .B \-\-datadir
65 Reports the default CUPS data directory.
66 .TP 5
67 .B \-\-help
68 Reports the program usage message.
69 .TP 5
70 .B \-\-ldflags
71 Reports the necessary linker options.
72 .TP 5
73 .B \-\-libs
74 Reports the necessary libraries to link to.
75 .TP 5
76 .B \-\-serverbin
77 Reports the default CUPS binary directory, where filters and backends are stored.
78 .TP 5
79 .B \-\-serverroot
80 Reports the default CUPS configuration file directory.
81 .TP 5
82 .B \-\-static
83 When used with \fI\-\-libs\fR, reports the static libraries instead of the default (shared) libraries.
84 .TP 5
85 .B \-\-version
86 Reports the full version number of the CUPS installation (major.minor.patch).
87 .SH EXAMPLES
88 Show the currently installed version of CUPS:
89 .nf
90
91 cups-config \-\-version
92
93 .fi
94 Compile a simple one-file CUPS filter:
95 .nf
96
97 cc `cups\-config \-\-cflags \-\-ldflags` \-o filter filter.c \\
98 `cups\-config \-\-libs`
99 .fi
100 .SH DEPRECATED OPTIONS
101 The following options are deprecated but continue to work for backwards compatibility:
102 .TP 5
103 .B \-\-image
104 Formerly used to add the CUPS imaging library to the list of libraries.
105 .SH SEE ALSO
106 .BR cups (1),
107 CUPS Online Help (http://localhost:631/help)
108 .SH COPYRIGHT
109 Copyright \[co] 2007-2019 by Apple Inc.