← Back to branch summary

~brian-sidebotham/wxwidgets-cmake/wxpython-2.9.4

« back to all changes in this revision

Viewing changes to debian/wx-config.1

  • Committer: Brian Sidebotham
  • Date: 2013-08-03 14:30:08 UTC
  • Revision ID: brian.sidebotham@gmail.com-20130803143008-c7806tkych1tp6fc
Initial import into Bazaar

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/wx-config.1
 
1
.TH wx\-config 1 "29 Sep 2004" "Debian GNU/Linux" "wxWidgets"
 
2
 
 
3
.SH NAME
 
4
wx-config \- wxWidgets configuration search and query tool
 
5
 
 
6
.SH SYNOPSIS
 
7
.nh
 
8
.HP
 
9
.B wx\-config [ OPTIONS ... ] [ LIB ... ]
 
10
 
 
11
.SH DESCRIPTION
 
12
.I wx\-config
 
13
returns information about the wxWidgets libraries available on your system.
 
14
It may be used to retrieve the information you require to build applications
 
15
using these libraries.
 
16
.PP
 
17
Changing the library options you wish to use for an application previously
 
18
involved managing alternative configurations by a system dependent means.
 
19
It is now possible to select from any of the configurations installed
 
20
on your system via this single tool.  You can view all available
 
21
configurations installed in the system default prefix with the command
 
22
.I wx\-config \-\-list
 
23
and select from them by using the feature options described below.
 
24
.PP
 
25
Optional LIB arguments (comma or space separated) may be used to specify
 
26
individually the wxWidgets component libraries that you wish to use,
 
27
or to specify additional components not ususally included by default.
 
28
The magic token
 
29
.B std
 
30
may be used to import all libraries that would be used by default if none
 
31
were specified explicitly.
 
32
.br
 
33
eg.
 
34
.I wx-config --libs std,gizmos
 
35
.hy
 
36
 
 
37
.SH OPTIONS
 
38
.l
 
39
\fIwx\-config\fP accepts the following options with no restrictions on
 
40
their order as was required in previous releases:
 
41
 
 
42
.SS Installed root
 
43
These options change or query the filesystem root for the operations
 
44
listed below.
 
45
 
 
46
.TP 15
 
47
.B  \-\-prefix[=PREFIX]
 
48
Without the optional argument, the current default prefix will be
 
49
output.  If the argument is supplied, PREFIX will be searched for
 
50
matching configs in place of the default.  You may use both forms
 
51
in the same command.
 
52
.TP 15
 
53
.B  \-\-exec\-prefix[=EXEC-PREFIX]
 
54
Similar to \-\-prefix, but acts on the exec-prefix.  If not specified
 
55
will default to the value of prefix.
 
56
 
 
57
.SS Query options
 
58
These options return information about the wxWidgets default version
 
59
and and installed alternatives.
 
60
.TP 15
 
61
.B  \-\-list
 
62
List all configs in prefix and show those that match any additional
 
63
feature options given.
 
64
.TP 15
 
65
.B  \-\-release
 
66
Output the wxWidgets release number.
 
67
.TP 15
 
68
.B  \-\-version\-full
 
69
Output the wxWidgets version number in all its glory.
 
70
.TP 15
 
71
.B  \-\-basename
 
72
Output the base name of the wxWidgets libraries.
 
73
.TP 15
 
74
.B  \-\-selected-config
 
75
Output the signature of the selected wxWidgets library.
 
76
This is a string of the form "port-unicode-release-version".
 
77
 
 
78
 
 
79
.SS Feature options
 
80
These options select features which determine which wxWidgets
 
81
configuration to use.
 
82
 
 
83
.TP 15
 
84
.B  \-\-host=HOST
 
85
Specify a (posix extended) regex of host aliases to match for cross
 
86
compiled configurations.  eg. \-\-host=i586-mingw32msvc, \-\-host=.*
 
87
If unspecified, the default is to match only configurations native to
 
88
the build machine.
 
89
.TP 15
 
90
.B  \-\-toolkit=TOOLKIT
 
91
Specify a (posix extended) regex of the toolkits to match.
 
92
The toolkit is responsible for look and feel of the compiled
 
93
application.  eg. gtk, gtk2, motif, msw.
 
94
If unspecified the default is to prefer the system default toolkit,
 
95
but to match any toolkit in the absence of a stricter specification.
 
96
.TP 15
 
97
.B  \-\-version[=VERSION]
 
98
Without the optional argument, return the wxWidgets version.  If the
 
99
argument is supplied it specifies a (posix extended) regex of the
 
100
versions to match.  If unspecified the default is to prefer the system
 
101
default version, but to match any version in the absence of a stricter
 
102
specification.
 
103
.TP 15
 
104
.B  \-\-unicode[=yes|no]]
 
105
Specify the default character type for the application.
 
106
If unspecified, the system default will be preferred, but any type may
 
107
match in the absence of a stricter specification.
 
108
.TP 15
 
109
.B  \-\-debug[=yes|no]]
 
110
Specify whether to create a debug or release build for the application.
 
111
If unspecified, the system default (release) will be preferred, but any
 
112
type may match in the absence of a stricter specification.
 
113
Debug builds should never be uploaded to Debian, but are very useful
 
114
for finding certain common failure idioms.  You are encouraged to use
 
115
them during active development of applications.  They are not binary
 
116
compatible with the release libraries.
 
117
.TP 15
 
118
.B  \-\-static[=yes|no]]
 
119
Specify whether to statically or dynamically link wxWidgets libraries
 
120
into your application.  If unspecified, the system default (dynamic)
 
121
will be preferred, but any type may match in the absence of a stricter
 
122
specification.  Static linking is mainly useful still for cross ports
 
123
not natively supported by Debian, and can be hazardous in conjunction
 
124
with the gtk toolkits.  Note that static libraries are no longer supplied
 
125
in the wxGTK packages any more.
 
126
 
 
127
.SS Compiler options
 
128
These options generate output required to build an application using
 
129
a particular wxWidgets configuration.
 
130
 
 
131
.TP 15
 
132
.B  \-\-libs
 
133
Output link flags required for a \fIwxWidgets\fP application.
 
134
.TP 15
 
135
.B  \-\-cppflags
 
136
Output parameters required by the C preprocessor.
 
137
.TP 15
 
138
.B  \-\-cflags
 
139
Output parameters required by the C compiler.
 
140
.TP 15
 
141
.B  \-\-cxxflags
 
142
Output parameters required by the C++ compiler.
 
143
.TP 15
 
144
.B  \-\-cc
 
145
Output the name of the C compiler \fB$(CC)\fP.
 
146
.TP 15
 
147
.B  \-\-cxx
 
148
Output the name of the C++ compiler \fB$(CXX)\fP.
 
149
.TP 15
 
150
.B  \-\-ld
 
151
Output the linker command.
 
152
 
 
153
.SH COPYRIGHT
 
154
This manpage was written by Ron Lee <ron@debian.org> for the Debian GNU/Linux
 
155
distribution of wxWindows.  It may be freely distributed by anyone who finds
 
156
it useful.
 
157