README

   1 -*- mode: org -*-
   2
   3 [[http://www.gnu.org/software/guix/][GNU Guix]] (IPA: /ɡiːks/) is a purely functional package manager, and
   4 associated free software distribution, for the [[http://www.gnu.org/gnu/gnu.html][GNU system]].  In addition
   5 to standard package management features, Guix supports transactional
   6 upgrades and roll-backs, unprivileged package management, per-user
   7 profiles, and garbage collection.
   8
   9 It provides [[http://www.gnu.org/software/guile/][Guile]] Scheme APIs, including a high-level embedded
  10 domain-specific languages (EDSLs) to describe how packages are to be
  11 built and composed.
  12
  13 A user-land free software distribution for GNU/Linux comes as part of
  14 Guix.
  15
  16 Guix is based on the [[http://nixos.org/nix/][Nix]] package manager.
  17
  18
  19 * Requirements
  20
  21 GNU Guix currently depends on the following packages:
  22
  23   - [[http://gnu.org/software/guile/][GNU Guile 2.0.x]], version 2.0.5 or later
  24   - [[http://gnupg.org/][GNU libgcrypt]]
  25   - optionally [[http://savannah.nongnu.org/projects/guile-json/][Guile-JSON]], for the 'guix import pypi' command
  26
  27 Unless `--disable-daemon' was passed, the following packages are needed:
  28
  29   - [[http://sqlite.org/][SQLite 3]]
  30   - [[http://www.bzip.org][libbz2]]
  31   - [[http://gcc.gnu.org][GCC's g++]]
  32
  33 When `--disable-daemon' was passed, you instead need the following:
  34
  35   - [[http://nixos.org/nix/][Nix]]
  36
  37 * Installation
  38
  39 See the manual for the installation instructions, either by running
  40
  41   info -f doc/guix.info "(guix) Installation"
  42
  43 or by checking the [[http://www.gnu.org/software/guix/manual/guix.html#Installation][web copy of the manual]].
  44
  45 For information on installation from a Git checkout, please see the ‘HACKING’
  46 file.
  47
  48 * Installing Guix from Guix
  49
  50 You can re-build and re-install Guix using a system that already runs Guix.
  51 To do so:
  52
  53   - Install the dependencies (see 'Requirements' above) and build tools using
  54     Guix:
  55
  56       guix package --install autoconf automake bzip2 gcc-toolchain gettext \
  57                              guile libgcrypt pkg-config sqlite
  58
  59   - Set the environment variables that Guix recommends you to set during the
  60     package installation process:
  61       ACLOCAL_PATH, CPATH, LIBRARY_PATH, PKG_CONFIG_PATH
  62
  63   - Set the PATH environment variable to refer to the profile:
  64       PATH=$HOME/.guix-profile/bin:$PATH
  65
  66   - Re-run the 'configure' script passing it the option
  67     '--with-libgcrypt-prefix=$HOME/.guix-profile/', as well as
  68     '--localstatedir=/somewhere', where '/somewhere' is the 'localstatedir'
  69     value of the currently installed Guix (failing to do that would lead the
  70     new Guix to consider the store to be empty!).
  71
  72   - Run "make", "make check", and "make install".
  73
  74 * How It Works
  75
  76 Guix does the high-level preparation of a /derivation/.  A derivation is
  77 the promise of a build; it is stored as a text file under
  78 =/gnu/store/xxx.drv=.  The (guix derivations) module provides the
  79 `derivation' primitive, as well as higher-level wrappers such as
  80 `build-expression->derivation'.
  81
  82 Guix does remote procedure calls (RPCs) to the Guix or Nix daemon (the
  83 =guix-daemon= or =nix-daemon= command), which in turn performs builds
  84 and accesses to the Nix store on its behalf.  The RPCs are implemented
  85 in the (guix store) module.
  86
  87 * Installing Guix as non-root
  88
  89 The Guix daemon allows software builds to be performed under alternate
  90 user accounts, which are normally created specifically for this
  91 purpose.  For instance, you may have a pool of accounts in the
  92 =guixbuild= group, and then you can instruct =guix-daemon= to use them
  93 like this:
  94
  95   $ guix-daemon --build-users-group=guixbuild
  96
  97 However, unless it is run as root, =guix-daemon= cannot switch users.
  98 In that case, it falls back to using a setuid-root helper program call
  99 =nix-setuid-helper=.  That program is not setuid-root by default when
 100 you install it; instead you should run a command along these lines
 101 (assuming Guix is installed under /usr/local):
 102
 103   # chown root.root /usr/local/libexec/nix-setuid-helper
 104   # chmod 4755 /usr/local/libexec/nix-setuid-helper
 105
 106 * Contact
 107
 108 GNU Guix is hosted at https://savannah.gnu.org/projects/guix/.
 109
 110 Please email <bug-guix@gnu.org> for bug reports or questions regarding
 111 Guix and its distribution; email <gnu-system-discuss@gnu.org> for
 112 general issues regarding the GNU system.
 113
 114 Join #guix on irc.freenode.net.
 115
 116 * Guix & Nix
 117
 118 GNU Guix is based on [[http://nixos.org/nix/][the Nix package manager]].  It implements the same
 119 package deployment paradigm, and in fact it reuses some of its code.
 120 Yet, different engineering decisions were made for Guix, as described
 121 below.
 122
 123 Nix is really two things: a package build tool, implemented by a library
 124 and daemon, and a special-purpose programming language.  GNU Guix relies
 125 on the former, but uses Scheme as a replacement for the latter.
 126
 127 Using Scheme instead of a specific language allows us to get all the
 128 features and tooling that come with Guile (compiler, debugger, REPL,
 129 Unicode, libraries, etc.)  And it means that we have a general-purpose
 130 language, on top of which we can have embedded domain-specific languages
 131 (EDSLs), such as the one used to define packages.  This broadens what
 132 can be done in package recipes themselves, and what can be done around them.
 133
 134 Technically, Guix makes remote procedure calls to the ‘nix-worker’
 135 daemon to perform operations on the store.  At the lowest level, Nix
 136 “derivations” represent promises of a build, stored in ‘.drv’ files in
 137 the store.  Guix produces such derivations, which are then interpreted
 138 by the daemon to perform the build.  Thus, Guix derivations can use
 139 derivations produced by Nix (and vice versa).
 140
 141 With Nix and the [[http://nixos.org/nixpkgs][Nixpkgs]] distribution, package composition happens at
 142 the Nix language level, but builders are usually written in Bash.
 143 Conversely, Guix encourages the use of Scheme for both package
 144 composition and builders.  Likewise, the core functionality of Nix is
 145 written in C++ and Perl; Guix relies on some of the original C++ code,
 146 but exposes all the API as Scheme.
 147
 148 * Related software
 149
 150   - [[http://nixos.org][Nix, Nixpkgs, and NixOS]], functional package manager and associated
 151     software distribution, are the inspiration of Guix
 152   - [[http://www.gnu.org/software/stow/][GNU Stow]] builds around the idea of one directory per prefix, and a
 153     symlink tree to create user environments
 154   - [[http://www.pvv.ntnu.no/~arnej/store/storedoc_6.html][STORE]] shares the same idea
 155   - [[https://live.gnome.org/OSTree/][GNOME's OSTree]] allows bootable system images to be built from a
 156     specified set of packages
 157   - The [[http://www.gnu.org/s/gsrc/][GNU Source Release Collection]] (GSRC) is a user-land software
 158     distribution; unlike Guix, it relies on core tools available on the
 159     host system