···

       
12
       
 
       
} ./script.sh

     

       
13
       
 
       
```

     

       
14
       
 
       


     

       
15
       
-
       
#### setup hook that depends on the hello package and runs hello and @shell@ is substituted with path to bash {#sec-pkgs.makeSetupHook-usage-example}

     

       
16
       
 
       


     

       
17
       
 
       
```nix

     

       
18
       
 
       
pkgs.makeSetupHook {

     

···

       
12
       
 
       
} ./script.sh

     

       
13
       
 
       
```

     

       
14
       
 
       


     

       
15
       
+
       
### setup hook that depends on the hello package and runs hello and @shell@ is substituted with path to bash {#sec-pkgs.makeSetupHook-usage-example}

     

       
16
       
 
       


     

       
17
       
 
       
```nix

     

       
18
       
 
       
pkgs.makeSetupHook {

     

···

       
1
       
-
       


     

       
2
       
-
       
### Autoconf {#setup-hook-autoconf}

     

       
3
       
 
       


     

       
4
       
 
       
The `autoreconfHook` derivation adds `autoreconfPhase`, which runs autoreconf, libtoolize and automake, essentially preparing the configure script in autotools-based builds. Most autotools-based packages come with the configure script pre-generated, but this hook is necessary for a few packages and when you need to patch the package’s configure scripts.

     

···

       
1
       
+
       
# Autoconf {#setup-hook-autoconf}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
The `autoreconfHook` derivation adds `autoreconfPhase`, which runs autoreconf, libtoolize and automake, essentially preparing the configure script in autotools-based builds. Most autotools-based packages come with the configure script pre-generated, but this hook is necessary for a few packages and when you need to patch the package’s configure scripts.

     

···

       
1
       
-
       


     

       
2
       
-
       
### Automake {#setup-hook-automake}

     

       
3
       
 
       


     

       
4
       
 
       
Adds the `share/aclocal` subdirectory of each build input to the `ACLOCAL_PATH` environment variable.

     

···

       
1
       
+
       
# Automake {#setup-hook-automake}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Adds the `share/aclocal` subdirectory of each build input to the `ACLOCAL_PATH` environment variable.

     

···

       
1
       
-
       


     

       
2
       
-
       
### autoPatchelfHook {#setup-hook-autopatchelfhook}

     

       
3
       
 
       


     

       
4
       
 
       
This is a special setup hook which helps in packaging proprietary software in that it automatically tries to find missing shared library dependencies of ELF files based on the given `buildInputs` and `nativeBuildInputs`.

     

       
5
       
 
       


     

···

       
1
       
+
       
# autoPatchelfHook {#setup-hook-autopatchelfhook}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
This is a special setup hook which helps in packaging proprietary software in that it automatically tries to find missing shared library dependencies of ELF files based on the given `buildInputs` and `nativeBuildInputs`.

     

       
4
       
 
       


     

···

       
1
       
-
       


     

       
2
       
-
       
### breakpointHook {#breakpointhook}

     

       
3
       
 
       


     

       
4
       
 
       
This hook will make a build pause instead of stopping when a failure happens. It prevents nix from cleaning up the build environment immediately and allows the user to attach to a build environment using the `cntr` command. Upon build error it will print instructions on how to use `cntr`, which can be used to enter the environment for debugging. Installing cntr and running the command will provide shell access to the build sandbox of failed build. At `/var/lib/cntr` the sandboxed filesystem is mounted. All commands and files of the system are still accessible within the shell. To execute commands from the sandbox use the cntr exec subcommand. `cntr` is only supported on Linux-based platforms. To use it first add `cntr` to your `environment.systemPackages` on NixOS or alternatively to the root user on non-NixOS systems. Then in the package that is supposed to be inspected, add `breakpointHook` to `nativeBuildInputs`.

     

       
5
       
 
       


     

···

       
1
       
+
       
# breakpointHook {#breakpointhook}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
This hook will make a build pause instead of stopping when a failure happens. It prevents nix from cleaning up the build environment immediately and allows the user to attach to a build environment using the `cntr` command. Upon build error it will print instructions on how to use `cntr`, which can be used to enter the environment for debugging. Installing cntr and running the command will provide shell access to the build sandbox of failed build. At `/var/lib/cntr` the sandboxed filesystem is mounted. All commands and files of the system are still accessible within the shell. To execute commands from the sandbox use the cntr exec subcommand. `cntr` is only supported on Linux-based platforms. To use it first add `cntr` to your `environment.systemPackages` on NixOS or alternatively to the root user on non-NixOS systems. Then in the package that is supposed to be inspected, add `breakpointHook` to `nativeBuildInputs`.

     

       
4
       
 
       


     

···

       
1
       
-
       


     

       
2
       
-
       
### cmake {#cmake}

     

       
3
       
 
       


     

       
4
       
 
       
Overrides the default configure phase to run the CMake command. By default, we use the Make generator of CMake. In addition, dependencies are added automatically to `CMAKE_PREFIX_PATH` so that packages are correctly detected by CMake. Some additional flags are passed in to give similar behavior to configure-based packages. You can disable this hook’s behavior by setting `configurePhase` to a custom value, or by setting `dontUseCmakeConfigure`. `cmakeFlags` controls flags passed only to CMake. By default, parallel building is enabled as CMake supports parallel building almost everywhere. When Ninja is also in use, CMake will detect that and use the ninja generator.

     

···

       
1
       
+
       
# cmake {#cmake}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Overrides the default configure phase to run the CMake command. By default, we use the Make generator of CMake. In addition, dependencies are added automatically to `CMAKE_PREFIX_PATH` so that packages are correctly detected by CMake. Some additional flags are passed in to give similar behavior to configure-based packages. You can disable this hook’s behavior by setting `configurePhase` to a custom value, or by setting `dontUseCmakeConfigure`. `cmakeFlags` controls flags passed only to CMake. By default, parallel building is enabled as CMake supports parallel building almost everywhere. When Ninja is also in use, CMake will detect that and use the ninja generator.

     

···

       
1
       
-
       


     

       
2
       
-
       
### gdk-pixbuf {#setup-hook-gdk-pixbuf}

     

       
3
       
 
       


     

       
4
       
 
       
Exports `GDK_PIXBUF_MODULE_FILE` environment variable to the builder. Add librsvg package to `buildInputs` to get svg support. See also the [setup hook description in GNOME platform docs](#ssec-gnome-hooks-gdk-pixbuf).

     

···

       
1
       
+
       
# gdk-pixbuf {#setup-hook-gdk-pixbuf}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Exports `GDK_PIXBUF_MODULE_FILE` environment variable to the builder. Add librsvg package to `buildInputs` to get svg support. See also the [setup hook description in GNOME platform docs](#ssec-gnome-hooks-gdk-pixbuf).

     

···

       
1
       
-
       


     

       
2
       
-
       
### GHC {#ghc}

     

       
3
       
 
       


     

       
4
       
 
       
Creates a temporary package database and registers every Haskell build input in it (TODO: how?).

     

···

       
1
       
+
       
# GHC {#ghc}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Creates a temporary package database and registers every Haskell build input in it (TODO: how?).

     

···

       
1
       
-
       


     

       
2
       
-
       
### GNOME platform {#gnome-platform}

     

       
3
       
 
       


     

       
4
       
 
       
Hooks related to GNOME platform and related libraries like GLib, GTK and GStreamer are described in [](#sec-language-gnome).

     

···

       
1
       
+
       
# GNOME platform {#gnome-platform}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Hooks related to GNOME platform and related libraries like GLib, GTK and GStreamer are described in [](#sec-language-gnome).

     

···

       
1
       
-
       


     

       
2
       
-
       
### `installShellFiles` {#installshellfiles}

     

       
3
       
 
       


     

       
4
       
 
       
This hook helps with installing manpages and shell completion files. It exposes 2 shell functions `installManPage` and `installShellCompletion` that can be used from your `postInstall` hook.

     

       
5
       
 
       


     

···

       
1
       
+
       
# `installShellFiles` {#installshellfiles}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
This hook helps with installing manpages and shell completion files. It exposes 2 shell functions `installManPage` and `installShellCompletion` that can be used from your `postInstall` hook.

     

       
4
       
 
       


     

···

       
1
       
-
       


     

       
2
       
-
       
### libiconv, libintl {#libiconv-libintl}

     

       
3
       
 
       


     

       
4
       
 
       
A few libraries automatically add to `NIX_LDFLAGS` their library, making their symbols automatically available to the linker. This includes libiconv and libintl (gettext). This is done to provide compatibility between GNU Linux, where libiconv and libintl are bundled in, and other systems where that might not be the case. Sometimes, this behavior is not desired. To disable this behavior, set `dontAddExtraLibs`.

     

···

       
1
       
+
       
# libiconv, libintl {#libiconv-libintl}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
A few libraries automatically add to `NIX_LDFLAGS` their library, making their symbols automatically available to the linker. This includes libiconv and libintl (gettext). This is done to provide compatibility between GNU Linux, where libiconv and libintl are bundled in, and other systems where that might not be the case. Sometimes, this behavior is not desired. To disable this behavior, set `dontAddExtraLibs`.

     

···

       
1
       
-
       


     

       
2
       
-
       
### libxml2 {#setup-hook-libxml2}

     

       
3
       
 
       


     

       
4
       
 
       
Adds every file named `catalog.xml` found under the `xml/dtd` and `xml/xsl` subdirectories of each build input to the `XML_CATALOG_FILES` environment variable.

     

···

       
1
       
+
       
# libxml2 {#setup-hook-libxml2}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Adds every file named `catalog.xml` found under the `xml/dtd` and `xml/xsl` subdirectories of each build input to the `XML_CATALOG_FILES` environment variable.

     

···

       
1
       
-
       


     

       
2
       
-
       
### Meson {#meson}

     

       
3
       
 
       


     

       
4
       
 
       
Overrides the configure phase to run meson to generate Ninja files. To run these files, you should accompany Meson with ninja. By default, `enableParallelBuilding` is enabled as Meson supports parallel building almost everywhere.

     

       
5
       
 
       


     

       
6
       
-
       
#### Variables controlling Meson {#variables-controlling-meson}

     

       
7
       
 
       


     

       
8
       
-
       
##### `mesonFlags` {#mesonflags}

     

       
9
       
 
       


     

       
10
       
 
       
Controls the flags passed to meson.

     

       
11
       
 
       


     

       
12
       
-
       
##### `mesonBuildType` {#mesonbuildtype}

     

       
13
       
 
       


     

       
14
       
 
       
Which [`--buildtype`](https://mesonbuild.com/Builtin-options.html#core-options) to pass to Meson. We default to `plain`.

     

       
15
       
 
       


     

       
16
       
-
       
##### `mesonAutoFeatures` {#mesonautofeatures}

     

       
17
       
 
       


     

       
18
       
 
       
What value to set [`-Dauto_features=`](https://mesonbuild.com/Builtin-options.html#core-options) to. We default to `enabled`.

     

       
19
       
 
       


     

       
20
       
-
       
##### `mesonWrapMode` {#mesonwrapmode}

     

       
21
       
 
       


     

       
22
       
 
       
What value to set [`-Dwrap_mode=`](https://mesonbuild.com/Builtin-options.html#core-options) to. We default to `nodownload` as we disallow network access.

     

       
23
       
 
       


     

       
24
       
-
       
##### `dontUseMesonConfigure` {#dontusemesonconfigure}

     

       
25
       
 
       


     

       
26
       
 
       
Disables using Meson’s `configurePhase`.

     

···

       
1
       
+
       
# Meson {#meson}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Overrides the configure phase to run meson to generate Ninja files. To run these files, you should accompany Meson with ninja. By default, `enableParallelBuilding` is enabled as Meson supports parallel building almost everywhere.

     

       
4
       
 
       


     

       
5
       
+
       
## Variables controlling Meson {#variables-controlling-meson}

     

       
6
       
 
       


     

       
7
       
+
       
### `mesonFlags` {#mesonflags}

     

       
8
       
 
       


     

       
9
       
 
       
Controls the flags passed to meson.

     

       
10
       
 
       


     

       
11
       
+
       
### `mesonBuildType` {#mesonbuildtype}

     

       
12
       
 
       


     

       
13
       
 
       
Which [`--buildtype`](https://mesonbuild.com/Builtin-options.html#core-options) to pass to Meson. We default to `plain`.

     

       
14
       
 
       


     

       
15
       
+
       
### `mesonAutoFeatures` {#mesonautofeatures}

     

       
16
       
 
       


     

       
17
       
 
       
What value to set [`-Dauto_features=`](https://mesonbuild.com/Builtin-options.html#core-options) to. We default to `enabled`.

     

       
18
       
 
       


     

       
19
       
+
       
### `mesonWrapMode` {#mesonwrapmode}

     

       
20
       
 
       


     

       
21
       
 
       
What value to set [`-Dwrap_mode=`](https://mesonbuild.com/Builtin-options.html#core-options) to. We default to `nodownload` as we disallow network access.

     

       
22
       
 
       


     

       
23
       
+
       
### `dontUseMesonConfigure` {#dontusemesonconfigure}

     

       
24
       
 
       


     

       
25
       
 
       
Disables using Meson’s `configurePhase`.

     

···

       
1
       
-
       


     

       
2
       
-
       
### ninja {#ninja}

     

       
3
       
 
       


     

       
4
       
 
       
Overrides the build, install, and check phase to run ninja instead of make. You can disable this behavior with the `dontUseNinjaBuild`, `dontUseNinjaInstall`, and `dontUseNinjaCheck`, respectively. Parallel building is enabled by default in Ninja.

     

···

       
1
       
+
       
# ninja {#ninja}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Overrides the build, install, and check phase to run ninja instead of make. You can disable this behavior with the `dontUseNinjaBuild`, `dontUseNinjaInstall`, and `dontUseNinjaCheck`, respectively. Parallel building is enabled by default in Ninja.

     

···

       
1
       
-
       


     

       
2
       
-
       
### Perl {#setup-hook-perl}

     

       
3
       
 
       


     

       
4
       
 
       
Adds the `lib/site_perl` subdirectory of each build input to the `PERL5LIB` environment variable. For instance, if `buildInputs` contains Perl, then the `lib/site_perl` subdirectory of each input is added to the `PERL5LIB` environment variable.

     

···

       
1
       
+
       
# Perl {#setup-hook-perl}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Adds the `lib/site_perl` subdirectory of each build input to the `PERL5LIB` environment variable. For instance, if `buildInputs` contains Perl, then the `lib/site_perl` subdirectory of each input is added to the `PERL5LIB` environment variable.

     

···

       
1
       
-
       


     

       
2
       
-
       
### pkg-config {#setup-hook-pkg-config}

     

       
3
       
 
       


     

       
4
       
 
       
Adds the `lib/pkgconfig` and `share/pkgconfig` subdirectories of each build input to the `PKG_CONFIG_PATH` environment variable.

     

···

       
1
       
+
       
# pkg-config {#setup-hook-pkg-config}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Adds the `lib/pkgconfig` and `share/pkgconfig` subdirectories of each build input to the `PKG_CONFIG_PATH` environment variable.

     

···

       
1
       
-
       


     

       
2
       
-
       
### Python {#setup-hook-python}

     

       
3
       
 
       


     

       
4
       
 
       
Adds the `lib/${python.libPrefix}/site-packages` subdirectory of each build input to the `PYTHONPATH` environment variable.

     

···

       
1
       
+
       
# Python {#setup-hook-python}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Adds the `lib/${python.libPrefix}/site-packages` subdirectory of each build input to the `PYTHONPATH` environment variable.

     

···

       
1
       
-
       


     

       
2
       
-
       
### Qt 4 {#qt-4}

     

       
3
       
 
       


     

       
4
       
 
       
Sets the `QTDIR` environment variable to Qt’s path.

     

···

       
1
       
+
       
# Qt 4 {#qt-4}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Sets the `QTDIR` environment variable to Qt’s path.

     

···

       
1
       
-
       


     

       
2
       
-
       
### scons {#scons}

     

       
3
       
 
       


     

       
4
       
 
       
Overrides the build, install, and check phases. This uses the scons build system as a replacement for make. scons does not provide a configure phase, so everything is managed at build and install time.

     

···

       
1
       
+
       
# scons {#scons}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Overrides the build, install, and check phases. This uses the scons build system as a replacement for make. scons does not provide a configure phase, so everything is managed at build and install time.

     

···

       
1
       
-
       


     

       
2
       
-
       
### teTeX / TeX Live {#tetex-tex-live}

     

       
3
       
 
       


     

       
4
       
 
       
Adds the `share/texmf-nix` subdirectory of each build input to the `TEXINPUTS` environment variable.

     

···

       
1
       
+
       
# teTeX / TeX Live {#tetex-tex-live}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Adds the `share/texmf-nix` subdirectory of each build input to the `TEXINPUTS` environment variable.

     

···

       
1
       
-
       


     

       
2
       
-
       
### unzip {#unzip}

     

       
3
       
 
       


     

       
4
       
 
       
This setup hook will allow you to unzip .zip files specified in `$src`. There are many similar packages like `unrar`, `undmg`, etc.

     

···

       
1
       
+
       
# unzip {#unzip}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
This setup hook will allow you to unzip .zip files specified in `$src`. There are many similar packages like `unrar`, `undmg`, etc.

     

···

       
1
       
-
       


     

       
2
       
-
       
### validatePkgConfig {#validatepkgconfig}

     

       
3
       
 
       


     

       
4
       
 
       
The `validatePkgConfig` hook validates all pkg-config (`.pc`) files in a package. This helps catching some common errors in pkg-config files, such as undefined variables.

     

···

       
1
       
+
       
# validatePkgConfig {#validatepkgconfig}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
The `validatePkgConfig` hook validates all pkg-config (`.pc`) files in a package. This helps catching some common errors in pkg-config files, such as undefined variables.

     

···

       
1
       
-
       


     

       
2
       
-
       
### wafHook {#wafhook}

     

       
3
       
 
       


     

       
4
       
 
       
Overrides the configure, build, and install phases. This will run the “waf” script used by many projects. If `wafPath` (default `./waf`) doesn’t exist, it will copy the version of waf available in Nixpkgs. `wafFlags` can be used to pass flags to the waf script.

     

···

       
1
       
+
       
# wafHook {#wafhook}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Overrides the configure, build, and install phases. This will run the “waf” script used by many projects. If `wafPath` (default `./waf`) doesn’t exist, it will copy the version of waf available in Nixpkgs. `wafFlags` can be used to pass flags to the waf script.

     

···

       
1
       
-
       


     

       
2
       
-
       
### xcbuildHook {#xcbuildhook}

     

       
3
       
 
       


     

       
4
       
 
       
Overrides the build and install phases to run the "xcbuild" command. This hook is needed when a project only comes with build files for the XCode build system. You can disable this behavior by setting buildPhase and configurePhase to a custom value. xcbuildFlags controls flags passed only to xcbuild.

     

···

       
1
       
+
       
# xcbuildHook {#xcbuildhook}

     

       
0
       
 
       

     

       
2
       
 
       


     

       
3
       
 
       
Overrides the build and install phases to run the "xcbuild" command. This hook is needed when a project only comes with build files for the XCode build system. You can disable this behavior by setting buildPhase and configurePhase to a custom value. xcbuildFlags controls flags passed only to xcbuild.

     

···

       
137
       
 
       


     

       
138
       
 
       
## Frequently encountered issues {#ssec-gnome-common-issues}

     

       
139
       
 
       


     

       
140
       
-
       
#### `GLib-GIO-ERROR **: 06:04:50.903: No GSettings schemas are installed on the system` {#ssec-gnome-common-issues-no-schemas}

     

       
141
       
 
       


     

       
142
       
 
       
There are no schemas available in `XDG_DATA_DIRS`. Temporarily add a random package containing schemas like `gsettings-desktop-schemas` to `buildInputs`. [`glib`](#ssec-gnome-hooks-glib) and [`wrapGAppsHook`](#ssec-gnome-hooks-wrapgappshook) setup hooks will take care of making the schemas available to application and you will see the actual missing schemas with the [next error](#ssec-gnome-common-issues-missing-schema). Or you can try looking through the source code for the actual schemas used.

     

       
143
       
 
       


     

       
144
       
-
       
#### `GLib-GIO-ERROR **: 06:04:50.903: Settings schema ‘org.gnome.foo’ is not installed` {#ssec-gnome-common-issues-missing-schema}

     

       
145
       
 
       


     

       
146
       
 
       
Package is missing some GSettings schemas. You can find out the package containing the schema with `nix-locate org.gnome.foo.gschema.xml` and let the hooks handle the wrapping as [above](#ssec-gnome-common-issues-no-schemas).

     

       
147
       
 
       


     

       
148
       
-
       
#### When using `wrapGAppsHook` with special derivers you can end up with double wrapped binaries. {#ssec-gnome-common-issues-double-wrapped}

     

       
149
       
 
       


     

       
150
       
 
       
This is because derivers like `python.pkgs.buildPythonApplication` or `qt5.mkDerivation` have setup-hooks automatically added that produce wrappers with makeWrapper. The simplest way to workaround that is to disable the `wrapGAppsHook` automatic wrapping with `dontWrapGApps = true;` and pass the arguments it intended to pass to makeWrapper to another.

     

       
151
       
 
       


     
···

       
193
       
 
       
}

     

       
194
       
 
       
```

     

       
195
       
 
       


     

       
196
       
-
       
#### I am packaging a project that cannot be wrapped, like a library or GNOME Shell extension. {#ssec-gnome-common-issues-unwrappable-package}

     

       
197
       
 
       


     

       
198
       
 
       
You can rely on applications depending on the library setting the necessary environment variables but that is often easy to miss. Instead we recommend to patch the paths in the source code whenever possible. Here are some examples:

     

       
199
       
 
       


     
···

       
209
       
 
       


     

       
210
       
 
       
  []{#ssec-gnome-common-issues-unwrappable-package-gsettings-c} [Hard-coding GSettings schema path in C library](https://github.com/NixOS/nixpkgs/blob/29c120c065d03b000224872251bed93932d42412/pkgs/development/libraries/glib-networking/default.nix#L31-L34) – nothing special other than using [Coccinelle patch](https://github.com/NixOS/nixpkgs/pull/67957#issuecomment-527717467) to generate the patch itself.

     

       
211
       
 
       


     

       
212
       
-
       
#### I need to wrap a binary outside `bin` and `libexec` directories. {#ssec-gnome-common-issues-weird-location}

     

       
213
       
 
       


     

       
214
       
 
       
You can manually trigger the wrapping with `wrapGApp` in `preFixup` phase. It takes a path to a program as a first argument; the remaining arguments are passed directly to [`wrapProgram`](#fun-wrapProgram) function.

     

···

       
137
       
 
       


     

       
138
       
 
       
## Frequently encountered issues {#ssec-gnome-common-issues}

     

       
139
       
 
       


     

       
140
       
+
       
### `GLib-GIO-ERROR **: 06:04:50.903: No GSettings schemas are installed on the system` {#ssec-gnome-common-issues-no-schemas}

     

       
141
       
 
       


     

       
142
       
 
       
There are no schemas available in `XDG_DATA_DIRS`. Temporarily add a random package containing schemas like `gsettings-desktop-schemas` to `buildInputs`. [`glib`](#ssec-gnome-hooks-glib) and [`wrapGAppsHook`](#ssec-gnome-hooks-wrapgappshook) setup hooks will take care of making the schemas available to application and you will see the actual missing schemas with the [next error](#ssec-gnome-common-issues-missing-schema). Or you can try looking through the source code for the actual schemas used.

     

       
143
       
 
       


     

       
144
       
+
       
### `GLib-GIO-ERROR **: 06:04:50.903: Settings schema ‘org.gnome.foo’ is not installed` {#ssec-gnome-common-issues-missing-schema}

     

       
145
       
 
       


     

       
146
       
 
       
Package is missing some GSettings schemas. You can find out the package containing the schema with `nix-locate org.gnome.foo.gschema.xml` and let the hooks handle the wrapping as [above](#ssec-gnome-common-issues-no-schemas).

     

       
147
       
 
       


     

       
148
       
+
       
### When using `wrapGAppsHook` with special derivers you can end up with double wrapped binaries. {#ssec-gnome-common-issues-double-wrapped}

     

       
149
       
 
       


     

       
150
       
 
       
This is because derivers like `python.pkgs.buildPythonApplication` or `qt5.mkDerivation` have setup-hooks automatically added that produce wrappers with makeWrapper. The simplest way to workaround that is to disable the `wrapGAppsHook` automatic wrapping with `dontWrapGApps = true;` and pass the arguments it intended to pass to makeWrapper to another.

     

       
151
       
 
       


     
···

       
193
       
 
       
}

     

       
194
       
 
       
```

     

       
195
       
 
       


     

       
196
       
+
       
### I am packaging a project that cannot be wrapped, like a library or GNOME Shell extension. {#ssec-gnome-common-issues-unwrappable-package}

     

       
197
       
 
       


     

       
198
       
 
       
You can rely on applications depending on the library setting the necessary environment variables but that is often easy to miss. Instead we recommend to patch the paths in the source code whenever possible. Here are some examples:

     

       
199
       
 
       


     
···

       
209
       
 
       


     

       
210
       
 
       
  []{#ssec-gnome-common-issues-unwrappable-package-gsettings-c} [Hard-coding GSettings schema path in C library](https://github.com/NixOS/nixpkgs/blob/29c120c065d03b000224872251bed93932d42412/pkgs/development/libraries/glib-networking/default.nix#L31-L34) – nothing special other than using [Coccinelle patch](https://github.com/NixOS/nixpkgs/pull/67957#issuecomment-527717467) to generate the patch itself.

     

       
211
       
 
       


     

       
212
       
+
       
### I need to wrap a binary outside `bin` and `libexec` directories. {#ssec-gnome-common-issues-weird-location}

     

       
213
       
 
       


     

       
214
       
 
       
You can manually trigger the wrapping with `wrapGApp` in `preFixup` phase. It takes a path to a program as a first argument; the remaining arguments are passed directly to [`wrapProgram`](#fun-wrapProgram) function.