aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Pkgconfig-module.md
blob: 81ca02041f1bc2dcea0f33281df00d94f10592b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Pkgconfig module

This module is a simple generator for [pkg-config](http://pkg-config.freedesktop.org/) files.

## Usage

To use this module, just do: **`pkg = import('pkgconfig')`**. The following function will then be available as `pkg.generate()`. You can, of course, replace the name `pkg` with anything else.

### pkg.generate()

The generated file's properties are specified with the following keyword arguments.

- `libraries` a list of built libraries (usually results of shared_library) that the user needs to link against
- `version` a string describing the version of this library
- `name` the name of this library
- `description` a string describing the library
- `filebase`, the base name to use for the pkg-config file, as an example the value of `libfoo` would produce a pkg-config file called `libfoo.pc`
- `subdirs` which subdirs of `include` should be added to the header search path, for example if you install headers into `${PREFIX}/include/foobar-1`, the correct value for this argument would be `foobar-1`
- `requires` list of strings to put in the `Requires` field
- `requires_private` list of strings to put in the `Requires.private` field
- `libraries_private` list of strings to put in the `Libraries.private` field
- `install_dir` the directory to install to, defaults to the value of option `libdir` followed by `/pkgconfig`