1.\" $OpenBSD: gnome-module.5,v 1.5 2023/04/24 11:54:28 ajacoutot Exp $ 2.\" 3.\" Copyright (c) 2008 Marc Espie 4.\" 5.\" All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR 17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, 20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26.\" 27.Dd $Mdocdate: April 24 2023 $ 28.Dt GNOME-MODULE 5 29.Os 30.Sh NAME 31.Nm gnome-module 32.Nd x11/gnome port module 33.Sh DESCRIPTION 34This manual page documents the behavior of setting 35.Li MODULES=x11/gnome 36in the 37.Xr ports 7 38tree. 39.Pp 40This module has full support for the 41.Ar gnu , 42.Ar simple 43and 44.Ar cmake 45CONFIGURE_STYLE. 46.Pp 47If both 48.Ev GNOME_PROJECT 49and 50.Ev GNOME_VERSION 51are set, this module defines 52.Ev DISTNAME , 53.Ev VERSION , 54.Ev MASTER_SITES , 55adds x11/gnome to 56.Ev CATEGORIES 57and 58.Ev EXTRACT_SUFX 59will default to .tar.xz if unset. 60.Pp 61Unless 62.Li NO_BUILD=Yes , 63.Pa devel/gettext,-tools 64is appended to 65.Ev MODGNOME_BUILD_DEPENDS 66for ports built using 67.Xr meson 1 68and 69.Pa textproc/intltool 70is appended to 71.Ev MODULES 72for other ports. 73.Pp 74.Ev USE_GMAKE 75is set to "Yes". 76.Pp 77When CONFIGURE_STYLE is set to 78.Ar gnu 79or 80.Ar simple , 81if none of 82.Ev AUTOCONF_VERSION 83nor 84.Ev AUTOMAKE_VERSION 85are defined, then "--disable-maintainer-mode" is appended to 86.Ev CONFIGURE_ARGS . 87When CONFIGURE_STYLE is set to 88.Ar cmake , 89"-DENABLE_MAINTAINER_MODE=OFF" and -DSYSCONF_INSTALL_DIR=${SYSCONFDIR} 90are appended to CONFIGURE_ARGS. 91.Pp 92MODGNOME_CPPFLAGS and MODGNOME_LDFLAGS can be used to add compiler and linker 93flags. 94.Li CPPFLAGS="-I${LOCALBASE}/include" 95and 96.Li LDFLAGS="-L${LOCALBASE}/lib" 97are always appended to 98.Ev CONFIGURE_ENV . 99.Pp 100Certain build/run dependencies and configure arguments and environment 101can be set by appending desktop-file-utils, docbook, gi-docgen, 102gobject-introspection, gtk-update-icon-cache, shared-mime-info, 103vala and/or yelp to 104.Ev MODGNOME_TOOLS . 105They are disabled otherwise. 106.Pp 107If 108.Ev MODGNOME_TOOLS 109includes desktop-file-utils, 110a dependency on 111.Pa devel/desktop-file-utils 112is appended to 113.Ev MODGNOME_RUN_DEPENDS 114and a link to /usr/bin/true is created under 115.Pa ${WRKDIR}/bin/desktop-file-validate . 116.Pp 117If 118.Ev MODGNOME_TOOLS 119includes docbook, 120.Pa textproc/docbook-xsl 121is appended to 122.Ev MODGNOME_BUILD_DEPENDS . 123This option is used when the generation of the man pages included in the 124source tarball requires docbook XML/SGML/XSL definitions and stylesheets. 125.Pp 126If 127.Ev MODGNOME_TOOLS 128includes gi-docgen, 129.Pa textproc/gi-docgen 130is appended to 131.Ev MODGNOME_BUILD_DEPENDS . 132This option is used to generate documentation using GI-Docgen. 133.Pp 134If 135.Ev MODGNOME_TOOLS 136includes gtk-update-icon-cache, a dependency on 137.Pa x11/gtk+4,-guic 138is appended to 139.Ev MODGNOME_RUN_DEPENDS . 140.Pp 141If 142.Ev MODGNOME_TOOLS 143includes shared-mime-info, a dependency on 144.Pa misc/shared-mime-info 145is appended to 146.Ev MODGNOME_RUN_DEPENDS 147and a link to /usr/bin/true is created under 148.Pa ${WRKDIR}/bin/update-mime-database . 149.Pp 150If 151.Ev MODGNOME_TOOLS 152includes yelp, 153.Pa textproc/itstool 154and 155.Pa x11/gnome/doc-utils 156are appended to 157.Ev MODGNOME_BUILD_DEPENDS . 158Furthermore, 159.Pa x11/gnome/yelp 160is appended to 161.Ev MODGNOME_RUN_DEPENDS 162if 163.Ev MODGNOME_TOOLS 164also contains "desktop-file-utils" 165This option is to be used when any files are installed into 166.Pa share/gnome/help/ 167or page files are installed into 168.Pa share/help/ . 169.Pp 170.Ev MODGNOME_BUILD_DEPENDS 171and 172.Ev MODGNOME_RUN_DEPENDS 173are appended to the 174corresponding 175.Ev BUILD_DEPENDS 176and 177.Ev RUN_DEPENDS . 178.Pp 179Some tools require the following tag in the PLIST: 180.Pp 181.Ar desktop-file-utils 182.Bd -literal -offset indent 183@tag update-desktop-database 184.Ed 185.Pp 186.Ar gtk-update-icon-cache 187($icon-theme is the theme directory) 188.Bd -literal -offset indent 189@tag gtk-update-icon-cache %D/share/icons/$icon-theme 190.Ed 191.Pp 192.Ar shared-mime-info 193.Bd -literal -offset indent 194@tag update-mime-database 195.Ed 196.Sh SEE ALSO 197.Xr port-modules 5 198