| 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 | |
| 74 | .SS Feature options |
| 75 | These options select features which determine which wxWidgets |
| 76 | configuration to use. |
| 77 | |
| 78 | .TP 15 |
| 79 | .B \-\-host=HOST |
| 80 | Specify a (posix extended) regex of host aliases to match for cross |
| 81 | compiled configurations. eg. \-\-host=i586-mingw32msvc, \-\-host=.* |
| 82 | If unspecified, the default is to match only configurations native to |
| 83 | the build machine. |
| 84 | .TP 15 |
| 85 | .B \-\-toolkit=TOOLKIT |
| 86 | Specify a (posix extended) regex of the toolkits to match. |
| 87 | The toolkit is responsible for look and feel of the compiled |
| 88 | application. eg. gtk, gtk2, motif, msw. |
| 89 | If unspecified the default is to prefer the system default toolkit, |
| 90 | but to match any toolkit in the absence of a stricter specification. |
| 91 | .TP 15 |
| 92 | .B \-\-version[=VERSION] |
| 93 | Without the optional argument, return the wxWidgets version. If the |
| 94 | argument is supplied it specifies a (posix extended) regex of the |
| 95 | versions to match. If unspecified the default is to prefer the system |
| 96 | default version, but to match any version in the absence of a stricter |
| 97 | specification. |
| 98 | .TP 15 |
| 99 | .B \-\-unicode[=yes|no]] |
| 100 | Specify the default character type for the application. |
| 101 | If unspecified, the system default will be preferred, but any type may |
| 102 | match in the absence of a stricter specification. |
| 103 | .TP 15 |
| 104 | .B \-\-debug[=yes|no]] |
| 105 | Specify whether to create a debug or release build for the application. |
| 106 | If unspecified, the system default (release) will be preferred, but any |
| 107 | type may match in the absence of a stricter specification. |
| 108 | Debug builds should never be uploaded to Debian, but are very useful |
| 109 | for finding certain common failure idioms. You are encouraged to use |
| 110 | them during active development of applications. They are not binary |
| 111 | compatible with the release libraries. |
| 112 | .TP 15 |
| 113 | .B \-\-static[=yes|no]] |
| 114 | Specify whether to statically or dynamically link wxWidgets libraries |
| 115 | into your application. If unspecified, the system default (dynamic) |
| 116 | will be preferred, but any type may match in the absence of a stricter |
| 117 | specification. Static linking is mainly useful still for cross ports |
| 118 | not natively supported by Debian, and can be hazardous in conjunction |
| 119 | with the gtk toolkits. |
| 120 | |
| 121 | .SS Compiler options |
| 122 | These options generate output required to build an application using |
| 123 | a particular wxWidgets configuration. |
| 124 | |
| 125 | .TP 15 |
| 126 | .B \-\-libs |
| 127 | Output link flags required for a \fIwxWidgets\fP application. |
| 128 | .TP 15 |
| 129 | .B \-\-cppflags |
| 130 | Output parameters required by the C preprocessor. |
| 131 | .TP 15 |
| 132 | .B \-\-cflags |
| 133 | Output parameters required by the C compiler. |
| 134 | .TP 15 |
| 135 | .B \-\-cxxflags |
| 136 | Output parameters required by the C++ compiler. |
| 137 | .TP 15 |
| 138 | .B \-\-cc |
| 139 | Output the name of the C compiler \fB$(CC)\fP. |
| 140 | .TP 15 |
| 141 | .B \-\-cxx |
| 142 | Output the name of the C++ compiler \fB$(CXX)\fP. |
| 143 | .TP 15 |
| 144 | .B \-\-ld |
| 145 | Output the linker command. |
| 146 | |
| 147 | .SH COPYRIGHT |
| 148 | This manpage was written by Ron Lee <ron@debian.org> for the Debian GNU/Linux |
| 149 | distribution of wxWindows. It may be freely distributed by anyone who finds |
| 150 | it useful. |
| 151 | |