jpayne@68: .\" Hey, Emacs! This is -*-nroff-*- you know...
jpayne@68: .\"
jpayne@68: .\" icu-config.1: manual page for the icu-config utility
jpayne@68: .\"
jpayne@68: .\" Copyright (C) 2016 and later: Unicode, Inc. and others.
jpayne@68: .\" License & terms of use: http://www.unicode.org/copyright.html
jpayne@68: .\" Copyright (C) 2002-2008 IBM, Inc. and others.
jpayne@68: .\"
jpayne@68: .\" Based on  Yves Arrouye's pkgdata page <yves@arrouye.net>
jpayne@68: .\" Modified by Steven R. Loomis <srl@jtcsv.com>.
jpayne@68: .\" With help from http://www.igpm.rwth-aachen.de/~albrecht/manpage.html
jpayne@68: 
jpayne@68: .TH ICU-CONFIG 1 "17 May 2004" "ICU MANPAGE" "ICU 67.1 Manual"
jpayne@68: .\".Dd "17 May 2004"
jpayne@68: .\".Dt ICU-CONFIG 1
jpayne@68: .\".Os 
jpayne@68: 
jpayne@68: .SH NAME
jpayne@68: .B icu-config
jpayne@68: \- output ICU build options 
jpayne@68: .SH SYNOPSIS
jpayne@68: .B icu-config
jpayne@68: [
jpayne@68: .BI "\-\-bindir"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-cc"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-cflags"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-cppflags"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-cppflags\-searchpath"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-cxx"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-cxxflags"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-detect\-prefix"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-exec\-prefix"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-exists"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-help\fP, \fB\-?\fP,\fB"
jpayne@68: .BI "\-\-usage"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-icudata"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-icudata\-install\-dir"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-icudata\-mode"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-icudatadir"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-invoke"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-invoke=" "prog"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-ldflags"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-ldflags\-libsonly"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-ldflags\-searchpath"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-ldflags\-system"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-ldflags\-icuio"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-mandir"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-prefix"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-prefix=" "prefix"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-sbindir"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-shared\-datadir"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-sysconfdir"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-unicode\-version"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-version"
jpayne@68: ]
jpayne@68: [
jpayne@68: .BI "\-\-incfile"
jpayne@68: ]
jpayne@68: 
jpayne@68: 
jpayne@68: 
jpayne@68: .SH DESCRIPTION
jpayne@68: .B icu-config
jpayne@68: simplifies the task of building and linking against ICU as compared to
jpayne@68: manually configuring user makefiles or equivalent.  Because 
jpayne@68: .B icu-config
jpayne@68: is an executable script, it also solves the problem of locating the ICU
jpayne@68: libraries and headers, by allowing the system PATH to locate it. 
jpayne@68: .SH EXAMPLES
jpayne@68: .B icu-config
jpayne@68: can be used without a makefile. The command line below is sufficient for
jpayne@68: building a single-file c++ program against ICU. (For example, \fBicu/source/samples/props/props.cpp\fR)
jpayne@68: .PP
jpayne@68: .RS
jpayne@68: `icu-config --cxx --cxxflags --cppflags --ldflags` -o props props.cpp
jpayne@68: .RE
jpayne@68: .PP
jpayne@68: More commonly,
jpayne@68: .B icu-config
jpayne@68: will be called from within a makefile, and used to set up variables. The
jpayne@68: following example also builds the \fIprops\fR example.
jpayne@68: .PP
jpayne@68: .RS
jpayne@68: CC=$(shell icu-config --cc)
jpayne@68: 
jpayne@68: CXX=$(shell icu-config --cxx)
jpayne@68: 
jpayne@68: CPPFLAGS=$(shell icu-config --cppflags)
jpayne@68: 
jpayne@68: CXXFLAGS=$(shell icu-config --cxxflags)
jpayne@68: 
jpayne@68: LDFLAGS =$(shell icu-config --ldflags)
jpayne@68: 
jpayne@68: all: props
jpayne@68: 
jpayne@68: props.o: props.cpp
jpayne@68: .RE
jpayne@68: .PP
jpayne@68: make(1) will automatically use the above variables.
jpayne@68: .SH OPTIONS
jpayne@68: .TP
jpayne@68: .BI "\-\-bindir"
jpayne@68: Prints the binary (executable) directory path. Normally equivalent to 'bin'.
jpayne@68: ICU user-executable applications and scripts are found here.
jpayne@68: .TP
jpayne@68: .BI "\-\-cc"
jpayne@68: Print the C compiler used.  Equivalent to the $(CC) Makefile variable.
jpayne@68: .TP
jpayne@68: .BI "\-\-cflags"
jpayne@68: Print the C compiler flags. Equivalent to the $(CFLAGS) Makefile variable.
jpayne@68: Does NOT include preprocessor directives such as include path or defined symbols. Examples include debugging (\-g) and optimization flags
jpayne@68: .TP
jpayne@68: .BI "\-\-cppflags"
jpayne@68: Print the C preprocessor flags. Equivalent to the $(CPPFLAGS) Makefile variable. Examples are \-I include paths  and \-D define directives.
jpayne@68: .TP
jpayne@68: .BI "\-\-cppflags\-searchpath"
jpayne@68: Print the C preprocessor flags, as above but only \-I search paths.
jpayne@68: .TP
jpayne@68: .BI "\-\-cxx"
jpayne@68: Print the C++ compiler. Equivalent to the $(CXX) Makefile variable.
jpayne@68: .TP
jpayne@68: .BI "\-\-cxxflags"
jpayne@68: Print the C++ compiler flags. Equivalent to the $(CXXFLAGS) Makefile variable.
jpayne@68: .TP
jpayne@68: .BI "\-\-detect\-prefix"
jpayne@68: If ICU has been moved from its installed location, prepending this flag to
jpayne@68: other 
jpayne@68: .B icu-config
jpayne@68: calls will attempt to locate ICU relative to where the
jpayne@68: .B icu-config
jpayne@68: script has been located. Can be used as a last-chance effort if the ICU
jpayne@68: install has been damaged.
jpayne@68: .TP
jpayne@68: .BI "\-\-exec\-prefix"
jpayne@68: Print the prefix used for executable program directories (such as bin, sbin, etc). Normally the same as the prefix.
jpayne@68: .TP
jpayne@68: .BI "\-\-exists"
jpayne@68: Script will return with a successful (0) status if ICU seems to be installed
jpayne@68: and located correctly, otherwise an error message and nonzero status will
jpayne@68: be displayed.
jpayne@68: .TP
jpayne@68: .BI "\-\-help\fP, \fB\-?\fP,\fB\-\-usage"
jpayne@68: Print a help and usage message.
jpayne@68: .TP
jpayne@68: .BI "\-\-icudata"
jpayne@68: 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
jpayne@68: .TP
jpayne@68: .BI "\-\-icudata\-install\-dir"
jpayne@68: Print the directory where ICU packaged data should 
jpayne@68: be installed.   Can use as pkgdata(1)'s --install option.
jpayne@68: .TP
jpayne@68: .BI "\-\-icudata\-mode"
jpayne@68: Print the default ICU pkgdata mode, such as dll or common.  Can use as pkgdata(1)'s --mode option.
jpayne@68: .TP
jpayne@68: .BI "\-\-icudatadir"
jpayne@68: Print the path to packaged archive data.  (should be where $ICU_DATA 
jpayne@68: or equivalent default path points.)  Will NOT point to the libdir.
jpayne@68: .TP
jpayne@68: .BI "\-\-invoke"
jpayne@68: If ICU is not installed in a location where the operating system will locate 
jpayne@68: its shared libraries, this option will print out commands so as to set the
jpayne@68: appropriate environment variables to load ICU's shared libraries. For example,
jpayne@68: on many systems a variable named LD_LIBRARY_PATH or equivalent must be set.
jpayne@68: .TP
jpayne@68: .BI "\-\-invoke=" "prog"
jpayne@68: Same as the \fB\-\-invoke\fP option, except includes options for invoking 
jpayne@68: a program named \fIprog\fP.  If \fIprog\fP is the name of an ICU tool, 
jpayne@68: such as genrb(1), then \fBicu-config\fP will also include the full path
jpayne@68: to that tool. 
jpayne@68: .TP
jpayne@68: .BI "\-\-ldflags"
jpayne@68: Print any flags which should be passed to the linker. These may include 
jpayne@68: -L for library search paths, and -l for including ICU libraries. By default, 
jpayne@68: this option will attempt to link in the "common" (libicuuc) and "i18n" 
jpayne@68: (libicui18n) libraries, as well as the data library. If additional libraries
jpayne@68: are required, any of the following two flags may be added in conjunction with this one,
jpayne@68: for example "\-\-ldflags \-\-ldflags-icuio" if the icuio library is required
jpayne@68: in addition to the standard ICU libraries.
jpayne@68: Equivalent to the $(LDFLAGS) Makefile variable.
jpayne@68: .TP
jpayne@68: .BI "\-\-ldflags\-layout"
jpayne@68: Prints the link option for the ICU layout library.
jpayne@68: .TP
jpayne@68: .BI "\-\-ldflags\-icuio"
jpayne@68: Prints the link option to add the ICU I/O package
jpayne@68: .TP
jpayne@68: .BI "\-\-ldflags\-libsonly"
jpayne@68: Similar to \fI\-\-ldflags\fP but only includes the \-l options.
jpayne@68: .TP
jpayne@68: .BI "\-\-ldflags\-searchpath"
jpayne@68: Similar to \fI\-\-ldflags\fP but only includes the \-L search path options.
jpayne@68: .TP
jpayne@68: .BI "\-\-ldflags\-system"
jpayne@68: Similar to \fI\-\-ldflags\fP but only includes system libraries (such as pthreads)
jpayne@68: .BI "\-\-mandir"
jpayne@68: Prints the location of the installed ICU man pages. Normally (man)
jpayne@68: .TP
jpayne@68: .BI "\-\-prefix"
jpayne@68: Prints the prefix (base directory) under which the installed ICU resides. 
jpayne@68: .TP
jpayne@68: .BI "\-\-prefix=" "prefix"
jpayne@68: Sets the ICU prefix to \fIprefix\fP for the remainder of this command line.  
jpayne@68: Does test whether the new prefix is valid.
jpayne@68: .TP
jpayne@68: .BI "\-\-sbindir"
jpayne@68: Prints the location of ICU system binaries, normally (sbin)
jpayne@68: .TP
jpayne@68: .BI "\-\-shared\-datadir"
jpayne@68: Prints the location of ICU shared data, normally (share)
jpayne@68: .TP
jpayne@68: .BI "\-\-sysconfdir"
jpayne@68: Prints the location of ICU system configuration data, normally (etc)
jpayne@68: .TP
jpayne@68: .BI "\-\-unicode\-version"
jpayne@68: Prints the Version of the Unicode Standard which the current ICU uses.
jpayne@68: .TP
jpayne@68: .BI "\-\-version"
jpayne@68: Prints the current version of ICU.
jpayne@68: .TP
jpayne@68: .BI "\-\-incfile"
jpayne@68: Prints the 'Makefile.inc' path, suitable for use with pkgdata(1)'s \-O option.
jpayne@68: .PP
jpayne@68: .SH AUTHORS
jpayne@68: Steven Loomis
jpayne@68: .SH VERSION
jpayne@68: 67.1
jpayne@68: .SH COPYRIGHT
jpayne@68: Copyright (C) 2002-2004 IBM, Inc. and others.
jpayne@68: