diff options
Diffstat (limited to 'nixpkgs/doc/languages-frameworks/gnome.xml')
| -rw-r--r-- | nixpkgs/doc/languages-frameworks/gnome.xml | 37 |
1 files changed, 28 insertions, 9 deletions
diff --git a/nixpkgs/doc/languages-frameworks/gnome.xml b/nixpkgs/doc/languages-frameworks/gnome.xml index 9e0f21a6c74f..bb68d026ae23 100644 --- a/nixpkgs/doc/languages-frameworks/gnome.xml +++ b/nixpkgs/doc/languages-frameworks/gnome.xml @@ -32,7 +32,11 @@ <title>Icons</title> <para> - When an application uses icons, an icon theme should be available in <envar>XDG_DATA_DIRS</envar>. The package for the default, icon-less <link xlink:href="https://www.freedesktop.org/wiki/Software/icon-theme/">hicolor-icon-theme</link> contains <link linkend="ssec-gnome-hooks-hicolor-icon-theme">a setup hook</link> that will pick up icon themes from <literal>buildInputs</literal> and pass it to our wrapper. Unfortunately, relying on that would mean every user has to download the theme included in the package expression no matter their preference. For that reason, we leave the installation of icon theme on the user. If you use one of the desktop environments, you probably already have an icon theme installed. + When an application uses icons, an icon theme should be available in <envar>XDG_DATA_DIRS</envar> during runtime. The package for the default, icon-less <link xlink:href="https://www.freedesktop.org/wiki/Software/icon-theme/">hicolor-icon-theme</link> (should be propagated by every icon theme) contains <link linkend="ssec-gnome-hooks-hicolor-icon-theme">a setup hook</link> that will pick up icon themes from <literal>buildInputs</literal> and pass it to our wrapper. Unfortunately, relying on that would mean every user has to download the theme included in the package expression no matter their preference. For that reason, we leave the installation of icon theme on the user. If you use one of the desktop environments, you probably already have an icon theme installed. + </para> + + <para> + To avoid costly file system access when locating icons, GTK, <link xlink:href="https://woboq.com/blog/qicon-reads-gtk-icon-cache-in-qt57.html">as well as Qt</link>, can rely on <filename>icon-theme.cache</filename> files from the themes’ top-level directories. These files are generated using <command>gtk-update-icon-cache</command>, which is expected to be run whenever an icon is added or removed to an icon theme (typically an application icon into <literal>hicolor</literal> theme) and some programs do indeed run this after icon installation. However, since packages are installed into their own prefix by Nix, this would lead to conflicts. For that reason, <package>gtk3</package> provides a <link xlink:href="#ssec-gnome-hooks-gtk-drop-icon-theme-cache">setup hook</link> that will clean the file from installation. Since most applications only ship their own icon that will be loaded on start-up, it should not affect them too much. On the other hand, icon themes are much larger and more widely used so we need to cache them. Because we recommend installing icon themes globally, we will generate the cache files from all packages in a profile using a NixOS module. You can enable the cache generation using <option>gtk.iconCache.enable</option> option if your desktop environment does not already do that. </para> </section> @@ -70,7 +74,7 @@ preFixup = '' for f in $(find $out/bin/ $out/libexec/ -type f -executable); do wrapProgram "$f" \ - --prefix GIO_EXTRA_MODULES : "${getLib gnome3.dconf}/lib/gio/modules" \ + --prefix GIO_EXTRA_MODULES : "${getLib dconf}/lib/gio/modules" \ --prefix XDG_DATA_DIRS : "$out/share" \ --prefix XDG_DATA_DIRS : "$out/share/gsettings-schemas/${name}" \ --prefix XDG_DATA_DIRS : "${gsettings-desktop-schemas}/share/gsettings-schemas/${gsettings-desktop-schemas.name}" \ @@ -91,9 +95,14 @@ preFixup = '' <package>glib</package> setup hook will populate <envar>GSETTINGS_SCHEMAS_PATH</envar> and then <package>wrapGAppsHook</package> will prepend it to <envar>XDG_DATA_DIRS</envar>. </para> </listitem> + <listitem xml:id="ssec-gnome-hooks-gtk-drop-icon-theme-cache"> + <para> + One of <package>gtk3</package>’s setup hooks will remove <filename>icon-theme.cache</filename> files from package’s icon theme directories to avoid conflicts. Icon theme packages should prevent this with <code>dontDropIconThemeCache = true;</code>. + </para> + </listitem> <listitem xml:id="ssec-gnome-hooks-dconf"> <para> - <package>gnome3.dconf.lib</package> is a dependency of <package>wrapGAppsHook</package>, which then also adds it to the <envar>GIO_EXTRA_MODULES</envar> variable. + <package>dconf.lib</package> is a dependency of <package>wrapGAppsHook</package>, which then also adds it to the <envar>GIO_EXTRA_MODULES</envar> variable. </para> </listitem> <listitem xml:id="ssec-gnome-hooks-hicolor-icon-theme"> @@ -190,9 +199,9 @@ python3.pkgs.buildPythonApplication { dontWrapGApps = true; # Arguments to be passed to `makeWrapper`, only used by buildPython* - makeWrapperArgs = [ - "\${gappsWrapperArgs[@]}" - ]; + preFixup = '' + makeWrapperArgs+=("''${gappsWrapperArgs[@]}") + ''; } </programlisting> And for a QT app like: @@ -210,9 +219,9 @@ mkDerivation { dontWrapGApps = true; # Arguments to be passed to `makeWrapper`, only used by qt5’s mkDerivation - qtWrapperArgs [ - "\${gappsWrapperArgs[@]}" - ]; + preFixup = '' + qtWrapperArgs+=("''${gappsWrapperArgs[@]}") + ''; } </programlisting> </para> @@ -258,6 +267,16 @@ mkDerivation { </para> </listitem> </varlistentry> + <varlistentry xml:id="ssec-gnome-common-issues-weird-location"> + <term> + I need to wrap a binary outside <filename>bin</filename> and <filename>libexec</filename> directories. + </term> + <listitem> + <para> + You can manually trigger the wrapping with <function>wrapGApp</function> in <literal>preFixup</literal> phase. It takes a path to a program as a first argument; the remaining arguments are passed directly to <function xlink:href="#fun-wrapProgram">wrapProgram</function> function. + </para> + </listitem> + </varlistentry> </variablelist> </section> </section> |