NixOS Wiki

Fonts: Difference between revisions

← Older edit
Visual
Klinger (talk | contribs)
trusted
871 edits
mNo edit summary
Geb (talk | contribs)
1 edit
m changed the example font configuration ('noto-fonts-cjk' has been renamed renamed to 'noto-fonts-cjk-sans')
 
(22 intermediate revisions by 11 users not shown)
Line 1: Line 1:
NixOS handles fonts like it handles many different parts of the system: they are not in an environment unless explicitly marked to be part of it. This guide covers the installation, configuration and troubleshooting of fonts.
== Installing fonts on NixOS ==
== Installing fonts on NixOS ==


Line 5: Line 7:
Despite looking like normal packages, simply adding these font packages to your <code>environment.systemPackages</code> won't make the fonts accessible to applications. To achieve that, put these packages in the <code>[https://search.nixos.org/options?channel=unstable&show=fonts.packages&from=0&size=50&sort=relevance&type=packages&query=fonts.packages fonts.packages]</code> NixOS options list instead.
Despite looking like normal packages, simply adding these font packages to your <code>environment.systemPackages</code> won't make the fonts accessible to applications. To achieve that, put these packages in the <code>[https://search.nixos.org/options?channel=unstable&show=fonts.packages&from=0&size=50&sort=relevance&type=packages&query=fonts.packages fonts.packages]</code> NixOS options list instead.


'''Note''': for 23.05 or older, <code>fonts.packages</code> is called <code>fonts.fonts</code> instead.
''For example:''
 
For example:  


