pyrox.dev
1# X.org {#sec-xorg}
2
3The Nix expressions for the X.org packages reside in `pkgs/servers/x11/xorg/default.nix`. This file is automatically generated from lists of tarballs in an X.org release. As such, it should not be modified directly; rather, you should modify the lists, the generator script, or the file `pkgs/servers/x11/xorg/overrides.nix`, in which you can override or add to the derivations produced by the generator.
4
5## Katamari Tarballs {#katamari-tarballs}
6
7X.org upstream releases used to include [katamari](https://en.wiktionary.org/wiki/%E3%81%8B%E3%81%9F%E3%81%BE%E3%82%8A) releases, which included a holistic recommended version for each tarball, up until 7.7. To create a list of tarballs in a katamari release:
8
9```ShellSession
10export release="X11R7.7"
11export url="mirror://xorg/$release/src/everything/"
12cat $(PRINT_PATH=1 nix-prefetch-url $url | tail -n 1) \
13 | perl -e 'while (<>) { if (/(href|HREF)="([^"]*.bz2)"/) { print "$ENV{'url'}$2\n"; }; }' \
14 | sort > "tarballs-$release.list"
15```
16
17## Individual Tarballs {#individual-tarballs}
18
19The upstream release process for [X11R7.8](https://x.org/wiki/Releases/7.8/) does not include a planned katamari. Instead, each component of X.org is released as its own tarball. We maintain `pkgs/servers/x11/xorg/tarballs.list` as a list of tarballs for each individual package. This list includes X.org core libraries and protocol descriptions, extra newer X11 interface libraries, like `xorg.libxcb`, and classic utilities which are largely unused but still available if needed, like `xorg.imake`.
20
21## Generating Nix Expressions {#generating-nix-expressions}
22
23The generator is invoked as follows:
24
25```ShellSession
26cd pkgs/servers/x11/xorg
27<tarballs.list perl ./generate-expr-from-tarballs.pl
28```
29
30For each of the tarballs in the `.list` files, the script downloads it, unpacks it, and searches its `configure.ac` and `*.pc.in` files for dependencies. This information is used to generate `default.nix`. The generator caches downloaded tarballs between runs. Pay close attention to the `NOT FOUND: $NAME` messages at the end of the run, since they may indicate missing dependencies. (Some might be optional dependencies, however.)
31
32## Overriding the Generator {#overriding-the-generator}
33
34If the expression for a package requires derivation attributes that the generator cannot figure out automatically (say, `patches` or a `postInstall` hook), you should modify `pkgs/servers/x11/xorg/overrides.nix`.