Release 1.39.0
[boost.git] / Boost_1_39_0 / libs / xpressive / doc / installation.qbk
blob8b025c96ede3f00e6cce60e4e18b3a89a72d94da
1 [/
2  / Copyright (c) 2008 Eric Niebler
3  /
4  / Distributed under the Boost Software License, Version 1.0. (See accompanying
5  / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6  /]
8 [section Installing xpressive]
10 [h2 Getting xpressive]
12 There are three ways to get xpressive. The first and simplest is to download
13 the latest version of Boost. Just go to [@http://sf.net/projects/boost] and
14 follow the ["Download] link.
16 The second way is by downloading xpressive.zip at the
17 [@http://www.boost-consulting.com/vault/index.php?directory=Strings%20-%20Text%20Processing
18 Boost File Vault] in the ["Strings - Text Processing] directory. In addition to
19 the source code and the Boost license, this archive contains a copy of this
20 documentation in PDF format. This version will always be stable and at least as
21 current as the version in the latest Boost release. It may be more recent. The
22 version in the File Vault is always guaranteed to work with the latest official
23 Boost release.
25 The third way is by directly accessing the Boost Subversion repository.
26 Just go to [@http://svn.boost.org/trac/boost/] and follow the instructions there for
27 anonymous Subversion access. The version in Boost Subversion is unstable.
29 [h2 Building with xpressive]
31 Xpressive is a header-only template library, which means you don't need to alter
32 your build scripts or link to any separate lib file to use it. All you need to
33 do is `#include <boost/xpressive/xpressive.hpp>`. If you are only using static
34 regexes, you can improve compile times by only including `xpressive_static.hpp`.
35 Likewise, you can include `xpressive_dynamic.hpp` if you only plan on using
36 dynamic regexes.
38 If you would also like to use semantic actions or custom assertions with your
39 static regexes, you will need to additionally include `regex_actions.hpp`.
41 [h2 Requirements]
43 Xpressive requires Boost version 1.34.1 or higher.
45 [h2 Supported Compilers]
47 Currently, Boost.Xpressive is known to work on the following compilers:
49 * Visual C++ 7.1 and higher
50 * GNU C++ 3.4 and higher
51 * Intel for Linux 8.1 and higher
52 * Intel for Windows 10 and higher
53 * tru64cxx 71 and higher
54 * MinGW 3.4 and higher
55 * HP C/aC++ A.06.14
57 [/ * QNX qcc 3.3 and higher]
58 [/ * Metrowerks CodeWarrior 9.4 and higher]
60 Check the latest tests results at Boost's
61 [@http://beta.boost.org/development/tests/trunk/developer/xpressive.html
62 Regression Results Page].
64 [note Please send any questions, comments and bug reports to eric <at>
65 boost-consulting <dot> com.]
67 [endsect]