Mercurial > vanilla

annotate Docs/options.md @ 1076:8645ec8420e1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fonts/font-ubuntu: initial import, closes #2338
author David Demelier <markand@malikania.fr>
date Tue, 03 Sep 2019 12:11:32 +0200
parents 25a95c53d800
children 7791d3dbfecf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
7 - ALSA: enable Advanced Linux Sound Architecture support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
8 - ATTR: enable attributes support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
9 - AUDIT: enable security audit support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
10 - AVAHI: enable avahi support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 - BLUETOOTH: enable bluetooth support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 - BZIP2: enable bzip2 compression support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
13 - CAIRO: enable cairo graphics
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
14 - CAP: enable capabilities support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
15 - CDPARANOIA: enable CD-Audio support through cdparanoia
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
16 - COLORS: enable colors support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
17 - CRYPTO: enable cryptographic functionalities
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
18 - CUPS: enable printing support through CUPS
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 - DBUS: enable D-Bus support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 - DOXYGEN: enable doxygen documentation support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 - DRM: enable direct rendering manager support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 - DTD: enable XML validation support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 - EGL: enable EGL support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
24 - EVDEV: enable input drivers through evdev
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
25 - FFI: enable foreign function interface support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 - FLAC: enable flac support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 - FONTCONFIG: enable fontconfig support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 - GALLIUM: enable LLVM gallium support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 - GDBM: enable GNU database support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
30 - GEOLOCATION: enable geolocation positioning support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 - GLAMOR: enable 2D graphics support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 - GLES1: enable GLES1 support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 - GLES2: enable GLES2 support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 - GLES3: enable GLES3 support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
35 - GLIB: enable glib library support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 - GMP: enable GNU multiple precision library
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
37 - GNOME: enable GNOME desktop support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
38 - GSTREAMER: enable gstreamer multimedia framework support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 - GTK2: enable Gtk 2 toolkit support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
40 - GTK: enable Gtk 3 toolkit support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 - GUILE: enable GNU guile support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
42 - HARFBUZZ: enable font rendering engine support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
43 - ICU: enable International Components for Unicode support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 - IDN2: enable libidn2 support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
45 - INTROSPECTION: enable GObject introspection support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
46 - IPV6: enable IPv6 support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
47 - JACK: enable JACK Audio Connection Kit support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
48 - JPEG: enable JPEG image format support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
49 - KERBEROS: enable kerberos authentication system support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 - KMS: enable kernel mode settings support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 - LEGACY: enable obsolete or deprecated features
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
52 - LIBEDIT: enable command line completion through libedit
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
53 - LIBINPUT: enable input drivers through libinput
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 - LLVM: enable LLVM support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 - LZ4: enable lz4 compression support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 - LZMA: enable lzma compression support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
57 - LZO: enable lz4 compression support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 - MIDI: enable midi support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 - MNL: enable netlink minimalistic library support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
60 - MTDEV: enable multitouch devices support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
61 - NCURSES: enable new curses library support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
62 - NGHTTP2: enable nghttp2 support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 - NLS: enable native language support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
64 - NOTIFICATIONS: enable desktop notifications
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 - OGG: enable libogg support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
66 - OPENGL: enable OpenGL support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
67 - OPENMP: enable OpenMP support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
68 - OPUS: enable OPUS audio codec support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
69 - OSS: enable OpenSound System support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 - PAM: enable PAM support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
71 - PANGO: enable pango font engine support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 - PCRE: enable perl-like regular expression support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
73 - PDF: enable PDF support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
74 - PERL: enable Perl language
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
75 - PNG: enable PNG image format support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
76 - POLKIT: enable polkit authentication engine support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 - PULSEAUDIO: enable PulseAudio support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 - PYTHON: enable Python 3 bindings or support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 - QT5: enable Qt 5 toolkit support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
80 - READLINE: enable command line completion support through readline
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
81 - SELINUX: enable NSA SELinux support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
82 - SPELL: enable spell check support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 - SPHINX: enable sphinx documentation support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 - SSH: enable SSH support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 - SSL: enable SSL/TLS, some packages offer several choices (e.g. openssl, gnutls)
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
86 - STATIC: build static libraries or executable (internal use only)
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
87 - SVG: enable SVG image format support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
88 - SYSLOG: enable logs through syslog support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
89 - TCL: enable TCL language support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
90 - THEORA: enable theora video codec support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
91 - TIFF: enable TIFF image format support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
92 - TRUECOLOR: enable truecolor in terminal applications
904
25a95c53d800 vanilla: rename FREETYPE to TTF, closes #2202
David Demelier <markand@malikania.fr>
parents: 721
diff changeset
93 - TTF: enable truetype font support (usually freetype)
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 - UDEV: enable eudev support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
95 - UPOWER: enable upower system support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 - UUID: enable UUID support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
97 - VALA: enable vala bindings support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 - VORBIS: enable libvorbis support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
99 - VULKAN: enable vulkan support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 - WACOM: enable wacom support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 - WAYLAND: enable wayland support
721
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
102 - WEBKIT: enable webkit web engine support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
103 - WEBP: enable webp image format support
034a2a62a9f8 vanilla: consolidate options with lint-options.sh
David Demelier <markand@malikania.fr>
parents: 714
diff changeset
104 - WOFF2: enable woff2 font support
714
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 - X: enable X.Org support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 - XML: enable XML support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 - XZ: enable XZ support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 - ZLIB: enable zlib compression support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 - ZSTD: enable zstd compression support
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
110
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
111 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
112 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
113 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
114 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
115 package offers it.
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
116
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 Example, if a package offers different implementations for SSL, consider the
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 option with a value (e.g. SSL=openssl, SSL=gnutls, and such).
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
119
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 Also, if a package offers different implementations that can be enabled all
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 together, use a list separated by space (e.g. XML="libxml2 expat").
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
122
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 Those options should only change the package behaviour, for example: manual
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
124 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
125 installed and the user may exclude them via `vpk` instead.
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
126
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
127 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
128 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
129 means is enabling the OGG codec support, not specifically the library.
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
130
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
131 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
132 code:
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
133
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 - CBUILD: build system (usually ARCH-linux-musl)
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
135 - CHOST: host system (usually ARCH-linux-musl)
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
136 - CTARGET: target system (usually ARCH-linux-musl)
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
137 - CC: C compiler (defaults to gcc)
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
138 - CFLAGS: C flags (defaults to -O2)
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
139 - CXX: C++ compiler (defaults to g++)
6b4ba668a43c vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
140 - CXXFLAGS: C++ flags (defaults to -O2)