icuSources/config/icu-config.1.in

   1 .\" Hey, Emacs! This is -*-nroff-*- you know...
   2 .\"
   3 .\" icu-config.1: manual page for the icu-config utility
   4 .\"
   5 .\" Copyright (C) 2002-2008 IBM, Inc. and others.
   6 .\"
   7 .\" Based on  Yves Arrouye's pkgdata page <yves@arrouye.net>
   8 .\" Modified by Steven R. Loomis <srl@jtcsv.com>.
   9 .\" With help from http://www.igpm.rwth-aachen.de/~albrecht/manpage.html
  10
  11 .TH ICU-CONFIG 1 "17 May 2004" "ICU MANPAGE" "ICU @VERSION@ Manual"
  12 .\".Dd "17 May 2004"
  13 .\".Dt ICU-CONFIG 1
  14 .\".Os
  15
  16 .SH NAME
  17 .B icu-config
  18 \- output ICU build options
  19 .SH SYNOPSIS
  20 .B icu-config
  21 [
  22 .BI "\-\-bindir"
  23 ]
  24 [
  25 .BI "\-\-cc"
  26 ]
  27 [
  28 .BI "\-\-cflags"
  29 ]
  30 [
  31 .BI "\-\-cppflags"
  32 ]
  33 [
  34 .BI "\-\-cppflags\-searchpath"
  35 ]
  36 [
  37 .BI "\-\-cxx"
  38 ]
  39 [
  40 .BI "\-\-cxxflags"
  41 ]
  42 [
  43 .BI "\-\-detect\-prefix"
  44 ]
  45 [
  46 .BI "\-\-exec\-prefix"
  47 ]
  48 [
  49 .BI "\-\-exists"
  50 ]
  51 [
  52 .BI "\-\-help\fP, \fB\-?\fP,\fB"
  53 .BI "\-\-usage"
  54 ]
  55 [
  56 .BI "\-\-icudata"
  57 ]
  58 [
  59 .BI "\-\-icudata\-install\-dir"
  60 ]
  61 [
  62 .BI "\-\-icudata\-mode"
  63 ]
  64 [
  65 .BI "\-\-icudatadir"
  66 ]
  67 [
  68 .BI "\-\-invoke"
  69 ]
  70 [
  71 .BI "\-\-invoke=" "prog"
  72 ]
  73 [
  74 .BI "\-\-ldflags"
  75 ]
  76 [
  77 .BI "\-\-ldflags\-layout"
  78 ]
  79 [
  80 .BI "\-\-ldflags\-libsonly"
  81 ]
  82 [
  83 .BI "\-\-ldflags\-searchpath"
  84 ]
  85 [
  86 .BI "\-\-ldflags\-system"
  87 ]
  88 [
  89 .BI "\-\-ldflags\-icuio"
  90 ]
  91 [
  92 .BI "\-\-mandir"
  93 ]
  94 [
  95 .BI "\-\-prefix"
  96 ]
  97 [
  98 .BI "\-\-prefix=" "prefix"
  99 ]
 100 [
 101 .BI "\-\-sbindir"
 102 ]
 103 [
 104 .BI "\-\-shared\-datadir"
 105 ]
 106 [
 107 .BI "\-\-sysconfdir"
 108 ]
 109 [
 110 .BI "\-\-unicode\-version"
 111 ]
 112 [
 113 .BI "\-\-version"
 114 ]
 115 [
 116 .BI "\-\-incfile"
 117 ]
 118
 119
 120
 121 .SH DESCRIPTION
 122 .B icu-config
 123 simplifies the task of building and linking against ICU as compared to
 124 manually configuring user makefiles or equivalent.  Because
 125 .B icu-config
 126 is an executable script, it also solves the problem of locating the ICU
 127 libraries and headers, by allowing the system PATH to locate it.
 128 .SH EXAMPLES
 129 .B icu-config
 130 can be used without a makefile. The command line below is sufficient for
 131 building a single-file c++ program against ICU. (For example, \fBicu/source/samples/props/props.cpp\fR)
 132 .PP
 133 .RS
 134 `icu-config --cxx --cxxflags --cppflags --ldflags` -o props props.cpp
 135 .RE
 136 .PP
 137 More commonly,
 138 .B icu-config
 139 will be called from within a makefile, and used to set up variables. The
 140 following example also builds the \fIprops\fR example.
 141 .PP
 142 .RS
 143 CC=$(shell icu-config --cc)
 144
 145 CXX=$(shell icu-config --cxx)
 146
 147 CPPFLAGS=$(shell icu-config --cppflags)
 148
 149 CXXFLAGS=$(shell icu-config --cxxflags)
 150
 151 LDFLAGS =$(shell icu-config --ldflags)
 152
 153 all: props
 154
 155 props.o: props.cpp
 156 .RE
 157 .PP
 158 make(1) will automatically use the above variables.
 159 .SH OPTIONS
 160 .TP
 161 .BI "\-\-bindir"
 162 Prints the binary (executable) directory path. Normally equivalent to 'bin'.
 163 ICU user-executable applications and scripts are found here.
 164 .TP
 165 .BI "\-\-cc"
 166 Print the C compiler used.  Equivalent to the $(CC) Makefile variable.
 167 .TP
 168 .BI "\-\-cflags"
 169 Print the C compiler flags. Equivalent to the $(CFLAGS) Makefile variable.
 170 Does NOT include preprocessor directives such as include path or defined symbols. Examples include debugging (\-g) and optimization flags
 171 .TP
 172 .BI "\-\-cppflags"
 173 Print the C preprocessor flags. Equivalent to the $(CPPFLAGS) Makefile variable. Examples are \-I include paths  and \-D define directives.
 174 .TP
 175 .BI "\-\-cppflags\-searchpath"
 176 Print the C preprocessor flags, as above but only \-I search paths.
 177 .TP
 178 .BI "\-\-cxx"
 179 Print the C++ compiler. Equivalent to the $(CXX) Makefile variable.
 180 .TP
 181 .BI "\-\-cxxflags"
 182 Print the C++ compiler flags. Equivalent to the $(CXXFLAGS) Makefile variable.
 183 .TP
 184 .BI "\-\-detect\-prefix"
 185 If ICU has been moved from its installed location, prepending this flag to
 186 other
 187 .B icu-config
 188 calls will attempt to locate ICU relative to where the
 189 .B icu-config
 190 script has been located. Can be used as a last-chance effort if the ICU
 191 install has been damaged.
 192 .TP
 193 .BI "\-\-exec\-prefix"
 194 Print the prefix used for executable program directories (such as bin, sbin, etc). Normally the same as the prefix.
 195 .TP
 196 .BI "\-\-exists"
 197 Script will return with a successful (0) status if ICU seems to be installed
 198 and located correctly, otherwise an error message and nonzero status will
 199 be displayed.
 200 .TP
 201 .BI "\-\-help\fP, \fB\-?\fP,\fB\-\-usage"
 202 Print a help and usage message.
 203 .TP
 204 .BI "\-\-icudata"
 205 Print the \fIshortname\fP of the ICU data file. This does not include any suffix such as .dat, .dll, .so, .lib, .a, etc nor does it include prefixes such as 'lib'.  It may be in the form \fBicudt21b\fP
 206 .TP
 207 .BI "\-\-icudata\-install\-dir"
 208 Print the directory where ICU packaged data should
 209 be installed.   Can use as pkgdata(1)'s --install option.
 210 .TP
 211 .BI "\-\-icudata\-mode"
 212 Print the default ICU pkgdata mode, such as dll or common.  Can use as pkgdata(1)'s --mode option.
 213 .TP
 214 .BI "\-\-icudatadir"
 215 Print the path to packaged archive data.  (should be where $ICU_DATA
 216 or equivalent default path points.)  Will NOT point to the libdir.
 217 .TP
 218 .BI "\-\-invoke"
 219 If ICU is not installed in a location where the operating system will locate
 220 its shared libraries, this option will print out commands so as to set the
 221 appropriate environment variables to load ICU's shared libraries. For example,
 222 on many systems a variable named LD_LIBRARY_PATH or equivalent must be set.
 223 .TP
 224 .BI "\-\-invoke=" "prog"
 225 Same as the \fB\-\-invoke\fP option, except includes options for invoking
 226 a program named \fIprog\fP.  If \fIprog\fP is the name of an ICU tool,
 227 such as genrb(1), then \fBicu-config\fP will also include the full path
 228 to that tool.
 229 .TP
 230 .BI "\-\-ldflags"
 231 Print any flags which should be passed to the linker. These may include
 232 -L for library search paths, and -l for including ICU libraries. By default,
 233 this option will attempt to link in the "common" (libicuuc) and "i18n"
 234 (libicui18n) libraries, as well as the data library. If additional libraries
 235 are required, any of the following two flags may be added in conjunction with this one,
 236 for example "\-\-ldflags \-\-ldflags-icuio" if the icuio library is required
 237 in addition to the standard ICU libraries.
 238 Equivalent to the $(LDFLAGS) Makefile variable.
 239 .TP
 240 .BI "\-\-ldflags\-layout"
 241 Prints the link option for the ICU layout library.
 242 .TP
 243 .BI "\-\-ldflags\-icuio"
 244 Prints the link option to add the ICU I/O package
 245 .TP
 246 .BI "\-\-ldflags\-libsonly"
 247 Similar to \fI\-\-ldflags\fP but only includes the \-l options.
 248 .TP
 249 .BI "\-\-ldflags\-searchpath"
 250 Similar to \fI\-\-ldflags\fP but only includes the \-L search path options.
 251 .TP
 252 .BI "\-\-ldflags\-system"
 253 Similar to \fI\-\-ldflags\fP but only includes system libraries (such as pthreads)
 254 .BI "\-\-mandir"
 255 Prints the location of the installed ICU man pages. Normally (man)
 256 .TP
 257 .BI "\-\-prefix"
 258 Prints the prefix (base directory) under which the installed ICU resides.
 259 .TP
 260 .BI "\-\-prefix=" "prefix"
 261 Sets the ICU prefix to \fIprefix\fP for the remainder of this command line.
 262 Does test whether the new prefix is valid.
 263 .TP
 264 .BI "\-\-sbindir"
 265 Prints the location of ICU system binaries, normally (sbin)
 266 .TP
 267 .BI "\-\-shared\-datadir"
 268 Prints the location of ICU shared data, normally (share)
 269 .TP
 270 .BI "\-\-sysconfdir"
 271 Prints the location of ICU system configuration data, normally (etc)
 272 .TP
 273 .BI "\-\-unicode\-version"
 274 Prints the Version of the Unicode Standard which the current ICU uses.
 275 .TP
 276 .BI "\-\-version"
 277 Prints the current version of ICU.
 278 .TP
 279 .BI "\-\-incfile"
 280 Prints the 'Makefile.inc' path, suitable for use with pkgdata(1)'s \-O option.
 281 .PP
 282 .SH AUTHORS
 283 Steven Loomis
 284 .SH VERSION
 285 @VERSION@
 286 .SH COPYRIGHT
 287 Copyright (C) 2002-2004 IBM, Inc. and others.
 288