Mercurial > vanilla
annotate Docs/options.md @ 714:6b4ba668a43c
vanilla: update documentation
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 02 Aug 2019 21:20:00 +0200 |
parents | |
children | 034a2a62a9f8 |
rev | line source |
---|---|
714
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 Available options |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 ================= |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 Use the following predefined options before creating your own. |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 - ACL: enable access control list support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 - BLUETOOTH: enable bluetooth support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 - BZIP2: enable bzip2 compression support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 - DBUS: enable D-Bus support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 - DOXYGEN: enable doxygen documentation support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 - DRM: enable direct rendering manager support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 - DTD: enable XML validation support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 - EGL: enable EGL support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 - FLAC: enable flac support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 - FONTCONFIG: enable fontconfig support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 - FREETYPE: enable freetype support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 - GALLIUM: enable LLVM gallium support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 - GDBM: enable GNU database support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 - GLAMOR: enable 2D graphics support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 - GLES1: enable GLES1 support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 - GLES2: enable GLES2 support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 - GLES3: enable GLES3 support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 - GMP: enable GNU multiple precision library |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 - GTK2: enable Gtk 2 toolkit support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 - GTK3: enable Gtk 3 toolkit support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 - GTK4: enable Gtk 4 toolkit support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 - GUILE: enable GNU guile support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 - IDN2: enable libidn2 support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 - KMS: enable kernel mode settings support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 - LEGACY: enable obsolete or deprecated features |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 - LLVM: enable LLVM support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 - LZ4: enable lz4 compression support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 - LZMA: enable lzma compression support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 - MIDI: enable midi support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 - MNL: enable netlink minimalistic library support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 - NLS: enable native language support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 - OGG: enable libogg support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 - PAM: enable PAM support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 - PCRE: enable perl-like regular expression support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 - PULSEAUDIO: enable PulseAudio support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 - PYTHON: enable Python 3 bindings or support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 - QT5: enable Qt 5 toolkit support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 - SPHINX: enable sphinx documentation support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 - SSH: enable SSH support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 - SSL: enable SSL/TLS, some packages offer several choices (e.g. openssl, gnutls) |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 - UDEV: enable eudev support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 - UUID: enable UUID support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 - VORBIS: enable libvorbis support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 - WACOM: enable wacom support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 - WAYLAND: enable wayland support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 - X: enable X.Org support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 - XML: enable XML support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 - XZ: enable XZ support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 - ZLIB: enable zlib compression support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 - ZSTD: enable zstd compression support |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 Always try to make an option easy to understand and not package specific. For |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 example BLUETOOTH is preferred over BLUEZ because a user knows what bluetooth is |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 but may not know that bluez is the current reference implementation. Also, it is |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 preferred to make an option generic to allow multiple values in case the |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 package offers it. |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 Example, if a package offers different implementations for SSL, consider the |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 option with a value (e.g. SSL=openssl, SSL=gnutls, and such). |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 Also, if a package offers different implementations that can be enabled all |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 together, use a list separated by space (e.g. XML="libxml2 expat"). |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 Those options should only change the package behaviour, for example: manual |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 pages or any other resource files that are not strictly required; they must be |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
71 installed and the user may exclude them via `vpk` instead. |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 Also, options should usually be named in a canonical manner rather than a |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 package name. For example, OGG is better than LIBOGG because what the options |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 means is enabling the OGG codec support, not specifically the library. |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 The following options should be available for any package that builds C or C++ |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 code: |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 - CBUILD: build system (usually ARCH-linux-musl) |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
81 - CHOST: host system (usually ARCH-linux-musl) |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
82 - CTARGET: target system (usually ARCH-linux-musl) |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
83 - CC: C compiler (defaults to gcc) |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
84 - CFLAGS: C flags (defaults to -O2) |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
85 - CXX: C++ compiler (defaults to g++) |
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
86 - CXXFLAGS: C++ flags (defaults to -O2) |