From 64106c4d3d4ddba8c7bc2af75376e6d3d3d75601 Mon Sep 17 00:00:00 2001 From: Date: Mon, 29 Jun 2015 20:16:15 +0000 Subject: Update documentation --- pkg_config/index.html | 189 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 189 insertions(+) create mode 100644 pkg_config/index.html (limited to 'pkg_config/index.html') diff --git a/pkg_config/index.html b/pkg_config/index.html new file mode 100644 index 0000000..a339e49 --- /dev/null +++ b/pkg_config/index.html @@ -0,0 +1,189 @@ + + + + + + + + + + pkg_config - Rust + + + + + + + + + + + + + + + +
+

Crate pkg_config + + [] + + [src]

+

A build dependency for Cargo libraries to find system artifacts through the +pkg-config utility.

+ +

This library will shell out to pkg-config as part of build scripts and +probe the system to determine how to link to a specified library. The +Config structure serves as a method of configuring how pkg-config is +invoked in a builder style.

+ +

A number of environment variables are available to globally configure how +this crate will invoke pkg-config:

+ + + +

There are also a number of environment variables which can configure how a +library is linked to (dynamically vs statically). These variables control +whether the --static flag is passed. Note that this behavior can be +overridden by configuring explicitly on Config. The variables are checked +in the following order:

+ + + +

After running pkg-config all appropriate Cargo metadata will be printed on +stdout if the search was successful.

+ +

Example

+

Find the system library named foo.

+
+extern crate pkg_config;
+
+fn main() {
+    pkg_config::find_library("foo").unwrap();
+}
+
+ +

Configure how library foo is linked to.

+
+extern crate pkg_config;
+
+fn main() {
+    pkg_config::Config::new().statik(true).find("foo").unwrap();
+}
+
+

Structs

+ + + + + + + + + + +
Config + +
Library + +

Functions

+ + + + + + + + + + +
find_library +

Simple shortcut for using all default options for finding a library.

+ +
target_supported + +
+ + + + + + + + + + + + + + + \ No newline at end of file -- cgit v1.2.3