1.\" $OpenBSD: gnome-module.5,v 1.8 2023/11/11 13:27:24 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: November 11 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 , 43.Ar meson 44and 45.Ar cmake 46CONFIGURE_STYLE. 47.Pp 48If 49.Ev DIST_TUPLE 50is set and the 51.Em gnome 52template is used, this module will set default values for 53.Ev GNOME_PROJECT, 54.Ev GNOME_VERSION, 55.Ev WRKDIST, 56and 57.Ev EXTRACT_SUFX . 58.Pp 59If both 60.Ev GNOME_PROJECT 61and 62.Ev GNOME_VERSION 63are set, this module defines 64.Ev DISTNAME , 65.Ev MASTER_SITES , 66adds x11/gnome to 67.Ev CATEGORIES 68and 69.Ev EXTRACT_SUFX 70will default to .tar.xz if unset. 71.Pp 72Unless 73.Li NO_BUILD=Yes , 74.Pa devel/gettext,-tools 75is appended to 76.Ev MODGNOME_BUILD_DEPENDS 77for ports built using 78.Xr meson 1 79and 80.Pa textproc/intltool 81is appended to 82.Ev MODULES 83for other ports. 84.Pp 85.Ev USE_GMAKE 86is set to "Yes". 87.Pp 88When CONFIGURE_STYLE is set to 89.Ar gnu 90or 91.Ar simple , 92if none of 93.Ev AUTOCONF_VERSION 94nor 95.Ev AUTOMAKE_VERSION 96are defined, then "--disable-maintainer-mode" is appended to 97.Ev CONFIGURE_ARGS . 98When CONFIGURE_STYLE is set to 99.Ar cmake , 100"-DENABLE_MAINTAINER_MODE=OFF" and -DSYSCONF_INSTALL_DIR=${SYSCONFDIR} 101are appended to CONFIGURE_ARGS. 102.Pp 103MODGNOME_CPPFLAGS and MODGNOME_LDFLAGS can be used to add compiler and linker 104flags. 105.Li CPPFLAGS="-I${LOCALBASE}/include" 106and 107.Li LDFLAGS="-L${LOCALBASE}/lib" 108are always appended to 109.Ev CONFIGURE_ENV . 110.Pp 111Certain build/run dependencies and configure arguments and environment 112can be set by appending desktop-file-utils, docbook, gi-docgen, 113gobject-introspection, gtk-update-icon-cache, shared-mime-info, 114vala and/or yelp to 115.Ev MODGNOME_TOOLS . 116They are disabled otherwise. 117.Pp 118If 119.Ev MODGNOME_TOOLS 120includes desktop-file-utils, 121a dependency on 122.Pa devel/desktop-file-utils 123is appended to 124.Ev MODGNOME_RUN_DEPENDS 125and a link to /usr/bin/true is created under 126.Pa ${WRKDIR}/bin/desktop-file-validate . 127.Pp 128If 129.Ev MODGNOME_TOOLS 130includes docbook, 131.Pa textproc/docbook-xsl 132is appended to 133.Ev MODGNOME_BUILD_DEPENDS . 134This option is used when the generation of the man pages included in the 135source tarball requires docbook XML/SGML/XSL definitions and stylesheets. 136.Pp 137If 138.Ev MODGNOME_TOOLS 139includes gi-docgen, 140.Pa textproc/gi-docgen 141is appended to 142.Ev MODGNOME_BUILD_DEPENDS . 143This option is used to generate documentation using GI-Docgen. 144.Pp 145If 146.Ev MODGNOME_TOOLS 147includes gtk-update-icon-cache, a dependency on 148.Pa x11/gtk+4,-guic 149is appended to 150.Ev MODGNOME_RUN_DEPENDS . 151.Pp 152If 153.Ev MODGNOME_TOOLS 154includes shared-mime-info, a dependency on 155.Pa misc/shared-mime-info 156is appended to 157.Ev MODGNOME_RUN_DEPENDS 158and a link to /usr/bin/true is created under 159.Pa ${WRKDIR}/bin/update-mime-database . 160.Pp 161If 162.Ev MODGNOME_TOOLS 163includes yelp, 164.Pa textproc/itstool 165and 166.Pa x11/gnome/doc-utils 167are appended to 168.Ev MODGNOME_BUILD_DEPENDS . 169Furthermore, 170.Pa x11/gnome/yelp 171is appended to 172.Ev MODGNOME_RUN_DEPENDS 173if 174.Ev MODGNOME_TOOLS 175also contains "desktop-file-utils" 176This option is to be used when any files are installed into 177.Pa share/gnome/help/ 178or page files are installed into 179.Pa share/help/ . 180.Pp 181.Ev MODGNOME_BUILD_DEPENDS 182and 183.Ev MODGNOME_RUN_DEPENDS 184are appended to the 185corresponding 186.Ev BUILD_DEPENDS 187and 188.Ev RUN_DEPENDS . 189.Pp 190Some tools require the following tag in the PLIST: 191.Pp 192.Ar desktop-file-utils 193.Bd -literal -offset indent 194@tag update-desktop-database 195.Ed 196.Pp 197.Ar gtk-update-icon-cache 198($icon-theme is the theme directory) 199.Bd -literal -offset indent 200@tag gtk-update-icon-cache %D/share/icons/$icon-theme 201.Ed 202.Pp 203.Ar shared-mime-info 204.Bd -literal -offset indent 205@tag update-mime-database 206.Ed 207.Sh SEE ALSO 208.Xr port-modules 5 209