1.\" $OpenBSD: gnome-module.5,v 1.3 2021/11/18 09:51:30 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 18 2021 $ 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. 60Unless 61.Li NO_BUILD=Yes , 62.Pa textproc/intltool 63is also appended to 64.Ev MODULES 65and when CONFIGURE_STYLE is set to 66.Ar gnu 67or 68.Ar simple , 69.Ev USE_GMAKE 70is set to "Yes". 71.Pp 72When CONFIGURE_STYLE is set to 73.Ar gnu 74or 75.Ar simple , 76if none of 77.Ev AUTOCONF_VERSION 78nor 79.Ev AUTOMAKE_VERSION 80are defined, then "--disable-maintainer-mode" is appended to 81.Ev CONFIGURE_ARGS . 82When CONFIGURE_STYLE is set to 83.Ar cmake , 84"-DENABLE_MAINTAINER_MODE=OFF" and -DSYSCONF_INSTALL_DIR=${SYSCONFDIR} 85are appended to CONFIGURE_ARGS. 86.Pp 87MODGNOME_CPPFLAGS and MODGNOME_LDFLAGS can be used to add compiler and linker 88flags. 89.Li CPPFLAGS="-I${LOCALBASE}/include" 90and 91.Li LDFLAGS="-L${LOCALBASE}/lib" 92are always appended to 93.Ev CONFIGURE_ENV . 94.Pp 95Certain build/run dependencies and configure arguments and environment 96can be set by appending desktop-file-utils, docbook, gobject-introspection, 97gtk-update-icon-cache, shared-mime-info, vala and/or yelp to 98.Ev MODGNOME_TOOLS . 99They are disabled otherwise. 100If 101.Ev MODGNOME_TOOLS 102is set to desktop-file-utils, 103a dependency on 104.Pa devel/desktop-file-utils 105is appended to 106.Ev MODGNOME_RUN_DEPENDS 107and a link to /usr/bin/true is created under 108.Pa ${WRKDIR}/bin/desktop-file-validate . 109If 110.Ev MODGNOME_TOOLS 111is set to docbook, 112.Pa textproc/docbook-xsl 113is appended to 114.Ev MODGNOME_BUILD_DEPENDS . 115This option is used when the generation of the man pages included in the 116source tarball requires docbook XML/SGML/XSL definitions and stylesheets. 117If 118.Ev MODGNOME_TOOLS 119is set to gtk-update-icon-cache, a dependency on 120.Pa x11/gtk+3,-guic 121is appended to 122.Ev MODGNOME_RUN_DEPENDS . 123If 124.Ev MODGNOME_TOOLS 125is set to shared-mime-info, a dependency on 126.Pa misc/shared-mime-info 127is appended to 128.Ev MODGNOME_RUN_DEPENDS 129and a link to /usr/bin/true is created under 130.Pa ${WRKDIR}/bin/update-mime-database . 131If 132.Ev MODGNOME_TOOLS 133is set to yelp, 134.Pa textproc/itstool 135and 136.Pa x11/gnome/doc-utils 137are appended to 138.Ev MODGNOME_BUILD_DEPENDS . 139Furthermore, 140.Pa x11/gnome/yelp 141is appended to 142.Ev MODGNOME_RUN_DEPENDS 143if 144.Ev MODGNOME_TOOLS 145also contains "desktop-file-utils" 146This option is to be used when any files are installed into 147.Pa share/gnome/help/ 148or page files are installed into 149.Pa share/help/ . 150.Ev MODGNOME_BUILD_DEPENDS 151and 152.Ev MODGNOME_RUN_DEPENDS 153are appended to the 154corresponding 155.Ev BUILD_DEPENDS 156and 157.Ev RUN_DEPENDS . 158.Pp 159Some tools require the following tag in the PLIST: 160.Pp 161.Ar desktop-file-utils 162.Bd -literal -offset indent 163@tag update-desktop-database 164.Ed 165.Pp 166.Ar gtk-update-icon-cache 167($icon-theme is the theme directory) 168.Bd -literal -offset indent 169@tag gtk-update-icon-cache %D/share/icons/$icon-theme 170.Ed 171.Pp 172.Ar shared-mime-info 173.Bd -literal -offset indent 174@tag update-mime-database 175.Ed 176.Sh SEE ALSO 177.Xr port-modules 5 178