diff --git a/docs/reference/gtk/building.sgml b/docs/reference/gtk/building.sgml index f11f363840..fb762cb1e4 100644 --- a/docs/reference/gtk/building.sgml +++ b/docs/reference/gtk/building.sgml @@ -338,181 +338,182 @@ How to compile GTK itself See for more information. - - Extra Configuration Options + + + Extra Configuration Options + + + In addition to the normal options provided by Meson, GTK defines + various arguments that modify what should be built. + + + meson + + + -Dx11-backend=true + -Dx11-backend=false + + + + -Dwayland-backend=true + -Dwayland-backend=false + + + + -Dbroadway-backend=true + -Dbroadway-backend=false + + + + -Dwin32-backend=true + -Dwin32-backend=false + + + + -Dquartz-backend=true + -Dquartz-backend=false + + + + -Dmedia=gstreamer + -Dmedia=ffmpeg + -Dmedia=all + -Dmedia=none + + + + -Dvulkan=yes + -Dvulkan=no + -Dvulkan=auto + + + + -Dxinerama=yes + -Dxinerama=no + -Dxinerama=auto + + + + -Dcloudproviders=true + -Dcloudproviders=false + + + + -Dprint-backends=all + -Dprint-backends=none + -Dprint-backends=cups,lpr,... + + + + -Dcolord=yes + -Dcolord=no + -Dcolord=auto + + + + -Dgtk_doc=true + -Dgtk_doc=false + + + + -Dman-pages=true + -Dman-pages=false + + + + -Dintrospection=true + -Dintrospection=false + + + + + + <systemitem>xinerama</systemitem> - In addition to the normal options provided by Meson, GTK defines - various arguments that modify what should be built. - - - meson - - - -Dx11-backend=true - -Dx11-backend=false - - - - -Dwayland-backend=true - -Dwayland-backend=false - - - - -Dbroadway-backend=true - -Dbroadway-backend=false - - - - -Dwin32-backend=true - -Dwin32-backend=false - - - - -Dquartz-backend=true - -Dquartz-backend=false - - - - -Dmedia=gstreamer - -Dmedia=ffmpeg - -Dmedia=all - -Dmedia=none - - - - -Dvulkan=yes - -Dvulkan=no - -Dvulkan=auto - - - - -Dxinerama=yes - -Dxinerama=no - -Dxinerama=auto - - - - -Dcloudproviders=true - -Dcloudproviders=false - - - - -Dprint-backends=all - -Dprint-backends=none - -Dprint-backends=cups,lpr,... - - - - -Dcolord=yes - -Dcolord=no - -Dcolord=auto - - - - -Dgtk_doc=true - -Dgtk_doc=false - - - - -Dman-pages=true - -Dman-pages=false - - - - -Dintrospection=true - -Dintrospection=false - - + By default GTK will try to link against the Xinerama libraries + if they are found. This options can be used to explicitly control + whether Xinerama should be used. + - - <systemitem>xinerama</systemitem> + + <systemitem>gtk_doc</systemitem> and + <systemitem>man-pages</systemitem> - - By default GTK will try to link against the Xinerama libraries - if they are found. This options can be used to explicitly control - whether Xinerama should be used. - - + + The gtk-doc package is + used to generate the reference documentation included + with GTK. By default support for gtk-doc + is disabled because it requires various extra dependencies + to be installed. If you have + gtk-doc installed and + are modifying GTK, you may want to enable + gtk-doc support by passing + in gtk_doc. + + + Additionally, some tools provided by GTK have their own + manual pages generated using a similar set of dependencies; + if you have xsltproc then you + can generate manual pages by passing man-pages + when configuring the build. + + - - <systemitem>gtk_doc</systemitem> and - <systemitem>man-pages</systemitem> + + <systemitem>print-backends</systemitem> - - The gtk-doc package is - used to generate the reference documentation included - with GTK. By default support for gtk-doc - is disabled because it requires various extra dependencies - to be installed. If you have - gtk-doc installed and - are modifying GTK, you may want to enable - gtk-doc support by passing - in gtk_doc. - - - Additionally, some tools provided by GTK have their own - manual pages generated using a similar set of dependencies; - if you have xsltproc then you - can generate manual pages by passing man-pages - when configuring the build. - - + + By default, GTK will try to build various print backends if + their dependencies are found. This option can be used to + explicitly control which print backends should be built. + + - - <systemitem>print-backends</systemitem> + + <systemitem>x11-backend</systemitem>, + <systemitem>win32-backend</systemitem>, + <systemitem>quartz-backend</systemitem>, + <systemitem>broadway-backend</systemitem> and + <systemitem>wayland-backend</systemitem> - - By default, GTK will try to build various print backends if - their dependencies are found. This option can be used to - explicitly control which print backends should be built. - - + + Enable specific backends for GDK. If none of these options + are given, the Wayland backend will be enabled by default, + if the platform is Linux; the X11 backend will also be enabled + by default, unless the platform is Windows, in which case the + default is win32, or the platform is macOS, in which case the + default is quartz. If any backend is explicitly enabled or disabled, + no other platform will be enabled automatically. + + - - <systemitem>x11-backend</systemitem>, - <systemitem>win32-backend</systemitem>, - <systemitem>quartz-backend</systemitem>, - <systemitem>broadway-backend</systemitem> and - <systemitem>wayland-backend</systemitem> + + <systemitem>introspection</systemitem> - - Enable specific backends for GDK. If none of these options - are given, the Wayland backend will be enabled by default, - if the platform is Linux; the X11 backend will also be enabled - by default, unless the platform is Windows, in which case the - default is win32, or the platform is macOS, in which case the - default is quartz. If any backend is explicitly enabled or disabled, - no other platform will be enabled automatically. - - + + Allows to disable building introspection support. This is option + is mainly useful for shortening turnaround times on developer + systems. Installed builds of GTK should always have introspection + support. + + - - <systemitem>introspection</systemitem> + + <systemitem>build-tests</systemitem>, + <systemitem>install-tests</systemitem>, + <systemitem>demos</systemitem> - - Allows to disable building introspection support. This is option - is mainly useful for shortening turnaround times on developer - systems. Installed builds of GTK should always have introspection - support. - - + + By default, GTK will build quite a few tests and demos. + While these are useful on a developer system, they are not + needed when GTK is built e.g. for a flatpak runtime. These + options allow to disable building tests and demos. + + - - <systemitem>build-tests</systemitem>, - <systemitem>install-tests</systemitem>, - <systemitem>demos</systemitem> - - - By default, GTK will build quite a few tests and demos. - While these are useful on a developer system, they are not - needed when GTK is built e.g. for a flatpak runtime. These - options allow to disable building tests and demos. - - - - +