<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
fonts.packages = with pkgs; [
fonts.packages = with pkgs; [
   noto-fonts
   noto-fonts
   noto-fonts-cjk
   noto-fonts-cjk-sans
   noto-fonts-emoji
   noto-fonts-emoji
   liberation_ttf
   liberation_ttf
Line 24: Line 24:


Be aware that sometimes font names and packages name differ and there is no universal convention in NixOS. See [https://discourse.nixos.org/t/guidelines-on-packaging-fonts/7683/2 Guidelines for font packaging]
Be aware that sometimes font names and packages name differ and there is no universal convention in NixOS. See [https://discourse.nixos.org/t/guidelines-on-packaging-fonts/7683/2 Guidelines for font packaging]
=== Installing specific fonts from nerdfonts ===
 
The <code>nerdfonts</code> package, which contains all fonts from the [https://www.nerdfonts.com/ nerdfonts] repository is quite large and contains a large number of fonts which take some time to install. If you only need a selection of fonts from the package, you can overwrite the font selection on Stable 20.09 like so:
=== Shorthands for fonts ===
* <code>fonts.enableDefaultPackages</code>: when set to <code>true</code>, causes some "basic" fonts to be installed for reasonable Unicode coverage. Set to <code>true</code> if you are unsure about what languages you might end up reading.
* <code>fonts.enableGhostscriptFonts</code>: affects the <code>ghostscript</code> package. Ghostscript packages some URW fonts for the standard PostScript typefaces. If <code>true</code>, these fonts will be visible to GUI applications. You could set it to <code>true</code> if you want these fonts, but <code>gyre-fonts</code> (part of <code>fonts.enableDefaultPackages</code>) might be higher-quality depending on your judgement.
 
=== Installing all nerdfonts ===
The <code>nerdfonts</code> package includes all fonts from the [https://www.nerdfonts.com/ Nerd Fonts repository], making it quite large and resulting in a longer installation time. If you want to install the entire collection, add the following line to your system configuration:{{file|/etc/nixos/configuration.nix|nix|3=fonts.packages = with pkgs; [ nerdfonts ];}}
 
=== Installing specific nerdfonts ===
 
If you only need a selection of fonts from the package, you can overwrite the font selection like so:


<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
Line 33: Line 42:
</syntaxhighlight>
</syntaxhighlight>


This will cause NixOS to download only the [https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/FiraCode Fira Code] and [https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/DroidSansMono Droid Sans Mono] fonts from [https://github.com/ryanoasis/nerd-fonts nerd-fonts] instead of the whole package.
This will cause NixOS to download only the [https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/FiraCode Fira Code] and [https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/DroidSansMono Droid Sans Mono] fonts from [https://github.com/ryanoasis/nerd-fonts nerd-fonts] instead of the whole package. The relevant names can be found by looking [https://github.com/NixOS/nixpkgs/blob/8764d898c4f365d98ef77af140b32c6396eb4e02/pkgs/data/fonts/nerdfonts/shas.nix at the list of the nerdfonts names in this commit].
 
For configurations using later versions of Nixpkgs (after 25.05), individual Nerd Fonts packages can be installed like so:<syntaxhighlight lang="nix">
fonts.packages = with pkgs; [
  nerd-fonts.fira-code
  nerd-fonts.droid-sans-mono
];
</syntaxhighlight>
 
=== Let Fontconfig know the fonts within your Nix profile ===
Nix inserts its user profile path into <code>$XDG_DATA_DIRS</code>, which Fontconfig by default doesn't look in. This cause graphical applications like KDE Plasma not able to recognize the fonts installed via <code>nix-env</code> or <code>nix profile</code>.
 
To solve this, add the file <code>100-nix.conf</code> to your Fontconfig user configuration directory (usually <code>$XDG_CONFIG_HOME/fontconfig/conf.d</code>):
<syntaxhighlight lang="xml">
<?xml version="1.0"?>
<!DOCTYPE fontconfig SYSTEM "urn:fontconfig:fonts.dtd">
<fontconfig>
  <!-- NIX_PROFILE is the path to your Nix profile. See Nix Reference Manual for details. -->
  <dir>NIX_PROFILE/lib/X11/fonts</dir>
  <dir>NIX_PROFILE/share/fonts</dir>
</fontconfig>
</syntaxhighlight>
and run <code>fc-cache</code>.
 
Alternatively, [https://nix-community.github.io/home-manager/options.xhtml#opt-fonts.fontconfig.enable enable Fontconfig configuration] in your Home Manager configuration.


=== Imperative installation of user fonts ===
=== Imperative installation of user fonts ===
This is useful for quick font experiments.
This is useful for quick font experiments.


Example: Install <code>SourceCodePro-Regular</code>.
''Example'': Install <code>SourceCodePro-Regular</code>.
<syntaxhighlight lang="bash">font=$(nix-build --no-out-link '<nixpkgs>' -A source-code-pro)/share/fonts/opentype/SourceCodePro-Regular.otf
<syntaxhighlight lang="bash">font=$(nix-build --no-out-link '<nixpkgs>' -A source-code-pro)/share/fonts/opentype/SourceCodePro-Regular.otf
cp $font ~/.local/share/fonts
cp $font ~/.local/share/fonts
Line 46: Line 79:
</syntaxhighlight>
</syntaxhighlight>


== Configuring fonts ==
The nixos key [https://search.nixos.org/options?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=fonts.fontconfig <code>fonts.fontconfig</code>] (click to see the full list!) handles the fontconfig options. Some options are nicely wrapped in nix; there's always <code>localConf</code> to go straight to the XML.


=== Set multiple fonts for different languages ===
=== Set multiple fonts for different languages ===
If you want to use other languages alongside English, you may want to set appropriate fonts for each language in your whole OS. For example, a Persian speaker might want to use the [https://rastikerdar.github.io/vazirmatn/ Vazirmatn] font for Persian texts and the [https://design.ubuntu.com/font/ Ubuntu] font for English texts. Just put these lines into your <code>configuration.nix</code>:
If you want to use other languages alongside English, you may want to set appropriate fonts for each language in your whole OS. For example, a Persian speaker might want to use the [https://rastikerdar.github.io/vazirmatn/ Vazirmatn] font for Persian texts, but [https://design.ubuntu.com/font/ Ubuntu] and Liberation Serif fonts for English texts. Just put these lines into your <code>configuration.nix</code>:


<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
#----=[ Fonts ]=----#
#----=[ Fonts ]=----#
fonts = {
fonts = {
   enableDefaultPackages = true;
   enableDefaultPackages = true;
   packages = with pkgs; [  
   packages = with pkgs; [  
     ubuntu_font_family
     ubuntu_font_family
    liberation_ttf
     # Persian Font
     # Persian Font
     vazir-fonts
     vazir-fonts
Line 62: Line 99:
   fontconfig = {
   fontconfig = {
     defaultFonts = {
     defaultFonts = {
       serif = [ "Vazirmatn" "Ubuntu" ];
       serif = [ "Liberation Serif" "Vazirmatn" ];
       sansSerif = [ "Vazirmatn" "Ubuntu" ];
       sansSerif = [ "Ubuntu" "Vazirmatn" ];
       monospace = [ "Ubuntu" ];
       monospace = [ "Ubuntu Mono" ];
     };
     };
   };
   };
};
};
</syntaxhighlight>
</syntaxhighlight>
NB:
* This actually just sets the font fallback order so that fontconfig tries using the English font first, then falls back to another font if the character set is not covered. You ''usually'' want to write the English font ''before'' the other-language font, because the other-language font might cover Latin characters too, preventing the English font from showing up.
* <code>defaultFonts</code> translates to <code>&lt;prefer&gt;</code> in the actual fontconfig file. See https://github.com/NixOS/nixpkgs/blob/nixos-23.11/nixos/modules/config/fonts/fontconfig.nix for how NixOS does it, and the links below for how fontconfig interpret it.
* Vazirmatn is actually a "sans-serif" font; using it for <code>serif</code> is not a good visual match. You might need not one, but two (or if you count monospace, three!) font packages for a language.


=== Use custom font substitutions ===
=== Use custom font substitutions ===
Line 75: Line 117:
For example, Okular may show in the ''Document Properties'' dialog that it has substituted DejaVu Sans Mono (a sans-serif font) in place of "NewCenturySchlbk". <code>fc-match NewCenturySchlbk</code> would display similiar info.
For example, Okular may show in the ''Document Properties'' dialog that it has substituted DejaVu Sans Mono (a sans-serif font) in place of "NewCenturySchlbk". <code>fc-match NewCenturySchlbk</code> would display similiar info.


Adding this to your <code>/etc/nixos/configuration.nix</code> should prompt it to use the nicer serif *Schola* font instead:
Adding this to your <code>/etc/nixos/configuration.nix</code> should prompt it to use the more similar (and nicer) serif ''Schola'' font instead:


<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
Line 94: Line 136:
For more information and examples on the xml configuration language:
For more information and examples on the xml configuration language:


* https://linux.die.net/man/5/fonts-conf
* https://www.mankier.com/5/fonts-conf
* https://wiki.archlinux.org/index.php/Font_configuration
* https://wiki.archlinux.org/index.php/Font_configuration
* https://wiki.archlinux.org/index.php/Font_configuration/Examples
* https://wiki.archlinux.org/index.php/Font_configuration/Examples
For a list of suitable replacement fonts:
* https://wiki.archlinux.org/title/Metric-compatible_fonts


== Troubleshooting ==
== Troubleshooting ==
Line 119: Line 164:
=== Flatpak applications can't find system fonts ===
=== Flatpak applications can't find system fonts ===


First, enable <code>fontDir</code> in your NixOS configuration:
To expose available fonts under <code>/run/current-system/sw/share/X11/fonts</code>, enable <code>fontDir</code> in your NixOS configuration.
<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
fonts.fontDir.enable = true;
fonts.fontDir.enable = true;
</syntaxhighlight>
</syntaxhighlight>You will then need to link/copy this folder to one of the Flatpak-supported locations - see below.


==== Best Solution: Just copy necessary fonts to <code>$HOME/.local/share/fonts</code> ====
==== Solution 1: Copy fonts to <code>$HOME/.local/share/fonts</code> ====
Create fonts directory <code>$HOME/.local/share/fonts</code> and copy system fonts with option <code>-L, --dereference</code> .<syntaxhighlight lang="bash">
Create fonts directory <code>$HOME/.local/share/fonts</code> and copy system fonts with option <code>-L, --dereference</code>. You will need to repeat this step whenever the fonts change.<syntaxhighlight lang="bash">
mkdir $HOME/.local/share/fonts && cp -L /run/current-system/sw/share/X11/fonts/* $HOME/.local/share/fonts/
mkdir $HOME/.local/share/fonts && cp -L /run/current-system/sw/share/X11/fonts/* $HOME/.local/share/fonts/
</syntaxhighlight>Note: There is '''no need''' to grant flatpak applications access to <code>$HOME/.local/share/fonts</code>.  
</syntaxhighlight>Note: There is no need to grant flatpak applications access to <code>$HOME/.local/share/fonts</code>.  


Instead, if you do that, some applications (for example, steam) won't work.<blockquote>Internals: How it works?
Instead, if you do that, some applications (for example, steam) won't work.<blockquote>Internals: How it works?
Line 144: Line 189:
</syntaxhighlight>Then flatpak application can read fonts from that to display contents correctly.</blockquote>
</syntaxhighlight>Then flatpak application can read fonts from that to display contents correctly.</blockquote>


==== Another Method: Create symlink to system fonts at  <code>$HOME/.local/share/fonts</code> ====
==== Solution 2: Symlink to system fonts at  <code>$HOME/.local/share/fonts</code> ====
<blockquote>'''Note:''' this method doesn't work for some flatpak applications (for example, steam)!
<blockquote>'''Note:''' this method doesn't work for some flatpak applications (for example, steam)!  


Error: <syntaxhighlight lang="console">
Error: <syntaxhighlight lang="console">
$ flatpak run  com.valvesoftware.Steam
$ flatpak run com.valvesoftware.Steam
bwrap: Can't make symlink at /home/username/.local/share/fonts: File exists
bwrap: Can't make symlink at /home/username/.local/share/fonts: File exists
</syntaxhighlight></blockquote>Create a symlink in <code>XDG_DATA_HOME/fonts</code> pointing to <code>/run/current-system/sw/share/X11/fonts</code>, e. g.  
</syntaxhighlight></blockquote>Create a symlink in <code>XDG_DATA_HOME/fonts</code> pointing to <code>/run/current-system/sw/share/X11/fonts</code>, e. g.  
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
ln -s /run/current-system/sw/share/X11/fonts ~/.local/share/fonts
mkdir $HOME/.local/share/fonts && ln -s /run/current-system/sw/share/X11/fonts ~/.local/share/fonts/
</syntaxhighlight>
</syntaxhighlight>
Now you have two options.
Now you have two options.


===== Option 1: allow the Flatpaks to access the font folder and <code>/nix/store</code> =====
===== Option 1: Allow access to the fonts folder and <code>/nix/store</code> =====
By using the Flatpak CLI or the Flatseal Flatpak make the following directory available to all Flatpaks <code>$HOME/.local/share/fonts</code> and <code>$HOME/.icons</code> the appropriate commands for this are:
By using the Flatpak CLI or the Flatseal Flatpak make the following directory available to all Flatpaks <code>$HOME/.local/share/fonts</code> and <code>$HOME/.icons</code> the appropriate commands for this are:


Line 164: Line 209:
</syntaxhighlight>
</syntaxhighlight>


And, because <code>~/.local/share/fonts</code> is linked to <code>/run/current-system/sw/share/X11/fonts</code>, which in turn is linked to content in <code>/nix/store</code>.
And, because <code>~/.local/share/fonts</code> is linked to <code>/run/current-system/sw/share/X11/fonts</code>, which in turn is linked to content in <code>/nix/store</code>. You need to grant flatpak applications access to the <code>/nix/store</code> directory, so that they can load fonts correctly. You may need to reboot for this to fully take effect.
You need to grant flatpak applications access to the <code>/nix/store</code> directory,
so that they can load fonts correctly.


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
flatpak --user override --filesystem=/nix/store:ro
flatpak --user override --filesystem=/nix/store:ro
flatpak --user override --filesystem=/run/current-system/sw/share/X11/fonts:ro
</syntaxhighlight>
</syntaxhighlight>


===== Option 2: allow the Flatpaks to access the WHOLE filesystem =====
===== Option 2: Allow access to the WHOLE filesystem =====
Allow them access the WHOLE filesystem of yours: <code>All system files</code> in Flatseal or equivalently <code>filesystem=host</code> available to your application, the command for this is:
Allow them access the WHOLE filesystem of yours: <code>All system files</code> in Flatseal or equivalently <code>filesystem=host</code> available to your application, the command for this is:


Line 181: Line 225:
It is important to keep in mind that some flatpak apps may refuse to launch if given certain permissions, such as the Steam flatpak.  
It is important to keep in mind that some flatpak apps may refuse to launch if given certain permissions, such as the Steam flatpak.  


=== Using bindfs for font support ===
==== Solution 3: Configure bindfs for fonts/cursors/icons support ====
Alternatively, you can expose relevant packages directly under <code>/usr/share/...</code> paths. This will also enable Flatpak to use a custom cursor theme if you have one. This solution doesn't require <code>fonts.fontDir.enable</code> to be enabled.<syntaxhighlight lang="nix">
  system.fsPackages = [ pkgs.bindfs ];


<syntaxhighlight lang="nix">
  system.fsPackages = [ pkgs.bindfs ];
   fileSystems = let
   fileSystems = let
     mkRoSymBind = path: {
     mkRoSymBind = path: {
Line 191: Line 235:
       options = [ "ro" "resolve-symlinks" "x-gvfs-hide" ];
       options = [ "ro" "resolve-symlinks" "x-gvfs-hide" ];
     };
     };
     aggregatedIcons = pkgs.buildEnv {
     aggregated = pkgs.buildEnv {
      name = "system-icons";
        name = "system-fonts-and-icons";
      paths = with pkgs; [
        paths = config.fonts.packages ++ (with pkgs; [
        #libsForQt5.breeze-qt5  # for plasma
          # Add your cursor themes and icon packages here
        gnome.gnome-themes-extra
          bibata-cursors
      ];
          gnome.gnome-themes-extra
      pathsToLink = [ "/share/icons" ];
          # etc.
    };
        ]);
    aggregatedFonts = pkgs.buildEnv {
        pathsToLink = [ "/share/fonts" "/share/icons" ];
      name = "system-fonts";
      paths = config.fonts.packages;
      pathsToLink = [ "/share/fonts" ];
     };
     };
   in {
   in {
     "/usr/share/icons" = mkRoSymBind "${aggregatedIcons}/share/icons";
     "/usr/share/fonts" = mkRoSymBind "${aggregated}/share/fonts";
     "/usr/local/share/fonts" = mkRoSymBind "${aggregatedFonts}/share/fonts";
     "/usr/share/icons" = mkRoSymBind "${aggregated}/share/icons";
   };
   };


   fonts = {
   fonts.packages = with pkgs; [
    fontDir.enable = true;
    noto-fonts
    packages = with pkgs; [
    noto-fonts-emoji
      noto-fonts
    noto-fonts-cjk
      noto-fonts-emoji
  ];
      noto-fonts-cjk
</syntaxhighlight>
    ];
=== Noto Color Emoji doesn't render on Firefox ===
  };
 
Enable <code>useEmbeddedBitmaps</code> in your NixOs configuration.
<syntaxhighlight lang="nix">
fonts.fontconfig.useEmbeddedBitmaps = true;
</syntaxhighlight>
</syntaxhighlight>


Line 222: Line 266:
[[Category:Configuration]]
[[Category:Configuration]]
[[Category:Desktop]]
[[Category:Desktop]]
[[Category:Fonts]]
Retrieved from "https://wiki.nixos.org/wiki/Fonts"