README.md
1pcre2-sys
2=========
3Bindings for [PCRE2](https://www.pcre.org/).
4
5[](https://travis-ci.org/BurntSushi/rust-pcre2)
6[](https://ci.appveyor.com/project/BurntSushi/rust-pcre2)
7[](https://crates.io/crates/pcre2-sys)
8
9Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
10
11
12### Documentation
13
14https://docs.rs/pcre2-sys
15
16
17### Usage
18
19Add this to your `Cargo.toml`:
20
21```toml
22[dependencies]
23pcre2-sys = "0.1"
24```
25
26and this to your crate root:
27
28```rust
29extern crate pcre2_sys;
30```
31
32
33### Notes
34
35As a `-sys` crate, this exposes only the bindings to PCRE2 based on the header
36file. The PCRE2 documentation itself should be consulted in order to use this
37crate.
38
39The bindings for this crate were generated for PCRE **10.31**. This crate
40intends to track the current release of PCRE2.
41
42The build script for this crate prefers dynamically linking with the host's
43PCRE2 system library. If that isn't available or if static linking is desired,
44then PCRE2 is built from source and statically linked.
45
46Static linking will automatically happen for MUSL targets, but can be forced by
47setting the `PCRE2_SYS_STATIC` environment variable to `1`. Similarly, if
48`PCRE2_SYS_STATIC` is set to `0`, then static linking will be forcefully
49disabled, even for MUSL targets.
50
51Currently, this crate only supports `libpcre-8` where
52`PCRE2_CODE_UNIT_WIDTH=8`.
53
54This crate has been tested to work on Windows, Linux and macOS. Other platforms
55may work, and PRs to support them are welcome.
56
57If you're compiling this crate on Windows with the GNU toolchain, then you'll
58need to make sure you have a compatible C compiler installed, such as the one
59provided by the [mingw-w64](http://mingw-w64.org) project.
60
61Set the `PCRE2_SYS_DEBUG` flag to forcefully enable debug symbols when doing a
62static build, even when compiling in release mode.
63
){kind=link}