]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
2 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
3 | <head> | |
4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | |
5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> | |
6 | <meta name="generator" content="Doxygen 1.8.6"/> | |
7 | <title>Boost.Locale: Building The library</title> | |
8 | <link href="tabs.css" rel="stylesheet" type="text/css"/> | |
9 | <script type="text/javascript" src="jquery.js"></script> | |
10 | <script type="text/javascript" src="dynsections.js"></script> | |
11 | <link href="navtree.css" rel="stylesheet" type="text/css"/> | |
12 | <script type="text/javascript" src="resize.js"></script> | |
13 | <script type="text/javascript" src="navtree.js"></script> | |
14 | <script type="text/javascript"> | |
15 | $(document).ready(initResizable); | |
16 | $(window).load(resizeHeight); | |
17 | </script> | |
18 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> | |
19 | </head> | |
20 | <body> | |
21 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> | |
22 | <div id="titlearea"> | |
23 | <table cellspacing="0" cellpadding="0"> | |
24 | <tbody> | |
25 | <tr style="height: 56px;"> | |
26 | <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td> | |
27 | <td style="padding-left: 0.5em;"> | |
28 | <div id="projectname">Boost.Locale | |
29 | </div> | |
30 | </td> | |
31 | </tr> | |
32 | </tbody> | |
33 | </table> | |
34 | </div> | |
35 | <!-- end header part --> | |
36 | <!-- Generated by Doxygen 1.8.6 --> | |
37 | <div id="navrow1" class="tabs"> | |
38 | <ul class="tablist"> | |
39 | <li><a href="index.html"><span>Main Page</span></a></li> | |
40 | <li class="current"><a href="pages.html"><span>Related Pages</span></a></li> | |
41 | <li><a href="modules.html"><span>Modules</span></a></li> | |
42 | <li><a href="namespaces.html"><span>Namespaces</span></a></li> | |
43 | <li><a href="annotated.html"><span>Classes</span></a></li> | |
44 | <li><a href="files.html"><span>Files</span></a></li> | |
45 | <li><a href="examples.html"><span>Examples</span></a></li> | |
46 | </ul> | |
47 | </div> | |
48 | </div><!-- top --> | |
49 | <div id="side-nav" class="ui-resizable side-nav-resizable"> | |
50 | <div id="nav-tree"> | |
51 | <div id="nav-tree-contents"> | |
52 | <div id="nav-sync" class="sync"></div> | |
53 | </div> | |
54 | </div> | |
55 | <div id="splitbar" style="-moz-user-select:none;" | |
56 | class="ui-resizable-handle"> | |
57 | </div> | |
58 | </div> | |
59 | <script type="text/javascript"> | |
60 | $(document).ready(function(){initNavTree('building_boost_locale.html','');}); | |
61 | </script> | |
62 | <div id="doc-content"> | |
63 | <div class="header"> | |
64 | <div class="headertitle"> | |
65 | <div class="title">Building The library </div> </div> | |
66 | </div><!--header--> | |
67 | <div class="contents"> | |
68 | <div class="textblock"><ul> | |
69 | <li><a class="el" href="building_boost_locale.html#building_boost_locale_bb">Building Boost.Locale</a><ul> | |
70 | <li><a class="el" href="building_boost_locale.html#bb_building_deps">Dependencies</a></li> | |
71 | <li><a class="el" href="building_boost_locale.html#bb_building_proc">Building Process</a></li> | |
72 | <li><a class="el" href="building_boost_locale.html#bb_build_opts">Build Options</a></li> | |
73 | <li><a class="el" href="building_boost_locale.html#bb_build_test">Running Unit Tests</a></li> | |
74 | </ul> | |
75 | </li> | |
76 | <li><a class="el" href="building_boost_locale.html#binary_compatibility">Binary Compatibility</a></li> | |
77 | </ul> | |
78 | <h1><a class="anchor" id="building_boost_locale_bb"></a> | |
79 | Building Boost.Locale</h1> | |
80 | <h2><a class="anchor" id="bb_building_deps"></a> | |
81 | Dependencies</h2> | |
82 | <ul> | |
83 | <li>ICU library 3.6 or above is strongly recommended</li> | |
84 | <li>If no ICU library is given, iconv support is required under POSIX platforms.</li> | |
85 | </ul> | |
86 | <h2><a class="anchor" id="bb_platform_opts"></a> | |
87 | Platform Notes</h2> | |
88 | <ul> | |
89 | <li>If you use Boost.Locale on Windows with MinGW/GCC < 4.5 you'll be able to use static version only. Mingw/GCC prior to 4.5 have no support of dynamic runtime linking.<br/> | |
90 | Using Boost.Locale DLL's with MinGW gcc also requires dynamic linking with the runtime libraries libstdc++ and libgcc. Some gcc builds use static linking by default so make sure you use correct link options with your compiler when you build your own programs.</li> | |
91 | <li>The AIX's iconv misses important character sets that Boost.Locale requires, so you need to either use GNU iconv or link with ICU library.</li> | |
92 | <li>If iconv library is not found on Darwin/Mac OS X builds make sure there is no multiple iconv installations and provide -sICONV_PATH build option to point to correct location of iconv library.</li> | |
93 | </ul> | |
94 | <h2><a class="anchor" id="bb_building_proc"></a> | |
95 | Building Process</h2> | |
96 | <p>Now all you need to do is invoke bjam command:</p> | |
97 | <pre class="fragment">./bjam --with-locale stage | |
98 | </pre><p>Or on Windows </p> | |
99 | <pre class="fragment">.\bjam --with-locale stage | |
100 | </pre><p>If you are using custom ICU build or you are using Microsoft Windows you need to provide a path to location of ICU library using <code>-sICU_PATH</code> option</p> | |
101 | <p>For example:</p> | |
102 | <ul> | |
103 | <li>If your icu build is placed at <code>/opt/icu46</code> such that the files are placed like<br/> | |
104 | <code>/opt/icu46/include/unicode/uversion</code>.h<br/> | |
105 | <code>/opt/icu46/include/unicode/calendar</code>.h<br/> | |
106 | <code></code>... <br/> | |
107 | <code>/opt/icu46/lib/libicudata</code>.so <br/> | |
108 | <code>/opt/icu46/lib/libicui18n</code>.so <br/> | |
109 | <code></code>... <br/> | |
110 | then you need to provide an option <code>-sICU_PATH=/opt/icu46</code> <pre class="fragment"> ./bjam --with-locale -sICU_PATH=/opt/icu46 stage</pre></li> | |
111 | <li>If your icu build is placed at <code>c:\icu46</code> such that the files are placed like <br/> | |
112 | <code>c:\icu46\include\unicode\uversion.h</code> <br/> | |
113 | <code>c:\icu46\include\unicode\calendar.h</code> <br/> | |
114 | <code>...</code> <br/> | |
115 | <code>c:\icu46\bin\icudt.dll</code> <br/> | |
116 | <code>c:\icu46\bin\icuin.dll</code> <br/> | |
117 | <code>...</code> <br/> | |
118 | <code>c:\icu46\lib\icudt.lib</code> <br/> | |
119 | <code>c:\icu46\lib\icuin.lib</code> <br/> | |
120 | <code>...</code> <br/> | |
121 | then you need to provide an option <code>-sICU_PATH=c:\icu46</code> <pre class="fragment"> .\bjam --with-locale -sICU_PATH=c:\icu46 stage</pre></li> | |
122 | </ul> | |
123 | <dl class="section note"><dt>Note</dt><dd>Don't forget to put both debug and release versions of ICU libraries in this path when using Microsoft Visual Studio so Boost.Build will link correctly debug and release versions of boost_locale library.</dd></dl> | |
124 | <h1><a class="anchor" id="bb_build_opts"></a> | |
125 | Build Options</h1> | |
126 | <p>Boost.Locale supports following options with values <code>off</code> or <code>on</code> </p> | |
127 | <ul> | |
128 | <li><code>boost.locale.icu=off</code> disable build of ICU backend even if ICU library exists</li> | |
129 | <li><code>boost.locale.iconv=off</code> or <code>boost.locale.iconv=on</code> enable or disable use of iconv library. It is off by default on Windows and Solaris</li> | |
130 | <li><code>boost.locale.winapi=off</code> - disable winapi backend, it is on by default on Windows and Cygwin</li> | |
131 | <li><code>boost.locale.std=off</code> or <code>boost.locale.winapi=on</code> Disable or enable std backends. <code>std</code> backend is disabled by default when using Sun Studio.</li> | |
132 | <li><code>boost.locale.posix=on</code> or <code>boost.locale.posix=off</code> Enable or disable support of POSIX backend, it is on by default on Linux and Mac OS X</li> | |
133 | </ul> | |
134 | <p>Also Boost.Locale supports following options</p> | |
135 | <ul> | |
136 | <li><code>-sICU_PATH=/path/to/location/of/icu</code> - the location of custom ICU library</li> | |
137 | <li><code>-sICONV_PATH=/path/to/location/of/iconv</code> - the location of custom iconv library</li> | |
138 | </ul> | |
139 | <p>For example:</p> | |
140 | <ul> | |
141 | <li>Build the library on Windows with ICU backend only: <pre class="fragment"> .\bjam boost.locale.winapi=off boost.locale.std=off -sICU_PATH=c:\icu46 --with-locale stage</pre></li> | |
142 | <li>Build the library on Linux with std backend only <pre class="fragment"> .\bjam boost.locale.posix=off boost.locale.icu=off --with-locale stage</pre></li> | |
143 | </ul> | |
144 | <h1><a class="anchor" id="bb_build_test"></a> | |
145 | Running Unit Tests</h1> | |
146 | <p>You can run unit tests by invoking <code>bjam</code> with <code>libs/locale/test</code> project parameter </p> | |
147 | <pre class="fragment">./bjam libs/locale/test | |
148 | </pre><h1><a class="anchor" id="binary_compatibility"></a> | |
149 | Binary Compatibility</h1> | |
150 | <p>Boost.Locale is built with binary compatibility in mind. Switching localization back ends on or off, or using iconv or not, does not affect binary compatibility. So if a dynamic library was built with all possible backends, other dynamic libraries compiled with, for example, only the <code>std</code>, <code>posix</code> or <code>winapi</code> backends would still be binary-compatible with it.</p> | |
151 | <p>However this definitely has an effect on some features. For example, if you try to use boundary analysis or a calendar facet when the library does not support the icu backend you would get an exception. </p> | |
152 | </div></div><!-- contents --> | |
153 | </div><!-- doc-content --> | |
154 | ||
155 | <li class="footer"> | |
156 | © Copyright 2009-2012 Artyom Beilis, Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0. | |
157 | </li> | |
158 | </ul> | |
159 | </div> | |
160 | </body> | |
161 | </html> |