Mercurial > vanilla

annotate README.options.md @ 304:15486ae047e2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
x11/xev: initial import, closes #1360
author David Demelier <markand@malikania.fr>
date Mon, 25 Mar 2019 12:56:03 +0100
parents de03aa2d54f5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 vanilla options
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 ===============
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
3
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 Packages may be configured using environment variables prior to building.
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
278
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
6 # General options
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
7
10
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 Use the following predefined options before creating your own.
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
278
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
10 - ACL: enable access control list support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
11 - BLUETOOTH: enable bluetooth support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
12 - BZIP2: enable bzip2 compression support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
13 - DBUS: enable D-Bus support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
14 - DOXYGEN: enable doxygen documentation support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
15 - DRM: enable direct rendering manager support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
16 - DTD: enable XML validation support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
17 - EGL: enable EGL support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
18 - FONTCONFIG: enable fontconfig support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
19 - FREETYPE: enable freetype support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
20 - GALLIUM: enable LLVM gallium support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
21 - GDBM: enable GNU database support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
22 - GLAMOR: enable 2D graphics support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
23 - GLES2: enable GLES2 support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
24 - GLES3: enable GLES3 support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
25 - GMP: enable GNU multiple precision library
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
26 - GTK2: enable Gtk 2 toolkit support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
27 - GTK3: enable Gtk 3 toolkit support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
28 - GTK4: enable Gtk 4 toolkit support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
29 - GUILE: enable GNU guile support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
30 - IDN2: enable libidn2 support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
31 - KMS: enable kernel mode settings support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
32 - LLVM: enable LLVM support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
33 - LZ4: enable lz4 compression support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
34 - LZMA: enable lzma compression support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
35 - MNL: enable netlink minimalistic library support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
36 - NLS: enable native language support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
37 - PAM: enable PAM support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
38 - PCRE: enable perl-like regular expression support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
39 - PULSEAUDIO: enable PulseAudio support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
40 - PYTHON: enable Python 3 bindings or support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
41 - QT5: enable Qt 5 toolkit support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
42 - SPHINX: enable sphinx documentation support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
43 - SSH: enable SSH support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
44 - SSL: enable SSL/TLS, some packages offer several choices (e.g. openssl, gnutls)
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
45 - UDEV: enable eudev support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
46 - UUID: enable UUID support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
47 - WACOM: enable wacom support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
48 - WAYLAND: enable wayland support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
49 - X: enable X.Org support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
50 - XML: enable XML support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
51 - XZ: enable XZ support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
52 - ZLIB: enable zlib compression support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
53 - ZSTD: enable zstd compression support
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
54
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
55 Always try to make an option easy to understand and not package specific. For
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
56 example BLUETOOTH is preferred over BLUEZ because a user knows what bluetooth is
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
57 but may not know that bluez is the current reference implementation. Also, it is
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
58 preferred to make an option generic to allow multiple values in case the
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
59 package offers it.
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
60
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
61 Example, if a package offers different implementations for SSL, consider the
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
62 option with a value (e.g. SSL=openssl, SSL=gnutls, and such).
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
63
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
64 Also, if a package offers different implementations that can be enabled all
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
65 together, use a list separated by space (e.g. XML="libxml2 expat").
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
66
de03aa2d54f5 vanilla: add more options in README
David Demelier <markand@malikania.fr>
parents: 116
diff changeset
67 # Toolchain options
116
c78bb6d0049c vanilla: update options
David Demelier <markand@malikania.fr>
parents: 80
diff changeset
68
c78bb6d0049c vanilla: update options
David Demelier <markand@malikania.fr>
parents: 80
diff changeset
69 Those options should only change the package behaviour, for example: manual
c78bb6d0049c vanilla: update options
David Demelier <markand@malikania.fr>
parents: 80
diff changeset
70 pages or any other resource files that are not strictly required; they must be
c78bb6d0049c vanilla: update options
David Demelier <markand@malikania.fr>
parents: 80
diff changeset
71 installed and the user may exclude them via `vpk` instead.
80
04f5776ff0be vanilla: generalize use of CC, CXX, CFLAGS and CXXFLAGS
David Demelier <markand@malikania.fr>
parents: 78
diff changeset
72
04f5776ff0be vanilla: generalize use of CC, CXX, CFLAGS and CXXFLAGS
David Demelier <markand@malikania.fr>
parents: 78
diff changeset
73 The following options should be available for any package that builds C or C++
04f5776ff0be vanilla: generalize use of CC, CXX, CFLAGS and CXXFLAGS
David Demelier <markand@malikania.fr>
parents: 78
diff changeset
74 code:
04f5776ff0be vanilla: generalize use of CC, CXX, CFLAGS and CXXFLAGS
David Demelier <markand@malikania.fr>
parents: 78
diff changeset
75
04f5776ff0be vanilla: generalize use of CC, CXX, CFLAGS and CXXFLAGS
David Demelier <markand@malikania.fr>
parents: 78
diff changeset
76 - CBUILD: build system (usually ARCH-linux-musl)
04f5776ff0be vanilla: generalize use of CC, CXX, CFLAGS and CXXFLAGS
David Demelier <markand@malikania.fr>
parents: 78
diff changeset
77 - CHOST: host system (usually ARCH-linux-musl)
04f5776ff0be vanilla: generalize use of CC, CXX, CFLAGS and CXXFLAGS
David Demelier <markand@malikania.fr>
parents: 78
diff changeset
78 - CTARGET: target system (usually ARCH-linux-musl)
04f5776ff0be vanilla: generalize use of CC, CXX, CFLAGS and CXXFLAGS
David Demelier <markand@malikania.fr>
parents: 78
diff changeset
79 - CC: C compiler (defaults to gcc)
04f5776ff0be vanilla: generalize use of CC, CXX, CFLAGS and CXXFLAGS
David Demelier <markand@malikania.fr>
parents: 78
diff changeset
80 - CFLAGS: C flags (defaults to -O2)
04f5776ff0be vanilla: generalize use of CC, CXX, CFLAGS and CXXFLAGS
David Demelier <markand@malikania.fr>
parents: 78
diff changeset
81 - CXX: C++ compiler (defaults to g++)
04f5776ff0be vanilla: generalize use of CC, CXX, CFLAGS and CXXFLAGS
David Demelier <markand@malikania.fr>
parents: 78
diff changeset
82 - CXXFLAGS: C++ flags (defaults to -O2)