     [file version-fr.texi not included]

Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018 Ludovic Courtès
 Copyright © 2013, 2014, 2016 Andreas Enge
 Copyright © 2013 Nikita Karetnikov
 Copyright © 2014, 2015, 2016 Alex Kost
 Copyright © 2015, 2016 Mathieu Lirzin

Copyright © 2014 Pierre-Antoine Rault
 Copyright © 2015 Taylan Ulrich Bayırlı/Kammer
 Copyright © 2015, 2016, 2017 Leo Famulari
 Copyright © 2015, 2016, 2017, 2018 Ricardo Wurmus
 Copyright © 2016 Ben Woodcroft
 Copyright © 2016, 2017, 2018 Chris Marusich
 Copyright © 2016, 2017, 2018 Efraim Flashner
 Copyright © 2016 John Darrington
 Copyright © 2016, 2017 Nils Gillmann
 Copyright © 2016, 2017, 2018 Jan Nieuwenhuizen
 Copyright © 2016 Julien Lepiller

Copyright © 2016 Alex ter Weele
 Copyright © 2017, 2018 Clément Lassieur
 Copyright © 2017 Mathieu Othacehe

Copyright © 2017 Federico Beffa
 Copyright © 2017 Carlo Zancanaro
 Copyright © 2017 Thomas Danckaert
 Copyright © 2017 humanitiesNerd
 Copyright © 2017 Christopher Allan Webber
 Copyright © 2017, 2018 Marius Bakke
 Copyright © 2017 Hartmut Goebel
 Copyright © 2017 Maxim Cournoyer
 Copyright © 2017, 2018 Tobias Geerinckx-Rice

Copyright © 2017 George Clemmer
 Copyright © 2017 Andy Wingo
 Copyright © 2017, 2018 Arun Isaac
 Copyright © 2017 nee
 Copyright © 2018 Rutger Helling

Copyright © 2018 Oleg Pykhalov
 Copyright © 2018 Mike Gerwitz
 Copyright © 2018 Pierre-Antoine Rouby
 Copyright © 2018 Gábor Boskovits

Vous avez la permission de copier, distribuer ou modifier ce document sous les termes de la Licence GNU Free Documentation, version 1.3 ou toute version ultérieure publiée par la Free Software Foundation ; sans section invariante, texte de couverture et sans texte de quatrième de couverture. Une copie de la licence est incluse dans la section intitulée « GNU Free Documentation License ».

GNU Guix
********

Cette documentation décrit GNU Guix version VERSION, un outil de gestion de paquets fonctionnel écrit pour le système GNU.

This manual is also available in French (see Manuel de référence de GNU Guix).  If you would like to translate it in your native language, consider joining the Translation Project (https://translationproject.org/domain/guix-manual.html).

Introduction
************

GNU Guix (« Guix » se prononce comme « geeks » (en prononçant le « s »), ou « ɡiːks » dans l'alphabet phonétique international (API).) est un outil de gestion de paquets pour le système GNU.  Guix facilite pour les utilisateurs non privilégiés l'installation, la mise à jour et la suppression de paquets, la restauration à un ensemble de paquets précédent, la construction de paquets depuis les sources et plus généralement aide à la création et à la maintenance d'environnements logiciels.

Guix fournit une interface de gestion des paquets par la ligne de commande (see Invoquer guix package), un ensemble d'utilitaires en ligne de commande (see Utilitaires) ainsi que des interfaces de programmation Scheme (see Interface de programmation). Son démon de construction est responsable de la construction des paquets pour les utilisateurs (see Paramétrer le démon) et du téléchargement des binaires pré-construits depuis les sources autorisées (see Substituts).

Guix contient de nombreuses définitions de paquet GNU et non-GNU qui respectent tous les libertés de l'utilisateur (https://www.gnu.org/philosophy/free-sw.fr.html).  Il est extensible : les utilisateurs peuvent écrire leurs propres définitions de paquets (see Définition des paquets) et les rendre disponibles dans des modules de paquets indépendants (see Modules de paquets).  Il est aussi personnalisable : les utilisateurs peuvent dériver des définitions de paquets spécialisées à partir de définitions existantes, même depuis la ligne de commande (see Options de transformation de paquets).

Vous pouvez installer GNU Guix sur un système GNU/Linux existant pour compléter les outils disponibles sans interférence (see Installation) ou vous pouvez l'utiliser à travers la Distribution Système Guix ou GuixSD (see Distribution GNU) distincte.  Avec GNU GuixSD, vous déclarez tous les aspects de la configuration du système d'exploitation et Guix s'occupe de créer la configuration d'une manière transactionnelle, reproductible et sans état (see Configuration système).

Sous le capot, Guix implémente la discipline de gestion de paquet fonctionnel inventé par Nix (see Remerciements).  Dans Guix le processus de construction et d'installation des paquets est vu comme une fonction dans le sens mathématique du terme.  Cette fonction a des entrées (comme des scripts de construction, un compilateur et des bibliothèques) et renvoie un paquet installé.  En tant que fonction pure, son résultat ne dépend que de ses entrées.  Par exemple, il ne peut pas faire référence à des logiciels ou des scripts qui n'ont pas été explicitement passés en entrée.  Une fonction de construction produit toujours le même résultat quand on lui donne le même ensemble d'entrée. Elle ne peut pas modifier l'environnement du système en cours d'exécution d'aucune manière ; par exemple elle ne peut pas créer, modifier ou supprimer des fichiers en dehors de ses répertoires de construction et d'installation.  Ce résultat s'obtient en lançant les processus de construction dans des environnements isolés (ou des conteneurs) où seules les entrées explicites sont visibles.

Le résultat des fonctions de construction de paquets est mis en cache dans le système de fichier, dans répertoire spécial appelé le dépôt (see Le dépôt).  Chaque paquet est installé dans son répertoire propre dans le dépôt — par défaut dans /gnu/store.  Le nom du répertoire contient un hash de toutes les entrées utilisées pour construire le paquet ; ainsi, changer une entrée donnera un nom de répertoire différent.

Cette approche est le fondement des fonctionnalités les plus importante de Guix : le support des mises à jour des paquets et des retours en arrière transactionnels, l'installation différenciée par utilisateur et le ramassage de miettes pour les paquets (see Fonctionnalités).

Installation
************

GNU Guix est disponible au téléchargement depuis son site web sur http://www.gnu.org/software/guix/.  Cette section décrit les pré-requis logiciels de Guix ainsi que la manière de l'installer et de se préparer à l'utiliser.

Remarquez que cette section concerne l'installation du gestionnaire de paquet, ce qui se fait sur un système GNU/Linux en cours d'exécution.  Si vous souhaitez plutôt installer le système d'exploitation GNU complet, see Installation du système.

Lorsqu'il est installé sur an système GNU/Linux existant — ci-après nommé distro extérieure — GNU Guix complète les outils disponibles sans interférence.  Ses données se trouvent exclusivement dans deux répertoires, typiquement /gnu/store et /var/guix ; les autres fichiers de votre système comme /etc sont laissés intacts.

Une fois installé, Guix peut être mis à jour en lançant guix pull (see Invoquer guix pull).

Installation binaire
====================

Cette section décrit comment intaller Guix sur un système quelconque depuis un archive autonome qui fournit les binaires pour Guix et toutes ses dépendances.  C'est souvent plus rapide que d'installer depuis les sources, ce qui est décrit dans les sections suivantes.  Le seul pré-requis est d'avoir GNU tar et Xz.

Nous fournissons un script script d'intallation shell (https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh) qui automatise le téléchargement, l'installation et la configuration initiale de Guix.  Il devrait être lancé en tant qu'utilisateur root.

L'installation se comme ceci :

 1. Download the binary tarball from https://alpha.gnu.org/gnu/guix/guix-binary-VERSION.SYSTEM.tar.xz, where SYSTEM is x86_64-linux for an x86_64 machine already running the kernel Linux, and so on.

     Assurez-vous de télécharger le fichier .sig associé et de vérifier l'authenticité de l'archive avec, comme ceci :

          $ wget https://alpha.gnu.org/gnu/guix/guix-binary-VERSION.SYSTEM.tar.xz.sig
          $ gpg --verify guix-binary-VERSION.SYSTEM.tar.xz.sig

     Si cette commande échoue parce que vous n'avez pas la clef publique requise, lancez cette commande pour l'importer :

          $ gpg --keyserver pgp.mit.edu --recv-keys 3CE464558A84FDC69DB40CFB090B11993D9AEBB5

     et relancez la commande gpg --verify.

 2. Maintenant, vous devez devenir l'utilisateur root.  En fonction de votre distribution, vous devrez lancer su - ou sudo -i.  En tant que root, lancez :

          # cd /tmp
          # tar --warning=no-timestamp -xf \
               guix-binary-VERSION.SYSTÈME.tar.xz
          # mv var/guix /var/ && mv gnu /

     Cela crée /gnu/store (see Le dépôt) and /var/guix.  Ce deuxième dossier contient un profil pret à être utilisé pour root (voir les étapes suivantes).

     Ne décompressez pas l'archive sur un système Guix lancé car cela écraserait ses propres fichiers essentiels.

     L'option --warning=no-timestamp s'assure que GNU tar ne produise pas d'avertissement disant que « l'horodatage est trop vieux pour être plausible » (ces avertissements étaient produits par GNU tar 1.26 et précédents ; les versions récentes n'ont pas ce problème).  Cela vient du fait que les fichiers de l'archive ont pour date de modification zéro (ce qui signifie le 1er janvier 1970).  C'est fait exprès pour s'assurer que le contenu de l'archive ne dépende pas de la date de création, ce qui la rend reproductible.

 3. Rendez le profil de root disponible sous ~root/.guix-profile :

          # ln -sf /var/guix/profiles/per-user/root/guix-profile \
                   ~root/.guix-profile

     Sourcez etc/profile pour augmenter PATH et les autres variables d'environnement nécessaires :

          # GUIX_PROFILE="`echo ~root`/.guix-profile" ; \
            source $GUIX_PROFILE/etc/profile

 4. Créez le groupe et les comptes utilisateurs pour les utilisateurs de construction comme expliqué plus loin (see Réglages de l'environnement de construction).

 5. Lancez le démon et paramétrez-le pour démarrer automatiquement au démarrage.

     Si votre distribution hôte utilise le système d'initialisation systemd, cela peut se faire avec ces commandes :

          # cp ~root/.guix-profile/lib/systemd/system/guix-daemon.service \
                  /etc/systemd/system/
          # systemctl start guix-daemon && systemctl enable guix-daemon

     Si votre distribution hôte utilise le système d'initialisation Upstart :

          # initctl reload-configuration
          # cp ~root/.guix-profile/lib/upstart/system/guix-daemon.conf /etc/init/
          # start guix-daemon

     Sinon, vous pouvez toujours démarrer le démon manuellement avec :

          # ~root/.guix-profile/bin/guix-daemon --build-users-group=guixbuild

 6. Rendez la commande guix disponible pour les autres utilisateurs sur la machine, par exemple avec :

          # mkdir -p /usr/local/bin
          # cd /usr/local/bin
          # ln -s /var/guix/profiles/per-user/root/guix-profile/bin/guix

     C'est aussi une bonne idée de rendre la version Info de ce manuel disponible ici :

          # mkdir -p /usr/local/share/info
          # cd /usr/local/share/info
          # for i in /var/guix/profiles/per-user/root/guix-profile/share/info/* ;
            do ln -s $i ; done

     Comme cela, en supposant que /usr/local/share/info est dans le chemin de recherche, lancer info guix ouvrira ce manuel (see Other Info Directories (GNU Texinfo), pour plus de détails sur comment changer le chemin de recherche de Info).

 7. Pour utiliser les substituts de hydra.gnu.org ou l'un de ses mirroirs (see Substituts), autorisez-les :

          # guix archive --authorize < ~root/.guix-profile/share/guix/hydra.gnu.org.pub

 8. Chaque utilisateur peut avoir besoin d'effectuer des étapes supplémentaires pour que leur environnement Guix soit prêt à être utilisé, see Réglages applicatifs.

Voilà, l'installation est terminée !

Vous pouvez confirmer que Guix fonctionne en installant un paquet d'exemple dans le profil de root :

     # guix package -i hello

Le paquet guix doit rester disponible dans le profil de root ou il pourrait être sujet au ramassage de miettes — dans ce cas vous vous retrouveriez gravement handicapé par l'absence de la commande guix.  En d'autres termes, ne supprimez pas guix en lançant guix package -r guix.

L'archive d'installation binaire peut être (re)produite et vérifiée simplement en lançaint la commande suivante dans l'arborescence des sources de Guix :

     make guix-binary.SYSTEM.tar.xz

… ce qui à son tour lance :

     guix pack -s SYSTEM --localstatedir guix

See Invoquer guix pack, pour plus d'info sur cet outil pratique.

Prérequis
=========

Cette section dresse la liste des pré-requis pour la construction de Guix depuis les sources.  La procédure de construction pour Guix est la même que pour les autres logiciels GNU, et n'est pas expliquée ici.  Regardez les fichiers README et INSTALL dans l'arborescence des sources de Guix pour plus de détails.

GNU Guix dépend des paquets suivants :

  * GNU Guile (http://gnu.org/software/guile/), version 2.0.13 ou ultérieure, dont 2.2.x,

  * GNU libgcrypt (http://gnupg.org/),

  * GnuTLS (http://gnutls.org/), en particulier ses liaisons Guile (see how to install the GnuTLS bindings for Guile (GnuTLS-Guile)),

  * Guile-SQLite3 (https://notabug.org/civodul/guile-sqlite3), version 0.1.0 or later;

  * Guile-Git (https://gitlab.com/guile-git/guile-git), d'août 2017 ou ultérieur,

  * zlib (http://zlib.net),

  * GNU Make (http://www.gnu.org/software/make/).

Les dépendances suivantes sont facultatives :

  * Installer Guile-JSON (http://savannah.nongnu.org/projects/guile-json/) vous permettra d'utiliser la commande guix import pypi (see Invoquer guix import).  Il est surtout utile pour les développeurs et pas pour les utilisateurs occasionnels.

  * Le support pour la décharge de construction (see Réglages du délestage du démon) et guix copy  (see Invoquer guix copy) dépend de Guile-SSH (https://github.com/artyom-poptsov/guile-ssh), version 0.10.2 ou ulltérieure.

  * Lorsque libbz2 (http://www.bzip.org) est disponible, guix-daemon peut l'utiliser pour compresser les journaux de construction.

À moins que --disable-daemon ne soit passé à configure, les paquets suivants sont aussi requis :

  * SQLite 3 (http://sqlite.org),

  * GCC's g++ (http://gcc.gnu.org), avec le support pour le standard C++11.

Lorsque vous configurez Guix sur un système qui a déjà une installation de Guix, assurez-vous de spécifier le même répertoire d'état que l'installation existante avec l'option --localstatedir du script configure (see localstatedir (GNU Coding Standards)).  Le script configure vous protège des mauvaises configurations involontaires de LOCALSTATEDIR pour éviter que vous ne corrompiez votre dépôt (see Le dépôt).

Lorsque vous avez une installation fonctionnelle du gestionnaire de paquets Nix (http://nixos.org/nix/), vous pouvez configurer Guix avec --disable-daemon.  Dan ce cas, Nix remplace les trois dépendances au dessus.

Guix est compatible avec Nix, donc il est possible de partager le même dépôt entre les deux.  Pour cela, vous devez passer à configure non seulement la même valeur de --with-store-dir mais aussi la même valeur de --localstatedir.  Cette dernière est nécessaires car elle spécifie l'emplacement de la base de données qui stocke les métadonnées sur le dépôt, entre autres choses.  Les valeurs par défaut pour Nix sont --with-store-dir=/nix/store et --localstatedir=/nix/var. Remarquez que --disable-daemon n'est pas requis si votre but est de partager le dépôt avec Nix.

Lancer la suite de tests
========================

Après avoir lancé configure et make correctement, c'est une bonne idée de lancer la suite de tests.  Elle peut aider à trouver des erreurs avec la configuration ou l'environnement, ou des bogues dans Guix lui-même — et vraiment, rapporter des échecs de tests est une bonne manière d'aider à améliorer le logiciel.  Pour lancer la suite de tests, tapez :

     make check

Les cas de tests peuvent être lancés en parallèle : vous pouvez utiliser l'option -j de GNU make pour accélérer les choses.  Le premier lancement peut prendre plusieurs minutes sur une machine récente ; les lancements suivants seront plus rapides car le dépôt créé pour les tests aura déjà plusieurs choses en cache.

Il est aussi possible de lancer un sous-ensemble des tests en définissant la variable makefile TESTS comme dans cet exemple :

     make check TESTS="tests/store.scm tests/cpio.scm"

Par défaut, les résultats des tests sont affichés au niveau du fichier. Pour voir les détails de chaque cas de test individuel, il est possible de définire la variable makefile SCM_LOG_DRIVER_FLAGS comme dans cet exemple :

     make check TESTS="tests/base64.scm" SCM_LOG_DRIVER_FLAGS="--brief=no"

Après un échec, envoyez un courriel à bug-guix@gnu.org et attachez le fichier test-suite.log.  Précisez la version de Guix utilisée ainsi que les numéros de version de ses dépendances (see Prérequis) dans votre message.

Guix possède aussi une suite de tests de systèmes complets qui test des instances complètes du système d'exploitation GuixSD.  Elle ne peut être lancée qui sur un système où Guix est déjà installé, avec :

     make check-system

Ou, de nouveau, en définissant TESTS pour choisir un sous-ensemble des tests à lancer :

     make check-system TESTS="basic mcron"

Ces tests systèmes sont définis dans les modules (gnu tests ...). Ils fonctionnent en lançant les systèmes d'exploitation sous test avec une instrumentation légère dans une machine virtuelle (VM).  Ils peuvent être intenses en terme de calculs ou plutôt rapides en fonction de la disponibilité des substituts de leurs dépendances (see Substituts). Certains requièrent beaucoup d'espace disque pour contenir les images des VM.

De nouveau, en cas d'échec, envoyez tous les détails à bug-guix@gnu.org.

Paramétrer le démon
===================

Les opérations comme la construction d'un paquet ou le lancement du ramasse-miettes sont toutes effectuées par un processus spécialisé, le démon de construction, pour le compte des clients.  Seul le démon peut accéder au dépôt et à sa base de données associée.  Ainsi, toute opération manipulant le dépôt passe par le démon.  Par exemple, les outils en ligne de commande comme guix package et guix build communiquent avec le démon (via des appels de procédures distantes) pour lui dire quoi faire.

Les sections suivantes expliquent comment préparer l'environnement du démon de construction.  Voir aussi Substituts pour apprendre comment permettre le téléchargement de binaires pré-construits.

Réglages de l'environnement de construction
-------------------------------------------

Dans une installation standard multi-utilisateurs, Guix et son démon — le programme guix-daemon — sont installé par l'administrateur système ; /gnu/store appartient à root et guix-daemon est lancé en root.  Les utilisateurs non-privilégiés peuvent utiliser les outils Guix pour construire des paquets ou accéder au dépôt et le démon le fera pour leur compte en s'assurant que le dépôt garde un état cohérent et permet le partage des paquets déjà construits entre les utilisateurs.

Alors que guix-daemon tourne en root, vous n'avez pas forcément envie que les processus de construction de paquets tournent aussi en root, pour des raisons de sécurité évidentes.  Pour éviter cela, vous devriez créer une réserve spéciale d'utilisateurs de construction que les processus de construction démarrés par le démon utiliseront.  Ces utilisateurs de construction n'ont pas besoin d'un shell ou d'un répertoire personnel ; ils seront seulement utilisés quand le démon délaissera ses privilèges root dans les processus de construction.  En ayant plusieurs de ces utilisateurs, vous permettez au démon de lancer des processus de construction distincts sous des UID différent, ce qui garanti qu'aucune interférence n'ait lieu entre les uns et les autres — une fonctionnalité essentielle puisque les constructions sont supposées être des fonctions pures (see Introduction).

Sur un système GNU/Linux, on peut créer une réserve d'utilisateurs de construction comme ceci (avec la syntaxe Bash et les commandes shadow) :

     # groupadd --system guixbuild
     # for i in `seq -w 1 10`;
       do
         useradd -g guixbuild -G guixbuild           \
                 -d /var/empty -s `which nologin`    \
                 -c "Utilisateur de construction Guix $i" --system    \
                 guixbuilder$i;
       done

Le nombre d'utilisateurs de construction détermine le nombre de tâches de constructions qui peuvent tourner en parallèle, tel que spécifié par l'option  --max-jobs (see --max-jobs).  Pour utiliser guix system vm et les commandes liées, vous devrez ajouter les utilisateurs de construction au groupe kvm pour qu'ils puissent accéder à /dev/kvm avec -G guixbuild,kvm plutôt que -G guixbuild (see Invoquer guix system).

Le programme guix-daemon peut ensuite être lancé en root avec la commande suivante (Si votre machine utilise le système d'initialisation systemd, copiez le fichier PREFIX/lib/systemd/system/guix-daemon.service dans /etc/systemd/system pour vous assurer que guix-daemon est démarré automatiquement.  De même, si votre machine utilise le système d'initialisation Upstart, copiez le fichier PREFIX/lib/upstart/system/guix-daemon.conf dans /etc/init.) :

     # guix-daemon --build-users-group=guixbuild

De cette façon, le démon démarre les processus de construction dans un chroot, sous un des utilisateurs guixbuilder.  Sur GNU/Linux par défaut, l'environnement chroot ne contient rien d'autre que :

  * un répertoire /dev minimal, créé presque indépendamment du /dev de l'hôte (« presque », parce que même si l'ensemble des fichiers qui apparaissent dans le /dev du chroot sont déterminés à l'avance, la plupart de ces fichiers ne peut pas être créée si l'hôte ne les a pas.) ;

  * le répertoire /proc ; il ne montre que les processus du conteneur car on utilise une espace de nom séparé pour les PID ;

  * /etc/passwd avec une entrée pour l'utilisateur actuel et une entrée pour l'utilisateur nobody ;

  * /etc/group avec une entrée pour le groupe de l'utilisateur ;

  * /etc/hosts avec une entrée qui fait correspondre localhost à 127.0.0.1 ;

  * un répertoire /tmp inscriptible.

Vous pouvez influencer le répertoire où le démon stocke les arbres de construction via la variable d'environnement TMPDIR.  Cependant, l'arbre de construction dans le chroot sera toujours appelé /tmp/guix-build-NOM.drv-0, où NOM est le nom de la dérivation — p. ex. coreutils-8.24.  De cette façon, la valeur de TMPDIR ne fuite pas à l'intérieur des environnements de construction, ce qui évite des différences lorsque le processus de construction retient le nom de leur répertoire de construction.

Le démon tient aussi compte de la variable d'environnement http_proxy pour ses téléchargements HTTP, que ce soit pour les dérivations à sortie fixes (see Dérivations) ou pour les substituts (see Substituts).

Si vous installez Guix en tant qu'utilisateur non-privilégié, il est toujours possible de lancer guix-daemon si vous passez --disable-chroot.  Cependant, les processus de construction ne seront pas isolés les uns des autres ni du reste du système.  Ainsi les processus de construction peuvent interférer les uns avec les autres, et peuvent accéder à des programmes, des bibliothèques et d'autres fichiers présents sur le système — ce qui rend plus difficile de les voir comme des fonctions pures.

Utiliser le dispositif de déchargement
--------------------------------------

Si vous le souhaitez, le démon de construction peut décharger des constructions de dérivations sur d'autres machines Guix avec le crochet de construction offload (Cette fonctionnalité n'est disponible que si Guile-SSH (https://github.com/artyom-poptsov/guile-ssh) est présent.).  Lorsque cette fonctionnalité est activée, Guix lit une liste de machines de constructions spécifiée par l'utilisateur dans /etc/guix/machines.scm ; à chaque fois qu'une construction est demandée, par exemple par guix build, le démon essaie de la décharger sur une des machines qui satisfont les contraintes de la dérivation, en particulier le type de système, p. ex. x86_64-linux.  Les prérequis manquants pour la construction sont copiés par SSH sur la machine de construction qui procède ensuite à la construction ; si elle réussi, les sorties de la construction sont copiés vers la machine de départ.

Le fichier /etc/guix/machines.scm ressemble typiquement à cela :

     (list (build-machine
             (name "eightysix.example.org")
             (system "x86_64-linux")
             (host-key "ssh-ed25519 AAAAC3Nza...")
             (user "bob")
             (speed 2.))     ;très rapide !

           (build-machine
             (name "meeps.example.org")
             (system "mips64el-linux")
             (host-key "ssh-rsa AAAAB3Nza...")
             (user "alice")
             (private-key
              (string-append (getenv "HOME")
                             "/.ssh/identity-for-guix"))))

Dans l'exemple ci-dessus nous spécifions une liste de deux machines de construction, une pour l'architecture x86_64 et une pour l'architecture mips64el.

En fait, ce fichier est — et ça ne devrait pas vous surprendre ! — un fichier Scheme qui est évalué au démarrage du crochet offload.  Sa valeur de retour doit être une liste d'objets build-machine.  Même si cet exemple montre une liste fixée de machines de construction, on pourrait imaginer par exemple utiliser DNS-SD pour renvoyer une liste de machines de constructions potentielles découvertes sur le réseau local (see Guile-Avahi (Using Avahi in Guile Scheme Programs)).  Le type de données build-machine est détaillé plus bas.

 -- Type de données: build-machine
     Ce type de données représente les machines de construction sur lesquelles le démon peut décharger des constructions.  Les champs importants sont :

     name
          Le nom d'hôte de la machine distante.

     system
          Le type de système de la machine distante, p. ex. "x86_64-linux".

     user
          Le compte utilisateur à utiliser lors de la connexion à la machine distante par SSH.  Remarquez que la paire de clef SSH ne doit pas être protégée par mot de passe pour permettre des connexions non-interactives.

     host-key
          Cela doit être la clef d'hôte SSH publique de la machine au format OpenSSH.  Elle est utilisée pour authentifier la machine lors de la connexion.  C'est une longue chaîne qui ressemble à cela :

               ssh-ed25519 AAAAC3NzaC...mde+UhL hint@example.org

          Si la machine utilise le démon OpenSSH, sshd, la clef d'hôte se trouve dans un fichier comme /etc/ssh/ssh_host_ed25519_key.pub.

          Si la machine utilise le démon SSH de GNU lsh, la clef d'hôte est dans /etc/lsh/host-key.pub ou un fichier similaire.  Elle peut être convertie au format OpenSSH avec lsh-export-key (see Converting keys (LSH Manual)) :

               $ lsh-export-key --openssh < /etc/lsh/host-key.pub
               ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV...

     Il y a un certain nombre de champs facultatifs que vous pouvez remplir :

     port (par défaut : 22)
          Numéro de port du serveur SSH sur la machine.

     private-key (par défaut : ~root/.ssh/id_rsa)
          The SSH private key file to use when connecting to the machine, in OpenSSH format.  This key must not be protected with a passphrase.

          Remarquez que la valeur par défaut est la clef privée du compte root.  Assurez-vous qu'elle existe si vous utilisez la valeur par défaut.

     compression (par défaut : "zlib@openssh.com,zlib")
     compression-level (par défaut : 3)
          Les méthodes de compression au niveau SSH et le niveau de compression demandé.

          Remarquez que le déchargement utilise la compression SSH pour réduire la bande passante utilisée lors du transfert vers et depuis les machines de construction.

     daemon-socket (par défaut : "/var/guix/daemon-socket/socket")
          Le nom de fichier du socket Unix-domain sur lequel guix-daemon écoute sur cette machine.

     parallel-builds (par défaut : 1)
          Le nombre de constructions qui peuvent tourner simultanément sur la machine.

     speed (par défaut : 1.0)
          Un « facteur de vitesse relatif ».  L'ordonnanceur des constructions tendra à préférer les machines avec un plus grand facteur de vitesse.

     features (par défaut : '())
          Une liste de chaînes qui contient les fonctionnalités spécifiques supportées par la machine.  Un exemple est "kvm" pour les machines qui ont le module Linux KVM et le support matériel correspondant.  Les dérivations peuvent demander des fonctionnalités par leur nom et seront orchestrées sur les machines de construction correspondantes.

La commande guile doit être dans le chemin de recherche des machines de construction.  En plus, les modules Guix doivent se trouver dans $GUILE_LOAD_PATH sur la machine de construction.  Vous pouvez vérifier si c'est le cas en lançant :

     ssh build-machine guile -c "'(use-modules (guix config))'"

Il reste une dernière chose à faire maintenant que machines.scm est en place.  Comme expliqué ci-dessus, lors du déchargement les fichiers sont transférés entre les dépôts des machines.  Pour que cela fonctionne, vous devez d'abord générer une paire de clef sur chaque machine pour permettre au démon d'exporter des archives signées des fichiers de son dépôt (see Invoquer guix archive) :

     # guix archive --generate-key

Chaque machine de construction doit autoriser la clef de la machine maîtresse pour qu'ils acceptent les éléments de dépôt de celle-ci :

     # guix archive --authorize < master-public-key.txt

De même, la machine maîtresse doit autoriser les clefs de chaque machine de construction.

Toute cette histoire de clefs permet d'exprimer la confiance mutuelle deux-à-deux entre le maître et les machines de construction.  Concrètement, lorsque le maître reçoit des fichiers d'une machine de construction (et vice-versa), son démon de construction s'assure qu'ils sont authentiques, n'ont pas été modifiés par un tiers et qu'il sont signés par un clef autorisée.

Pour tester que votre paramétrage fonctionne, lancez cette commande sur le nœud maître :

     # guix offload test

Cela essaiera de se connecter à toutes les machines de construction spécifiées dans /etc/guix/machines.scm, s'assurera que Guile et les modules Guix sont disponibles sur toutes les machines et tentera d'exporter vers la machine et d'importer depuis elle, et rapportera toute erreur survenu pendant le processus.

Si vous souhaitez tester un fichier de machines différent, spécifiez-le sur la ligne de commande :

     # guix offload test machines-qualif.scm

Enfin, vous pouvez tester un sous-ensemble de machines dont le nom correspond à une expression rationnelle comme ceci :

     # guix offload test machines.scm '\.gnu\.org$'

Pour afficher la charge actuelle de tous les hôtes de construction, lancez cette commande sur le nœud principal :

     # guix offload status

Support de SELinux
------------------

Guix inclus un fichier de politique SELniux dans etc/guix-daemon.cil qui peut être installé sur un système où SELinux est activé pour que les fichiers Guix soient étiquetés et pour spécifier le comportement attendu du démon.  Comme GuixSD ne fournit pas de politique SELniux de base, la politique du démon ne peut pas être utilisée sur GuixSD.

Installer la politique SELinux
..............................

Pour installer la politique, lancez cette commande en root :

     semodule -i etc/guix-daemon.cil

Puis ré-étiquetez le système de fichier avec restorecon ou par un mécanisme différent fournit par votre système.

Une fois la politique installée, le système de fichier ré-étiqueté et le démon redémarré, il devrait être lancé dans le contexte guix_daemon_t.  Vous pouvez le confirmer avec la commande suivante :

     ps -Zax | grep guix-daemon

Surveillez les fichiers journaux de SELinux pendant que vous lancez une commande comme guix build hello pour vous convaincre que SELniux permet toutes les opérations nécessaires.

Limitations
...........

La politique n'et pas parfaite.  Voici une liste de limitations et de bizarreries qui vous devriez prendre en compte avant de déployer la politique SELinux fournie pour le démon Guix.

 1. guix_daemon_socket_t n'est pas vraiment utilisé.  Aucune des opérations sur les sockets n'impliquent de contextes qui ont quoi que ce soit à voir avec guix_daemon_socket_t.  Ça ne fait pas de mal d'avoir une étiquette inutilisée, mais il serait préférable de définir des règles sur les sockets uniquement pour cette étiquette.

 2. guix gc ne peut pas accéder à n'importe quel lien vers les profils. Par conception, l'étiquette de fichier de la destination d'un lien symbolique est indépendant de l'étiquette du lien lui-même.  Bien que tous les profils sous $localstatedir aient une étiquette, les liens vers ces profils héritent de l'étiquette du répertoire dans lequel ils se trouvent. Pour les liens dans le répertoire personnel cela sera user_home_t. Mais pour les liens du répertoire personnel de l'utilisateur root, ou /tmp, ou du répertoire de travail du serveur HTTP, etc, cela ne fonctionnera pas.  SELinux empêcherait guix gc de lire et de suivre ces liens.

 3. La fonctionnalité du démon d'écouter des connexions TCP pourrait ne plus fonctionner.  Cela demande des règles supplémentaires car SELinux traite les sockets réseau différemment des fichiers.

 4. Actuellement tous les fichiers qui correspondent à l'expression rationnelle /gnu/store/.+-(guix-.+|profile)/bin/guix-daemon reçoivent l'étiquette guix_daemon_exec_t ; cela signifie que tout fichier avec ce nom dans n'importe quel profil serait autorisé à se lancer dans le domaine guix_daemon_t.  Ce n'est pas idéal.  Un attaquant pourrait construire un paquet qui fournit cet exécutable et convaincre un utilisateur de l'installer et de le lancer, ce qui l'élève dans le domaine guix_daemon_t.  À ce moment SELinux ne pourrait pas l'empêcher d'accéder à des fichiers autorisés pour les processus de ce domaine.

     Nous pourrions générer une politique bien plus restrictive à l'installation, pour que seuls les noms de fichiers exacts de l'exécutable guix-daemon actuellement installé soit étiqueté avec guix_daemon_exec_t, plutôt que d'utiliser une expression rationnelle plus large.  L'inconvénient c'est que root devrait installer ou mettre à jour la politique à l'installation à chaque fois que le paquet Guix qui fournit l'exécutable guix-daemon effectivement exécuté est mis à jour.

Invoquer guix-daemon
====================

Le programme guix-daemon implémente toutes les fonctionnalités d'accès au dépôt.  Cela inclus le lancement des processus de construction, le lancement du ramasse-miettes, la demande de disponibilité des résultats de construction, etc.  Il tourne normalement en root comme ceci :

     # guix-daemon --build-users-group=guixbuild

Pour des détails sur son paramétrage, see Paramétrer le démon.

Par défaut, guix-daemon lance les processus de construction sous différents UID récupérés depuis le groupe de construction spécifié avec --build-users-group.  En plus, chaque processus de construction est lancé dans un environnement chroot qui ne contient que le sous-ensemble du dépôt dont le processus de construction dépend, tel que spécifié par sa dérivation (see dérivation), plus un ensemble de répertoires systèmes spécifiques.  Par défaut ce dernier contient /dev et /dev/pts.  De plus, sous GNU/Linux, l'environnement de construction est un conteneur : en plus d'avoir sa propre arborescence du système de fichier, elle a un espace de montage séparé, son propre espace de PID, son espace de réseau, etc.  Cela aide à obtenir des constructions reproductibles (see Fonctionnalités).

Lorsque le démon effectue une construction pour le compte de l'utilisateur, il crée un répertoire sous /tmp ou sous le répertoire spécifié par sa variable d'environnement TMPDIR.  Ce répertoire est partagé avec le conteneur pendant la durée de la construction.  Soyez conscient qu'utiliser un répertoire différent de /tmp peut affecter les résultats de la construction — par exemple avec un nom de répertoire plus long, un processus de construction qui utiliserait des socket Unix-domain pourrait atteindre la limite de longueur de nom de fichier pour sun_path, qu'il n'aurait sinon pas atteinte.

Le répertoire de construction est automatiquement supprimé à la fin, à moins que la construction n'ait échoué et que le client ait spécifié --keep-failed (see --keep-failed).

Les options en ligne de commande suivantes sont disponibles :

--build-users-group=GROUPE
     Prendre les utilisateurs de GROUP pour lancer les processus de construction (see utilisateurs de construction).

--no-substitutes
     Ne pas utiliser de substitut pour les résultats de la construction. C'est-à-dire, toujours construire localement plutôt que de permettre le téléchargement de binaires pré-construits (see Substituts).

     Lorsque le démon tourne avec --no-substitutes, les clients peuvent toujours activer explicitement la substitution via l'appel de procédure distante set-build-options (see Le dépôt).

--substitute-urls=URLS
     Considèrer URLS comme la liste séparée par des espaces des URL des sources de substituts par défaut.  Lorsque cette option est omise, https://mirror.hydra.gnu.org https://hydra.gnu.org est utilisé (mirror.hydra.gnu.org est un mirroire de hydra.gnu.org).

     Cela signifie que les substituts sont téléchargés depuis les URLS, tant qu'ils sont signés par une signature de confiance (see Substituts).

--no-build-hook
     Ne pas utiliser le crochet de construction.

     Le crochet de construction est un programme d'aide qui le démon peut démarrer et auquel soumettre les requêtes de construction.  Ce mécanisme est utilisé pour décharger les constructions à d'autres machines (see Réglages du délestage du démon).

--cache-failures
     Mettre les échecs de construction en cache.  Par défaut, seules les constructions réussies sont mises en cache.

     Lorsque cette option est utilisée, guix gc --list-failures peut être utilisé pour demander l'ensemble des éléments du dépôt marqués comme échoués ; guix gc --clear-failures vide la liste des éléments aillant échoué.  See Invoquer guix gc.

--cores=N
-c N
     Utiliser N cœurs CPU pour construire chaque dérivation ; 0 signifie autant que possible.

     La valeur par défaut est 0, mais elle peut être modifiée par les clients comme avec l'option --cores de guix build (see Invoquer guix build).

     L'effet est de définir la variable d'environnement NIX_BUILD_CORES dans le processus de construction, qui peut ensuite l'utiliser pour exploiter le parallélisme en interne — par exemple en lançant make -j$NIX_BUILD_CORES.

--max-jobs=N
-M N
     Permettre au plus N travaux de construction en parallèle.  La valeur par défaut est 1.  La mettre à 0 signifie qu'aucune construction ne sera effectuée localement ; à la place, le démon déchargera les constructions (see Réglages du délestage du démon) ou échouera.

--max-silent-time=SECONDES
     Lorsque le processus de construction ou de substitution restent silencieux pendant plus de SECONDES, le terminer et rapporter une erreur de construction.

     La valeur par défaut est 0, ce qui désactive le délai.

     La valeur spécifiée ici peut être modifiée par les clients (see --max-silent-time).

--timeout=SECONDES
     De même, lorsque le processus de construction ou de substitution dure plus de SECONDES, le terminer et rapporter une erreur de construction.

     La valeur par défaut est 0, ce qui désactive le délai.

     La valeur spécifiée ici peut être modifiée par les clients (see --timeout).

--rounds=N
     Construire chaque dérivations N fois à la suite, et lever une erreur si les résultats de construction consécutifs ne sont pas identiques bit-à-bit.  Remarquez que ce paramètre peut être modifié par les clients comme guix build (see Invoquer guix build).

     Lorsqu'utilisé avec --keep-failed, la sourtie différente est gardée dans le dépôt sous /gnu/store/...-check.  Cela rend plus facile l'étude des différences entre les deux résultats.

--debug
     Produire une sortie de débogage.

     Cela est utile pour déboguer des problèmes de démarrage du démon, mais ensuite elle peut être modifiée par les clients, par exemple par l'option --verbosity de guix build (see Invoquer guix build).

--chroot-directory=RÉP
     Ajouter RÉP au chroot de construction

     Cela peut changer le résultat d'un processus de construction — par exemple s'il utilise une dépendance facultative trouvée dans RÉP lorsqu'elle est disponible ou pas sinon.  Pour cette raison, il n'est pas recommandé d'utiliser cette option.  À la place, assurez-vous que chaque dérivation déclare toutes les entrées dont elle a besoin.

--disable-chroot
     Désactive les constructions dans un chroot.

     Utiliser cette option n'est pas recommandé car, de nouveau, elle permet aux processus de construction d'accéder à des dépendances non déclarées.  Elle est nécessaire cependant lorsque guix-daemon tourne en tant qu'utilisateur non privilégié.

--log-compression=TYPE
     Compresser les journaux de construction suivant le TYPE, parmi gzip, bzip2 ou none.

     À moins que --lose-logs ne soit utilisé, tous les journaux de construction sont gardés dans LOCALSTATEDIR.  Pour gagner de la place, le démon les compresse automatiquement avec bzip2 par défaut.

--disable-deduplication
     Désactiver la « déduplication » automatique des fichiers dans le dépôt.

     Par défaut, les fichiers ajoutés au dépôt sont automatiquement « dédupliqués » : si un nouveau fichier est identique à un autre fichier trouvé dans le dépôt, le démon en fait un lien en dur vers l'autre fichier.  Cela réduit considérablement l'utilisation de l'espace disque au prix d'une charge en entrée/sortie plus grande à la fin d'un processus de construction.  Cette option désactive cette optimisation.

--gc-keep-outputs[=yes|no]
     Dire si le ramasse-miettes (GC) doit garder les sorties des dérivations utilisées.

     When set to ``yes'', the GC will keep the outputs of any live derivation available in the store---the .drv files.  The default is ``no'', meaning that derivation outputs are kept only if they are reachable from a GC root.  See Invoquer guix gc, for more on GC roots.

--gc-keep-derivations[=yes|no]
     Dire si le ramasse-miettes (GC) doit garder les dérivations correspondant à des sorties utilisées.

     Lorsqu'elle est à « yes », comme c'est le cas par défaut, le GC garde les dérivations — c.-à-d. les fichiers .drv — tant qu'au moins une de leurs sorties est utilisée.  Cela permet aux utilisateurs de garder une trace de l'origine des éléments du dépôt.  Le mettre à « no » préserve un peu d'espace disque.

     In this way, setting --gc-keep-derivations to ``yes'' causes liveness to flow from outputs to derivations, and setting --gc-keep-outputs to ``yes'' causes liveness to flow from derivations to outputs.  When both are set to ``yes'', the effect is to keep all the build prerequisites (the sources, compiler, libraries, and other build-time tools) of live objects in the store, regardless of whether these prerequisites are reachable from a GC root.  This is convenient for developers since it saves rebuilds or downloads.

--impersonate-linux-2.6
     Sur les système basés sur Linux, se faire passer pour Linux 2.6.  Cela signifie que l'appel système du noyau uname rapportera 2.6 comme numéro de version.

     Cela peut être utile pour construire des programmes qui dépendent (généralement sans fondement) du numéro de version du noyau.

--lose-logs
     Ne pas garder les journaux de construction.  Par défaut ils sont gardés dans LOCALSTATEDIR/guix/log.

--system=SYSTÈME
     Supposer que SYSTÈME est le type de système actuel.  Par défaut c'est la paire architecture-noyau trouvée à la configuration, comme x86_64-linux.

--listen=EXTRÉMITÉ
     Écouter les connexions sur EXTRÉMITÉ.  EXTRÉMITÉ est interprété comme un nom de fichier d'un socket Unix-domain s'il commence par / (barre oblique).  Sinon, EXTRÉMITÉ est interprété comme un nom de domaine ou d'hôte et un port sur lequel écouter.  Voici quelques exemples :

     --listen=/gnu/var/daemon
          Écouter les connexions sur le socket Unix-domain /gnu/var/daemon en le créant si besoin.

     --listen=localhost
          Écouter les connexions TCP sur l'interface réseau correspondant à localhost sur le port 44146.

     --listen=128.0.0.42:1234
          Écouter les connexions TCP sur l'interface réseau correspondant à 128.0.0.42 sur le port 1234.

     Cette option peut être répétée plusieurs fois, auquel cas guix-daemon accepte des connexions sur toutes les extrémités spécifiées.  Les utilisateurs peuvent dire aux commandes clientes à quelle extrémité se connecter en paramétrant la variable d'environnement GUIX_DAEMON_SOCKET (see GUIX_DAEMON_SOCKET).

          Le protocole du démon est non authentifié et non chiffré.  Utiliser --listen=HOST est adapté sur des réseaux locaux, comme pour des grappes de serveurs, où seuls des nœuds de confiance peuvent se connecter au démon de construction.  Dans les autres cas où l'accès à distance au démon est requis, nous conseillons d'utiliser un socket Unix-domain avec SSH.

     Lorsque --listen est omis, guix-daemon écoute les connexions sur le socket Unix-domain situé à LOCALSTATEDIR/guix/daemon-socket/socket.

Réglages applicatifs
====================

Lorsque vous utilisez Guix par dessus une distribution GNU/Linux différente de GuixSD — ce qu'on appelle une distro externe — quelques étapes supplémentaires sont requises pour que tout soit en place.  En voici certaines.

Régionalisation
---------------

Les paquets installés via Guix n'utiliseront pas les données de régionalisation du système hôte.  À la place, vous devrez d'abord installer l'un des paquets linguistiques disponibles dans Guix puis définir la variable d'environnement GUIX_LOCPATH :

     $ guix package -i glibc-locales
     $ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale

Remarquez que le paquet glibc-locales contient les données pour tous les environnement linguistiques supportés par la GNU libc et pèse environ 110 Mo.  Autrement, les glibc-utf8-locales est plus petit mais limité à quelques environnements UTF-8.

La variable GUIX_LOCPATH joue un rôle similaire à LOCPATH (see LOCPATH (The GNU C Library Reference Manual)).  Il y a deux différences importantes cependant :

 1. GUIX_LOCPATH n'est compris que par la libc dans Guix et pas par la libc fournie par les distros externes.  Ainsi, utiliser GUIX_LOCPATH vous permet de vous assurer que les programmes de la distro externe ne chargeront pas de données linguistiques incompatibles.

 2. La libc ajoute un suffixe /X.Y à chaque entrée de GUIX_LOCPATH, où X.Y est la version de la libc — p. ex. 2.22.  Cela signifie que, si votre profile Guix contient un mélange de programmes liés avec des versions différentes de la libc, chaque version de la libc essaiera de charger les environnements linguistiques dans le bon format.

Cela est important car le format des données linguistiques utilisés par différentes version de la libc peuvent être incompatibles.

Name Service Switch
-------------------

Lorsque vous utilisez Guix sur une distro externe, nous recommandons fortement que ce système fasse tourner le démon de cache de service de noms de la bibliothèque C de GNU, nscd, qui devrait écouter sur le socket /var/run/nscd/socket.  Sans cela, les applications installées avec Guix peuvent échouer à résoudre des noms d'hôtes ou d'utilisateurs, ou même planter.  Les paragraphes suivants expliquent pourquoi.

La bibliothèque C de GNU implémente un name service switch (NSS), qui est un mécanisme d'extension pour les « résolutions de noms » en général : résolution de nom d'hôte, de compte utilisateur et plus (see Name Service Switch (The GNU C Library Reference Manual)).

Comme il est extensible, NSS supporte des greffons qui fournissent une nouvelle implémentation de résolution de nom : par exemple le greffon nss-mdns permet la résolution de noms d'hôtes en .local, le greffon nis permet la résolution de comptes utilisateurs avec le Network Information Service (NIS), etc.  Ces « services de recherches » supplémentaires sont configurés au niveau du système dans /etc/nsswitch.conf, et tous les programmes qui tournent sur ce système honorent ces paramètres (see NSS Configuration File (The GNU C Reference Manual))

Lorsqu'ils essayent d'effectuer une résolution de nom — par exemple en appelant la fonction getaddrinfo en C — les applications essayent d'abord de se connecter au nscd ; en cas de réussite, nscd effectue la résolution de nom pour eux.  Si le nscd ne tourne pas, alors ils effectue la résolution eux-même, en changeant les service de résolution dans leur propre espace d'adressage et en le lançant.  Ce services de résolution de noms — les fichiers libnns_*.so — sont dlopenés mais ils peuvent provenir de la bibliothèque C du système, plutôt que de la bibliothèque C à laquelle l'application est liée (la bibliothèque C de Guix).

Et c'est là que se trouve le problème : si votre application est liée à la bibliothèque C de Guix (disons, glibc-2.24) et essaye de charger les greffons NSS d'une autre bibliothèque C (disons, libnss_mdns.so pour glibc-2.22), il est très probable qu'elle plante ou que sa résolution de nom échoue de manière inattendue.

Lancer nscd sur le système, entre autres avantages, élimine ce problème d'incompatibilité binaire car ces fichiers libnss_*.so sont chargés par le processus nscd, pas par l'application elle-même.

Polices X11
-----------

La majorité des applications graphiques utilisent fontconfig pour trouver et charger les police et effectuer le rendu côté client X11.  Le paquet fontconfig dans Guix cherche les polices dans $HOME/.guix-profile par défaut.  Ainsi, pour permettre aux applications graphiques installées avec Guix d'afficher des polices, vous devez aussi installer des polices avec Guix.  Les paquets de polices essentiels sont gs-fonts, font-dejavu et font-gnu-freefont-ttf.

Pour afficher des textes écrits en chinois, en japonais ou en coréen dans les applications graphiques, installez font-adobe-source-han-sans ou font-wqy-zenhei.  Le premier a plusieurs sorties, une par famille de langue (see Des paquets avec plusieurs résultats).  Par exemple, la commande suivante installe les polices pour le chinois :

     guix package -i font-adobe-source-han-sans:cn

Les vieux programmes comme xterm n'utilisent pas fontconfig et s'appuient sur le rendu du côté du serveur.  Ces programmes ont besoin de spécifier le nom complet de la police en utlisant XLFD (X Logical Font Description), comme ceci :

     -*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1

Pour pouvoir utiliser ces noms complets avec les polices TrueType installées dans votre profil Guix, vous devez étendre le chemin des polices du serveur X :

     xset +fp $(dirname $(readlink -f ~/.guix-profile/share/fonts/truetype/fonts.dir))

Ensuite, vous pouvez lancer xlsfonts (du paquet xlsfonts) pour vous assurer que vos polices TrueType y sont listées.

Après l'installation des polices vous devrez peut-être rafraîchir le cache des polices pour pouvoir les utiliser dans les applications.  Ça s'applique aussi lorsque les applications installées avec Guix n'ont pas l'air de trouver les polices.  Pour forcer la reconstruction du cache de polices lancez fc-cache -f.  La commande fc-cache est fournie par le paquet fontconfig.

Certificats X.509
-----------------

Le paquet nss-certs fournit les certificats X.509 qui permettent aux programmes d'authentifier les serveurs web par HTTPS.

Lorsque vous utilisez Guix sur une distribution externe, vous pouvez installer ce paquet et définir les variables d'environnement adéquates pour que les paquets sachent où trouver les certificats.  See Certificats X.509, pour des informations détaillées.

Paquets emacs
-------------

Lorsque vous installez les paquets Emacs avec Guix, les fichiers elisp peuvent être placés soit dans $HOME/.guix-profile/share/emacs/site-lisp/ soit dans des sous-répertoires de $HOME/.guix-profile/share/emacs/site-lisp/guix.d/.  Ce dernier existe car il existe potentiellement des milliers de paquets Emacs et stocker leurs fichiers dans un seul répertoire peut ne pas être fiable (à cause de conflits de noms).  Donc on pense qu'utiliser un répertoire séparé est une bonne idée.  C'est très similaire à la manière dont le système de paquet d'Emacs organise la structure de fichiers (see Package Files (The GNU Emacs Manual)).

Par défaut, Emacs (installé avec Guix) « sait » où ces paquets ce trouvent, donc vous n'avez pas besoin de le configurer.  Si, pour quelque raison que ce soit, vous souhaitez éviter de charger automatiquement les paquets Emacs installés avec Guix, vous pouvez le faire en lançaint Emacs avec l'option --no-site-file (see Init File (The GNU Emacs Manual)).

La chaîne d'outils GCC
----------------------

Guix offre des paquets de compilateurs individuels comme gcc mais si vous avez besoin d'une chaîne de compilation complète pour compiler et lier du code source, vous avez en fait besoin du paquet gcc-toolchain.  Ce paquet fournit une chaîne d'outils GCC pour le développement C/C++, dont GCC lui-même, la bibliothèque C de GNU (les en-têtes et les binaires, plus les symboles de débogage dans la sortie debug), Binutils et une enveloppe pour l'éditeur de liens.

Le rôle de l'enveloppe est d'inspecter les paramètres -L et -l passés à l'éditeur de liens, d'ajouter des arguments -rpath correspondants et d'invoquer le véritable éditeur de liens avec ce nouvel ensemble d'arguments.  Par défaut, l'enveloppe refuse de lier des bibliothèques en dehors du dépôt pour assure la « pureté ».  Cela peut être embêtant lorsque vous utilisez la chaîne d'outils pour lier des bibliothèques locales.  Pour permettre des références à des bibliothèques en dehors du dépôt, vous devrez définir la variable d'environnement GUIX_LD_WRAPPER_ALLOW_IMPURITIES.

Gestion de paquets
******************

Le but de GNU Guix est de permettre à ses utilisateurs d'installer, mettre à jour et supprimer facilement des paquets logiciels sans devoir connaître leur procédure de construction ou leurs dépendances.  Guix va aussi plus loin que ces fonctionnalités évidentes.

Ce chapitre décrit les principales fonctionnalités de Guix, ainsi que des outils de gestion des paquets qu'il fournit.  En plus de l'interface en ligne de commande décrite en dessous de (see guix package), vous pouvez aussi utiliser l'interface Emacs-Guix (see Le manuel de référence de emacs-guix), après avoir installé le paquet emacs-guix (lancez la commande M-x guix-help pour le démarrer) :

     guix package -i emacs-guix

Fonctionnalités
===============

Lorsque vous utilisez Guix, chaque paquet arrive dans dépôt des paquets, dans son propre répertoire — quelque chose comme /gnu/store/xxx-paquet-1.2, où xxx est une chaîne en base32.

Plutôt que de se rapporter à ces répertoires, les utilisateurs ont leur propre profil qui pointe vers les paquets qu'ils veulent vraiment utiliser.  Ces profils sont stockés dans le répertoire personnel de chaque utilisateur dans $HOME/.guix-profile.

Par exemple, alice installe GCC 4.7.2.  Il en résulte que /home/alice/.guix-profile/bin/gcc pointe vers /gnu/store/...-gcc-4.7.2/bin/gcc. Maintenant, sur la même machine, bob a déjà intallé GCC 4.8.0.  Le profil de bob continue simplement de pointer vers /gnu/store/...-gcc-4.8.0/bin/gcc — c.-à-d. les deux versions de GCC coexistent surs le même système sans aucune interférence.

La commande guix package est l'outil central pour gérer les paquets (see Invoquer guix package).  Il opère sur les profils utilisateurs et peut être utilisé avec les privilèges utilisateurs normaux.

La commande fournit les opérations évidentes d'installation, de suppression et de mise à jour.  Chaque invocation est en fait une transaction : soit l'opération demandée réussi, soit rien ne se passe.  Ainsi, si le processus guix package est terminé pendant la transaction ou si une panne de courant arrive pendant la transaction, le profil de l'utilisateur reste dans son état précédent et reste utilisable.

En plus, il est possible d'annuler toute transaction sur les paquets.  Donc si par exemple un mise à jour installe une nouvelle version d'un paquet qui révèle un bogue sérieux, les utilisateurs peuvent revenir en arrière à l'instance précédente de leur profil qui est connu pour bien fonctionner.  De manière similaire, la configuration globale du système dans GuixSD est sujette aux mises à jour transactionnelles et aux annulations (see Utiliser le système de configuration).

Tous les paquets du dépôt des paquets peut être glané.  Guix peut déterminer quels paquets sont toujours référencés par les profils des utilisateurs et supprimer ceux qui ne sont plus référencés de manière prouvable (see Invoquer guix gc).  Les utilisateurs peuvent toujours explicitement supprimer les anciennes générations de leur profil pour que les paquets auxquels elles faisaient référence puissent être glanés.

Finalement, Guix prend une approche purement fonctionnelle de la gestion de paquets, telle que décrite dans l'introduction (see Introduction).  Chaque nom de répertoire de paquet dans /gnu/store contient un hash de toutes les entrées qui ont été utilisées pendant la construction de ce paquet — le compilateur, les bibliothèques, les scripts de construction, etc.  Cette correspondance directe permet aux utilisateurs de s'assurer que l'installation d'un paquet donné correspond à l'état actuel de leur distribution.  Elle aide aussi à maximiser la reproductibilité : grâce aux environnements de construction utilisés, une construction donnée à de forte chances de donner des fichiers identiques bit-à-bit lorsqu'elle est effectuée sur des machines différents (see container).

Ce fondement permet à Guix de supporter le déploiement transparent de binaire ou source.  Lorsqu'une binaire pré-construit pour une entrée de /gnu/store est disponible depuis une source externe (un substitut), Guix le télécharge simplement et le décompresse ; sinon, il construit le paquet depuis les sources localement (see Substituts). Comme les résultats des constructions sont généralement reproductibles au bit près, si vous n'avez pas besoin de faire confiance aux serveurs qui fournissent les substituts : vous pouvez forcer une construction locale et défier les fournisseurs (see Invoquer guix challenge).

Le contrôle de l'environnement de construction est aussi une fonctionnalité utile pour les développeurs.  La commande guix environment permet aux développeurs d'un paquet de mettre en place rapidement le bon environnement de développement pour leur paquet, sans avoir à installer manuellement les dépendances du paquet dans leur profil (see Invoquer guix environment).

Invoquer guix package
=====================

La commande guix package est l'outil qui permet d'installer, mettre à jour et supprimer les paquets ainsi que de revenir à une configuration précédente.  Elle n'opère que dans le profil de l'utilisateur et fonctionne avec les privilèges utilisateurs normaux (see Fonctionnalités).  Sa syntaxe est :

     guix package OPTIONS

OPTIONS spécifie d'abord les opérations à effectuer pendant la transaction.  À la fin, une nouvelle génération du profil est créée mais les générations précédentes du profil restent disponibles si l'utilisateur souhaite y revenir.

Par exemple, pour supprimer lua et installer guile et guile-cairo en une seule transaction :

     guix package -r lua -i guile guile-cairo

guix package supporte aussi une approche déclarative où l'utilisateur spécifie l'ensemble exact des paquets qui doivent être disponibles le passe via l'option --manifest (see --manifest).

Pour chaque utilisateur, un lien symbolique vers le profil par défaut de cet utilisateur est automatiquement créé dans $HOME/.guix-profile.  Ce lien symbolique pointe toujours vers la génération actuelle du profil par défaut de l'utilisateur.  Ainsi, les utilisateurs peuvent ajouter $HOME/.guix-profile/bin à leur variable d'environnement PATH etc. Si vous n'utilisez pas la distribution système Guix, vous devriez ajouter les lignes suivantes à votre ~/.bash_profile (see Bash Startup Files (The GNU Bash Reference Manual)) pour que les shells créés ensuite aient les bonnes définitions des variables d'environnement :

     GUIX_PROFILE="$HOME/.guix-profile" ; \
     source "$HOME/.guix-profile/etc/profile"

Dans un environnement multi-utilisateur, les profils utilisateurs sont stockés comme une racine du ramasse-miettes, vers laquelle pointe $HOME/.guix-profile (see Invoquer guix gc).  Ce répertoire est normalement LOCALSTATEDIR/guix/profiles/per-user/UTILISATEUR,  où LOCALSTATEDIR est la valeur passée à configure avec --localstatedir et UTILISATEUR le nom d'utilisateur.  Le répertoire per-user est créé lorsque guix-daemon est démarré et sous-répertoire UTILISATEUR est créé par guix package.

Les OPTIONS peuvent être les suivante :

--install=PAQUET ...
-i PAQUET ...
     Installer les PAQUETs spécifiés.

     Chaque PAQUET peut spécifier soit un simple nom de paquet, comme guile ou un nom de paquet suivi d'un arobase et d'un numéro de version, comme guile@1.8.8 ou simplement guile@1.8 (dans ce dernier cas, la version la plus récente commençant par 1.8 est utilisée).

     Si aucun numéro de version n'est spécifié, la version la plus récente disponible est choisie.  En plus, PAQUET peut contenir un deux-points, suivi du nom d'une des sorties du paquet, comme dans gcc:doc ou binutils@2.22:lib (see Des paquets avec plusieurs résultats).  Des paquets avec un nom correspondant et (éventuellement une version) sont recherchés dans les modules de la distribution GNU (see Modules de paquets).

     Parfois les paquets ont des entrées propagées : ce sont des dépendances qui sont installées automatiquement avec le paquet demandé (see propagated-inputs in package objects pour plus d'informations sur les entrées propagées dans les définitions des paquets).

     Un exemple est la bibliothèque MPC de GNU : ses fichiers d'en-tête C se réfèrent à ceux de la bibliothèque MPFR de GNU, qui se réfèrent en retour à ceux de la bibliothèque GMP.  Ainsi, lorsqu'on installe MPC, les bibliothèques MPFR et GMP sont aussi installées dans le profil ; supprimer MPC supprimera aussi MPFR et GMP — à moins qu'ils n'aient été aussi installés explicitement par l'utilisateur.

     D'autre part, les paquets dépendent parfois de la définition de variables d'environnement pour leur chemin de recherche (voir les explications sur --search-paths plus bas).  Toute définition de variable d'environnement manquante ou possiblement incorrecte est rapportée ici.

--install-from-expression=EXP
-e EXP
     Installer le paquet évalué par EXP

     EXP doit être une expression Scheme qui s'évalue en un objet <package>.  Cette option est notamment utile pour distinguer les variantes d'un paquet avec le même nom, avec des expressions comme (@ (gnu packages base) guile-final).

     Remarquez que cette option installe la première sortie du paquet, ce qui peut être insuffisant lorsque vous avez besoin d'une sortie spécifique d'un paquet à plusieurs sorties.

--install-from-file=FICHIER
-f FICHIER
     Installer le paquet évalué par le code dans le FICHIER.

     Par exemple, FICHIER peut contenir une définition comme celle-ci (see Définition des paquets) :

               [file package-hello.scm not included]

     Les développeurs peuvent trouver utile d'inclure un tel fichier guix.scm à la racine de l'arborescence des sources de leur projet qui pourrait être utilisé pour tester des versions de développement et créer des environnements de développement reproductibles (see Invoquer guix environment).

--remove=PAQUET ...
-r PAQUET ...
     Supprimer les PAQUETs spécifiés.

     Comme pour --install, chaque PAQUET peut spécifier un numéro de version ou un nom de sortie en plus du nom du paquet.  Par exemple, -r glibc:debug supprimerait la sortie debug de glibc.

--upgrade[=REGEXP ...]
-u [REGEXP ...]
     Mettre à jour tous les paquets installés.  Si une REGEXP ou plus est spécifiée, la mise à jour n'installera que les paquets dont le nom correspond à REGEXP.  Voyez aussi l'option --do-not-upgrade en dessous.

     Remarquez que cela met à jour vers la dernière version des paquets trouvée dans la distribution actuellement installée.  Pour mettre à jour votre distribution, vous devriez lancer régulièrement guix pull (see Invoquer guix pull).

--do-not-upgrade[=REGEXP ...]
     Lorsqu'elle est utilisée avec l'option --upgrade, ne pas mettre à jour les paquets dont le nom correspond à REGEXP.  Par exemple, pour mettre à jour tous les paquets du profil actuel à l'exception de ceux qui contiennent la chaîne « emacs » :

          $ guix package --upgrade . --do-not-upgrade emacs

--manifest=FICHIER
-m FICHIER
     Créer une nouvelle génération du profil depuis l'objet manifeste renvoyé par le code Scheme dans FICHIER.

     Cela vous permet de déclarer le contenu du profil plutôt que de le construire avec une série de --install et de commandes similaires. L'avantage étant que le FICHIER peut être placé sous contrôle de version, copié vers d'autres machines pour reproduire le même profil, etc.

     FICHIER doit retourner un objet manifest qui est en gros une liste de paquets :

          (use-package-modules guile emacs)

          (packages->manifest
           (list emacs
                 guile-2.0
                 ;; Utiliser une sortie spécifique d'un paquet.
                 (list guile-2.0 "debug")))

     Dans cet exemple on doit savoir quels modules définissent les variables emacs et guile-2.0 pour fournir la bonne ligne use-package-modules ce qui peut être embêtant.  On peut à la place fournir des spécifications de paquets normales et laisser specifications->manifest rechercher les objets de paquets correspondants, comme ceci :

          (specifications->manifest
           '("emacs" "guile@2.2" "guile@2.2:debug"))

--roll-back
     Revenir à la génération précédente du profil c.-à-d. défaire la dernière transaction.

     Lorsqu'elle est combinée avec des options comme --install, cette option revient en arrière avant toute autre action.

     Lorsque vous revenez de la première génération qui contient des fichiers, le profil pointera vers la zéroième génération qui ne contient aucun fichier en dehors de ses propres métadonnées.

     Après être revenu en arrière, l'installation, la suppression et la mise à jour de paquets réécrit les futures générations précédentes.  Ainsi, l'historique des générations dans un profil est toujours linéaire.

--switch-generation=MOTIF
-S MOTIF
     Basculer vers une génération particulière définie par le MOTIF.

     Le MOTIF peut être soit un numéro de génération soit un nombre précédé de « + » ou « - ».  Ce dernier signifie : se déplacer en avant ou en arrière d'un nombre donné de générations.  Par exemple, si vous voulez retourner à la dernière génération après --roll-back, utilisez --switch-generation=+1.

     La différence entre --roll-back et --switch-generation=-1 est que --switch-generation ne vous amènera pas à la zéroième génération, donc si la génération demandée n'existe pas la génération actuelle ne changera pas.

--search-paths[=GENRE]
     Rapporter les définitions des variables d'environnement dans la syntaxe Bash qui peuvent être requises pour utiliser l'ensemble des paquets installés. Ces variables d'environnement sont utilisées pour spécifier les chemins de recherche de fichiers utilisés par les paquets installés.

     Par exemple, GCC a besoin des variables d'environnement CPATH et LIBRARY_PATH pour trouver les en-têtes et les bibliothèques dans le profil de l'utilisateur (see Environment Variables (Using the GNU Compiler Collection (GCC))).  Si GCC et, disons, la bibliothèque C sont installés dans le profil, alors --search-paths suggérera d'initialiser ces variables à PROFIL/include et PROFIL/lib, respectivement.

     Le cas d'utilisation typique est de définir ces variables d'environnement dans le shell :

          $ eval `guix package --search-paths`

     GENRE peut être l'une des valeurs exact, prefix ou suffix, ce qui signifie que les définitions des variables d'environnement retournées seront soit les paramètres exactes, ou placés avant ou après la valeur actuelle de ces paramètres.  Lorsqu'il est omis, GENRE a pour valeur par défaut exact.

     Cette option peut aussi être utilisé pour calculer les chemins de recherche combinés de plusieurs profils.  Regardez cet exemple :

          $ guix package -p foo -i guile
          $ guix package -p bar -i guile-json
          $ guix package -p foo -p bar --search-paths

     La dernière commande ci-dessus montre la variable GUILE_LOAD_PATH bien que, pris individuellement, ni foo ni bar n'auraient donné cette recommendation.

--profile=PROFIL
-p PROFIL
     Utiliser le PROFIL à la place du profil par défaut de l'utilisateur.

--allow-collisions
     Permettre des collisions de paquets dans le nouveau profil.  À utiliser à vos risques et périls !

     Par défaut, guix package rapporte les collisions dans le profil comme des erreurs.  Les collisions ont lieu quand deux version ou variantes d'un paquet donné se retrouvent dans le profil.

--verbose
     Produire une sortie verbeuse.  En particulier, fournir les journaux de construction de l'environnement sur le port d'erreur standard.

--bootstrap
     Utiliser le programme d'amorçage Guile pour compiler le profil.  Cette option n'est utile que pour les développeurs de la distriibution.

En plus de ces actions, guix package supporte les options suivantes pour demander l'état actuel d'un profil ou la disponibilité des paquets :

--search=REGEXP
-s REGEXP
     Lister les paquets disponibles dont le nom, le synopsis ou la description correspondent à la REGEXP, triés par pertinence.  Afficher toutes les métadonnées des paquets correspondants au format recutils (see GNU recutils databases (GNU recutils manual)).

     Cela permet à des champs spécifiques d'être extraits avec la commande recsel, par exemple :

          $ guix package -s malloc | recsel -p name,version,relevance
          name: jemalloc
          version: 4.5.0
          relevance: 6

          name: glibc
          version: 2.25
          relevance: 1

          name: libgc
          version: 7.6.0
          relevance: 1

     De manière similaire, pour montrer le nom de tous les paquets disponibles sous license GNU LGPL version 3 :

          $ guix package -s "" | recsel -p name -e 'license ~ "LGPL 3"'
          name: elfutils

          name: gmp
          ...

     Il est aussi possible de raffiner les résultats de la recherche avec plusieurs options -s.  Par exemple, la commande suivante renvoie la liste des jeux de plateau :

          $ guix package -s '\<board\>' -s game | recsel -p name
          name: gnubg
          ...

     Si on avait oublié -s game, on aurait aussi eu les paquets logiciels qui s'occupent de circuits imprimés (en anglais : circuit board) ; supprimer les chevrons autour de board aurait aussi ajouté les paquets qui parlent de clavier (en anglais : keyboard).

     Et maintenant un exemple plus élaboré.  La commande suivante recherche les bibliothèques cryptographiques, retire les bibliothèques Haskell, Perl, Python et Ruby et affiche le nom et le synopsis des paquets correspondants :

          $ guix package -s crypto -s library | \
              recsel -e '! (name ~ "^(ghc|perl|python|ruby)")' -p name,synopsis

     See Selection Expressions (GNU recutils manual) pour plus d'information sur les expressions de sélection pour recsel -e.

--show=PAQUET
     Afficher les détails du PAQUET dans la liste des paquets disponibles, au format recutils (see GNU recutils databases (GNU recutils manual)).

          $ guix package --show=python | recsel -p name,version
          name: python
          version: 2.7.6

          name: python
          version: 3.3.5

     Vous pouvez aussi spécifier le nom complet d'un paquet pour n'avoir que les détails concernant une version spécifique :

          $ guix package --show=python@3.4 | recsel -p name,version
          name: python
          version: 3.4.3

--list-installed[=REGEXP]
-I [REGEXP]
     Liste les paquets actuellement installés dans le profil spécifié, avec les paquets les plus récemment installés en dernier.  Lorsque REGEXP est spécifié, liste uniquement les paquets installés dont le nom correspond à REGEXP.

     Pour chaque paquet installé, affiche les éléments suivants, séparés par des tabulations : le nom du paquet, sa version, la partie du paquet qui est installé (par exemple, out pour la sortie par défaut, include pour ses en-têtes, etc) et le chemin du paquet dans le dépôt.

--list-available[=REGEXP]
-A [REGEXP]
     Lister les paquets actuellement disponibles dans la distribution pour ce système (see Distribution GNU).  Lorsque REGEXP est spécifié, liste uniquement les paquets dont le nom correspond à REGEXP.

     Pour chaque paquet, affiche les éléments suivants séparés par des tabulations : son nom, sa version, les parties du paquet (see Des paquets avec plusieurs résultats), et l'emplacement de sa définition.

--list-generations[=MOTIF]
-l [MOTIF]
     Renvoyer la liste des générations avec leur date de création ; pour chaque génération, montre les paquets installés avec les paquets installés les plus récemment en dernier.  Remarquez que la zéroième génération n'est jamais montrée.

     Pour chaque paquet installé, afficher les éléments suivants, séparés par des tabulations : le nom du paquet, sa version, la partie du paquet qui a été installée (see Des paquets avec plusieurs résultats), et l'emplacement du paquet dans le dépôt.

     Lorsque MOTIF est utilisé, la commande ne renvoie que les générations correspondantes.  Les motifs valides sont :

       * Des entiers et des entiers séparés par des virgules.  Les deux motifs correspondent à des numéros de version.  Par exemple, --list-generations=1 renvoie la première.

          Et --list-generations=1,8,2 renvoie les trois générations dans l'ordre spécifié.  Aucune espace ni virgule surnuméraire n'est permise.

       * Des interval.  --list-generations=2..9 affiche les générations demandées et tout ce qui se trouvent entre elles.  Remarquez que le début d'un interval doit être plus petit que sa fin.

          Il est aussi possible d'omettre le numéro final.  Par exemple, --list-generations=2.. renvoie toutes les générations à partir de la deuxième.

       * Des durées.  Vous pouvez aussi récupérer les derniers N jours, semaines, ou moins en passant un entier avec la première lettre de la durée (en anglais : d, w ou m).  Par exemple --list-generations=20d liste les générations qui sont agées d'au plus 20 jours.

--delete-generations[=MOTIF]
-d [MOTIF]
     Lorsque MOTIF est omis, supprimer toutes les générations en dehors de l'actuelle.

     Cette commande accepte les même motifs que --list-generations. Lorsque MOTIF est spécifié, supprimer les générations correspondante. Lorsque MOTIF spécifie une durée, les générations plus vieilles que la durée spécifiée correspondent.  Par exemple --delete-generations=1m supprime les générations vieilles de plus d'un mois.

     Si la génération actuelle correspond, elle n'est pas supprimée.  La zéroième génération n'est elle non plus jamais supprimée.

     Remarquez que supprimer des générations empêche de revenir en arrière vers elles.  Ainsi, cette commande doit être utilisée avec précaution.

Enfin, comme guix package peut démarrer des processus de construction, elle supporte les options de construction communes (see Options de construction communes).   Elle supporte aussi les options de transformation de paquets comme --with-source (see Options de transformation de paquets).  Cependant, remarquez que les transformations de paquets sont perdues à la mise à jour ; pour les préserver à travers les mises à jours, vous devriez définir vos propres variantes des paquets dans une module Guile et l'ajouter à GUIX_PACKAGE_PATH (see Définition des paquets).

Substituts
==========

Guix gère le déploiement depuis des binaires ou des sources de manière transparente ce qui signifie qu'il peut aussi bien construire localement que télécharger des éléments pré-construits depuis un serveur ou les deux.  Nous appelons ces éléments pré-construits des substituts — ils se substituent aux résultats des constructions locales.  Dans la plupart des cas, télécharger un substitut est bien plus rapide que de construire les choses localement.

Les substituts peuvent être tout ce qui résulte d'une construction de dérivation (see Dérivations).  Bien sûr dans le cas général, il s'agit de paquets binaires pré-construits, mais les archives des sources par exemple résultent aussi de la construction d'une dérivation qui peut aussi être disponible en tant que substitut.

Serveur de substituts officiel
------------------------------

Le serveur mirror.hydra.gnu.org est une interface à la ferme de construction officielle qui construit des paquets pour Guix continuellement pour certaines architectures et les rend disponibles en tant que substituts.  C'est la source par défaut des substituts ; elle peut être modifiée en passant l'option --substitute-urls soit à guix-daemon (see guix-daemon --substitute-urls) soit aux outils clients comme  guix package (see client --substitute-urls option).

Les URL des substituts peuvent être soit en HTTP soit en HTTPS.  Le HTTPS est recommandé parce que les communications sont chiffrées ; à l'inverse HTTP rend les communications visibles pour un espion qui peut utiliser les informations accumulées sur vous pour déterminer par exemple si votre système a des vulnérabilités de sécurités non corrigées.

Les substituts de la ferme de construction officielle sont activés par défaut dans la distribution système Guix (see Distribution GNU). Cependant, ils sont désactivés par défaut lorsque vous utilisez Guix sur une distribution externe, à moins que vous ne les ayez explicitement activés via l'une des étapes d'installation recommandées (see Installation).  Les paragraphes suivants décrivent comment activer ou désactiver les substituts de la ferme de construction ; la même procédure peut être utilisée pour activer les substituts de n'importe quel autre serveur de substituts.

Autoriser un serveur de substituts
----------------------------------

Pour permettre à Guix de télécharger les substituts depuis hydra.gnu.org ou un mirroir, vous devez ajouter sa clef publique à la liste de contrôle d'accès (ACL) des imports d'archives, avec la commande guix archive (see Invoquer guix archive).  Cela implique que vous faîtes confiance à hydra.gnu.org pour ne pas être compromis et vous servir des substituts authentiques.

La clef publique pour hydra.gnu.org est installée avec Guix, dans PRÉFIXE/share/guix/hydra.gnu.org.pub, où PRÉFIXE est le préfixe d'installation de Guix.  Si vous avez installé Guix depuis les sources, assurez-vous d'avoir vérifié la signature GPG de guix-VERSION.tar.gz qui contient ce fichier de clef publique.  Ensuite vous pouvez lancer quelque chose comme ceci :

     # guix archive --authorize < PRÉFIXE/share/guix/hydra.gnu.org.pub

     De même, le fichier berlin.guixsd.org.pub contient la clef publique de la nouvelle ferme de construction du projet, disponible depuis https://berlin.guixsd.org.

     Au moment où ces lignes sont écrites, berlin.guixsd.org est mis à niveau pour mieux passer à l'échelle, mais vous pourriez vouloir le tester. Il est associé à 20 nœuds de construction x86_64/i686 et pourrait fournir des substituts plus rapidement que mirror.hydra.gnu.org

Une fois que cela est en place, la sortie d'une commande comme guix build devrait changer de quelque chose comme :

     $ guix build emacs --dry-run
     Les dérivations suivantes seraient construites :
        /gnu/store/yr7bnx8xwcayd6j95r2clmkdl1qh688w-emacs-24.3.drv
        /gnu/store/x8qsh1hlhgjx6cwsjyvybnfv2i37z23w-dbus-1.6.4.tar.gz.drv
        /gnu/store/1ixwp12fl950d15h2cj11c73733jay0z-alsa-lib-1.0.27.1.tar.bz2.drv
        /gnu/store/nlma1pw0p603fpfiqy7kn4zm105r5dmw-util-linux-2.21.drv
     ...

à quelque chose comme :

     $ guix build emacs --dry-run
     112.3 Mo seraient téléchargés :
        /gnu/store/pk3n22lbq6ydamyymqkkz7i69wiwjiwi-emacs-24.3
        /gnu/store/2ygn4ncnhrpr61rssa6z0d9x22si0va3-libjpeg-8d
        /gnu/store/71yz6lgx4dazma9dwn2mcjxaah9w77jq-cairo-1.12.16
        /gnu/store/7zdhgp0n1518lvfn8mb96sxqfmvqrl7v-libxrender-0.9.7
     ...

Cela indique que les substituts de hydra.gnu.org sont utilisables et seront téléchargés, si possible, pour les futures constructions.

Le mécanisme de substitution peut être désactivé globalement en lançant guix-daemon avec --no-substitutes (see Invoquer guix-daemon).  Il peut aussi être désactivé temporairement en passant l'option --no-substitutes à guix package, guix build et aux autres outils en ligne de commande.

Authentification des substituts
-------------------------------

Guix détecte et lève une erreur lorsqu'il essaye d'utiliser un substituts qui a été modifié.  De même, il ignore les substituts qui ne sont pas signés ou qui ne sont pas signés par l'une des clefs listés dans l'ACL.

Il y a une exception cependant : si un serveur non autorisé fournit des substituts qui sont identiques bit-à-bit à ceux fournis par un serveur autorisé, alors le serveur non autorisé devient disponible pour les téléchargements.  Par exemple en supposant qu'on a choisi deux serveurs de substituts avec cette option :

     --substitute-urls="https://a.example.org https://b.example.org"

Si l'ACL contient uniquement la clef de b.example.org, et si a.example.org sert exactement les mêmes substituts, alors Guix téléchargera les substituts de a.example.org parce qu'il vient en premier dans la liste et peut être considéré comme un mirroir de b.example.org.  En pratique, des machines de constructions produisent souvent les mêmes binaires grâce à des construction reproductibles au bit près (voir plus bas).

Lorsque vous utilisez HTTPS, le certificat X.509 du serveur n'est pas validé (en d'autre termes, le serveur n'est pas authentifié), contrairement à ce que des clients HTTPS comme des navigateurs web font habituellement. Cela est dû au fait que Guix authentifie les informations sur les substituts eux-même, comme expliqué plus haut, ce dont on se soucie réellement (alors que les certificats X.509 authentifie la relation entre nom de domaine et clef publique).

Paramètres de serveur mandataire
--------------------------------

Les substituts sont téléchargés par HTTP ou HTTPS.  La variable d'environnement http_proxy peut être initialisée dans l'environnement de guix-daemon et est respectée pour le téléchargement des substituts.  Remarquez que la valeur de http_proxy dans l'environnement où tournent guix build, guix package et les autres clients n'a absolument aucun effet.

Échec de substitution
---------------------

Même lorsqu'un substitut pour une dérivation est disponible, la substitution échoue parfois.  Cela peut arriver pour plusieurs raisons : le serveur de substitut peut être hors ligne, le substitut a récemment été supprimé du serveur, la connexion peut avoir été interrompue, etc.

Lorsque les substituts sont activés et qu'un substitut pour une dérivation est disponible, mais que la tentative de substitution échoue, Guix essaiera de construire la dérivation localement si --fallback a été passé en argument (see common build option --fallback). Plus spécifiquement, si cet option n'a pas été passée en argument, alors aucune construction locale n'est effectuée et la dérivation est considérée comme étant en échec. Cependant, si --fallback est passé en argument, alors Guix essaiera de construire la dérivation localement et l'échec ou le succès de la dérivation dépend de l'échec ou du succès de la construction locale.  Remarquez que lorsque les substituts sont désactivés ou qu'aucun substitut n'est disponible pour la dérivation en question, une construction locale sera toujours effectuée, indépendamment du fait que l'argument --fallback ait été ou non passé.

Pour se donner une idée du nombre de substituts disponibles maintenant, vous pouvez essayer de lancer la commande guix weather (see Invoquer guix weather).  Cette command fournit des statistiques sur les substituts fournis par un serveur.

De la confiance en des binaires
-------------------------------

De nos jours, le contrôle individuel sur son utilisation propre de l'informatique est à la merci d'institutions, de sociétés et de groupes avec assez de pouvoir et de détermination pour contourner les infrastructures informatiques et exploiter leurs faiblesses.  Bien qu'utiliser les substituts de hydra.gnu.org soit pratique, nous encourageons les utilisateurs à construire aussi par eux-même, voir à faire tourner leur propre ferme de construction, pour que hydra.gnu.org devienne une cible moins intéressante.  Une façon d'aider est de publier les logiciels que vous construisez avec guix publish pour que les autres aient plus de choix de serveurs où télécharger les substituts (see Invoquer guix publish).

Guix possède les fondations pour maximiser la reproductibilité logicielle (see Fonctionnalités).  Dans la plupart des cas, des constructions indépendantes d'un paquet donnée ou d'une dérivation devrait donner des résultats identiques au bit près.  Ainsi, à travers un ensemble de constructions de paquets indépendantes il est possible de renforcer l'intégrité du système.  La commande guix challenge a pour but d'aider les utilisateurs à tester les serveurs de substituts et à aider les développeurs à trouver les constructions de paquets non-déterministes (see Invoquer guix challenge).  De même, l'option --check de guix build permet aux utilisateurs de vérifier si les substituts précédemment installés sont authentiques en les reconstruisant localement (see guix build --check).

Dans le futur, nous aimerions que Guix puisse publier et recevoir des binaires d'autres utilisateurs, d'une manière pair-à-pair.  Si vous voulez discuter de ce projet, rejoignez-nous sur guix-devel@gnu.org.

Des paquets avec plusieurs résultats
====================================

Souvent, les paquets définis dans Guix ont une seule sortie — c.-à-d. que le paquet source conduit à exactement un répertoire dans le dépôt.  Lorsque vous lancez guix package -i glibc, vous installez la sortie par défaut du paquet GNU libc ; la sortie par défaut est appelée out mais son nom peut être omis comme le montre cette commande.  Dans ce cas particuliers, la sortie par défaut de glibc contient tous les fichiers d'en-tête C, les bibliothèques partagées, les bibliothèques statiques, la documentation Info et les autres fichiers de support.

Parfois il est plus approprié de séparer les divers types de fichiers produits par un même paquet source en plusieurs sorties.  Par exemple, la bibliothèque C GLib (utilisée par GTK+ et des paquets associés) installe plus de 20 Mo de documentation de référence dans des pages HTML.  Pour préserver l'espace disque des utilisateurs qui n'en ont pas besoin, la documentation va dans une sortie séparée nommée doc.  Pour installer la sortie principale de GLib, qui contient tout sauf la documentation, on devrait lancer :

     guix package -i glib

La commande pour installer la documentation est :

     guix package -i glib:doc

Certains paquets installent des programmes avec des « empreintes dépendances » différentes.  Par exemple le paquet WordNet installe à la fois les outils en ligne de commande et les interfaces graphiques (GUI).  La première ne dépend que de la bibliothèque C, alors que cette dernière dépend de Tcl/Tk et des bibliothèques X sous-jacentes.  Dans ce cas, nous laissons les outils en ligne de commande dans la sortie par défaut et l'interface graphique dans une sortie séparée.  Cela permet aux utilisateurs qui n'ont pas besoin d'interface graphique de gagner de la place.  La commande guix size peut aider à trouver ces situations (see Invoquer guix size). guix graph peut aussi être utile (see Invoquer guix graph).

Il y a plusieurs paquets à sorties multiples dans la distribution GNU. D'autres noms de sorties conventionnels sont lib pour les bibliothèques et éventuellement les fichiers d'en-tête, bin pour les programmes indépendants et debug pour les informations de débogage (see Installer les fichiers de débogage).   Les sorties d'un paquet sont listés dans la troisième colonne de la sortie de guix package --list-available (see Invoquer guix package).

Invoquer guix gc
================

Les paquets qui sont installés mais pas utilisés peuvent être glanés. La commande guix gc permet aux utilisateurs de lancer explicitement le ramasse-miettes pour récupérer de l'espace dans le répertoire /gnu/store.  C'est la seule manière de supprimer des fichiers de /gnu/store — supprimer des fichiers ou des répertoires à la main peut le casser de manière impossible à réparer !

Le ramasse-miettes a un ensemble de racines connues : tout fichier dans /gnu/store atteignable depuis une racine est considéré comme utilisé et ne peut pas être supprimé ; tous les autres fichiers sont considérés comme inutilisés et peuvent être supprimés.  L'ensemble des racines du ramasse-miettes (ou « racines du GC » pour faire court) inclue les profils par défaut des utilisateurs ; par défaut les liens symboliques sous /var/guix/gcroots représentent ces racines du GC.  De nouvelles racines du GC peuvent être ajoutées avec la guix build -- root par exemple (see Invoquer guix build).

Avant de lancer guix gc --collect-garbage pour faire de la place, c'est souvent utile de supprimer les anciennes génération des profils utilisateurs ; de cette façon les anciennes constructions de paquets référencées par ces générations peuvent être glanées.  Cela se fait en lançaint guix package --delete-generations (see Invoquer guix package).

Nous recommandons de lancer le ramasse-miettes régulièrement ou lorsque vous avez besoin d'espace disque.  Par exemple pour garantir qu'au moins 5 Go d'espace reste libre sur votre disque, lancez simplement :

     guix gc -F 5G

Il est parfaitement possible de le lancer comme une tâche périodique non-interactive (see Exécution de tâches planifiées pour apprendre comment paramétrer une telle tâche sur GuixSD).  Lancer guix gc sans argument ramassera autant de miettes que possible mais ça n'est pas le plus pratique : vous pourriez vous retrouver à reconstruire ou re-télécharger des logiciels « inutilisés » du point de vu du GC mais qui sont nécessaires pour construire d'autres logiciels — p. ex. la chaîne de compilation.

La command guix gc a trois modes d'opération : il peut être utilisé pour glaner des fichiers inutilisés (par défaut), pour supprimer des fichiers spécifiques (l'option --delete), pour afficher des informations sur le ramasse-miettes ou pour des requêtes plus avancées.  Les options du ramasse-miettes sont :

--collect-garbage[=MIN]
-C [MIN]
     Ramasse les miettes — c.-à-d. les fichiers inaccessibles de /gnu/store et ses sous-répertoires.  C'est l'opération par défaut lorsqu'aucune option n'est spécifiée.

     Lorsque MIN est donné, s'arrêter une fois que MIN octets ont été collectés.  MIN pour être un nombre d'octets ou inclure un suffixe d'unité, comme MiB pour mébioctet et GB pour gigaoctet (see size specifications (GNU Coreutils)).

     Lorsque MIN est omis, tout glaner.

--free-space=LIBRE
-F LIBRE
     Glaner jusqu'à ce que LIBRE espace soit disponible dans /gnu/store si possible ; LIBRE est une quantité de stockage comme 500MiB comme décrit ci-dessus.

     Lorsque LIBRE ou plus est disponible dans /gnu/store ne rien faire et s'arrêter immédiatement.

--delete
-d
     Essayer de supprimer tous les fichiers et les répertoires du dépôt spécifiés en argument.  Cela échoue si certains des fichiers ne sont pas dans le dépôt ou s'ils sont toujours utilisés.

--list-failures
     Lister les éléments du dépôt qui correspondent à des échecs de construction

     Cela n'affiche rien à moins que le démon n'ait été démarré avec --cache-failures (see --cache-failures).

--clear-failures
     Supprimer les éléments du dépôt spécifiés du cache des constructions échouées.

     De nouveau, cette option ne fait de sens que lorsque le démon est démarré avec --cache-failures.  Autrement elle ne fait rien.

--list-dead
     Montrer la liste des fichiers et des répertoires inutilisés encore présents dans le dépôt — c.-à-d. les fichiers et les répertoires qui ne sont plus atteignables par aucune racine.

--list-live
     Montrer la liste des fichiers et des répertoires du dépôt utilisés.

En plus, les références entre les fichiers existants du dépôt peuvent être demandés :

--references
--referrers
     Lister les références (respectivement les référents) des fichiers du dépôt en argument.

--requisites
-R
     Lister les prérequis des fichiers du dépôt passés en argument.  Les prérequis sont le fichier du dépôt lui-même, leur références et les références de ces références, récursivement.  En d'autre termes, la liste retournée est la closure transitive des fichiers du dépôt.

     See Invoquer guix size pour un outil pour surveiller la taille de la closure d'un élément.  See Invoquer guix graph pour un outil pour visualiser le graphe des références.

--derivers
     Renvoie les dérivations menant aux éléments du dépôt donnés (see Dérivations).

     Par exemple cette commande :

          guix gc --derivers `guix package -I ^emacs$ | cut -f4`

     renvoie les fichiers .drv menant au paquet emacs installé dans votre profil.

     Remarquez qu'il peut n'y avoir aucun fichier .drv par exemple quand ces fichiers ont été glanés.  Il peut aussi y avoir plus d'un fichier .drv correspondant à cause de dérivations à sortie fixées.

Enfin, les options suivantes vous permettent de vérifier l'intégrité du dépôt et de contrôler l'utilisation du disque.

--verify[=OPTIONS]
     Vérifier l'intégrité du dépôt.

     Par défaut, s'assurer que tous les éléments du dépôt marqués comme valides dans la base de données du démon existent bien dans /gnu/store.

     Lorsqu'elle est fournie, l'OPTION doit être une liste séparée par des virgule de l'un ou plus parmi contents et repair.

     Lorsque vous passez --verify=contents, le démon calcul le hash du contenu de chaque élément du dépôt et le compare au hash de sa base de données.  Les différences de hash sont rapportées comme des corruptions de données.  Comme elle traverse tous les fichiers du dépôt, cette commande peut prendre très longtemps pour terminer, surtout sur un système avec un disque lent.

     Utiliser --verify=repair ou --verify=contents,repair fait que le démon essaie de réparer les objets du dépôt corrompus en récupérant leurs substituts (see Substituts).  Comme la réparation n'est pas atomique et donc potentiellement dangereuse, elle n'est disponible que pour l'administrateur système.  Une alternative plus légère lorsque vous connaissez exactement quelle entrée est corrompue consiste à lancer guix build --repair (see Invoquer guix build).

--optimize
     Optimiser le dépôt en liant en dur les fichiers identiques — c'est la déduplication.

     Le démon effectue une déduplication à chaque construction réussie ou import d'archive à moins qu'il n'ait été démarré avec --disable-deduplication (see --disable-deduplication).  Ainsi, cette option est surtout utile lorsque le démon tourne avec --disable-deduplication.

Invoquer guix pull
==================

Les paquets sont installés ou mis à jour vers la dernière version disponible dans la distribution actuellement disponible sur votre machine locale.  Pour mettre à jour cette distribution, en même temps que les outils Guix, vous devez lancer guix pull ; la commande télécharge le dernier code source de Guix et des descriptions de paquets et le déploie.  Le code source est téléchargé depuis un dépôt Git (https://git-scm.com).

À la fin, guix package utilisera les paquets et les versions des paquets de la copie de Guix tout juste récupérée.  Non seulement ça, mais toutes les commandes Guix et les modules Scheme seront aussi récupérés depuis la dernière version.  Les nouvelles sous-commandes de guix ajoutés par la mise à jour sont aussi maintenant disponibles.

Chaque utilisateur peut mettre à jour sa copie de Guix avec guix pull et l'effet est limité à l'utilisateur qui a lancé guix pull.  Par exemple, lorsque l'utilisateur root lance guix pull, cela n'a pas d'effet sur la version de Guix que vois alice et vice-versa

Le résultat après avoir lancé guix pull est un profil disponible sous ~/.config/guix/current contenant la dernière version de Guix.  Ainsi, assurez-vous de l'ajouter au début de votre chemin de recherche pour que vous utilisiez la dernière version.  Le même conseil s'applique au manuel Info (see Documentation) :

     export PATH="$HOME/.config/guix/current/bin:$PATH"
     export INFOPATH="$HOME/.config/guix/current/share/info:$INFOPATH"

L'option --list-generations ou -l liste les anciennes générations produites par guix pull, avec des détails sur leur origine :

     $ guix pull -l
     Génération 1	10 juin 2018 00:18:18
       guix 65956ad
         URL du dépôt : https://git.savannah.gnu.org/git/guix.git
         branche : origin/master
         commit : 65956ad3526ba09e1f7a40722c96c6ef7c0936fe

     Generation 2	Jun 11 2018 11:02:49
       guix e0cc7f6
         repository URL: https://git.savannah.gnu.org/git/guix.git
         branch: origin/master
         commit: e0cc7f669bec22c37481dd03a7941c7d11a64f1d
       2 new packages: keepalived, libnfnetlink
       6 packages upgraded: emacs-nix-mode@2.0.4,
         guile2.0-guix@0.14.0-12.77a1aac, guix@0.14.0-12.77a1aac,
         heimdal@7.5.0, milkytracker@1.02.00, nix@2.0.4

     Generation 3	Jun 13 2018 23:31:07	(current)
       guix 844cc1c
         repository URL: https://git.savannah.gnu.org/git/guix.git
         branch: origin/master
         commit: 844cc1c8f394f03b404c5bb3aee086922373490c
       28 new packages: emacs-helm-ls-git, emacs-helm-mu, ...
       69 packages upgraded: borg@1.1.6, cheese@3.28.0, ...

Ce profil ~/.config/guix/current fonctionne comme les autres profils créés par guix package (see Invoquer guix package). C'est-à-dire que vous pouvez lister les générations, revenir en arrière à une génération précédente — c.-à-d. la version de Guix précédente — etc :

     $ guix package -p ~/.config/guix/current --roll-back
     passé de la génération 3 à 2
     $ guix package -p ~/.config/guix/current --delete-generations=1
     suppression de /home/charlie/.config/guix/current-1-link

La commande guix pull est typiquement invoquée sans arguments mais il supporte les options suivantes :

--verbose
     Produire une sortie verbeuse, en écrivant les journaux de construction sur la sortie d'erreur standard.

--url=URL
     Télécharger Guix depuis le dépôt Git à URL.

     Par défaut, la source est récupérée depuis le dépôt Git canonique sur gnu.org, pour la branche stable de Guix.  Pour utiliser une autre source, paramétrez la variable d'environnement GUIX_PULL_URL.

--commit=COMMIT
     Déployer de COMMIT, un ID de commit Git valide représenté par une chaîne hexadécimale.

--branch=BRANCHE
     Déployer le haut de la BRANCHE, le nom d'une branche Git disponible sur le répertoire à URL.

--list-generations[=MOTIF]
-l [MOTIF]
     Liste toutes les générations de ~/.config/guix/current ou, si MOTIF est fournit, le sous-ensemble des générations qui correspondent à MOTIF.  La syntaxe de MOTIF est la même qu'avec guix package --list-generations (see Invoquer guix package).

--bootstrap
     Utiliser le programme d'amorçage Guile pour construire la dernière version de Guix.  Cette option n'est utile que pour les développeurs de Guix.

En plus, guix pull supporte toutes les options de construction communes (see Options de construction communes).

Invoquer guix pack
==================

Parfois vous voulez passer un logiciel à des gens qui n'ont pas (encore !) la chance d'utiliser Guix.  Vous leur diriez bien de lancer guix package -i QUELQUE CHOSE mais ce n'est pas possible dans ce cas. C'est là que guix pack entre en jeu.

     Si vous cherchez comment échanger des binaires entre des machines où Guix est déjà installé, see Invoquer guix copy, Invoquer guix publish, et Invoquer guix archive.

La commande guix pack crée un pack ou lot de logiciels : elle crée une archive tar ou un autre type d'archive contenunt les binaires pour le logiciel qui vous intéresse ainsi que ses dépendances. L'archive qui en résulte peut être utilisée sur toutes les machines qui n'ont pas Guix et les gens peuvent lancer exactement les mêmes binaires que ceux que vous avez avec Guix.  Le pack lui-même est créé d'une manière reproductible au bit près, pour que n'importe qui puisse vérifier qu'il contient bien les résultats que vous prétendez proposer.

Par exemple, pour créer un lot contenant Guile, Emacs, Geiser et toutes leurs dépendances, vous pouvez lancer :

     $ guix pack guile emacs geiser
     ...
     /gnu/store/...-pack.tar.gz

Le résultat ici est une archive tar contenant un répertoire /gnu/store avec tous les paquets nécessaires.  L'archive qui en résulte contient un profil avec les trois paquets qui vous intéressent ; le profil est le même qui celui qui aurait été créé avec guix package -i.  C'est ce mécanisme qui est utilisé pour créer les archives tar binaires indépendantes de Guix (see Installation binaire).

Les utilisateurs de ce pack devraient lancer /gnu/store/...-profile/bin/guile pour lancer Guile, ce qui n'est pas très pratique.  Pour éviter cela, vous pouvez créer, disons, un lien symbolique /opt/gnu/bin vers le profil :

     guix pack -S /opt/gnu/bin=bin guile emacs geiser

De cette façon, les utilisateurs peuvent joyeusement taper /opt/gnu/bin/guile et profiter.

Et si le destinataire de votre pack n'a pas les privilèges root sur sa machine, et ne peut donc pas le décompresser dans le système de fichiers racine ?  Dans ce cas, vous pourriez utiliser l'option --relocatable (voir plus bas).  Cette option produite des binaire repositionnables, ce qui signifie qu'ils peuvent être placés n'importe où dans l'arborescence du système de fichiers : dans l'exemple au-dessus, les utilisateurs peuvent décompresser votre archive dans leur répertoire personnel et lancer directement ./opt/gnu/bin/guile.

Autrement, vous pouvez produire un pack au format d'image Docker avec la commande suivante :

     guix pack -f docker guile emacs geiser

Le résultat est une archive tar qui peut être passée à la commande docker load.  Voir la documentation de Docker (https://docs.docker.com/engine/reference/commandline/load/) pour plus d'informations.

Autrement, vous pouvez produire une image SquashFS avec la commande suivante :

     guix pack -f squashfs guile emacs geiser

Le résultat est une image de système de fichiers SquashFS qui peut soit être montée directement soit être utilisée comme image de conteneur de système de fichiers avec l'environnement d'exécution conteneurisé Singularity (http://singularity.lbl.gov), avec des commandes comme singularity shell ou singularity exec.

Diverses options en ligne de commande vous permettent de personnaliser votre pack :

--format=FORMAT
-f FORMAT
     Produire un pack dans le FORMAT donné.

     Les formats disponibles sont :

     tarball
          C'est le format par défaut.  Il produit une archive tar contenant tous les binaires et les liens symboliques spécifiés.

     docker
          Cela produit une archive tar qui suit la spécification des images Docker (https://github.com/docker/docker/blob/master/image/spec/v1.2.md).

     squashfs
          Cela produit une image SquashFS contenant tous les binaires et liens symboliques spécifiés, ainsi que des points de montages vides pour les systèmes de fichiers virtuels comme procfs.

--relocatable
-R
     Produit des binaires repositionnables — c.-à-d. des binaires que vous pouvez placer n'importe où dans l'arborescence du système de fichiers et les lancer à partir de là.  Par exemple, si vous créez un pack contenant Bash avec :

          guix pack -R -S /mybin=bin bash

     … vous pouvez copier ce pack sur une machine qui n'a pas Guix et depuis votre répertoire personnel en tant qu'utilisateur non-privilégié, lancer :

          tar xf pack.tar.gz
          ./mybin/sh

     Dans ce shell, si vous tapez ls /gnu/store, vous remarquerez que /gnu/store apparaît et contient toutes les dépendances de bash, même si la machine n'a pas du tout de /gnu/store ! C'est sans doute la manière la plus simple de déployer du logiciel construit avec Guix sur une machine sans Guix.

     Il y a un inconvénient cependant : cette technique repose sur les espaces de noms du noyau Linux qui permettent à des utilisateurs non-privilégiés de monter des systèmes de fichiers ou de changer de racine. Les anciennes versions de Linux ne le supportaient pas et certaines distributions GNU/Linux les désactivent ; sur ces système, les programme du pack ne fonctionneront pas à moins qu'ils ne soient décompressés à la racine du système de fichiers.

--expression=EXPR
-e EXPR
     Considérer le paquet évalué par EXPR.

     Cela a le même but que l'option de même nom de guix build (see --expression dans guix build).

--manifest=FICHIER
-m FICHIER
     Utiliser les paquets contenus dans l'objet manifeste renvoyé par le code Scheme dans FICHIER

     Elle a un but similaire à l'option de même nom dans guix package (see --manifest) et utilise les mêmes fichiers manifeste.  Ils vous permettent de définir une collection de paquets une fois et de l'utiliser aussi bien pour créer des profils que pour créer des archives pour des machines qui n'ont pas Guix d'installé. Remarquez que vous pouvez spécifier soit un fichier manifeste, soit une liste de paquet, mais pas les deux.

--system=SYSTÈME
-s SYSTÈME
     Tenter de construire pour le SYSTÈME — p. ex. i686-linux — plutôt que pour le type de système de l'hôte de construction.

--target=TRIPLET
     Effectuer une compilation croisée pour TRIPLET qui doit être un triplet GNU valide, comme "mips64el-linux-gnu" (see GNU configuration triplets (Autoconf)).

--compression=OUTIL
-C OUTIL
     Compresser l'archive résultante avec OUTIL — l'un des outils parmi bzip2, xz, lzip ou none pour aucune compression.

--symlink=SPEC
-S SPEC
     Ajouter les liens symboliques spécifiés par SPEC dans le pack.  Cette option peut apparaître plusieurs fois.

     SPEC a la forme SOURCE=CIBLE, où SOURCE est le lien symbolique qui sera créé et CIBLE est la cible du lien.

     Par exemple, -S /opt/gnu/bin=bin crée un lien symbolique /opt/gnu/bin qui pointe vers le sous-répertoire bin du profil.

--localstatedir
     Inclure le « répertoire d'état local », /var/guix dans le paquet résultant.

     /var/guix contient la base de données du dépôt (see Le dépôt) ainsi que les racines du ramasse-miettes (see Invoquer guix gc).  Le fournir dans le pack signifie que le dépôt et « complet » et gérable par Guix ; ne pas le fournir dans le pack signifie que le dépôt est « mort » : aucun élément ne peut être ajouté ni enlevé après l'extraction du pack.

     Un cas d'utilisation est l'archive binaire indépendante de Guix (see Installation binaire).

--bootstrap
     Utiliser les programmes d'amorçage pour construire le pack.  Cette option n'est utile que pour les développeurs de Guix.

En plus, guix pack supporte toutes les options de construction communes (see Options de construction communes) et toutes les options de transformation de paquets (see Options de transformation de paquets).

Invoquer guix archive
=====================

La commande guix archive permet aux utilisateurs d'exporter des fichiers du dépôt dans une simple archive puis ensuite de les importer sur une machine qui fait tourner Guix.  En particulier, elle permet de transférer des fichiers du dépôt d'une machine vers le dépôt d'une autre machine.

     Si vous chercher une manière de produire des archives dans un format adapté pour des outils autres que Guix, see Invoquer guix pack.

Pour exporter des fichiers du dépôt comme une archive sur la sortie standard, lancez :

     guix archive --export OPTIONS SPÉCIFICATIONS...

SPÉCIFICATIONS peut être soit des noms de fichiers soit des spécifications de paquets, comme pour guix package (see Invoquer guix package).  Par exemple, la commande suivante crée une archive contenant la sortie gui du paquet git et la sortie principale de emacs :

     guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar

Si les paquets spécifiés ne sont pas déjà construits, guix archive les construit automatiquement.  Le processus de construction peut être contrôlé avec les options de construction communes (see Options de construction communes).

Pour transférer le paquet emacs vers une machine connectée en SSH, on pourrait lancer :

     guix archive --export -r emacs | ssh la-machine guix archive --import

De même, on peut transférer un profil utilisateur complet d'une machine à une autre comme cela :

     guix archive --export -r $(readlink -f ~/.guix-profile) | \
       ssh la-machine guix-archive --import

Cependant, remarquez que, dans les deux exemples, le paquet emacs, le profil ainsi que toutes leurs dépendances sont transférées (à cause de -r), indépendamment du fait qu'ils soient disponibles dans le dépôt de la machine cible.  L'option --missing peut vous aider à comprendre les éléments qui manquent dans le dépôt de la machine cible.  La commande guix copy simplifie et optimise ce processus, c'est donc ce que vous devriez utiliser dans ce cas (see Invoquer guix copy).

Les archives sont stockées au format « archive normalisé » ou « nar », qui est comparable dans l'esprit à « tar » mais avec des différences qui le rendent utilisable pour ce qu'on veut faire.  Tout d'abord, au lieu de stocker toutes les métadonnées Unix de chaque fichier, le format nar ne mentionne que le type de fichier (normal, répertoire ou lien symbolique) ; les permissions Unix, le groupe et l'utilisateur ne sont pas mentionnés. Ensuite, l'ordre dans lequel les entrées de répertoires sont stockés suit toujours l'ordre des noms de fichier dans l'environnement linguistique C. Cela rend la production des archives entièrement déterministe.

Lors de l'export, le démon signe numériquement le contenu de l'archive et cette signature est ajoutée à la fin du fichier.  Lors de l'import, le démon vérifie la signature et rejette l'import en cas de signature invalide ou si la clef de signature n'est pas autorisée.

Les principales options sont :

--export
     Exporter les fichiers ou les paquets du dépôt (voir plus bas).  Écrire l'archive résultante sur la sortie standard.

     Les dépendances ne sont pas incluses dans la sortie à moins que --recursive ne soit passé.

-r
--recursive
     En combinaison avec --export, cette option demande à guix archive d'inclure les dépendances des éléments donnés dans l'archive. Ainsi, l'archive résultante est autonome : elle contient la closure des éléments du dépôt exportés.

--import
     Lire une archive depuis l'entrée standard et importer les fichiers inclus dans le dépôt.  Annuler si l'archive a une signature invalide ou si elle est signée par une clef publique qui ne se trouve pas dans le clefs autorisées (voir --authorize plus bas.)

--missing
     Liste une liste de noms de fichiers du dépôt sur l'entrée standard, un par ligne, et écrit sur l'entrée standard le sous-ensemble de ces fichiers qui manquent dans le dépôt.

--generate-key[=PARAMÈTRES]
     Générer une nouvelle paire de clefs pour le démon.  Cela est un prérequis avant que les archives ne puissent être exportées avec --export. Remarquez que cette opération prend généralement du temps parce qu'elle doit récupère suffisamment d'entropie pour générer la paire de clefs.

     La paire de clefs générée est typiquement stockée dans /etc/guix, dans signing-key.pub (clef publique) et signing-key.sec (clef privée, qui doit rester secrète).  Lorsque PARAMÈTRES est omis, une clef ECDSA utilisant la courbe Ed25519 est générée ou pour les version de libgcrypt avant 1.6.0, une clef RSA de 4096 bits.  Autrement, PARAMÈTRES peut spécifier les paramètres genkey adaptés pour libgcrypt (see gcry_pk_genkey (The Libgcrypt Reference Manual)).

--authorize
     Autoriser les imports signés par la clef publique passée sur l'entrée standard.  La clef publique doit être au « format avancé s-expression  » — c.-à-d. le même format que le fichier signing-key.pub.

     La liste des clefs autorisées est gardée dans un fichier modifiable par des humains dans /etc/guix/acl.  Le fichier contient des « s-expressions au format avancé » (http://people.csail.mit.edu/rivest/Sexp.txt) et est structuré comme une liste de contrôle d'accès dans l'infrastructure à clefs publiques simple (SPKI) (http://theworld.com/~cme/spki.txt).

--extract=RÉPERTOIRE
-x RÉPERTOIRE
     Lit une archive à un seul élément telle que servie par un serveur de substituts (see Substituts) et l'extrait dans RÉPERTOIRE.  C'est une opération de bas niveau requise seulement dans de rares cas d'usage ; voir plus loin.

     Par exemple, la commande suivante extrait le substitut pour Emacs servi par hydra.gnu.org dans /tmp/emacs :

          $ wget -O - \
            https://hydra.gnu.org/nar/...-emacs-24.5 \
            | bunzip2 | guix archive -x /tmp/emacs

     Les archives à un seul élément sont différentes des archives à plusieurs éléments produites par guix archive --export ; elles contiennent un seul élément du dépôt et elles n'embarquent pas de signature. Ainsi cette opération ne vérifie pas de signature et sa sortie devrait être considérée comme non sûre.

     Le but principal de cette opération est de faciliter l'inspection du contenu des archives venant de serveurs auxquels on ne fait potentiellement pas confiance.

Interface de programmation
**************************

GNU Guix fournit diverses interface de programmation Scheme (API) qui pour définir, construire et faire des requêtes sur des paquets.  La première interface permet aux utilisateurs d'écrire des définitions de paquets de haut-niveau.  Ces définitions se réfèrent à des concepts de création de paquets familiers, comme le nom et la version du paquet, son système de construction et ses dépendances.  Ces définitions peuvent ensuite être transformées en actions concrètes lors de la construction.

Les actions de construction sont effectuées par le démon Guix, pour le compte des utilisateurs.  Dans un environnement standard, le démon possède les droits en écriture sur le dépôt — le répertoire /gnu/store — mais pas les utilisateurs.  La configuration recommandée permet aussi au démon d'effectuer la construction dans des chroots, avec un utilisateur de construction spécifique pour minimiser les interférences avec le reste du système.

Il y a des API de plus bas niveau pour interagir avec le démon et le dépôt. Pour demander au démon d'effectuer une action de construction, les utilisateurs lui donnent en fait une dérivation.  Une dérivation est une représentation à bas-niveau des actions de construction à entreprendre et l'environnement dans lequel elles devraient avoir lieu — les dérivations sont aux définitions de paquets ce que l'assembleur est aux programmes C. Le terme de « dérivation » vient du fait que les résultats de la construction en dérivent.

Ce chapitre décrit toutes ces API tour à tour, à partir des définitions de paquets à haut-niveau.

Définition des paquets
======================

L'interface de haut-niveau pour les définitions de paquets est implémentée dans les modules (guix packages) et (guix build-system).  Par exemple, la définition du paquet, ou la recette, du paquet GNU Hello ressemble à cela :

     (define-module (gnu packages hello)
       #:use-module (guix packages)
       #:use-module (guix download)
       #:use-module (guix build-system gnu)
       #:use-module (guix licenses)
       #:use-module (gnu packages gawk))

     (define-public hello
       (package
         (name "hello")
         (version "2.10")
         (source (origin
                   (method url-fetch)
                   (uri (string-append "mirror://gnu/hello/hello-" version
                                       ".tar.gz"))
                   (sha256
                    (base32
                     "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i"))))
         (build-system gnu-build-system)
         (arguments '(#:configure-flags '("--enable-silent-rules")))
         (inputs `(("gawk" ,gawk)))
         (synopsis "Hello, GNU world: An example GNU package")
         (description "Guess what GNU Hello prints!")
         (home-page "http://www.gnu.org/software/hello/")
         (license gpl3+)))

Sans être un expert Scheme, le lecteur peut comprendre la signification des différents champs présents.  Cette expression lie la variable hello à un objet <package>, qui est essentiellement un enregistrement (see Scheme records (GNU Guile Reference Manual)).  On peut inspecter cet objet de paquet avec les procédures qui se trouvent dans le module (guix packages) ; par exemple, (package-name hello) renvoie — oh surprise ! — "hello".

Avec un peu de chance, vous pourrez importer tout ou partie de la définition du paquet qui vous intéresse depuis un autre répertoire avec la commande guix import (see Invoquer guix import).

Dans l'exemple précédent, HELLO est défini dans un module à part, (gnu packages hello).  Techniquement, cela n'est pas strictement nécessaire, mais c'est pratique : tous les paquets définis dans des modules sous (gnu packages ...) sont automatiquement connus des outils en ligne de commande (see Modules de paquets).

Il y a quelques points à remarquer dans la définition de paquet précédente :

  * Le champ source du paquet est un objet <origin> (see Référence d'origine, pour la référence complète).  Ici, on utilise la méthode url-fetch de (guix download), ce qui signifie que la source est un fichier à télécharger par FTP ou HTTP.

     Le préfixe mirror://gnu demande à url-fetch d'utiliser l'un des miroirs GNU définis dans (guix download).

     Le champ sha256 spécifie le hash SHA256 attendu pour le fichier téléchargé.  Il est requis et permet à Guix de vérifier l'intégrité du fichier.  La forme (base32 ...) introduit a représentation en base32 du hash.  Vous pouvez obtenir cette information avec guix download (see Invoquer guix download) et guix hash (see Invoquer guix hash).

     Lorsque cela est requis, la forme origin peut aussi avec un champ patches qui liste les correctifs à appliquer et un champ snippet qui donne une expression Scheme pour modifier le code source.

  * Le champ build-system spécifie la procédure pour construire le paquet (see Systèmes de construction).  Ici, GNU-BUILD-SYSTEM représente le système de construction GNU familier, où les paquets peuvent être configurés, construits et installés avec la séquence ./configure && make && make check && make install habituelle.

  * Le champ arguments spécifie des options pour le système de construction (see Systèmes de construction).  Ici il est interprété par GNU-BUILD-SYSTEM comme une demande de lancer configure avec le drapeau --enable-silent-rules.

     Que sont ces apostrophes (') ?  C'est de la syntaxe Scheme pour introduire une liste ; ' est synonyme de la fonction quote. See quoting (GNU Guile Reference Manual), pour des détails.  Ice la valeur du champ arguments est une liste d'arguments passés au système de construction plus tard, comme avec apply  (see apply (GNU Guile Reference Manual)).

     La séquence dièse-deux-points (#:) définie un mot-clef Scheme (see Keywords (GNU Guile Reference Manual)), et #:configure-flags est un mot-clef utilisé pour passer un argument au système de construction (see Coding With Keywords (GNU Guile Reference Manual)).

  * Le champ inputs spécifie les entrées du processus de construction — c.-à-d. les dépendances à la construction ou à l'exécution du paquet.  Ici on définie une entrée nommée "gawk" dont la valeur est la variable GAWK ; GAWK est elle-même liée à un objet <package>.

     De nouveau, ` (un accent grave, synonyme de la fonction quasiquote) nous permet d'introduire une liste litérale dans le champ inputs, tandis que , (une virgule, synonyme de la fonction unquote) nous permet d'insérer une valeur dans cette liste (see unquote (GNU Guile Reference Manual)).

     Remarquez que GCC, Coreutils, Bash et les autres outils essentiels n'ont pas besoin d'être spécifiés en tant qu'entrées ici.  À la place, le GNU-BUILD-SYSTEM est en charge de s'assurer qu'ils sont présents (see Systèmes de construction).

     Cependant, toutes les autres dépendances doivent être spécifiées dans le champ inputs.  Toute dépendance qui ne serait pas spécifiée ici sera simplement indisponible pour le processus de construction, ce qui peut mener à un échec de la construction.

See Référence de paquet, pour une description complète des champs possibles.

Lorsqu'une définition de paquet est en place, le paquet peut enfin être construit avec l'outil en ligne de commande guix build (see Invoquer guix build), pour résoudre les échecs de construction que vous pourriez rencontrer (see Débogage des échecs de construction).  Vous pouvez aisément revenir à la définition du paquet avec la commande guix edit (see Invoquer guix edit).  See Consignes d'empaquetage, pour plus d'inforamtions sur la manière de tester des définitions de paquets et Invoquer guix lint, pour des informations sur la manière de vérifier que la définition réspecte les conventions de style. Enfin, see Modules de paquets pour des informations sur la manière d'étendre la distribution en ajoutant vos propres définitions de paquets dans GUIX_PACKAGE_PATH.

Finalement, la mise à jour de la définition du paquet à une nouvelle version amont peut en partie s'automatiser avec la commande guix refresh (see Invoquer guix refresh).

Sous le capot, une dérivation qui correspond à un objet <package> est d'abord calculé par la procédure package-derivation.  Cette dérivation est stockée dans un fichier .drv dans /gnu/store. Les actions de construction qu'il prescrit peuvent ensuite être réalisées par la procédure build-derivation (see Le dépôt).

 -- Procédure Scheme: package-derivation DÉPÔT PAQUET [SYSTÈME]
     Renvoie l'objet <derivation> du PAQUET pour le SYSTÈME (see Dérivations).

     PAQUET doit être un objet <package> valide et SYSTÈME une chaîne indiquant le type de système cible — p.ex. "x86_64-linux" pour un système GNU x86_64 basé sur Linux.  DÉPÔT doit être une connexion au démon, qui opère sur les dépôt (see Le dépôt).

De manière identique, il est possible de calculer une dérivation qui effectue une compilation croisée d'un paquet pour un autre système :

 -- Procédure Scheme: package-cross-derivation DÉPÔT
     PAQUET CIBLE [SYSTÈME] renvoie l'objet <derivation>
     duof PAQUET construit depuis SYSTÈME pour CIBLE.

     CIBLE doit être un triplet GNU valide indiquant le matériel cible et le système d'exploitation, comme "mips64el-linux-gnu" (see GNU configuration triplets (GNU Configure and Build System)).

On peut manipuler les paquets de manière arbitraire.  Une transformation utile est par exemple la réécriture d'entrées où l'arbre des dépendances d'un paquet est réécrit en replaçant des entrées spécifiques par d'autres :

 -- Procédure Scheme: package-input-rewriting REMPLACEMENTS
     [NOM-RÉÉCRIT] Renvoie une procédure qui, lorsqu'on lui donne un
     paquet, remplace des dépendances directes et indirectes (mais pas ses entrées implicites) en fonction de REMPLACEMENTS.  REMPLACEMENTS est une liste de paires de paquets ; le premier élément de chaque pair est le paquet à remplacer, le second son remplaçant.

     De manière facultative, NOM-RÉÉCRIT est une procédure à un argument qui prend le nom d'un paquet et renvoie son nouveau nom après l'avoir réécrit.

Regardez cet exemple :

     (define libressl-instead-of-openssl
       ;; Cette procédure remplace OPENSSL par LIBRESSL,
       ;; récursivement.
       (package-input-rewriting `((,openssl . ,libressl))))

     (define git-with-libressl
       (libressl-instead-of-openssl git))

Ici nous définissons d'abord une procédure de réécriture qui remplace OPENSSL par LIBRESSL.  Ensuite nous l'utilisons pour définir une variante du paquet GIT qui utilise LIBRESSL plutôt que OPENSSL.  cela est exactement ce que l'option en ligne de commande --with-input fait (see --with-input).

Une procédure plus générique pour réécrire un graphe de dépendance d'un paquet est package-mapping : elle supporte n'importe quel changement dans les nœuds du graphe.

 -- Procédure Scheme: package-mapping PROC [CUT?]
     Renvoie une procédure qui, avec un paquet, applique PROC sur tous les paquets dont il dépend et renvoie le paquet qui en résulte.  La procédure arrête la récursion là où CUT? renvoie vrai pour un paquet donné.

Référence de package
--------------------

Cette section résume toutes les options disponibles dans les déclarations package  (see Définition des paquets).

 -- Type de donnée: package
     C'est le type de donnée représentant une recette de paquets

     name
          Le nom du paquet, comme une chaîne de caractères.

     version
          La version du paquet, comme une chaîne de caractères.

     source
          Un objet qui indique comment le code source du paquet devrait être récupéré.  La plupart du temps, c'est un objet origin qui indique un fichier récupéré depuis internet (see Référence d'origine).  Il peut aussi s'agir de tout autre objet ``simili-fichier'' comme un local-file qui indique un fichier du système de fichier local (see local-file).

     build-system
          Le système de construction qui devrait être utilisé pour construire le paquet (see Systèmes de construction).

     arguments (par défaut : '())
          Les arguments à passer au système de construction.  C'est une liste qui contient typiquement une séquence de paires de clefs-valeurs.

     inputs (par défaut : '())
     native-inputs (par défaut : '())
     propagated-inputs (par défaut : '())
          Ces champs listent les dépendances du paquet.  Chacune est une liste de tuples, où chaque tuple a une étiquette pour une entrée (une chaîne de caractères) comme premier élément, un paquet, une origine ou une dérivation comme deuxième élément et éventuellement le nom d'une sortie à utiliser qui est "out" par défaut (see Des paquets avec plusieurs résultats, pour plus d'informations sur les sorties des paquets).  Par exemple, la liste suivante spécifie trois entrées :

               `(("libffi" ,libffi)
                 ("libunistring" ,libunistring)
                 ("glib:bin" ,glib "bin"))  ;la sortie "bin" de Glib

          La distinction entre native-inputs et inputs est nécessaire lorsqu'on considère la compilation croisée.  Lors d'une compilation croisée, les dépendances listées dans inputs sont construites pour l'architecture cible ; inversement, les dépendances listées dans native-inputs sont construites pour l'architecture de la machine de construction.

          native-inputs est typiquement utilisé pour lister les outils requis à la construction mais pas à l'exécution, comme Autoconf, Automake, pkg-config, Gettext ou Bison.  guix lint peut rapporter des erreurs de ce type (see Invoquer guix lint).

          Enfin, propagated-inputs est similaire à inputs, mais les paquets spécifiés seront automatiquement installés avec le paquet auquel ils appartiennent (see guix package, pour des informations sur la manière dont guix package traite les entrées propagées).

          Par exemple cela est nécessaire lorsque des bibliothèques C/C++ ont besoin d'en-têtes d'une autre bibliothèque pour être compilé ou lorsqu'un fichier pkg-config se rapporte à un autre via son champ Requires.

          Un autre exemple où propagated-inputs est utile est pour les langages auxquels il manque un moyen de retenir le chemin de recherche comme c'est le cas du RUNPATH des fichiers ELF ; cela comprend Guile, Python, Perl et plus.  Pour s'assurer que les bibliothèques écrites dans ces langages peuvent trouver le code des bibliothèques dont elles dépendent à l'exécution, les dépendances à l'exécution doivent être listées dans propagated-inputs plutôt que inputs.

     self-native-input? (par défaut : #f)
          C'est un champ booléen qui indique si le paquet devrait s'utiliser lui-même comme entrée native lors de la compilation croisée.

     outputs (par défaut : '("out"))
          La liste des noms de sorties du paquet.  See Des paquets avec plusieurs résultats, pour des exemples typiques d'utilisation de sorties supplémentaires.

     native-search-paths (par défaut : '())
     search-paths (par défaut : '())
          Une liste d'objets search-path-specification décrivant les variables d'environnement de recherche de chemins que ce paquet utilise.

     replacement (par défaut : #f)
          Ce champ doit être soit #f soit un objet de paquet qui sera utilisé comme remplaçant de ce paquet.  See grafts, pour plus de détails.

     synopsis
          Une description sur une ligne du paquet.

     description
          Une description plus détaillée du paquet.

     license
          La licence du paquet ; une valeur tirée de (guix licenses) ou une liste de ces valeurs.

     home-page
          L'URL de la page d'accueil du paquet, en tant que chaîne de caractères.

     supported-systems (par défaut : %SUPPORTED-SYSTEMS)
          La liste des systèmes supportés par le paquet, comme des chaînes de caractères de la forme architecture-noyau, par exemple "x86_64-linux".

     maintainers (par défaut : '())
          La liste des mainteneurs du paquet, comme des objets maintainer.

     location (par défaut : emplacement de la source de la forme package)
          L'emplacement de la source du paquet.  C'est utile de le remplacer lorsqu'on hérite d'un autre paquet, auquel cas ce champ n'est pas automatiquement corrigé.

Référence de origin
-------------------

Cette section résume toutes les options disponibles dans le déclarations origin (see Définition des paquets).

 -- Type de donnée: origin
     C'est le type de donnée qui représente l'origine d'un code source.

     uri
          Un objet contenant l'URI de la source.  Le type d'objet dépend de la method (voir plus bas).  Par exemple, avec la méthode URL-FETCH de (guix download), les valeurs valide d'uri sont : une URL représentée par une chaîne de caractères, ou une liste de chaînes de caractères.

     method
          Un procédure qui gère l'URI.

          Quelques exemples :

          URL-FETCH de (guix download)
               télécharge un fichier depuis l'URL HTTP, HTTPS ou FTP spécifiée dans le champ uri ;

          GIT-FETCH de (guix git-download)
               clone le dépôt sous contrôle de version Git et récupère la révision spécifiée dans le champ uri en tant qu'objet git-reference ; un objet git-reference ressemble à cela :

                    (git-reference
                      (url "git://git.debian.org/git/pkg-shadow/shadow")
                      (commit "v4.1.5.1"))

     sha256
          Un bytevector contenant le hash SHA-256 de la source.  Typiquement la forme base32 est utilisée ici pour générer le bytevector depuis une chaîne de caractères en base-32.

          Vous pouvez obtenir cette information avec guix download (see Invoquer guix download) ou guix hash (see Invoquer guix hash).

     file-name (par défaut : #f)
          Le nom de fichier à utiliser pour sauvegarder le fichier.  Lorsqu'elle est à #f, une valeur par défaut raisonnable est utilisée dans la plupart des cas.  Dans le cas où la source est récupérée depuis une URL, le nom de fichier est celui de l'URL.  Pour les sources récupérées depuis un outil de contrôle de version, il est recommandé de fournir un nom de fichier explicitement parce que le nom par défaut n'est pas très descriptif.

     patches (par défaut : '())
          Une liste de noms de fichiers, d'origines ou d'objets simili-fichiers (see file-like objects) qui pointent vers des correctifs à appliquer sur la source.

          Cette liste de correctifs doit être inconditionnelle.  En particulier, elle ne peut pas dépendre des valeurs de %current-system ou %current-target-system.

     snippet (par défaut : #f)
          Une G-expression (see G-Expressions) ou une S-expression qui sera lancée dans le répertoire des sources.  C'est une manière pratique de modifier la source, parfois plus qu'un correctif.

     patch-flags (par défaut : '("-p1"))
          Une liste de drapeaux à passer à la commande patch.

     patch-inputs (par défaut : #f)
          Paquets d'entrées ou dérivations pour le processus de correction. Lorsqu'elle est à #f, l'ensemble d'entrées habituellement nécessaire pour appliquer des correctifs est fournit, comme GNU Patch.

     modules (par défaut : '())
          Une liste de modules Guile qui devraient être chargés pendant le processus de correction et pendant que le lancement du code du champ snippet.

     patch-guile (par défaut : #f)
          Le paquet Guile à utiliser dans le processus de correction.  Lorsqu'elle est à #f, une valeur par défaut raisonnable est utilisée.

Systèmes de construction
========================

Chaque définition de paquet définie un système de construction et des arguments pour ce système de construction (see Définition des paquets).  Ce champ build-system représente la procédure de construction du paquet, ainsi que des dépendances implicites pour cette procédure de construction.

Les systèmes de construction sont des objets <build-system>. L'interface pour les créer et les manipuler est fournie par le module (guix build-system) et les systèmes de construction eux-mêmes sont exportés par des modules spécifiques.

Sous le capot, les systèmes de construction compilent d'abord des objets paquets en sacs.  Un sac est comme un paquet, mais avec moins de décoration — en d'autres mots, un sac est une représentation à bas-niveau d'un paquet, qui inclus toutes les entrées de ce paquet, dont certaines ont été implicitement ajoutées par le système de construction.  Cette représentation intermédiaire est ensuite compilée en une dérivation (see Dérivations).

Les systèmes de construction acceptent une liste d'arguments facultatifs.  Dans les définitions de paquets, ils sont passés via le champ arguments (see Définition des paquets).  Ce sont typiquement des arguments par mot-clef (see keyword arguments in Guile (GNU Guile Reference Manual)).  La valeur de ces arguments est habituellement évaluée dans la strate de construction — c.-à-d. par un processus Guile lancé par le démon (see Dérivations).

Le système de construction principal est le GNU-BUILD-SYSTEM qui implémente les procédures de construction standard pour les paquets GNU et de nombreux autres.  Il est fournit par le module (guix build-system gnu).

 -- Variable Scheme: gnu-build-system
     GNU-BUILD-SYSTEM représente le système de construction GNU et ses variantes (see configuration and makefile conventions (GNU Coding Standards)).

     En résumé, les paquets qui l'utilisent sont configurés, construits et installés avec la séquence ./configure && make && make check && make install habituelle.  En pratique, des étapes supplémentaires sont souvent requises.  Toutes ces étapes sont séparées dans des phases différentes, notamment (Regardez les modules (guix build gnu-build-system) pour plus de détails sur les phases de construction.):

     unpack
          Décompresse l'archive des sources et se déplace dans l'arborescence des sources fraîchement extraites.  Si la source est en fait un répertoire, le copie dans l'arborescence de construction et entre dans ce répertoire.

     patch-source-shebangs
          Corrige les shebangs (#!) rencontrés dans les fichiers pour qu'ils se réfèrent aux bons noms de fichiers.  Par exemple, elle change #!/bin/sh en #!/gnu/store/...-bash-4.3/bin/sh.

     configure
          Lance le script configure avec un certain nombre d'options par défaut, comme --prefix=/gnu/store/..., ainsi que les options spécifiées par l'argument #:configure-flags.

     build
          Lance make avec la liste des drapeaux spécifiés avec #:make-flags.  Si l'argument #:parallel-build? est vrai (par défaut), construit avec make -j.

     check
          Lance make check, ou une autre cible spécifiée par #:test-target, à moins que #:tests? #f ne soit passé.  Si l'argument #:parallel-tests? est vrai (par défaut), lance make check -j.

     install
          Lance make install avec les drapeaux listés dans #:make-flags.

     patch-shebangs
          Corrige les shebangs des fichiers exécutables installés.

     strip
          Nettoie les symboles de débogage dans les fichiers ELF (à moins que #:strip-binaries? ne soit faux), les copie dans la sortie debug lorsqu'elle est disponible (see Installer les fichiers de débogage).

     Le module du côté du constructeur (guix build gnu-build-system) définie %STANDARD-PHASES comme la liste par défaut des phases de construction.  %STANDARD-PHASES  est une liste de paires de symboles et de procédures, où la procédure implémente la phase en question.

     La liste des phases utilisées par un paquet particulier peut être modifiée avec le paramètre #:phases.  Par exemple, en passant :

          #:phases (modify-phases %standard-phases (delete 'configure))

     signifie que toutes les procédures décrites plus haut seront utilisées, sauf la phase configure.

     En plus, ce système de construction s'assure que l'environnement « standard » pour les paquets GNU est disponible.  Cela inclus des outils comme GCC, libc, Coreutils, Bash, Make, Diffutils, grep et sed (voir le module (guix build-system gnu) pour une liste complète).  Nous les appelons les entrées implicites d'un paquet parce que la définition du paquet ne les mentionne pas.

D'autres objets <build-system> sont définis pour supporter d'autres conventions et outils utilisés par les paquets de logiciels libres.  Ils héritent de la plupart de GNU-BUILD-SYSTEM et diffèrent surtout dans l'ensemble des entrées implicites ajoutées au processus de construction et dans la liste des phases exécutées.  Certains de ces systèmes de construction sont listés ci-dessous.

 -- Variable Scheme: ant-build-system
     Cette variable est exportée par (guix build-system ant).  Elle implémente la procédure de construction pour les paquets Java qui peuvent être construits avec l'outil de construction Ant (http://ant.apache.org/).

     Elle ajoute à la fois ant et the kit de développement Java (JDK) fournit par le paquet icedtea à l'ensemble des entrées.  Des paquets différents peuvent être spécifiés avec les paramètres #:ant et #:jdk respectivement.

     Lorsque le paquet d'origine ne fournit pas de fichier de construction Ant acceptable, le paramètre #:jar-name peut être utilisé pour générer un fichier de construction Ant build.xml minimal, avec des tâches pour construire l'archive jar spécifiée.  Dans ce cas, le paramètre #:source-dir peut être utilisé pour spécifier le sous-répertoire des sources, par défaut « src ».

     Le paramètre #:main-class peut être utilisé avec le fichier de construction minimal pour spécifier la classe principale du jar.  Cela rend le fichier jar exécutable.  Le paramètre #:test-include peut être utilisé pour spécifier la liste des tests junit à lancer.  Il vaut par défaut (list "**/*Test.java").  Le paramètre #:test-exclude peut être utilisé pour désactiver certains tests.  Sa valeur par défaut est (list "**/Abstract*.java"), parce que les classes abstraites ne peuvent pas être utilisées comme des tests.

     Le paramètre #:build-target peut être utilisé pour spécifier la tâche Ant qui devrait être lancée pendant la phase build.  Par défaut la tâche « jar » sera lancée.

 -- Variable Scheme: android-ndk-build-system
     Cette variable est exportée par (guix build-system android-ndk). Elle implémente une procédure de construction pour les paquets du NDK Android (native development kit) avec des processus de construction spécifiques à Guix.

     Le système de construction suppose que les paquets installent leur interface publique (les en-têtes) dans un sous-répertoire de « include » de la sortie « out » et leurs bibliothèques dans le sous-répertoire « lib » de la sortie « out ».

     Il est aussi supposé que l'union de toutes les dépendances d'un paquet n'a pas de fichiers en conflit.

     Pour l'instant, la compilation croisée n'est pas supportées — donc pour l'instant les bibliothèques et les fichiers d'en-têtes sont supposés être des outils de l'hôte.

 -- Variable Scheme: asdf-build-system/source
 -- Variable Scheme: asdf-build-system/sbcl
 -- Variable Scheme: asdf-build-system/ecl

     Ces variables, exportées par (guix build-system asdf), implémentent les procédures de constructions pour les paquets en Common Lisp qui utilisent ``ASDF'' (https://common-lisp.net/project/asdf/).  ASDF est un dispositif de définition de systèmes pour les programmes et les bibliothèques en Common Lisp.

     Le système asdf-build-system/source installe les paquets au format source qui peuvent être chargés avec n'importe quelle implémentation de common lisp, via ASDF.  Les autres, comme asdf-build-system/sbcl, installent des binaires au format qu'un implémentation particulière comprend.  Ces systèmes de constructions peuvent aussi être utilisés pour produire des programmes exécutables ou des images lisp qui contiennent un ensemble de paquets pré-chargés.

     Le système de construction utilise des conventions de nommage.  Pour les paquets binaires, le nom du paquet devrait être préfixé par l'implémentation lisp, comme sbcl- pour asdf-build-system/sbcl.

     En plus, le paquet source correspondant devrait étiquetté avec la même convention que les paquets python (voir Modules python), avec le préfixe cl-.

     Pour les paquets binaires, chaque système devrait être défini comme un paquet Guix.  Si un paquet origine contient plusieurs systèmes, on peut créer des variantes du paquet pour construire tous les systèmes.  Les paquets sources, qui utilisent asdf-build-system/source, peuvent contenir plusieurs systèmes.

     Pour créer des programmes exécutables et des images, les procédures côté construction build-program et build-image peuvent être utilisées.  Elles devraient être appelées dans une phase de construction après la phase create-symlinks pour que le système qui vient d'être construit puisse être utilisé dans l'image créée.  build-program requiert une liste d'expressions Common Lisp dans l'argument #:entry-program.

     Si le système n'est pas défini dans son propre fichier .asd du même nom, alors le paramètre #:asd-file devrait être utilisé pour spécifier dans quel fichier le système est défini.  De plus, si le paquet défini un système pour ses tests dans un fichier séparé, il sera chargé avant que les tests ne soient lancés s'il est spécifié par le paramètre #:test-asd-file.  S'il n'est pas spécifié, les fichiers <system>-tests.asd, <system>-test.asd, tests.asd et test.asd seront testés.

     Si pour quelque raison que ce soit le paquet doit être nommé d'une manière différente de ce que la convention de nommage suggère, le paramètre #:asd-system-name peut être utilisé pour spécifier le nom du système.

 -- Variable Scheme: cargo-build-system
     Cette variable est exportée par (guix build-system cargo).  Elle supporte les construction de paquets avec Cargo, le système de construction du langage de programmation Rust (https://www.rust-lang.org).

     Dans sa phase configure, ce système de construction remplace les dépendances spécifiées dans le fichier Cargo.toml par des paquets Guix.  La phase install installe les binaires et installe aussi le code source et le fichier Cargo.toml.

 -- Variable Scheme: cmake-build-system
     Cette variable est exportée par (guix build-system cmake).  Elle implémente la procédure de construction des paquets qui utilisent l'outils de construction CMake (http://www.cmake.org).

     Elle ajoute automatiquement le paquet cmake à l'ensemble des entrées.  Le paquet utilisé peut être spécifié par le paramètre #:cmake.

     Le paramètre #:configure-flags est pris comme une liste de drapeaux à passer à la commande cmake.  Le paramètre #:build-type spécifie en termes abstrait les drapeaux passés au compilateur ; sa valeur par défaut est "RelWithDebInfo" (ce qui veut dire « mode public avec les informations de débogage » en plus court), ce qui signifie en gros que le code sera compilé avec -O2 -g comme pour les paquets autoconf par défaut.

 -- Variable Scheme: go-build-system
     Cette variable est exportée par (guix build-system go).  Elle implémente la procédure pour les paquets Go utilisant les mécanismes de construction Go (https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies) standard.

     L'utilisateur doit fournir une valeur à la clef #:import-path et, dans certains cas, #:unpack-path.  Le chemin d'import (https://golang.org/doc/code.html#ImportPaths) correspond au chemin dans le système de fichiers attendu par le script de construction du paquet et les paquets qui s'y réfèrent et fournit une manière unique de se référer à un paquet Go.  Il est typiquement basé sur une combinaison de l'URI du code source du paquet et d'une structure hiérarchique du système de fichier.  Dans certains cas, vous devrez extraire le code source du paquet dans une structure de répertoires différente que celle indiquée par le chemin d'import et #:unpack-path devrait être utilisé dans ces cas-là.

     Les paquets qui fournissent des bibliothèques Go devraient être installées avec leur code source.  La clef #:install-soruce?, qui vaut #t par défaut, contrôle l'installation du code source.  Elle peut être mise à #f pour les paquets qui ne fournissent que des fichiers exécutables.

 -- Variable Scheme: glib-or-gtk-build-system
     Cette variable est exportée par (guix build-system glib-or-gtk). Elle est conçue pour être utilisée par des paquets qui utilisent GLib ou GTK+.

     Ce système de construction ajoute les deux phases suivantes à celles définies par GNU-BUILD-SYSTEM :

     glib-or-gtk-wrap
          La phase glib-or-gtk-wrap s'assure que les programmes dans bin/ sont capable de trouver les « schemas » GLib et les modules GTK+ (https://developer.gnome.org/gtk3/stable/gtk-running.html).  Ceci est fait en enveloppant les programmes dans des scripts de lancement qui initialisent correctement les variables d'environnement XDG_DATA_DIRS et GTK_PATH.

          Il est possible d'exclure des sorties spécifiques de ce processus d'enveloppage en listant leur nom dans le paramètre #:glib-or-gtk-wrap-excluded-outputs.  C'est utile lorsqu'une sortie est connue pour ne pas contenir de binaires GLib ou GTK+, et où l'enveloppe ajouterait une dépendance inutile vers GLib et GTK+.

     glib-or-gtk-compile-schemas
          La phase  glib-or-gtk-compile-schemas s'assure que tous les schémas GSettings (https://developer.gnome.org/gio/stable/glib-compile-schemas.html) de GLib sont compilés.  La compilation est effectuée par le programme glib-compile-schemas.  Il est fournit par le paquet glib:bin qui est automatiquement importé par le système de construction.  Le paquet glib qui fournit glib-compile-schemas peut être spécifié avec le paramètre #:glib.

     Ces deux phases sont exécutées après la phase install.

 -- Scheme Variable: guile-build-system
     This build system is for Guile packages that consist exclusively of Scheme code and that are so lean that they don't even have a makefile, let alone a configure script.  It compiles Scheme code using guild compile (see Compilation (GNU Guile Reference Manual)) and installs the .scm and .go files in the right place.  It also installs documentation.

     This build system supports cross-compilation by using the --target option of guild compile.

     Packages built with guile-build-system must provide a Guile package in their native-inputs field.

 -- Variable Scheme: minify-build-system
     Cette variable est exportée par (guix build-system minify).  Elle implémente une procédure de minification pour des paquets JavaScript simples.

     Elle ajoute uglify-js à l'ensemble des entrées et l'utilise pour compresser tous les fichiers JavaScript du répertoire src.  Un minifieur différent peut être spécifié avec le paramètre #:uglify-js mais il est attendu que ce paquet écrive le code minifié sur la sortie standard.

     Lorsque les fichiers JavaScript d'entrée ne sont pas situés dans le répertoire src, le paramètre #:javascript-files peut être utilisé pour spécifier une liste de noms de fichiers à donner au minifieur.

 -- Variable Scheme: ocaml-build-system
     Cette variable est exportée par (guix build-system ocaml).  Elle implémente une procédure de construction pour les paquets OCaml (https://ocaml.org) qui consiste à choisir le bon ensemble de commande à lancer pour chaque paquet.  Les paquets OCaml peuvent demander des commandes diverses pour être construit.  Ce système de construction en essaye certaines.

     Lorsqu'un fichier setup.ml est présent dans le répertoire de plus haut niveau, elle lancera ocaml setup.ml -configure, ocaml setup.ml -build et ocaml setup.ml -install.  Le système de construction supposera que ces fichiers ont été générés par OASIS (http://oasis.forge.ocamlcore.org/) et prendra soin d'initialiser le préfixe et d'activer les tests s'ils ne sont pas désactivés.  Vous pouvez passer des drapeaux de configuration et de consturction avec #:configure-flags et #:build-flags.  La clef #:test-flags peut être passée pour changer l'ensemble des drapeaux utilisés pour activer les tests.  La clef #:use-make? peut être utilisée pour outrepasser ce système dans les phases de construction et d'installation.

     Lorsque le paquet a un fichier configure, il est supposé qu'il s'agit d'un script configure écrit à la main qui demande un format différent de celui de gnu-build-system.  Vous pouvez ajouter plus de drapeaux avec la clef #:configure-flags.

     Lorsque le paquet a un fichier Makefile (ou #:use-make? vaut #t), il sera utilisé et plus de drapeaux peuvent être passés à la construction et l'installation avec la clef #:make-flags.

     Enfin, certains paquets n'ont pas ces fichiers mais utilisent un emplacement plus ou moins standard pour leur système de construction.  Dans ce cas, le système de construction lancera ocaml pkg/pkg.ml ou pkg/build.ml et prendra soin de fournir le chemin du module findlib requis.  Des drapeaux supplémentaires peuvent être passés via la clef #:bulid-flags.  L'installation se fait avec opam-installer.  Dans ce cas, le paquet opam doit être ajouté au champ native-inputs de la définition du paquet.

     Remarquez que la plupart des paquets OCaml supposent qu'ils seront installés dans le même répertoire qu'OCaml, ce qui n'est pas ce que nous voulons faire dans Guix.  En particulier, ils installeront leurs fichiers .so dans leur propre répertoire de module, ce qui est normalement correct puisqu'il s'agit du répertoire du compilateur OCaml.  Dans Guix en revanche, le bibliothèques ne peuvent pas y être trouvées et on utilise CAML_LD_LIBRARY_PATH à la place.  Cette variable pointe vers lib/ocaml/site-lib/stubslibs et c'est là où les bibliothèques .so devraient être installées.

 -- Variable Scheme: python-build-system
     Cette variable est exportée par (guix build-system python).  Elle implémente la procédure de construction plus ou moins standarde utilisée pour les paquets Python, qui consiste à lancer python setup.py build puis python setup.py install --prefix=/gnu/store/....

     Pour les paquets qui installent des programmes autonomes dans bin/, elle prend soin d'envelopper ces binaires pour que leur variable d'environnement PYTHONPATH pointe vers toutes les bibliothèques Python dont ils dépendent.

     Le paquet Python utilisé pour effectuer la construction peut être spécifié avec le paramètre #:python.  C'est une manière utile de forcer un paquet à être construit avec une version particulière de l'interpréteur python, ce qui peut être nécessaire si le paquet n'est compatible qu'avec une version de l'interpréteur.

     Par défaut Guix appelle setup.py sous le contrôle de setuptools, comme le fait pip.  Certains paquets ne sont pas compatibles avec setuptools (et pip), ainsi vous pouvez désactiver cela en mettant le paramètre #:use-setuptools à #f.

 -- Variable Scheme: perl-build-system
     Cette variable est exportée par (guix build-system perl).  Elle implémente la procédure de construction standarde des paquets Perl, qui consiste soit à lancer perl Build.PL --prefix=/gnu/store/..., suivi de Build et Build install ; ou à lancer perl Makefile.PL PREFIX=/gnu/store/..., suivi de make et make install, en fonction de la présence de Build.PL ou Makefile.PL dans la distribution du paquet.  Le premier a la préférence si Build.PL et Makefile.PL existent tous deux dans la distribution du paquet.  Cette préférence peut être inversée en spécifiant #t pour le paramètre #:make-maker?.

     L'invocation initiale de perl Makefile.PL ou perl Build.PL passe les drapeaux spécifiés par le paramètre #:make-maker-flags ou #:module-build-flags, respectivement.

     Le paquet Perl utilisé peut être spécifié avec #:perl.

 -- Variable Scheme: r-build-system
     Cette variable est exportée par (guix build-system r).  Elle implémente la procédure de construction utilisée par les paquets R (http://r-project.org) qui consiste à lancer à peine plus que R CMD INSTALL --library=/gnu/store/... dans un environnement où R_LIBS_SITE contient les chemins de toutes les entrées R.  Les tests sont lancés après l'installation avec la fonction R tools::testInstalledPackage.

 -- Variable Scheme: texlive-build-system
     Cette variable est exportée par (guix build-system texlive).  Elle est utilisée pour construire des paquets TeX en mode batch avec le moteur spécifié.  Le système de construction initialise la variable TEXINPUTS pour trouver tous les fichiers source TeX dans ses entrées.

     Par défaut, elle lance luatex sur tous les fichiers qui se terminent par ins.  Un moteur et un format différent peuvent être spécifiés avec l'argument #:tex-format.  Plusieurs cibles de constructions peuvent être indiquées avec l'argument #:build-targets qui attend une liste de noms de fichiers.  Le système de construction ajoute uniquement texlive-bin et texlive-latex-base (de (gnu packages tex) à la liste des entrées.  Les deux peuvent être remplacés avec les arguments #:texlive-bin et #:texlive-latex-base, respectivement.

     Le paramètre #:tex-directory dit au système de construction où installer les fichiers construit dans l'arbre texmf.

 -- Variable Scheme: ruby-build-system
     Cette variable est exportée par (guix build-system ruby).  Elle implémenter la procédure de construction RubyGems utilisée par les paquets Ruby qui consiste à lancer gem build suivi de gem install.

     Le champ source d'un paquet qui utilise ce système de construction référence le plus souvent une archive gem, puisque c'est le format utilisé par les développeurs Ruby quand ils publient leur logiciel.  Le système de construction décompresse l'archive gem, éventuellement en corrigeant les sources, lance la suite de tests, recompresse la gemme et l'installe.  En plus, des répertoires et des archives peuvent être référencés pour permettre de construire des gemmes qui n'ont pas été publiées depuis Git ou une archive de sources traditionnelle.

     Le paquet Ruby utilisé peut être spécifié avec le paramètre #:ruby. Une liste de drapeaux supplémentaires à passer à la commande gem peut être spécifiée avec le paramètre #:gem-flags.

 -- Variable Scheme: waf-build-system
     Cette variable est exportée par (guix build-system waf).  Elle implémente une procédure de construction autour du script waf.  Les phases usuelles — configure, build et install — sont implémentée en passant leur nom en argument au script waf.

     Le script waf est exécuté par l'interpréteur Python.  Le paquet Python utilisé pour lancer le script peut être spécifié avec le paramètre #:python.

 -- Variable Scheme: scons-build-system
     Cette variable est exportée par (guix build-system scons).  Elle implémente la procédure de construction utilisée par l'outil de construction SCons.  Ce système de construction lance scons pour construire le paquet, scons test pour lancer les tests puis scons install pour installer le paquet.

     On peut passer des drapeaux supplémentaires à scons en les spécifiant avec le paramètre #:scons-flags.  La version de python utilisée pour lancer SCons peut être spécifiée en sélectionnant le paquet SCons approprié avec le paramètre #:scons.

 -- Variable Scheme: haskell-build-system
     Cette variable est exportée par (guix build-system haskell).  Elle implémente la procédure de construction Cabal utilisée par les paquets Haskell, qui consiste à lancer runhaskell Setup.hs configure --prefix=/gnu/store/... et runhaskell Setup.hs build.  Plutôt que d'installer le paquets en lançant runhaskell Setup.hs install, pour éviter d'essayer d'enregistrer les bibliothèques dans le répertoire du dépôt en lecture-seule du compilateur, le système de construction utilise runhaskell Setup.hs copy, suivi de runhaskell Setup.hs register.  En plus, le système de construction génère la documentation du paquet en lançant runhaskell Setup.hs haddock, à moins que #:haddock? #f ne soit passé.  Des paramètres facultatifs pour Haddock peuvent être passés à l'aide du paramètre #:haddock-flags.  Si le fichier Setup.hs n'est pas trouvé, le système de construction cherchera Setup.lhs à la place.

     Le compilateur Haskell utilisé peut être spécifié avec le paramètre #:haskell qui a pour valeur par défaut ghc.

 -- Variable Scheme: dub-build-system
     Cette variable est exportée par (guix build-system dub).  Elle implémente la procédure de construction Dub utilisée par les paquets D qui consiste à lancer dub build et dub run.  L'installation est effectuée en copiant les fichiers manuellement.

     Le compilateur D utilisé peut être spécifié avec le paramètre #:ldc qui vaut par défaut ldc.

 -- Variable Scheme: emacs-build-system
     Cette variable est exportée par (guix build-system emacs).  Elle implémente une procédure d'installation similaire au système de gestion de paquet d'Emacs lui-même (see Packages (The GNU Emacs Manual)).

     Elle crée d'abord le fichier PACKAGE-autoloads.el, puis compile tous les fichiers Emacs Lisp en bytecode.  Contrairement au système de gestion de paquets d'Emacs, les fichiers de documentation info sont déplacés dans le répertoire standard et le fichier dir est supprimé.  Chaque paquet est installé dans son propre répertoire dans share/emacs/site-lisp/guix.d.

 -- Variable Scheme: font-build-system
     Cette variable est exportée par (guix build-system font).  Elle implémente une procédure d'installation pour les paquets de polices où des fichiers de polices TrueType, OpenType, etc sont fournis en amont et n'ont qu'à être copiés à leur emplacement final.  Elle copie les fichiers de polices à l'emplacement standard dans le répertoire de sortie.

 -- Variable Scheme: meson-build-system
     Cette variable est exportée par (guix build-system meson).  Elle implémente la procédure de construction des paquets qui utilisent Meson (http://mesonbuild.com) comme système de construction.

     Elle ajoute à la fois Meson et Ninja (https://ninja-build.org/) à l'ensemble des entrées, et ils peuvent être modifiés avec les paramètres #:meson et #:ninja si requis.  Le Meson par défaut est meson-for-build, qui est spécial parce qu'il ne nettoie pas le RUNPATH des binaires et les bibliothèques qu'il installe.

     Ce système de construction est une extension de GNU-BUILD-SYSTEM, mais avec les phases suivantes modifiées pour Meson :

     configure
          La phase lance meson avec les drapeaux spécifiés dans #:configure-flags.  Le drapeau --build-type est toujours initialisé à plain à moins que quelque chose d'autre ne soit spécifié dans #:build-type.

     build
          La phase lance ninja pour construire le paquet en parallèle par défaut, mais cela peut être changé avec #:parallel-build?.

     check
          La phase lance ninja avec la cible spécifiée dans #:test-target, qui est "test" par défaut.

     install
          La phase lance ninja install et ne peut pas être changée.

     En dehors de cela, le système de construction ajoute aussi la phase suivante :

     fix-runpath
          Cette phase s'assure que tous les binaire peuvent trouver les bibliothèques dont ils ont besoin.  Elle cherche les bibliothèques requises dans les sous-répertoires du paquet en construction et les ajoute au RUNPATH là où c'est nécessaire.  Elle supprime aussi les références aux bibliothèques laissées là par la phase de construction par meson-for-build comme les dépendances des tests, qui ne sont pas vraiment requises pour le programme.

     glib-or-gtk-wrap
          Cette phase est la phase fournie par glib-or-gtk-build-system et n'est pas activée par défaut.  Elle peut l'être avec #:glib-or-gtk?.

     glib-or-gtk-compile-schemas
          Cette phase est la phase fournie par glib-or-gtk-build-system et n'est pas activée par défaut.  Elle peut l'être avec #:glib-or-gtk?.

Enfin, pour les paquets qui n'ont pas besoin de choses sophistiquées, un système de construction « trivial » est disponible.  Il est trivial dans le sens où il ne fournit en gros aucun support : il n'apporte pas de dépendance implicite, et n'a pas de notion de phase de construction.

 -- Variable Scheme: trivial-build-system
     Cette variable est exportée par (guix build-system trivial).

     Ce système de construction requiert un argument #:builder.  Cet argument doit être une expression Scheme qui construit la sortie du paquet — comme avec build-expression->derivation (see build-expression->derivation).

Le dépôt
========

Conceptuellement, le dépôt est l'endroit où les dérivations qui ont bien été construites sont stockées — par défaut, /gnu/store.  Les sous-répertoires dans le dépôt s'appellent des éléments du dépôt ou parfois des chemins du dépôt.  Le dépôt a une base de données associée qui contient des informations comme les chemins du dépôt auxquels se réfèrent chaque chemin du dépôt et la liste des éléments du dépôt valides — les résultats d'une construction réussie.  Cette base de données se trouve dans LOCALSTATEDIR/guix/db où LOCALSTATEDIR est le répertoire d'états spécifié via --localstatedir à la configuration, typiquement /var.

C'est toujours le démon qui accède au dépôt pour le compte de ses clients (see Invoquer guix-daemon).  Pour manipuler le dépôt, les clients se connectent au démon par un socket Unix-domain, envoient une requête dessus et lisent le résultat — ce sont des appels de procédures distantes, ou RPC.

     Les utilisateurs ne doivent jamais modifier les fichiers dans /gnu/store directement.  Cela entraînerait des incohérences et casserait l'hypothèse d'immutabilité du modèle fonctionnel de Guix (see Introduction).

     See guix gc --verify, pour des informations sur la manière de vérifier l'intégrité du dépôt et d'essayer de réparer des modifications accidentelles.

Le module (guix store) fournit des procédures pour se connecter au démon et pour effectuer des RPC.  Elles sont décrites plus bas.  Par défaut, open-connection, et donc toutes les commandes guix se connectent au démon local ou à l'URI spécifiée par la variable d'environnement GUIX_DAEMON_SOCKET.

 -- Variable d'environnement: GUIX_DAEMON_SOCKET
     Lorsqu'elle est initialisée, la valeur de cette variable devrait être un nom de fichier ou une URI qui désigne l'extrémité du démon.  Lorsque c'est un nom de fichier, il dénote un socket Unix-domain où se connecter.  En plus des noms de fichiers, les schémas d'URI supportés sont :

     file
     unix
          Pour les sockets Unix-domain.  file:///var/guix/daemon-socket/socket est équivalent à /var/guix/daemon-socket/socket.

     guix
          Ces URI dénotent des connexions par TCP/IP, sans chiffrement ni authentification de l'hôte distant.  L'URI doit spécifier le nom d'hôte et éventuellement un numéro de port (par défaut 44146) :

               guix://master.guix.example.org:1234

          Ce paramétrage est adapté aux réseaux locaux, comme dans le cas de grappes de serveurs, où seuls des noms de confiance peuvent se connecter au démon de construction sur master.guix.example.org.

          L'option --listen de guix-daemon peut être utilisé pour lui dire d'écouter des connexions TCP (see --listen).

     ssh
          Ces URI vous permettent de vous connecter au démon à distance à travers SSH (Cette fonctionnalité requiert Guile-SSH (see Prérequis).).

               ssh://charlie@guix.example.org:22

          Comme pour guix copy, les fichiers de configuration du client OpenSSH sont respectés (see Invoquer guix copy).

     Des schémas d'URI supplémentaires pourraient être supportés dans le futur.

          La capacité de se connecter à un démon de construction distant est considéré comme expérimental à la version VERSION.  Contactez-nous pour partager vos problèmes ou des suggestions que vous pourriez avoir (see Contribuer).

 -- Procédure Scheme: open-connection [URI] [#:reserve-space? #t]
     Se connecte au démon à travers le socket Unix-domain à URI (une chaîne de caractères).  Lorsque RESERVE-SPACE? est vrai, cela demande de réserver un peu de place supplémentaire sur le système de fichiers pour que le ramasse-miette puisse opérer au cas où le disque serait plein.  Renvoie un objet serveur.

     FILE a pour valeur par défaut %DEFAULT-SOCKET-PATH, qui est l'emplacement normal en fonction des options données à configure.

 -- Procédure Scheme: close-connection SERVEUR
     Ferme la connexion au SERVEUR.

 -- Variable Scheme: current-build-output-port
     Cette variable est liée à un paramètre SRFI-39, qui se réfère au port où les journaux de construction et d'erreur envoyés par le démon devraient être écrits.

Les procédures qui font des RPC prennent toutes un objet serveur comme premier argument.

 -- Scheme Procedure: valid-path? SERVER PATH
     Renvoie #t lorsque PATH désigne un élément du dépôt valide et #f sinon (un élément invalide peut exister sur le disque mais rester invalide, par exemple parce que c'est le résultat d'une construction annulée ou échouée).

     Une condition &nix-protocol-error est levée si PATH n'est pas préfixée par le répertoire du dépôt (/gnu/store).

 -- Procédure Scheme: add-text-to-store SERVER NAME TEXT [REFERENCES]
     Ajoute TEXT dans le fichier NAME dans le dépôt et renvoie son chemin.  REFERENCES est la liste des chemins du dépôt référencés par le chemin du dépôt qui en résulte.

 -- Procédure Scheme: build-derivations SERVER DERIVATIONS
     Construit DERIVATON (ne liste d'objets <derivation> ou de chemins de dérivations) et retourne quand le travailleur a fini de les construire.  Renvoie #t en cas de réussite.

Remarque que le module (guix monads) fournit une monad ainsi que des version monadiques des procédures précédentes, avec le but de rendre plus facile de travailler avec le code qui accède au dépôt (see La monad du dépôt).

Cette section est actuellement incomplète.

Dérivations
===========

Les actions de construction à bas-niveau et l'environnement dans lequel elles sont effectuées sont représentés par des dérivations.  Une dérivation contient cet ensemble d'informations :

  * Les sorties de la dérivation — les dérivations produisent au moins un fichier ou répertoire dans le dépôt, mais peuvent en produire plus.

  * Les entrées de la dérivation, qui peuvent être d'autres dérivations ou des fichiers dans le dépôt (correctifs, scripts de construction, etc).

  * Le type de système ciblé par la dérivation — p.ex. x86_64-linux.

  * Le nom de fichier d'un script de construction dans le dépôt avec les arguments à lui passer.

  * Une liste de variables d'environnement à définir.

Les dérivations permettent aux client du démon de communiquer des actions de construction dans le dépôt.  Elles existent sous deux formes : en tant que représentation en mémoire, à la fois côté client et démon, et en tant que fichiers dans le dépôt dont le nom fini par .drv — on dit que ce sont des chemins de dérivations.  Les chemins de dérivations peuvent être passés à la procédure build-derivations pour effectuer les actions de construction qu'ils prescrivent (see Le dépôt).

Des opérations comme le téléchargement de fichiers et la récupération de sources gérés par un logiciel de contrôle de version pour lesquels le hash du contenu est connu à l'avance sont modélisés par des dérivations à sortie fixe.  Contrairement aux dérivation habituelles, les sorties d'une dérivation à sortie fixe sont indépendantes de ses entrées — p.ex. un code source téléchargé produit le même résultat quelque soit la méthode de téléchargement utilisée.

Le module (guix derivations) fournit une représentation des dérivations comme des objets Scheme, avec des procédures pour créer et manipuler des dérivations.  La primitive de plus bas-niveau pour créer une dérivation est la procédure derivation :

 -- Procédure Scheme: derivation STORE NAME BUILDER
     ARGS [#:outputs '("out")] [#:hash #f] [#:hash-algo #f]
     [#:recursive? #f] [#:inputs '()] [#:env-vars '()]  [#:system
     (%current-system)] [#:references-graphs #f] [#:allowed-references #f] [#:disallowed-references #f] [#:leaked-env-vars #f] [#:local-build? #f] [#:substitutable? #t]

     Construit une dérivation avec les arguments donnés et renvie l'objet <derivation> obtenu.

     Lorsque HASH et HASH-ALGO sont donnés, une dérivation à sortie fixe est créée — c.-à-d. une dérivation dont le résultat est connu à l'avance, comme dans le cas du téléchargement d'un fichier.  Si, en plus, RECURSIVE? est vrai, alors la sortie fixe peut être un fichier exécutable ou un répertoire et HASH doit être le hash d'une archive contenant la sortie.

     Lorsque REFERENCES-GRAPHS est vrai, il doit s'agir d'une liste de paires de noms de fichiers et de chemins du dépôt.  Dans ce cas, le graphe des références de chaque chemin du dépôt est exporté dans l'environnement de construction dans le fichier correspondant, dans un simple format texte.

     Lorsque ALLOWED-REFERENCES est vrai, il doit s'agir d'une liste d'éléments du dépôt ou de sorties auxquelles la sortie de la dérivations peut faire référence.  De même, DISALLOWED-REFERENCES, si vrai, doit être une liste de choses que la sortie ne doit pas référencer.

     Lorsque LEAKED-ENV-VARS est vrai, il doit s'agir d'une liste de chaînes de caractères qui désignent les variables d'environnements qui peuvent « fuiter » de l'environnement du démon dans l'environnement de construction.  Ce n'est possible que pour les dérivations à sortie fixe — c.-à-d. lorsque HASH est vrai.  L'utilisation principale est de permettre à des variables comme http_proxy d'être passées aux dérivations qui téléchargent des fichiers.

     Lorsque LOCAL-BUILD? est vrai, déclare que la dérivation n'est pas un bon candidat pour le déchargement et devrait plutôt être construit localement (see Réglages du délestage du démon).  C'est le cas des petites dérivations où le coût du transfert de données est plus important que les bénéfices.

     Lorsque que SUBSTITUTABLE? est faux, déclare que les substituts de la sortie de la dérivation ne devraient pas être utilisés (see Substituts). Cela est utile par exemple pour construire des paquets qui utilisent des détails du jeu d'instruction du CPU hôte.

Voici un exemple avec un script shell comme constructeur, en supposant que STORE est une connexion ouverte au démon et BASH pointe vers un exécutable Bash dans le dépôt :

     (use-modules (guix utils)
                  (guix store)
                  (guix derivations))

     (let ((builder   ; ajoute le script Bash au dépôt
             (add-text-to-store store "my-builder.sh"
                                "echo hello world > $out\n" '())))
       (derivation store "foo"
                   bash `("-e" ,builder)
                   #:inputs `((,bash) (,builder))
                   #:env-vars '(("HOME" . "/homeless"))))
     => #<derivation /gnu/store/...-foo.drv => /gnu/store/...-foo>

Comme on pourrait s'en douter, cette primitive est difficile à utiliser directement.  Une meilleure approche est d'écrire les scripts de construction en Scheme, bien sur !  Le mieux à faire pour cela est d'écrire le code de construction comme une « G-expression » et de la passer à gexp->derivation.  Pour plus d'informations, see G-Expressions.

Il fut un temps où gexp->derivation n'existait pas et où construire une dérivation donc le code de construction était écrit en Scheme se faisait avec build-expression->derivation, documenté plus bas.  Cette procédure est maintenant obsolète, remplacée par gexp->derivation qui est meilleure.

 -- Procédure Scheme: build-expression->derivation STORE
     NAME EXP
     [#:system (%current-system)] [#:inputs '()]
     [#:outputs '("out")] [#:hash #f] [#:hash-algo #f]
     [#:recursive? #f] [#:env-vars '()] [#:modules '()]
     [#:references-graphs #f] [#:allowed-references #f]
     [#:disallowed-references #f]
     [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f]
     Renvoie une dérivation qui exécute l'expression Scheme EXP comme un constructeur pour la dérivation NAME.  INPUTS doit être une liste de tuples (name drv-path sub-drv) ; lorsque SUB-DRV est omis, "out" est utilisé.  MODULES est une liste de noms de modules Guile du chemin de recherche actuel qui seront copiés dans le dépôt, compilés et rendus disponibles dans le chemin de chargement pendant l'exécution de EXP — p. ex. ((guix build utils) (guix build gnu-build-system)).

     EXP est évaluée dans une environnement où %outputs est lié à une liste de paires de sortie/chemin, et où %build-inputs est lié à une liste de paires de chaînes de caractères et de chemin de sortie construite à partir de INPUTS.  Éventuellement, ENV-VARS est une liste de paires de chaînes de caractères spécifiant le nom et la valeur de variables d'environnement visibles pour le constructeur.  Le constructeur termine en passant le résultat de EXP à exit ; ainsi, lorsque EXP renvoie #f, la construction est considérée en échec.

     EXP est construite avec GUILE-FOR-BUILD (une dérivation). Lorsque GUILE-FOR-BUILD est omis où est #f, la valeur du fluide %guile-for-build est utilisée à la place.

     Voir la procédure derivation pour la signification de REFERENCES-GRAPH, ALLOWED-REFERENCES, DISALLOWED-REFERENCES, LOCAL-BUILD? et SUBSTITUTABLE?.

Voici un exemple de dérivation à sortie unique qui crée un répertoire avec un fichier :

     (let ((builder '(let ((out (assoc-ref %outputs "out")))
                       (mkdir out)    ; create /gnu/store/...-goo
                       (call-with-output-file (string-append out "/test")
                         (lambda (p)
                           (display '(hello guix) p))))))
       (build-expression->derivation store "goo" builder))

     => #<derivation /gnu/store/...-goo.drv => ...>

La monad du dépôt
=================

Les procédures qui travaillent sur le dépôt décrites dans les sections précédentes prennent toutes une connexion ouverte au démon de construction comme premier argument.  Bien que le modèle sous-jacent soit fonctionnel, elles ont soit des effets de bord, soit dépendent de l'état actuel du dépôt.

Le premier point est embêtant : on doit se balader avec la connexion au démon dans toutes ces fonctions, ce qui rend impossible le fait de composer des fonctions qui ne prennent pas ce paramètre avec des fonctions qui le prennent.  Le deuxième point est problématique : comme les opérations sur le dépôt ont des effets de bord ou dépendent d'états externes, elles doivent être enchaînés correctement.

C'est là que le module (guix monads) arrive à la rescousse.  Ce module fournit un cadre pour travailler avec des monads, en particulier une monad très utile pour notre usage, la monad du dépôt. Les monads sont des constructions qui permettent deux choses : associer un « contexte » avec une valeur (dans notre cas, le contexte est le dépôt) et construire une séquence de calculs (ici les calculs comprennent des accès au dépôt).  Les valeurs dans une monad — les valeurs qui contiennent ce contexte supplémentaire — sont appelées des valeurs monadiques ; les procédures qui renvoient ce genre de valeur sont appelées des procédures monadiques.

Considérez cette procédure « normale » :

     (define (sh-symlink store)
       ;; Renvoie une dérivation qui crée un lien symbolique vers l'exécutable « bash ».
       (let* ((drv (package-derivation store bash))
              (out (derivation->output-path drv))
              (sh  (string-append out "/bin/bash")))
         (build-expression->derivation store "sh"
                                       `(symlink ,sh %output))))

En utilisant (guix monads) et (guix gexp), on peut la réécrire en une fonction monadique :

     (define (sh-symlink)
       ;; Pareil, mais renvoie une valeur monadique.
       (mlet %store-monad ((drv (package->derivation bash)))
         (gexp->derivation "sh"
                           #~(symlink (string-append #$drv "/bin/bash")
                                      #$output))))

Il y a plusieurs choses à remarquer avec cette deuxième version : le paramètre store est maintenant implicitement « enfilé » dans les appels aux procédures monadiques package->derivation et gexp->derivation, et la valeur monadique renvoyée par package->derivation est liée avec mlet plutôt qu'avec un simple let.

Il se trouve que l'appel à package->derivation peut même être omis puisqu'il aura lieu implicitement, comme nous le verrons plus tard (see G-Expressions) :

     (define (sh-symlink)
       (gexp->derivation "sh"
                         #~(symlink (string-append #$bash "/bin/bash")
                                    #$output)))

L'appel à la procédure monadique sh-symlink n'a aucun effet.  En anglais on pourrait dire « you exit a monad like you exit a building on fire: by running » (NdT : « on sort d'une monad comme d'un immeuble en flamme, en courant ».  Le jeu de mot est perdu à la traduction : courrir et lancer utilisent le même verbe run en anglais.). Donc, pour sortir de la monad et obtenir l'effet escompté, on doit utiliser run-with-store.

     (run-with-store (open-connection) (sh-symlink))
     => /gnu/store/...-sh-symlink

Remarquez que le module (guix monad-repl) étend la console Guile avec de nouvelles « méta-commandes » pour rendre plus facile la manipulation de procédures monadiques : run-in-store et enter-store-monad.  La première est utilisée pour « lancer » une seule valeur monadique à travers le dépôt :

     scheme@(guile-user)> ,run-in-store (package->derivation hello)
     $1 = #<derivation /gnu/store/...-hello-2.9.drv => ...>

La deuxième entre dans une console récursive, où toutes les valeurs de retour sont automatiquement lancées à travers le dépôt :

     scheme@(guile-user)> ,enter-store-monad
     store-monad@(guile-user) [1]> (package->derivation hello)
     $2 = #<derivation /gnu/store/...-hello-2.9.drv => ...>
     store-monad@(guile-user) [1]> (text-file "foo" "Hello!")
     $3 = "/gnu/store/...-foo"
     store-monad@(guile-user) [1]> ,q
     scheme@(guile-user)>

Remarquez qu'on ne peut pas renvoyer de valeur non monadique dans la console store-monad.

Les formes syntaxiques principales pour utiliser des monads en général sont disponibles dans le module (guix monads) et sont décrites ci-dessous.

 -- Syntaxe Scheme: with-monad MONAD BODY ...
     Évalue n'importe quelle forme >>= ou return dans BODY comme une MONAD.

 -- Syntaxe Scheme: return VAL
     Renvoie une valeur monadique qui encapsule VAL.

 -- Syntaxe Scheme: >>= MVAL MPROC ...
     Lie une valeur monadique MVAL, en passant son « contenu » aux procédures monadiques MPROC... (Cette opération est souvent appelée « bind », mais ce nom dénote une procédure qui n'a rien à voir en Guile.  Ainsi, nous empruntons ce symbole quelque peu cryptique au langage Haskell).  Il peut y avoir une ou plusieurs mproc, comme dans cet exemple :

          (run-with-state
              (with-monad %state-monad
                (>>= (return 1)
                     (lambda (x) (return (+ 1 x)))
                     (lambda (x) (return (* 2 x)))))
            'some-state)

          => 4
          => some-state

 -- Syntaxe Scheme: mlet MONAD ((VAR MVAL) ...)
     BODY ...
 -- Syntaxe Scheme: mlet* MONAD ((VAR MVAL) ...)
     BODY ...
     Lie les variables VAR aux valeurs monadiques MVAL dans BODY, une séquence d'expressions.  Comme avec l'opérateur de liaison, on peut réfléchir comme si on « ouvrait » la valeur non-monadique « contenue » dans MVAL et comme si on faisait en sorte que VAR se réfère à cette valeur pure, non-monadique, dans la portée de BODY.  La forme (VAR -> VAL) lie VAR à la valeur « normale » VAL, comme let.  L'opération de liaison a lieu en séquence de la gauche vers la droite.  La dernière expression de BODY doit être une expression monadique et son résultat deviendra le résultat de mlet ou mlet* lorsque lancé dans la MONAD.

     mlet* est à mlet ce que let* est à let (see Local Bindings (GNU Guile Reference Manual)).

 -- Système Scheme: mbegin MONAD MEXP ...
     Lie MEXP et les expressions monadiques suivantes en séquence, et renvoie le résultat de la dernière expression.  Chaque expression dans la séquence doit être une expression monadique.

     Cette procédure est similaire à mlet, sauf que les valeurs de retour des expressions monadiques sont ignorées.  Dans ce sens, elle est analogue à begin, mais appliqué à des expressions monadiques.

 -- Système Scheme: mwhen CONDITION MEXP0 MEXP* ...
     Lorsque la CONDITION est vraie, évalue la séquence des expressions monadiques MEXP0..MEXP* comme dans un mbegin.  Lorsque la CONDITION est fausse, renvoie *unspecified* dans la monad actuelle.  Cahque expression dans la séquence doit être une expression monadique.

 -- Système Scheme: munless CONDITION MEXP0 MEXP* ...
     Lorsque la CONDITION est fausse, évalue la séquence des expressions monadiques MEXP0..MEXP* comme dans un mbegin.  Lorsque la CONDITION est vraie, renvoie *unspecified* dans la monad actuelle.  Cahque expression dans la séquence doit être une expression monadique.

Le module (guix monads) fournit la monad d'état qui permet à une valeur supplémentaire — l'état — d'être enfilée à travers les appels de procédures.

 -- Variable Scheme: %state-monad
     La monad d'état.  les procédure dans la monad d'état peuvent accéder et modifier l'état qui est enfilé.

     Considérez l'exemple ci-dessous.  La procédure square renvoie une valeur dans la monad d'état.  Elle renvoie le carré de son argument, mais incrémente aussi la valeur actuelle de l'état :

          (define (square x)
            (mlet %state-monad ((count (current-state)))
              (mbegin %state-monad
                (set-current-state (+ 1 count))
                (return (* x x)))))

          (run-with-state (sequence %state-monad (map square (iota 3))) 0)
          => (0 1 4)
          => 3

     Lorsqu'on la lance à travers %STATE-MONAD, on obtient cet valeur d'état supplémentaire, qui est le nombre d'appels à square.

 -- Procédure Monadic: current-state
     Renvoie l'état actuel dans une valeur monadique.

 -- Procédure Monadic: set-current-state VALUE
     Initialise l'état actuel à VALUE et renvoie l'état précédent dans une valeur monadique.

 -- Procédure Monadic: state-push VALUE
     Pousse VALUE sur l'état actuel, qui est supposé être une liste, et renvoie l'état précédent dans une valeur monadique.

 -- Procédure Monadic: state-pop
     Récupère (pop) une valeur dans l'état actuel et la renvoie comme une valeur monadique.  L'état est supposé être une liste.

 -- Procédure Scheme: run-with-state MVAL [STATE]
     Lance la valeur monadique MVAL avec STATE comme valeur initiale.  Renvoie deux valeurs : la valeur du résultat et l'état du résultat.

L'interface principale avec la monad du dépôt, fournit par le module (guix store), est la suivante.

 -- Variable Scheme: %store-monad
     La monad du dépôt — un alias pour %STATE-MONAD.

     Les valeurs dans la monad du dépôt encapsulent des accès au dépôt.  Lorsque son effet est requis, une valeur de la monad du dépôt doit être « évaluée » en la passant à la procédure run-with-store (voir plus bas).

 -- Procédure Scheme: run-with-store STORE MVAL [#:guile-for-build] [#:system (%current-system)]
     Lance MVAL, une valeur monadique dans la monad du dépôt, dans STORE, une connexion ouvert au dépôt.

 -- Procédure Monadique: text-file NAME TEXT [REFERENCES]
     Renvoie une valeur monadique correspondant au nom de fichier dans le dépôt du fichier contenant TEXT, une chaîne de caractères.  REFERENCES est une liste d'éléments du dépôt auxquels le fichier texte en résultat se réfère ; c'est la liste vide par défaut.

 -- Monadic Procedure: binary-file NAME DATA [REFERENCES]
     Return as a monadic value the absolute file name in the store of the file containing DATA, a bytevector.  REFERENCES is a list of store items that the resulting binary file refers to; it defaults to the empty list.

 -- Procédure Monadique: interned-file FILE [NAME]
     [#:recursive? #t] [#:select? (const #t)]
     Renvoie le nom de FILE une fois ajouté au dépôt.  Utilise NAME comme nom dans le dépôt ou le nom de fichier de FILE si NAME est omis.

     Lorsque RECURSIVE? est vraie, le contenu de FILE est ajouté récursivement ; si FILE désigne un fichier simple et que RECURSIVE? est vrai, son contenu est ajouté et ses bits de permissions sont préservés.

     Lorsque RECURSIVE? est vraie, appelle (SELECT? FILE STAT) pour chaque répertoire où FILE est le nom de fichier absolu de l'entrée et STAT est le résultat de lstat ; à l'exception des entrées pour lesquelles SELECT? ne renvoie pas vrai.

     L'exemple ci-dessous ajoute un fichier au dépôt, sous deux noms différents :

          (run-with-store (open-connection)
            (mlet %store-monad ((a (interned-file "README"))
                                (b (interned-file "README" "LEGU-MIN")))
              (return (list a b))))

          => ("/gnu/store/rwm...-README" "/gnu/store/44i...-LEGU-MIN")

Le module (guix packages) exporte les procédures monadiques liées aux paquets suivantes :

 -- Procédure Monadique: package-file PACKAGE [FILE]
     [#:system (%current-system)] [#:target #f]
     [#:output "out"]
     Renvoie une valeur monadique qui contient le nom de fichier absolu de FILE dans le répertoire OUTPUT de PACKAGE.  Lorsque FILE est omis, renvoie le nom du répertoire OUTPUT de PACKAGE.  Lorsque TARGET est vrai, l'utilise comme un triplet de cible pour la compilation croisée.

 -- Procédure Monadique: package->derivation PACKAGE [SYSTEM]
 -- Procédure Monadique: package->cross-derivation PACKAGE
     TARGET [SYSTEM]
     Version monadique de package-derivation et package-cross-derivation (see Définition des paquets).

G-Expressions
=============

On a donc des « dérivations » qui représentent une séquence d'actions de construction à effectuer pour produire un élément du dépôt (see Dérivations).  Ces actions de construction sont effectuées lorsqu'on demande au démon de construire effectivement les dérivations ; elles sont lancées par le démon dans un conteneur (see Invoquer guix-daemon).

Ça ne devrait pas vous surprendre, mais nous aimons écrire ces actions de construction en Scheme.  Lorsqu'on fait ça, on fini avec deux strates de code Scheme (Le terme strate dans ce contexte a été inventé par Manuel Serrano et ses collaborateurs dans le contexte de leur travaux sur Hop.  Oleg Kiselyov, qui a écrit des essais perspicaces et du code sur le sujet (http://okmij.org/ftp/meta-programming/#meta-scheme), utilise le terme de « mise en scène » pour ce genre de génération de code.) : le « code hôte » — le code qui défini les paquets, parle au démon, etc — et le « code côté construction » — le code qui effectue effectivement les actions de construction, comme créer des répertoires, invoquer make, etc.

Pour décrire une dérivation et ses actions de construction, on a typiquement besoin d'intégrer le code de construction dans le code hôte.  Ça revient à manipuler le code de construction comme de la donnée, et l'homoiconicité de Scheme — le code a une représentation directe en tant que donnée — est très utile pour cela.  Mais on a besoin de plus que le mécanisme de quasiquote en Scheme pour construire des expressions de construction.

Le module (guix gexp) implémente les G-expressions, une forme de S-expression adaptée aux expressions de construction.  Les G-expression, ou gexps, consistent en gros en trois formes syntaxiques : gexp, ungexp et ungexp-splicing (ou plus simplement : #~, #$ et #$@), qui sont comparable à quasiquote, unquote ett unquote-splicing respectivement (see quasiquote (GNU Guile Reference Manual)).  Cependant il y a des différences majeures :

  * Les Gexps sont conçues pour être écrites dans un fichier et être lancées ou manipulées par d'autres processus.

  * Lorsqu'un objet de haut-niveau comme un paquet ou une dérivation est unquotée dans une gexp, le résultat est comme si le nom de fichier de son résultat avait été introduit.

  * Les gexps transportent des informatinos sur les paquets ou les dérivations auxquels elles se réfèrent, et ces dépendances sont automatiquement ajoutées comme des entrées du processus de construction qui les utilise.

Ce mécanisme n'est pas limité aux paquets et aux dérivations : on peut définir des compilateurs capable « d'abaisser » d'autres objets de haut-niveau ou des fichiers dans le dépôt, pour que ces objets puissent aussi être insérés dans des gexps.  Par exemple, des objets haut-niveau utiles qui pourraient être insérées dans une gexp sont les « objets simili-fichiers », qui rendent facile l'ajout de fichiers dans le dépôt et les références vers eux dans les dérivations et autres (voir local-file et plain-file ci-dessous).

Pour illustrer cette idée, voici un exemple de gexp :

     (define build-exp
       #~(begin
           (mkdir #$output)
           (chdir #$output)
           (symlink (string-append #$coreutils "/bin/ls")
                    "list-files")))

Cette gexp peut être passée à gexp->derivation ; on obtient une dérivation qui construit une répertoire contenant exactement un lien symbolique à /gnu/store/...-coreutils-8.22/bin/ls :

     (gexp->derivation "the-thing" build-exp)

Comme on pourrait s'y attendre, la chaîne "/gnu/store/...-coreutils-8.22" est substituée à la place de la référence au paquet COREUTILS dans le code de construction final, et COREUTILS est automatiquement devenu une entrée de la dérivation.  De même, #$output (équivalent à (ungexp output)) est remplacé par une chaîne de caractères contenant le nom du répertoire de la sortie de la dérivation.

Dans le contexte d'une compilation croisée, il est utile de distinguer entre des références à la construction native d'un paquet — qui peut être lancé par l'hôte — et des références à la construction croisée d'un paquet. Pour cela, #+ joue le même rôle que #$, mais référence une construction native d'un paquet :

     (gexp->derivation "vi"
        #~(begin
            (mkdir #$output)
            (system* (string-append #+coreutils "/bin/ln")
                     "-s"
                     (string-append #$emacs "/bin/emacs")
                     (string-append #$output "/bin/vi")))
        #:target "mips64el-linux-gnu")

Dans l'exemple ci-dessus, la construction native de COREUTILS est utilisée, pour que ln puisse effectivement être lancé sur l'hôte ; mais ensuite la construction croisée d'EMACS est utilisée.

Une autre fonctionnalité, ce sont les modules importés : parfois vous voudriez pouvoir utiliser certains modules Guile de « l'environnement hôte » dans la gexp, donc ces modules devraient être importés dans « l'environnement de construction ».  La forme with-imported-modules vous permet d'exprimer ça :

     (let ((build (with-imported-modules '((guix build utils))
                    #~(begin
                        (use-modules (guix build utils))
                        (mkdir-p (string-append #$output "/bin"))))))
       (gexp->derivation "empty-dir"
                         #~(begin
                             #$build
                             (display "success!\n")
                             #t)))

Dans cet exemple, le module (guix build utils) est automatiquement récupéré dans l'environnement de construction isolé de notre gexp, pour que (use-modules (guix build utils)) fonctionne comme on s'y attendrait.

Typiquement, vous voudriez que la closure complète du mondule soit importé — c.-à-d. le module lui-même et tous les modules dont il dépend — plutôt que seulement le module ; sinon, une tentative de chargement du module échouera à cause des modules dépendants manquants.  La procédure source-module-closure calcule la closure d'un module en cherchant dans ses en-têtes sources, ce qui est pratique dans ce cas :

     (use-modules (guix modules))   ;pour 'source-module-closure'

     (with-imported-modules (source-module-closure
                              '((guix build utils)
                                (gnu build vm)))
       (gexp->derivation "something-with-vms"
                         #~(begin
                             (use-modules (guix build utils)
                                          (gnu build vm))
                             ...)))

Dans la même idée, parfois vous pouvez souhaiter importer non seulement des modules en Scheme pur, mais aussi des « extensions » comme des liaisons Guile de bibliothèques C ou d'autres paquet « complets ».  Disons que vous voulez utiliser le paquet guile-json du côté de la construction, voici comme procéder :

     (use-modules (gnu packages guile))  ;pour 'guile-json'

     (with-extensions (list guile-json)
       (gexp->derivation "something-with-json"
                         #~(begin
                             (use-modules (json))
                             ...)))

La forme syntaxique pour construire des gexps est résumée ci-dessous.

 -- Syntaxe Scheme: #~EXP
 -- Syntaxe Scheme: (gexp EXP)
     Renvoie une G-expression contenant EXP.  EXP peut contenir une ou plusieurs de ces formes :

     #$OBJ
     (ungexp OBJ)
          Introduit une référence à OBJ.  OBJ peut être d'un des types supportés, par exemple un paquet ou une dérivation, auquel cas la forme ungexp est remplacée par le nom de fichier de sa sortie — p. ex. "/gnu/store/...-coreutils-8.22.

          Si BOJ est une liste, elle est traversée et les références aux objets supportés sont substitués de manière similaire.

          Si OBJ est une autre gexp, son contenu est inséré et ses dépendances sont ajoutées à celle de la gexp qui l'entoure.

          Si OBJ est un autre type d'objet, il est inséré tel quel.

     #$OBJ:OUTPUT
     (ungexp OBJ OUTPUT)
          Cette forme est similaire à la précédente, mais se réfère explicitement à la sortie OUTPUT de l'objet OBJ — c'est utile lorsque OBJ produit plusieurs sorties (see Des paquets avec plusieurs résultats).

     #+OBJ
     #+OBJ:output
     (ungexp-native OBJ)
     (ungexp-native OBJ OUTPUT)
          Comme ungexp, mais produit une référence à la construction native de OBJ lorsqu'elle est utilisée dans une compilation croisée.

     #$output[:OUTPUT]
     (ungexp output [OUTPUT])
          Insère une référence à la sortie OUTPUT de la dérivation, ou à la sortie principale lorsque OUTPUT est omis.

          Cela ne fait du sens que pour les gexps passées à gexp->derivation.

     #$@LST
     (ungexp-splicing LST)
          Comme au dessus, mais recolle (splice) le contenu de LST dans la liste qui la contient.

     #+@LST
     (ungexp-native-splicing LST)
          Comme au dessus, mais se réfère à la construction native des objets listés dans LST.

     Les G-expressions crées par gexp ou #~ sont des objets à l'exécution du type gexp? (voir plus bas).

 -- Syntaxe Scheme: with-imported-modules MODULES BODY...
     Marque les gexps définies dans BODY... comme requérant MODULES dans leur environnement d'exécution.

     Chaque élément dans MODULE peut être le nom d'un module, comme (guix build utils) ou le nom d'un module suivi d'une flêche, suivie d'un objet simili-fichier :

          `((guix build utils)
            (guix gcrypt)
            ((guix config) => ,(scheme-file "config.scm"
                                            #~(define-module ...))))

     Dans l'exemple au dessus, les deux premiers modules sont récupérés dans le chemin de recherche, et le dernier est créé à partir d'un objet simili-fichier.

     Cette forme a une portée lexicale : elle a un effet sur les gexp directement définies dans BODY..., mais pas sur celles définies dans des procédures appelées par BODY....

 -- Syntaxe Scheme: with-extensions EXTENSIONS BODY...
     Marque les gexps définies dans BODY... comme requérant EXTENSIONS dans leur environnement de construction et d'exécution. EXTENSIONS est typiquement une liste d'objets paquets comme définis dans le module (gnu packages guile).

     Concrètement, les paquets listés dans EXTENSIONS sont ajoutés au chemin de chargement lors de la compilation des modules importés dans BODY... ; ils sont aussi ajoutés au chemin de chargement de la gexp renvoyée par BODY....

 -- Procédure Scheme: gexp? OBJ
     Renvoie #t si OBJ est une G-expression.

Les G-expressions sont conçues pour être écrites sur le disque, soit en tant que code pour construire une dérivation, soit en tant que fichier normal dans le dépôt.  Les procédure monadiques suivantes vous permettent de faire cela (see La monad du dépôt, pour plus d'information sur les monads).

 -- Procédure Monadique: gexp->derivation NAME EXP
     [#:system (%current-system)] [#:target #f] [#:graft? #t]
     [#:hash #f] [#:hash-algo #f]
     [#:recursive? #f] [#:env-vars '()] [#:modules '()]
     [#:module-path %LOAD-PATH]
     [#:effective-version "2.2"]
     [#:references-graphs #f] [#:allowed-references #f]
     [#:disallowed-references #f]
     [#:leaked-env-vars #f]
     [#:script-name (string-append NAME "-builder")]
     [#:deprecation-warnings #f]
     [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f]
     Renvoie une dérivation NAME qui lance EXP (une gexp) avec GUILE-FOR-BUILD (une dérivation) sur SYSTEM ; EXP est stocké dans un fichier appelé SCRIPT-NAME.  Lorsque TARGET est vraie, elle est utilisée comme triplet de cible de compilation croisée pour les paquets référencés par EXP.

     MODULES est devenu obsolète en faveur de with-imported-modules.  Sa signification est de rendre MODULES disponibles dans le contexte d'évaluation de EXP ; MODULES est une liste de noms de modules Guile qui sont cherchés dans MODULE-PATH pour les copier dans le dépôt, les compiler et les rendre disponibles dans le chemin de chargement pendant l'exécution de EXP — p. ex. ((guix build utils) (guix build gnu-build-system)).

     EFFECTIVE-VERSION détermine la chaîne à utiliser lors d'ajout d'extensions de EXP (voir with-extensions) au chemin de recherche — p. ex. "2.2".

     GRAFT? détermine si les paquets référencés par EXP devraient être greffés si possible.

     Lorsque REFERENCES-GRAPHS est vrai, il doit s'agir d'une liste de tuples de la forme suivante :

          (FILE-NAME PACKAGE)
          (FILE-NAME PACKAGE OUTPUT)
          (FILE-NAME DERIVATION)
          (FILE-NAME DERIVATION OUTPUT)
          (FILE-NAME STORE-ITEM)

     La partie droite des éléments de REFERENCES-GRAPHS est automatiquement transformée en une entrée du processus de construction EXP.  Dans l'environnement de construction, chaque FILE-NAME contient le graphe des références de l'élément correspondant, dans un format texte simple.

     ALLOWED-REFERENCES doit soit être #f, soit une liste de noms de sorties ou de paquets.  Dans ce dernier cas, la liste dénote les éléments du dépôt auxquels le résultat a le droit de faire référence.  Toute référence à un autre élément du dépôt conduira à une erreur à la construction.  Comme pour DISALLOWED-REFERENCES, qui peut lister des éléments qui ne doivent pas être référencés par les sorties.

     DEPRECATION-WARNINGS détermine s'il faut afficher les avertissement d'obsolescence à la compilation de modules.  Il peut valoir #f, t ou 'detailed.

     Les autres arguments sont les mêmes que pour derivation (see Dérivations).

Les procédures local-file, plain-file, computed-file, program-file et scheme-file ci-dessous renvoient des objets simili-fichiers.  C'est-à-dire, lorsqu'ils sont unquotés dans une G-expression, ces objets donnent un fichier dans le dépôt.  Considérez cette G-expression :

     #~(system* #$(file-append glibc "/sbin/nscd") "-f"
                #$(local-file "/tmp/my-nscd.conf"))

Ici, l'effet est « d'internaliser » /tmp/my-nscd.conf en le copiant dans le dépôt.  Une fois étendu, par exemple via gexp->derivation, la G-expression se réfère à cette copie dans /gnu/store ; ainsi, modifier ou supprimer le fichier dans /tmp n'a aucun effet sur ce que fait la G-expression.  plain-file peut être utilisé de la même manière ; elle est seulement différente par le fait que le contenu du fichier est passé directement par une chaîne de caractères.

 -- Procédure Scheme: local-file FILE [NAME]
     [#:recursive? #f] [#:select? (const #t)]
     Renvoie un objet représentant un fichier local FILE à ajouter au dépôt ; cet objet peut être utilisé dans une gexp.  Si FILE est un nom de fichier relatif, il est récupéré à partir de la position du fichier source dans lequel il apparaît.  FILE sera ajouté au dépôt sous le nom NAME — par défaut le nom de base de FILE.

     Lorsque RECURSIVE? est vraie, le contenu de FILE est ajouté récursivement ; si FILE désigne un fichier simple et que RECURSIVE? est vrai, son contenu est ajouté et ses bits de permissions sont préservés.

     Lorsque RECURSIVE? est vraie, appelle (SELECT? FILE STAT) pour chaque répertoire où FILE est le nom de fichier absolu de l'entrée et STAT est le résultat de lstat ; à l'exception des entrées pour lesquelles SELECT? ne renvoie pas vrai.

     C'est la version déclarative de la procédure monadique interned-file (see interned-file).

 -- Procédure Scheme: plain-file NAME CONTENT
     Return an object representing a text file called NAME with the given CONTENT (a string or a bytevector) to be added to the store.

     C'est la version déclarative de text-file.

 -- Procédure Scheme: computed-file NAME GEXP
     [#:options '(#:local-build? #t)]
     Renvoie un objet représentant un élément du dépôt NAME, un fichier ou un répertoire calculé par GEXP.  OPTIONS est une liste d'arguments supplémentaires à passer à gexp->derivation.

     C'est la version déclarative de gexp->derivation.

 -- Procédure monadique: gexp->script NAME EXP
     [#:guile (default-guile)] [#:module-path %load-path]
     Renvoie un script exécutable NAME qui lance EXP avec GUILE, avec les modules importés de EXP dans son chemin de recherche.  Cherche les modules de EXP dans MODULE-PATH.

     L'exemple ci-dessous construit un script qui invoque simplement la commande ls :

          (use-modules (guix gexp) (gnu packages base))

          (gexp->script "list-files"
                        #~(execl #$(file-append coreutils "/bin/ls")
                                 "ls"))

     Lorsqu'elle est « lancée » à travers le dépôt (see run-with-store), on obtient une dérivation qui produit une fichier exécutable /gnu/store/...-list-files qui ressemble à :

          #!/gnu/store/...-guile-2.0.11/bin/guile -ds
          !#
          (execl "/gnu/store/...-coreutils-8.22"/bin/ls" "ls")

 -- Procédure Scheme: program-file NAME EXP
     [#:guile #f] [#:module-path %load-path]
     Renvoie un objet représentant un élément du dépôt NAME qui lance GEXP.  GUILE est le paquet Guile à utiliser pour exécuter le script.  Les modules importés par GEXP sont recherchés dans MODULE-PATH.

     C'est la version déclarative de gexp->script.

 -- Procédure monadique: gexp->file NAME EXP
     [#:set-load-path? #t] [#:module-path %load-path]
     [#:splice? #f]
     [#:guile (default-guile)]
     Renvoie une dérivation qui construit un fichier NAME contenant EXP.  Lorsque SPLICE? est vrai, EXP est considéré comme une liste d'expressions qui seront splicée dans le fichier qui en résulte.

     Lorsque SET-LOAD-PATH? est vrai, émet du code dans le fichier de résultat pour initialiser %load-path et %load-compiled-path pour honorer les modules importés de EXP.  Les modules de EXP sont trouvés dans MODULE-PATH.

     Le fichier qui en résulte retient les références à toutes les dépendances de EXP ou un sous-ensemble.

 -- Procédure Scheme: scheme-file NAME EXP [#:splice? #f]
     Renvoie un objet représentant le fichier Scheme NAME qui contient EXP.

     C'est la version déclarative de gexp->file.

 -- Procédure monadique: text-file* NAME TEXT ...
     Renvoie une valeur monadique qui construit un ficher texte contenant TEXT.  TEXT peut lister, en plus de chaînes de caractères, des objet de n'importe quel type qui peut être utilisé dans une gexp : des paquets, des dérivations, des fichiers objet locaux, etc.  Le fichier du dépôt qui en résulte en retient toutes les références.

     Cette variante devrait être préférée à text-file lorsque vous souhaitez créer des fichiers qui référencent le dépôt.  Cela est le cas typiquement lorsque vous construisez un fichier de configuration qui contient des noms de fichiers du dépôt, comme ceci :

          (define (profile.sh)
            ;; Renvoie le nom d'un script shell dans le dépôt qui initialise
            ;; la variable d'environnement « PATH ».
            (text-file* "profile.sh"
                        "export PATH=" coreutils "/bin:"
                        grep "/bin:" sed "/bin\n"))

     Dans cet exemple, le fichier /gnu/store/...-profile.sh qui en résulte référence  COREUTILS, GREP et SED, ce qui les empêche d'être glanés tant que le script est accessible.

 -- Procédure Scheme: mixed-text-file NAME TEXT ...
     Renvoie un objet représentant le fichier du dépôt NAME contenant TEXT.  TEXT est une séquence de chaînes de caractères et de fichiers simili-objets, comme dans :

          (mixed-text-file "profile"
                           "export PATH=" coreutils "/bin:" grep "/bin")

     C'est la version déclarative de text-file*.

 -- Procédure Scheme: file-union NAME FILES
     Renvoie un <computed-file> qui construit un répertoire qui contient tous les fichiers de FILES.  Chaque élément de FILES doit être une paire où le premier élément est le nom de fichier à utiliser dans le nouveau répertoire et le second élément est une gexp dénotant le fichier cible.  Voici un exemple :

          (file-union "etc"
                      `(("hosts" ,(plain-file "hosts"
                                              "127.0.0.1 localhost"))
                        ("bashrc" ,(plain-file "bashrc"
                                               "alias ls='ls --color=auto'"))))

     Cela crée un répertoire etc contenant ces deux fichiers.

 -- Procédure Scheme: directory-union NAME THINGS
     Renvoie un répertoire qui est l'union de THINGS, où THINGS est une liste d'objets simili-fichiers qui dénotent des répertoires. Par exemple :

          (directory-union "guile+emacs" (list guile emacs))

     crée un répertoire qui est l'union des paquets guile et emacs.

 -- Procédure Scheme: file-append OBJ SUFFIX ...
     Renvoie un objet simili-fichier qui correspond à la concaténation de OBJ et SUFFIX où OBJ est un objet abaissable et chaque SUFFIX est une chaîne de caractères.

     Par exemple, considérez cette gexp :

          (gexp->script "run-uname"
                        #~(system* #$(file-append coreutils
                                                  "/bin/uname")))

     On peut obtenir le même effet avec :

          (gexp->script "run-uname"
                        #~(system* (string-append #$coreutils
                                                  "/bin/uname")))

     Il y a une différence cependant : dans le cas file-append, le script qui en résulte contient le nom de fichier absolu comme une chaîne de caractère alors que dans le deuxième cas, le script contient une expression (string-append ...) pour construire le nom de fichier à l'exécution.

Bien sûr, en plus de gexps inclues dans le code « hôte », certains modules contiennent des outils de construction.  Pour savoir facilement qu'ils sont à utiliser dans la strate de construction, ces modules sont gardés dans l'espace de nom (guix build ...).

En interne, les objets de haut-niveau sont abaissés, avec leur compilateur, soit en des dérivations, soit en des objets du dépôt.  Par exemple, abaisser un paquet crée une dérivation, et abaisser un plain-file crée un élément du dépôt.  Cela est effectué par la procédure monadique lower-object.

 -- Procédure Monadique: lower-object OBJ [SYSTEM]
     [#:target #f]
     Renvoie la dérivation ou l'élément du dépôt comme une valeur de %STORE-MONAD qui correspond à OBJ pour SYSTEM, en compilant de manière croisée pour TARGET si TARGET est vrai. OBJ doit être un objet qui a un compilateur de gexp associé, comme un <package>.

Invoking guix repl
==================

The guix repl command spawns a Guile read-eval-print loop (REPL) for interactive programming (see Using Guile Interactively (GNU Guile Reference Manual)).  Compared to just launching the guile command, guix repl guarantees that all the Guix modules and all its dependencies are available in the search path.  You can use it this way:

     $ guix repl
     scheme@(guile-user)> ,use (gnu packages base)
     scheme@(guile-user)> coreutils
     $1 = #<package coreutils@8.29 gnu/packages/base.scm:327 3e28300>

In addition, guix repl implements a simple machine-readable REPL protocol for use by (guix inferior), a facility to interact with inferiors, separate processes running a potentially different revision of Guix.

The available options are as follows:

--type=TYPE
-t TYPE
     Start a REPL of the given TYPE, which can be one of the following:

     guile
          This is default, and it spawns a standard full-featured Guile REPL.

     machine
          Spawn a REPL that uses the machine-readable protocol.  This is the protocol that the (guix inferior) module speaks.

--listen=EXTRÉMITÉ
     By default, guix repl reads from standard input and writes to standard output.  When this option is passed, it will instead listen for connections on ENDPOINT.  Here are examples of valid options:

     --listen=tcp:37146
          Accept connections on localhost on port 37146.

     --listen=unix:/tmp/socket
          Accept connections on the Unix-domain socket /tmp/socket.

Utilitaires
***********

cette section décrit les utilitaires en ligne de commande de Guix.  certains sont surtout faits pour les développeurs qui écrivent de nouvelles définitions de paquets tandis que d'autres sont plus utiles pour une utilisation générale.  Ils complètent l'interface de programmation Scheme de Guix d'une manière pratique.

Invoquer guix build
===================

La commande guix build construit des paquets ou des dérivations et leurs dépendances et affiche les chemins du dépôt qui en résulte.  Remarquez qu'elle ne modifie pas le profil de l'utilisateur — c'est le travail de la commande guix package (see Invoquer guix package).  Ainsi, elle est surtout utile pour les développeurs de la distribution.

La syntaxe générale est :

     guix build OPTIONS PACKAGE-OR-DERIVATION...

Par exemple, la commande suivante construit la dernière version d'Emacs et de Guile, affiche leur journaux de construction et enfin affiche les répertoires des résultats :

     guix build emacs guile

De même, la commande suivante construit tous les paquets disponibles :

     guix build --quiet --keep-going \
       `guix package -A | cut -f1,2 --output-delimiter=@`

PACKAGE-OR-DERIVATION peut être soit le nom d'un paquet trouvé dans la distribution logicielle comme coreutils, soit coreutils@8.20, soit une dérivation comme /gnu/store/...-coreutils-8.19.drv. Dans le premier cas, la commande cherchera un paquet avec le nom correspondant (et éventuellement la version) dans les modules de la distribution GNU (see Modules de paquets).

Autrement, l'option --expression peut être utilisée pour spécifier une expression Scheme qui s'évalue en un paquet ; c'est utile pour différencier des paquets avec le même nom ou des variantes de paquets.

Il peut y avoir aucune, une ou plusieurs OPTIONS.  Les options disponibles sont décrites dans les sous-sections ci-dessous.

Options de construction communes
--------------------------------

Un certain nombre d'options qui contrôlent le processus de construction sont communes avec guix build et les autres commandes qui peuvent générer des constructions, comme guix package ou guix archive.  Voici ces options :

--load-path=RÉPERTOIRE
-L RÉPERTOIRE
     Ajoute RÉPERTOIRE au début du chemin de recherche de module de paquets (see Modules de paquets).

     Cela permet à des utilisateurs de définir leur propres paquets et les rendre disponibles aux outils en ligne de commande.

--keep-failed
-K
     Garde l'arborescence de construction des constructions en échec.  Ainsi, si une construction échoue, son arborescence de construction est préservée dans /tmp, dans un répertoire dont le nom est affiché à la fin du journal de construction.  Cela est utile pour déboguer des échecs de construction. See Débogage des échecs de construction, pour des astuces sur la manière de déboguer des problèmes de construction.

--keep-going
-k
     Continue lorsque certaines dérivations échouent ; ne s'arrête que lorsque toutes les constructions ont soit réussies, soit échouées.

     Le comportement par défaut est de s'arrêter dès qu'une des dérivations spécifiées échoue.

--dry-run
-n
     Ne pas construire les dérivations.

--fallback
     Lorsque la substitution d'un binaire pré-compilé échoue, construit les paquets localement à la place (see Échec de substitution).

--substitute-urls=URLS
     Considère URLS comme une liste d'URL de sources de substituts séparés par des espaces, et remplace la liste par défaut d'URL de guix-daemon (see guix-daemon URLs).

     Cela signifie que les substituts peuvent être téléchargés depuis URLS, tant qu'ils sont signés par une clef autorisée par l'administrateur système (see Substituts).

     Lorsque URLS est la chaîne vide, cela a pour effet de désactiver la substitution.

--no-substitutes
     Ne pas utiliser de substitut pour les résultats de la construction. C'est-à-dire, toujours construire localement plutôt que de permettre le téléchargement de binaires pré-construits (see Substituts).

--no-grafts
     Ne par « greffer » les paquets.  En pratique, cela signifie que les mises à jour des paquets disponibles comme des greffes ne sont pas appliquées. See Mises à jour de sécurité, pour plus d'information sur les greffes.

--rounds=N
     Construit chaque dérivation N fois d'affilé, et renvoie une erreur si les constructions consécutives ne sont pas identiques bit-à-bit.

     Cela est une manière utile pour détecter des processus de construction non déterministes.  Les processus de construction non déterministes sont problématiques car ils rendent pratiquement impossible la vérification par les utilisateurs de l'authenticité de binaires tiers.  See Invoquer guix challenge, pour plus d'informations.

     Remarquez que, les résultats qui diffèrent ne sont pas gardés, donc vous devrez inspecter manuellement chaque erreur — p. ex. en gardant l'un des résultats avec guix archive --export (see Invoquer guix archive), puis en reconstruisant, et enfin en comparant les deux résultats.

--no-build-hook
     N'essaye pas de décharger les constructions via le « crochet de construction » du démon (see Réglages du délestage du démon).  C'est-à-dire que tout sera construit localement plutôt que de décharger les constructions à une machine distante.

--max-silent-time=SECONDES
     Lorsque le processus de construction ou de substitution restent silencieux pendant plus de SECONDES, le terminer et rapporter une erreur de construction.

     Par défaut, les paramètres du démon sont pris en compte (see --max-silent-time).

--timeout=SECONDES
     De même, lorsque le processus de construction ou de substitution dure plus de SECONDES, le terminer et rapporter une erreur de construction.

     Par défaut, les paramètres du démon sont pris en compte (see --timeout).

--verbosity=LEVEL
     Utilise le niveau de verbosité donné.  LEVEL doit être un entier entre 0 et 5 ; les entiers les plus hauts signifient une sortie plus verbeuse.  Le mettre à 4 ou plus peut être utile pour déboguer des problèmes de configuration du démon de construction.

--cores=N
-c N
     Permet d'utiliser jusqu'à N cœurs du CPU pour la construction.  La valeur spéciale 0 signifie autant de cœurs que possible.

--max-jobs=N
-M N
     Permet au plus N travaux de construction en parallèle.  See --max-jobs, pour plus de détails sur cette option et l'option équivalente pour guix-daemon.

Sous le capot, guix build est surtout un interface à la procédure package-derivation du module (guix packages), et à la procédure build-derivations du module (guix derivations).

En plus des options passées explicitement par la ligne de commande, guix build et les autres commande guix qui peuvent effectuer des construction honorent la variable d'environnement GUIX_BUILD_OPTIONS.

 -- Variable d'environnement: GUIX_BUILD_OPTIONS
     Les utilisateurs peuvent définir cette variable à une liste d'options de la ligne de commande qui seront automatiquement utilisées par guix build et les autres commandes guix qui peuvent effectuer des constructions, comme dans l'exemple suivant :

          $ export GUIX_BUILD_OPTIONS="--no-substitutes -c 2 -L /foo/bar"

     Ces options sont analysées indépendamment, et le résultat est ajouté aux options de la ligne de commande analysées.

Options de transformation de paquets
------------------------------------

Un autre ensemble d'options de la ligne de commande supportés par guix build et aussi guix package sont les options de transformation de paquets.  Ce sont des options qui rendent possible la définition de variantes de paquets — par exemple, des paquets construit à partir de sources différentes.  C'est une manière simple de créer des paquets personnalisés à la volée sans avoir à taper les définitions de variantes de paquets (see Définition des paquets).

--with-source=SOURCE
--with-source=PAQUET=SOURCE
--with-source=PAQUET@VERSION=SOURCE
     Utiles SOURCE comme la source de PAQUET, et VERSION comme son numéro de version.  SOURCE doit être un nom de fichier ou une URL, comme pour guix download (see Invoquer guix download).

     Lorsque PAQUET est omis, la commande utilisera le nom de paquet spécifié par la base de SOURCE — p. ex. si SOURCE est /src/guix-2.0.10.tar.gz, le paquet correspondant est guile.

     De même, lorsque VERSION est omis, la chaîne de version est inférée à partir de SOURCE ; dans l'exemple précédent, il s'agit de 2.0.10.

     Cette option permet aux utilisateurs d'essayer des version des paquets différentes de celles fournies par la distribution.  L'exemple ci-dessous télécharge ed-1.7.tar.g depuis un mirroir GNU et l'utilise comme source pour le paquet ed :

          guix build ed --with-source=mirror://gnu/ed/ed-1.7.tar.gz

     En tant que développeur, --with-source permet de tester facilement des version bêta :

          guix build guile --with-source=../guile-2.0.9.219-e1bb7.tar.xz

     ... ou pour construire un dépôt de gestion de version dans un environnement vierge :

          $ git clone git://git.sv.gnu.org/guix.git
          $ guix build guix --with-source=guix@1.0=./guix

--with-input=PAQUET=REMPLAÇANT
     Remplace la dépendance sur PAQUET par une dépendance à REMPLAÇANT.  PAQUET doit être un nom de paquet et REMPLAÇANT doit être une spécification de paquet comme guile ou guile@1.8.

     Par exemple, la commande suivante construit Guix, mais remplace sa dépendance à la version stable actuelle de Guile par une dépendance à une ancienne version de Guile, guile@2.0 :

          guix build --with-input=guile=guile@2.0 guix

     C'est un remplacement récursif profond.  Donc dans cet exemple, à la fois guix et ses dépendances guile-json (qui dépend aussi de guile) sont reconstruits avec guile@2.0.

     Cette option est implémentée avec la procédure Scheme package-input-rewriting (see package-input-rewriting).

--with-graft=PAQUET=REMPLAÇANT
     Cette option est similaire à --with-input mais avec une différence importante : plutôt que de reconstruire la chaîne de dépendance complète, REMPLAÇANT est construit puis greffé sur les binaires qui référençaient initialement PAQUET.  See Mises à jour de sécurité, pour plus d'information sur les greffes.

     Par exemple, la commande ci-dessous greffe la version 3.5.4 de GnuTLS sur Wget et toutes ses dépendances, en remplaçant les références à la version actuelle de GnuTLS à laquelle ils se réfèrent actuellement :

          guix build --with-graft=gnutls=gnutls@3.5.4 wget

     Cela a l'avantage d'être bien plus rapide que de tout reconstruire.  Mais il y a un piège : cela ne fonctionne que si PAQUET et REMPLAÇANT sont strictement compatibles — par exemple, s'ils fournissent une bibliothèque, l'interface binaire applicative (ABI) de ces bibliothèques doivent être compatibles.  Si REMPLAÇANT est incompatible avec PAQUET, alors le paquet qui en résulte peut devenir inutilisable.  À utilisez avec précaution !

Options de construction supplémentaires
---------------------------------------

Les options de la ligne de commande ci-dessous sont spécifiques à guix build.

--quiet
-q
     Construire en silence, sans afficher les journaux de construction.  À la fin, le journal de construction est gardé dans /var (ou similaire) et on peut toujours l'y trouver avec l'option --log-file.

--file=FICHIER
-f FICHIER

     Construit le paquet ou la dérivation en lequel le code dans FILE s'évalue.

     Par exemple, FILE peut contenir une définition de paquet comme ceci (see Définition des paquets) :

               [file package-hello.scm not included]

--expression=EXPR
-e EXPR
     Construit le paquet ou la dérivation en lequel EXPR s'évalue.

     Par exemple, EXPR peut être (@ (gnu packages guile) guile-1.8), qui désigne sans ambiguïté cette variante spécifique de la version 1.8 de Guile.

     Autrement, EXP peut être une G-expression, auquel cas elle est utilisée comme un programme de construction passé à gexp->derivation (see G-Expressions).

     Enfin, EXPR peut se référer à une procédure monadique à au moins un argument (see La monad du dépôt).  La procédure doit renvoyer une dérivation comme une valeur monadique, qui est ensuite lancée à travers run-with-store.

--source
-S
     Construit les dérivation source des paquets, plutôt que des paquets eux-même.

     Par exemple, guix build -S gcc renvoie quelque chose comme /gnu/store/...-gcc-4.7.2.tar.bz2, qui est l'archive des sources de GCC.

     L'archive des sources renvoyée est le résultat de l'application des correctifs et des extraits de code éventuels spécifiés dans le champ origin du paquet (see Définition des paquets).

--sources
     Récupère et renvoie la source de PACKAGE-OR-DERIVATION et toute ses dépendances, récursivement.  C'est pratique pour obtenir une copie locale de tous les codes sources requis pour construire PACKAGES, ce qui vous permet de les construire plus tard même sans accès réseau.  C'est une extension de l'option --source et peut accepter l'un des arguments facultatifs suivants :

     package
          Cette valeur fait que l'option --sources se comporte comme l'option --source.

     all
          Construit les dérivations des sources de tous les paquets, dont les sources qui pourraient être listées dans inputs.  C'est la valeur par défaut.

               $ guix build --sources tzdata
               The following derivations will be built:
                  /gnu/store/...-tzdata2015b.tar.gz.drv
                  /gnu/store/...-tzcode2015b.tar.gz.drv

     transitive
          Construit les dérivations des sources de tous les paquets, ainsi que toutes celles les entrées transitives des paquets.  On peut utiliser cette option pour précharger les sources des paquets pour les construire plus tard hors ligne par exemple.

               $ guix build --sources=transitive tzdata
               The following derivations will be built:
                  /gnu/store/...-tzcode2015b.tar.gz.drv
                  /gnu/store/...-findutils-4.4.2.tar.xz.drv
                  /gnu/store/...-grep-2.21.tar.xz.drv
                  /gnu/store/...-coreutils-8.23.tar.xz.drv
                  /gnu/store/...-make-4.1.tar.xz.drv
                  /gnu/store/...-bash-4.3.tar.xz.drv
               ...

--system=SYSTÈME
-s SYSTÈME
     Tenter de construire pour le SYSTÈME — p. ex. i686-linux — plutôt que pour le type de système de l'hôte de construction.

          Le drapeau --system est utilisé pour une compilation native et ne doit pas être confondu avec une compilation croisée.  Voir --target ci-dessous pour des informations sur la compilation croisée.

     Par exemple, passer --system=i686-linux sur un système x86_64-linux ou --system=armhf-linux sur un système aarch64-linux vous permet de construire des paquets dans un environnement entièrement 32-bits.  C'est une exemple d'utilisation de cette option sur les systèmes Linux, qui peuvent émuler plusieurs personnalités.

          La possibilité de construire pour un système armhf-linux est activé sans condition sur les machines aarch64-linux, bien que certaines puces aarch64 n'en soient pas capables, comme les ThunderX.

     De même, lorsque l'émulation transparente avec QEMU et binfnmt_misc est activée (see qemu-binfmt-service-type), vous pouvez construire pour n'importe quel système pour lequel un gestionnaire QEMU binfmt_misc est installé.

     Les constructions pour un autre système que celui de la machine que vous utilisez peuvent aussi être déchargées à une machine distante de la bonne architecture.  See Réglages du délestage du démon, pour plus d'information sur le déchargement.

--target=TRIPLET
     Effectuer une compilation croisée pour TRIPLET qui doit être un triplet GNU valide, comme "mips64el-linux-gnu" (see GNU configuration triplets (Autoconf)).

--check
     Reconstruit les PACKAGE-OR-DERIVATION, qui sont déjà disponibles dans le dépôt et lève une erreur si les résultats des constructions ne sont pas identiques bit-à-bit.

     Ce mécanisme vous permet de vérifier si les substituts précédemment installés sont authentiques (see Substituts) ou si le résultat de la construction d'un paquet est déterministe. See Invoquer guix challenge pour plus d'informations et pour les outils.

     Lorsqu'utilisé avec --keep-failed, la sourtie différente est gardée dans le dépôt sous /gnu/store/...-check.  Cela rend plus facile l'étude des différences entre les deux résultats.

--repair
     Essaye de réparer les éléments du dépôt spécifiés, s'ils sont corrompus, en les téléchargeant ou en les construisant à nouveau.

     Cette opération n'est pas atomique et donc restreinte à l'utilisateur root

--derivations
-d
     Renvoie les chemins de dérivation, et non les chemins de sortie, des paquets donnés.

--root=FICHIER
-r FICHIER
     Fait de FICHIER un lien symbolique vers le résultat, et l'enregistre en tant que racine du ramasse-miettes.

     En conséquence, les résultats de cette invocation de guix build sont protégés du ramasse-miettes jusqu'à ce que FICHIER soit supprimé.  Lorsque cette option est omise, les constructions sont susceptibles d'être glanées.

--log-file
     Renvoie les noms des journaux de construction ou les URL des PACKAGE-OR-DERIVATION donnés ou lève une erreur si les journaux de construction sont absents.

     Cela fonctionne indépendamment de la manière dont les paquets ou les dérivations sont spécifiées.  Par exemple, les invocations suivantes sont équivalentes :

          guix build --log-file `guix build -d guile`
          guix build --log-file `guix build guile`
          guix build --log-file guile
          guix build --log-file -e '(@ (gnu packages guile) guile-2.0)'

     Si un journal n'est pas disponible localement, à moins que --no-substitutes ne soit passé, la commande cherche un journal correspondant sur l'un des serveurs de substituts (tels que spécifiés avec --substitute-urls.)

     Donc par exemple, imaginons que vous souhaitiez voir le journal de construction de GDB sur MIPS, mais que vous n'avez qu'une machine x86_64 :

          $ guix build --log-file gdb -s mips64el-linux
          https://hydra.gnu.org/log/...-gdb-7.10

     Vous pouvez accéder librement à un vaste bibliothèque de journaux de construction !

Débogage des échecs de construction
-----------------------------------

Lors de la définition d'un nouveau paquet (see Définition des paquets), vous passerez probablement du temps à déboguer et modifier la construction jusqu'à ce que ça marche.  Pour cela, vous devez effectuer les commandes de construction vous-même dans un environnement le plus proche possible de celui qu'utilise le démon de construction.

Pour cela, la première chose à faire est d'utiliser l'option --keep-failed ou -K de guix build, qui gardera l'arborescence de construction dans /tmp ou le répertoire spécifié par TMPDIR (see --keep-failed).

À partir de là, vous pouvez vous déplacer dans l'arborescence de construction et sourcer le fichier environment-variables, qui contient toutes les variables d'environnement qui étaient définies lorsque la construction a échoué.  Disons que vous déboguez un échec de construction dans le paquet foo ; une session typique ressemblerait à cela :

     $ guix build foo -K
     ... build fails
     $ cd /tmp/guix-build-foo.drv-0
     $ source ./environment-variables
     $ cd foo-1.2

Maintenant, vous pouvez invoquer les commandes comme si vous étiez le démon (presque) et corriger le processus de construction.

Parfois il arrive que, par exemple, les tests d'un paquet réussissent lorsque vous les lancez manuellement mais échouent quand ils sont lancés par le démon.  Cela peut arriver parce que le démon tourne dans un conteneur où, contrairement à notre environnement au-dessus, l'accès réseau est indisponible, /bin/sh n'existe pas, etc (see Réglages de l'environnement de construction).

Dans ce cas, vous pourriez avoir besoin de lancer le processus de construction dans un conteneur similaire à celui que le démon crée :

     $ guix build -K foo
     ...
     $ cd /tmp/guix-build-foo.drv-0
     $ guix environment --no-grafts -C foo --ad-hoc strace gdb
     [env]# source ./environment-variables
     [env]# cd foo-1.2

Ici, guix environment -C crée un conteneur et démarre un nouveau shell dedans (see Invoquer guix environment).  La partie --ad-hoc strace gdb ajoute les commandes strace et gdb dans le conteneur, ce qui pourrait s'avérer utile pour le débogage.  L'option --no-grafts s'assure qu'on obtient le même environnement, avec des paquets non greffés (see Mises à jour de sécurité, pour plus d'informations sur les greffes).

Pour obtenir un conteneur plus proche de ce qui serait utilisé par le démon de construction, on peut enlever /bin/sh :

     [env]# rm /bin/sh

Ne vous inquiétez pas, c'est sans danger : tout cela se passe dans un conteneur jetable créé par guix environment.

La commande strace n'est probablement pas dans le chemin de recherche, mais on peut lancer :

     [env]# $GUIX_ENVIRONMENT/bin/strace -f -o log make check

De cette manière, non seulement vous aurez reproduit les variables d'environnement utilisées par le démon, mais vous lancerez aussi le processus de construction dans un conteneur similaire à celui utilisé par le démon.

Invoquer guix edit
==================

Tant de paquets, tant de fichiers source ! La commande guix edit facilite la vie des utilisateurs et des packagers en plaçant leur éditeur sur le fichier source qui contient la définition des paquets spécifiés.  Par exemple :

     guix edit gcc@4.9 vim

lance le programme spécifié dans la variable d'environnement VISUAL ou EDITOR pour visionner la recette de GCC 4.9.3 et cele de Vim.

Si vous utilisez une copie du dépôt Git de Guix (see Construire depuis Git), ou que vous avez créé vos propres paquets dans GUIX_PACKAGE_PATH (see Définition des paquets), vous pourrez modifier les recettes des paquets.  Sinon, vous pourrez examiner les recettes en lecture-seule des paquets actuellement dans le dépôt.

Invoquer guix download
======================

En écrivant des définitions de paquets, les développeurs ont généralement besoin de télécharger une archive des sources, calculer son hash SHA256 et écrire ce hash dans la définition du paquet (see Définition des paquets). L'outil guix download aide à cette tâche : il télécharge un fichier à l'URL donné, l'ajoute au dépôt et affiche à la fois son nom dans le dépôt et son hash SHA56.

Le fait que le fichier téléchargé soit ajouté au dépôt préserve la bande passante : losque les développeurs finissent par construire le paquet nouvellement défini avec guix build, l'archive des sources n'aura pas besoin d'être téléchargée de nouveau puisqu'elle se trouvera déjà dans le dépôt.  C'est aussi une manière pratique de garder des fichiers temporairement, qui pourront ensuite être supprimés (see Invoquer guix gc).

La commande guix download supporte les mêmes URI que celles utilisées dans les définitions de paquets.  En particulier, elle supporte les URI mirror://.  Les URI http (HTTP sur TLS) sont supportées si les liaisons Guile de GnuTLS sont disponibles dans l'environnement de l'utilisateur ; si elle ne sont pas disponibles, une erreur est renvoyée.  See how to install the GnuTLS bindings for Guile (GnuTLS-Guile), pour plus d'informations.

guix download vérifie les certificats du serveur HTTPS en chargeant les autorités de certification X.509 depuis le répertoire vers lequel pointe la variable d'environnement SSL_CERT_DIR (see Certificats X.509), à moins que --no-check-certificate ne soit utilisé.

Les options suivantes sont disponibles :

--format=FMT
-f FMT
     Écrit le hash dans le format spécifié par FMT.  Pour plus d'informations sur les valeurs valides pour FMT, see Invoquer guix hash.

--no-check-certificate
     Ne pas valider les certificats HTTPS des serveurs.

     Lorsque vous utilisez cette option, vous n'avez absolument aucune garanti que vous communiquez avec le serveur authentique responsable de l'URL donnée, ce qui vous rend vulnérable à des attaques de « l'homme du milieu ».

--output=FICHIER
-o FICHIER
     Enregistre le fichier téléchargé dans FICHIER plutôt que de l'ajouter au dépôt.

Invoquer guix hash
==================

La commande guix hash calcul le hash SHA256 d'un fichier.  C'est surtout un outil pour simplifier la vie des contributeurs de la distribution : il calcul le hash cryptographique d'un fichier, qui peut être utilisé dans la définition d'un paquet (see Définition des paquets).

La syntaxe générale est :

     guix hash OPTION FICHIER

Lorsque FICHIER est - (un tiret), guix hash calcul le hash des données lues depuis l'entrée standard.  guix hash a les options suivantes :

--format=FMT
-f FMT
     Écrit le hash dans le format spécifié par FMT.

     Les formats supportés sont : nix-base32, base32, base16 (hex et hexadecimal peuvent aussi être utilisés).

     Si l'option --format n'est pas spécifiée, guix hash affichera le hash en nix-base32.  Cette représentation est utilisée dans les définitions des paquets.

--recursive
-r
     Calcule le hash sur FICHIER récursivement.

     Dans ce cas, le hash est calculé sur une archive contenant FICHIER, dont ses enfants si c'est un répertoire.  Certaines métadonnées de FICHIER fait partie de l'archive ; par exemple lorsque FICHIER est un fichier normal, le hash est différent que le FICHIER soit exécutable ou non.  Les métadonnées comme un horodatage n'ont aucun impact sur le hash (see Invoquer guix archive).

--exclude-vcs
-x
     Lorsqu'elle est combinée à --recursive, exclut les répertoires de système de contrôle de version (.bzr, .git, .hg, etc).

     Par exemple, voici comment calculer le hash d'un dépôt Git, ce qui est utile avec la méthode git-fetch (see Référence d'origine) :

          $ git clone http://example.org/foo.git
          $ cd foo
          $ guix hash -rx .

Invoquer guix import
====================

La commande guix import est utile pour les gens qui voudraient ajouter un paquet à la distribution avec aussi peu de travail que possible — une demande légitime.  La commande connaît quelques dépôts logiciels d'où elle peut « importer » des métadonnées de paquets.  Le résultat est une définition de paquet, ou un modèle de définition, dans le format reconnu par Guix (see Définition des paquets).

La syntaxe générale est :

     guix import IMPORTER OPTIONS...

IMPORTER spécifie la source depuis laquelle importer des métadonnées de paquets, et OPTIONS spécifie un identifiant de paquet et d'autres options spécifiques à IMPORTER.  Actuellement les « importateurs » disponibles sont :

gnu
     Importe des métadonnées d'un paquet GNU donné.  Cela fournit un modèle pour la dernière version de ce paquet GNU, avec le hash de son archive, le synopsis et la description canonique.

     Les informations supplémentaires comme les dépendances du paquet et sa licence doivent être renseignées manuellement.

     Par exemple, la commande suivante renvoie une définition de paquets pour GNU Hello :

          guix import gnu hello

     Les options spécifiques sont :

     --key-download=POLITIQUE
          Comme pour guix refresh, spécifie la politique de gestion des clefs OpenPGP manquantes lors de la vérification de la signature d'un paquet. See --key-download.

pypi
     Importe des métadonnées depuis l'index des paquets Python (https://pypi.python.org/) (Cette fonctionnalité requiert l'installation de Guile-JSON. See Prérequis.).  Les informations sont récupérées à partir de la description en JSON disponible sur pypi.python.org et inclus généralement toutes les informations utiles, dont les dépendances des paquets.  Pour une efficacité maximale, il est recommandé d'installer l'utilitaire unzip, pour que l'importateur puisse dézipper les wheels Python et récupérer les informations contenues à l'intérieur.

     La commande ci-dessous importe les métadonnées du paquet Python itsdangerous :

          guix import pypi itsdangerous

gem
     Importe des métadonnées de RubyGems (https://rubygems.org/) (Cette fonctionnalité requiert l'installation de Guile-JSON.  See Prérequis.).  Les informations sont récupérées au format JSON disponible sur rubygems.org et inclut les informations les plus utiles, comme les dépendances à l'exécution.  Il y a des pièges cependant.  Les métadonnées ne distinguent pas synopsis et description, donc la même chaîne est utilisée pour les deux champs.  En plus, les détails des dépendances non Ruby requises pour construire des extensions natives sont indisponibles et laissé en exercice au packager.

     La commande ci-dessous importe les métadonnées pour le paquet Ruby rails :

          guix import gem rails

     --recursive
     -r
          Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.

cpan
     Importe des métadonnées de MetaCPAN (https://www.metacpan.org/) (Cette fonctionnalité requiert l'installation de Guile-JSON.  See Prérequis.).  Les informations sont récupérées au format JSON disponible à travers  l'API de MetaCPAN (https://fastapi.metacpan.org/) et inclus les informations les plus utiles, comme les dépendances des modules.  L'information sur les licences doit être vérifiée avec attention.  Si Perl est disponible dans le dépôt, alors l'utilitaire corelist sera utiliser pour exclure les modules du cœur de la distribution Perl de la liste des dépendances.

     La commande ci-dessous importe les métadonnées du module Perl Acme::Boolean :

          guix import cpan Acme::Boolean

cran
     Importe des métadonnées de CRAN (https://cran.r-project.org/), le dépôt central de l'environnement statistique et graphique GUN R (http://r-project.org).

     Les informations sont extraites du fichier DESCRIPTION du paquet.

     La commande ci-dessous importe les métadonnées du paquet R Cairo :

          guix import cran Cairo

     Lorsque l'option --recursive est utilisée, l'importateur traversera le graphe des dépendances du paquet amont récursivement et générera des expressions de paquets pour tous ceux qui ne sont pas déjà dans Guix.

     Lorsque l'option --archive=bioconductor est utilisée, les métadonnées sont importées de Bioconductor (https://www.bioconductor.org/), un répertoire de paquets R pour l'analyse et la compréhension de données génomiques volumineuses en bioinformatique.

     Les informations sont extraites du fichier DESCRIPTION d'un paquet publié sur l'interface web du dépôt SVN de Bioconductor.

     La commande ci-dessous importe les métadonnées du paquet R GenomicRanges :

          guix import cran --archive=bioconductor GenomicRanges

texlive
     Importe les métadonnées de CTAN (http://www.ctan.org/), l'archive TeX réseau complète pour les paquets TeX qui font partie de la distribution TeX Live (https://www.tug.org/texlive/).

     Les informations sur les paquets sont obtenues à travers l'API XML fournie par CTAN, tandis que le code source est téléchargé depuis le dépôt SVN du projet Tex Live.  Cette méthode est utilisée parce que CTAN ne garde pas d'archives versionnées.

     La commande ci-dessous importe les métadonnées du paquet TeX fontspec :

          guix import texlive fontspec

     Lorsque l'option --archive=DIRECTORY est utilisée, le code source n'est pas téléchargé depuis le sous-répertoire latex du l'arborescence texmf-dist/source dans le dépôt SVN de TeX Live, mais depuis le répertoire voisin spécifié sous la même racine.

     La commande ci-dessous importe les métadonnées du paquet ifxetex depuis CTAN en récupérant les sources depuis le répertoire texmf/source/generic :

          guix import texlive --archive=generic ifxetex

json
     Importe des métadonnées d'un fichier JSON local (Cette fonctionnalité requiert l'installation de Guile-JSON. See Prérequis.).  Considérez l'exemple suivant d'une définition de paquet au format JSON :

          {
            "name": "hello",
            "version": "2.10",
            "source": "mirror://gnu/hello/hello-2.10.tar.gz",
            "build-system": "gnu",
            "home-page": "https://www.gnu.org/software/hello/",
            "synopsis": "Hello, GNU world: An example GNU package",
            "description": "GNU Hello prints a greeting.",
            "license": "GPL-3.0+",
            "native-inputs": ["gcc@6"]
          }

     Les noms des champs sont les mêmes que pour les enregistrements de <package> (see Définition des paquets).  Les référence à d'autres paquets sont fournies comme des listes JSON de chaînes de spécifications de paquets comme guile ou guile@2.0.

     L'importateur supporte aussi une définition plus explicite des sources avec les champs habituels pour les enregistrements <origin> :

          {
            ...
            "source": {
              "method": "url-fetch",
              "uri": "mirror://gnu/hello/hello-2.10.tar.gz",
              "sha256": {
                "base32": "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i"
              }
            }
            ...
          }

     La commande ci-dessous lit les métadonnées du fichier JSON hello.json et renvoie une expression de paquet :

          guix import json hello.json

nix
     Importe les métadonnées d'une copie locale des source de la distribution Nixpkgs (http://nixos.org/nixpkgs/) (Cela repose sur la commande nix-instantiate de Nix (http://nixos.org/nix/).).  Les définitions de paquets dans Nixpkgs sont habituellement écrites en un mélange entre le langage Nix et Bash.  Cette commande n'importe que la structure de haut-niveau du paquet qui est écrite dans le langage Nix.  Elle inclut normalement tous les champs de base de la définition d'un paquet.

     Lorsque vous importez un paquet GNU, le synopsis et la description sont replacés par la version canonique en amont.

     Normalement, vous devrez d'abord faire :

          export NIX_REMOTE=daemon

     pour que nix-instantiate n'essaye pas d'ouvrir la base de données de Nix.

     Par exemple, la commande ci-dessous importe la définition du paquet de LibreOffice (plus précisément, elle importe la définition du paquet lié à l'attribut de plus haut-niveau libreoffice) :

          guix import nix ~/path/to/nixpkgs libreoffice

hackage
     Importe les métadonnées de l'archive de paquets centrale de la communauté Haskell, Hackage (https://hackage.haskell.org/).  Les informations sont récupérées depuis les fichiers Cabal et incluent toutes les informations utiles, dont les dépendances des paquets.

     Les options spécifiques sont :

     --stdin
     -s
          Lit un fichier Cabal depuis l'entrée standard.

     --no-test-dependencies
     -t
          N'inclut pas les dépendances requises uniquement par les suites de tests.

     --cabal-environment=ALIST
     -e ALIST
          ALIST est une alist Scheme qui définie l'environnement dans lequel les conditions de Cabal sont évaluées.  Les clefs acceptées sont : os, arch, impl et une représentation sous forme de chaîne de caractères du nom d'un drapeau.  La valeur associée à un drapeau doit être le symbole true ou false.  La valeur associée aux autres clefs doivent se conformer avec la définition du format de fichiers Cabal.  La valeur par défaut associée avec les clefs os, arch et impl sont respectivement linux, x86_64 et ghc.

     --recursive
     -r
          Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.

     La commande ci-dessous importe les métadonnées de la dernière version du paquet Haskell HTTP sans inclure les dépendances des tests et en spécifiant la valeur du drapeau network-uri comme étant false :

          guix import hackage -t -e "'((\"network-uri\" . false))" HTTP

     Une version spécifique du paquet peut éventuellement être spécifiée en faisant suivre le nom du paquet par un arobase et un numéro de version comme dans l'exemple suivant :

          guix import hackage mtl@2.1.3.1

stackage
     L'importateur stackage est une enveloppe autour de l'importateur hackage.  Il prend un nom de paquet, recherche la version incluse dans une version au support étendu (LTS) de Stackage (https://www.stackage.org) et utilise l'importateur hackage pour récupérer les métadonnées.  Remarquez que c'est à vous de choisir une version LTS compatible avec le compilateur GHC utilisé par Guix.

     Les options spécifiques sont :

     --no-test-dependencies
     -t
          N'inclut pas les dépendances requises uniquement par les suites de tests.

     --lts-version=VERSION
     -r VERSION
          VERSION est la version LTS désirée.  Si elle est omise, la dernière version est utilisée.

     La commande ci-dessous importe les métadonnées du paquet Haskell HTTP inclus dans la version LTS 7.18 de Stackage :

          guix import stackage --lts-version=7.18 HTTP

elpa
     Importe les métadonnées du dépôt de paquets ELPA (Emacs Lisp Package Archive) (see Packages (The GNU Emacs Manual)).

     Les options spécifiques sont :

     --archive=REPO
     -a REPO
          REPO identifie le dépôt d'archive depuis lequel récupérer les informations.  Actuellement les dépôts supportés et leurs identifiants sont :

            - GNU (http://elpa.gnu.org/packages), qu'on peut choisir avec l'identifiant gnu.  C'est la valeur par défaut.

               Les paquets de elpa.gnu.org avec l'une des clefs contenues dans le porte-clef GnuPG share/emacs/25.1/etc/package-keyring.gpg (ou similaire) dans le paquet emacs (see ELPA package signatures (The GNU Emacs Manual)).

            - MELPA-Stable (http://stable.melpa.org/packages), qu'on peut sélectionner avec l'identifiant melpa-stable.

            - MELPA (http://melpa.org/packages), qu'on peut sélectionner avec l'identifiant melpa.

     --recursive
     -r
          Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.

crate
     Importe les métadonnées du répertoire des paquets Rust crates.io (https://crates.io).

opam
     Import metadata from the OPAM (https://opam.ocaml.org/) package repository used by the OCaml community.

La structure du code de guix import est modulaire.  Il serait utile d'avoir plus d'importateurs pour d'autres formats de paquets et votre aide est la bienvenue sur ce sujet (see Contribuer).

Invoquer guix refresh
=====================

L'audience première de la commande guix refresh est l'ensemble des développeurs de la distribution logicielle GNU.  Par défaut, elle rapporte les paquets fournis par la distribution qui sont en retard par rapport aux dernières versions disponibles en amont, comme ceci :

     $ guix refresh
     gnu/packages/gettext.scm:29:13: gettext serait mis à jour de 0.18.1.1 à 0.18.2.1
     gnu/packages/glib.scm:77:12: glib serait mis à jour de 2.34.3 à 2.37.0

Autrement, on peut spécifier les paquets à considérer, auquel cas un avertissement est émis pour les paquets qui n'ont pas de gestionnaire de mise à jour associé :

     $ guix refresh coreutils guile guile-ssh
     gnu/packages/ssh.scm:205:2 : avertissement : aucun gestionnaire de mise à jour pour guile-ssh
     gnu/packages/guile.scm:136:12 : guile serait mis à jour de 2.0.12 à 2.0.13

guix refresh navigue le dépôt amont de chaque paquet et détermine le numéro de version le plus élevé parmi les versions publiées.  La commande sait comment mettre à jour certains types de paquets : les paquets GNU, les paquets ELPA, etc. — voir la documentation pour --type ci-dessous. Il y a beaucoup de paquet cependant pour lesquels il manque une méthode pour déterminer si une nouvelle version est disponible en amont.  Cependant, le mécanisme est extensible, alors n'hésitez pas à nous contacter pour ajouter une nouvelle méthode !

Parfois les noms en amont diffèrent du nom de paquet utilisé par Guix et guix refresh a besoin d'un peu d'aide.  La plupart des gestionnaires de mise à jour honorent la propriété upstream-name dans les définitions de paquets, ce qui peut être utilisé à cette fin :

     (define-public network-manager
       (package
         (name "network-manager")
         ;; ...
         (properties '((upstream-name . "NetworkManager")))))

Lorsque l'option --update est utilisée, elle modifie les fichiers source de la distribution pour mettre à jour le numéro de version et le hash de l'archive source de ces recettes de paquets (see Définition des paquets). Cela est effectué en téléchargeant la dernière version de l'archive des sources de chaque paquet et des signatures associées, en authentifiant l'archive téléchargée avec sa signature en utilisant gpg puis en calculant son hash.  Lorsque la clef publique utilisée pour signer l'archive manque du porte-clefs de l'utilisateur, le gestionnaire tente de la récupérer automatiquement d'un serveur de clef public ; si cela réussi, la clef est ajoutée au porte-clefs de l'utilisateur, sinon guix refresh rapporte une erreur.

Les options suivantes sont supportées :

--expression=EXPR
-e EXPR
     Considérer le paquet évalué par EXPR.

     C'est utile pour précisément se référer à un paquet, comme dans cet exemple :

          guix refresh -l -e '(@@ (gnu packages commencement) glibc-final)'

     Cette commande liste les paquets qui dépendent de la libc « finale » (en gros tous les paquets).

--update
-u
     Met à jour les fichiers source de la distribution (les recettes de paquets) en place.  Cette option est généralement utilisée depuis une copie du dépôt git de Guix (see Lancer Guix avant qu'il ne soit installé) :

          $ ./pre-inst-env guix refresh -s non-core -u

     See Définition des paquets, pour plus d'information sur les définitions des paquets.

--select=[SUBSET]
-s SUBSET
     Choisi tous les paquets dans SUBSET, entre core et non-core.

     Le sous-ensemble core se réfère à tous les paquets du cœur de la distribution — c.-à-d. les paquets qui sont utilisés pour construire « tout le rest ».  Cela comprend GCC, libc, Binutils, Bash, etc. Habituellement, changer l'un de ces paquets dans la distribution implique de reconstruire tous les autres.  Ainsi, ces mises à jour sont une nuisance pour les utilisateurs, en terme de temps de compilation et de bande passante utilisés pour effectuer la mise à jour.

     Le sous-ensemble non-core se réfère au reste des paquets.  C'est habituellement utile dans les cas où une mise à jour des paquets du cœur serait dérangeante.

--manifest=FICHIER
-m FICHIER
     Choisi tous les paquets du manifeste dans FILE.  C'est utile pour vérifier qu'aucun des paquets du manifeste utilisateur ne peut être mis à jour.

--type=UPDATER
-t UPDATER
     Chois uniquement les paquets pris en charge par UPDATER (éventuellement une liste de gestionnaires de mise à jour séparés par des virgules). Actuellement, UPDATER peut être l'une des valeurs suivantes :

     gnu
          le gestionnaire de mise à jour pour les paquets GNU ;

     gnome
          le gestionnaire de mise à jour pour les paquets GNOME ;

     kde
          le gestionnaire de mise à jour pour les paquets KDE ;

     xorg
          le gestionnaire de mise à jour pour les paquets X.org ;

     kernel.org
          le gestionnaire de mise à jour pour les paquets hébergés sur kernel.org ;

     elpa
          le gestionnaire de mise à jour pour les paquets ELPA (http://elpa.gnu.org/) ;

     cran
          le gestionnaire de mise à jour pour les paquets CRAN (https://cran.r-project.org/) ;

     bioconductor
          le gestionnaire de mise à jour pour les paquets Bioconductor (https://www.bioconductor.org/) ;

     cpan
          le gestionnaire de mise à jour pour les paquets CPAN (http://www.cpan.org/) ;

     pypi
          le gestionnaire de mise à jour pour les paquets PyPI (https://pypi.python.org) ;

     gem
          le gestionnaire de mise à jour pour les paquets RubyGems (https://rubygems.org) ;

     github
          le gestionnaire de mise à jour pour les paquets GitHub (https://github.com) ;

     hackage
          le gestionnaire de mise à jour pour les paquets Hackage (https://hackage.haskell.org) ;

     stackage
          le gestionnaire de mise à jour pour les paquets Stackage (https://www.stackage.org) ;

     crate
          le gestionnaire de mise à jour pour les paquets Crates (https://crates.io) ;

     Par exemple, la commande suivante ne vérifie que les mises à jour des paquets Emacs hébergés sur elpa.gnu.org et les paquets CRAN :

          $ guix refresh --type=elpa,cran
          gnu/packages/statistics.scm:819:13 : r-testthat serait mis à jour de 0.10.0 à 0.11.0
          gnu/packages/emacs.scm:856:13 : emacs-auctex serait mis à jour de 11.88.6 à 11.88.9

En plus, on peut passer à guix refresh un ou plusieurs noms de paquets, comme dans cet exemple :

     $ ./pre-inst-env guix refresh -u emacs idutils gcc@4.8

La commande au-dessus met à jour spécifiquement les paquets emacs et idutils.  L'option --select n'aurait aucun effet dans ce cas.

Pour déterminer s'il faut mettre à jour un paquet, il est parfois pratique de savoir quels paquets seraient affectés par la mise à jour pour pouvoir vérifier la compatibilité.  Pour cela l'option suivante peut être utilisée avec un ou plusieurs noms de paquets passés à guix refresh :

--list-updaters
-L
     Liste les gestionnaires de mise à jour et quitte (voir l'option --type plus haut).

     Pour chaque gestionnaire, affiche le pourcentage de paquets qu'il couvre ; à la fin, affiche le pourcentage de paquets couverts par tous les gestionnaires.

--list-dependent
-l
     Liste les paquets de plus haut-niveau qui devraient être reconstruits après la mise à jour d'un ou plusieurs paquets.

     See le type reverse-package de guix graph, pour des informations sur la manière de visualiser la liste des paquets dépendant d'un autre.

Soyez conscients que l'option --list-dependent ne fait qu'approximer les reconstructions qui seraient requises par une mise à jour.  Plus de reconstructions pourraient être requises dans certaines circonstances.

     $ guix refresh --list-dependent flex
     Building the following 120 packages would ensure 213 dependent packages are rebuilt:
     hop@2.4.0 geiser@0.4 notmuch@0.18 mu@0.9.9.5 cflow@1.4 idutils@4.6 ...

La commande ci-dessus liste un ensemble de paquets qui peuvent être construits pour vérifier la compatibilité d'une mise à jour de flex.

Les options suivante peuvent être utilisées pour personnaliser les opérations avec GnuPG :

--gpg=COMMANDE
     Utilise COMMANDE comme la commande de GnuPG 2.x.  COMMANDE est recherchée dans PATH.

--key-download=POLITIQUE
     Gère les clefs OpenPGP manquantes d'après la POLITIQUE, qui peut être l'une des suivantes :

     always
          Toujours télécharger les clefs manquantes depuis un serveur de clefs et les ajouter au porte-clefs de l'utilisateur.

     never
          Ne jamais essayer de télécharger les clefs OpenPGP manquante.  Quitter à la place.

     interactive
          Lorsqu'on rencontre un paquet signé par une clef OpenPGP inconnue, demander à l'utilisateur s'il souhaite la télécharger ou non.  C'est le comportement par défaut.

--key-server=HOST
     Utiliser HOST comme serveur de clefs OpenPGP lors de l'importe d'une clef publique.

Le gestionnaire de mises à jour github utilise l'API de GitHub (https://developer.github.com/v3/) pour faire des requêtes sur les nouvelles versions.  Lorsqu'elle est utilisé de manière répétée, p. ex. lorsque vous vérifiez tous les paquets, GitHub finira par refuser de répondre à d'autres requêtes de l'API.  Par défaut 60 requêtes à l'heure sont autorisées, et une vérification complète de tous les paquets GitHub dans Guix requiert bien plus que cela.  L'authentification avec GitHub à travers l'utilisation d'un jeton d'API lève ces limites.  Pour utiliser un jeton de l'API, initialisez la variable d'environnement GUIX_GITHUB_TOKEN avec un jeton que vous vous serez procuré sur https://github.com/settings/tokens ou autrement.

Invoquer guix lint
==================

La commande guix lint est conçue pour aider les développeurs à éviter des erreurs commune et à utiliser un style cohérent lors de l'écriture de recettes de paquets.  Elle lance des vérifications sur un ensemble de paquets donnés pour trouver des erreurs communes dans leur définition.  Les vérifieurs disponibles comprennent (voir --list-checkers pour une liste complète) :

synopsis
description
     Vérifie certaines règles typographiques et stylistiques dans les descriptions et les synopsis.

inputs-should-be-native
     Identifie les entrées qui devraient sans doute plutôt être des entrées natives.

source
home-page
mirror-url
source-file-name
     Sonde les URL home-page et source et rapporte celles qui sont invalides.  Suggère une URL en mirror:// lorsque c'est possible. Vérifie que le nom du fichier source a un sens, p. ex. qu'il ne s'agisse pas juste d'un numéro de version ou « git-checkou », sans avoir déclaré un file-name (see Référence d'origine).

cve
     Rapporte les vulnérabilités connues trouvées dans les bases de données CVE (Common Vulnerabilities and Exposures) de l'année en cours et des années précédentes publié par le NIST américain (https://nvd.nist.gov/download.cfm#CVE_FEED).

     Pour voir les informations sur une vulnérabilité en particulier, visitez les pages :

       * https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-ANNÉE-ABCD

       * https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-ANNÉE-ABCD

     où CVE-ANNÉE-ABCD est l'identifiant CVE — p. ex. CVE-2015-7554.

     Les développeurs de paquets peuvent spécifier dans les recettes des paquets le nom CPE (Common Platform Enumeration) (https://nvd.nist.gov/cpe.cfm) et la version du paquet s'ils diffèrent du nom et de la version que Guix utilise, comme dans cet exemple :

          (package
            (name "grub")
            ;; ...
            ;; CPE calls this package "grub2".
            (properties '((cpe-name . "grub2")
                          (cpe-version . "2.3")))

     Certaines entrées dans la base de données CVE ne spécifient pas la version du paquet auquel elles s'appliquent et lui restera donc attachée pour toujours.  Les développeurs qui trouvent des alertes CVE et ont vérifiés qu'elles peuvent être ignorées peuvent les déclarer comme dans cet exemple :

          (package
            (name "t1lib")
            ;; ...
            ;; Ces CVE ne s'appliquent plus et peuvent être ignorée sans problème.
            (properties `((lint-hidden-cve . ("CVE-2011-0433"
                                              "CVE-2011-1553"
                                              "CVE-2011-1554"
                                              "CVE-2011-5244")))))

formatting
     Avertit le développeurs lorsqu'il y a des problèmes de formatage du code source évident : des espaces en fin de ligne, des tabulations, etc.

La syntaxe générale est :

     guix lint OPTIONS PACKAGE...

Si aucun paquet n'est donné par la ligne de commande, tous les paquets seront vérifiés.  Les OPTIONS peuvent contenir aucune ou plus des options suivantes :

--list-checkers
-l
     Liste et décrit tous les vérificateurs disponibles qui seront lancés sur les paquets puis quitte.

--checkers
-c
     N'active que les vérificateurs spécifiés dans une liste de noms séparés par des virgules parmi la liste renvoyée par --list-checkers.

Invoquer guix size
==================

La commande guix size aide les développeurs à dresser un profil de l'utilisation du disque que font les paquets.  C'est facile de négliger l'impact d'une dépendance supplémentaire ajoutée à un paquet, ou l'impact de l'utilisation d'une sortie unique pour un paquet qui pourrait être facilement séparé (see Des paquets avec plusieurs résultats).  Ce sont les problèmes que guix size peut typiquement mettre en valeur.

On peut passer un ou plusieurs spécifications de paquets à la commande, comme gcc@4.8 ou guile:debug, ou un nom de fichier dans le dépôt.  Regardez cet exemple :

     $ guix size coreutils
     store item                               total    self
     /gnu/store/...-gcc-5.5.0-lib           60.4    30.1  38.1%
     /gnu/store/...-glibc-2.27              30.3    28.8  36.6%
     /gnu/store/...-coreutils-8.28          78.9    15.0  19.0%
     /gnu/store/...-gmp-6.1.2               63.1     2.7   3.4%
     /gnu/store/...-bash-static-4.4.12       1.5     1.5   1.9%
     /gnu/store/...-acl-2.2.52              61.1     0.4   0.5%
     /gnu/store/...-attr-2.4.47             60.6     0.2   0.3%
     /gnu/store/...-libcap-2.25             60.5     0.2   0.2%
     total: 78.9 MiB

Les éléments du dépôt listés ici constituent la cloture transitive de Coreutils — c.-à-d. Coreutils et toutes ses dépendances, récursivement — comme ce qui serait renvoyé par :

     $ guix gc -R /gnu/store/...-coreutils-8.23

Ici, la sortie possède trois colonnes à côté de chaque élément du dépôt.  La première colonne, nommée « total », montre la taille en mébioctet (Mio) de la cloture de l'élément du dépôt — c'est-à-dire sa propre taille plus la taille de ses dépendances. La colonne suivante, nommée « lui-même », montre la taille de l'élément lui-même.  La dernière colonne montre le ration de la taille de l'élément lui-même par rapport à celle de tous les éléments montrés.

Dans cet exemple, on voit que la cloture de Coreutils pèse 79 Mio, dont la plupart est dû à la libc et aux bibliothèques à l'exécution de GCC (ce n'est pas un problème en soit que la libc et les bibliothèques de GCC représentent une grande part de la cloture parce qu'elles sont toujours disponibles sur le système de toute façon).

Lorsque les paquets passés à guix size sont disponibles dans le dépôt (Plus précisément, guix size cherche les variantes non greffées des paquets donnés, tels qu'ils sont renvoyés par guix build PAQUET --no-graft.  See Mises à jour de sécurité pour des informations sur les greffes), guix size demande au démon de déterminer ses dépendances, et mesure sa taille dans le dépôt, comme avec du -ms --apparent-size (see du invocation (GNU Coreutils)).

Lorsque les paquets donnés ne sont pas dans le dépôt, guix size rapporte les informations en se basant sur les substituts disponibles (see Substituts). Cela permet de profiler l'utilisation du disque des éléments du dépôt même s'ils ne sont pas sur le disque, mais disponibles à distance.

Vous pouvez aussi spécifier plusieurs noms de paquets :

     $ guix size coreutils grep sed bash
     store item                               total    self
     /gnu/store/...-coreutils-8.24          77.8    13.8  13.4%
     /gnu/store/...-grep-2.22               73.1     0.8   0.8%
     /gnu/store/...-bash-4.3.42             72.3     4.7   4.6%
     /gnu/store/...-readline-6.3            67.6     1.2   1.2%
     ...
     total: 102.3 MiB

Dans cet exemple on voit que la combinaison des quatre paquets prent 102.3 Mio en tout, ce qui est bien moins que la somme des clotures puisqu'ils ont beaucoup de dépendances en commun.

Les options disponibles sont :

--substitute-urls=URLS
     Utilise les informations de substituts de URLS. See the same option for guix build.

--sort=CLEF
     Trie les lignes en fonction de la CLEF, l'une des optinos suivantes :

     self
          la taille de chaque élément (par défaut) ;

     closure
          la taille totale de la cloture de l'élémente.

--map-file=FICHIER
     Écrit un schéma de l'utilisation du disque au format PNG dans FICHIER.

     Pour l'exemple au-dessus, le schéma ressemble à ceci :

     schéma de l'utilisation du disque de Coreutils produit par guix size

     Cette option requiert l'installation de Guile-Charting (http://wingolog.org/software/guile-charting/) et qu'il soit visible dans le chemin de recherche des modules Guile.  Lorsque ce n'est pas le cas, guix size plante en essayant de le charger.

--system=SYSTÈME
-s SYSTÈME
     Considère les paquets pour SYSTÈME — p. ex. x86_64-linux.

Invoque guix graph
==================

Les paquets et leurs dépendances forment un graphe, plus précisément un graphe orienté acyclique (DAG).  Il peut vite devenir difficile d'avoir une représentation mentale du DAG d'un paquet, donc la commande guix graph fournit une représentation visuelle du DAG.  Par défaut, guix graph émet un représentation du DAG dans le format d'entrée de Graphviz (http://www.graphviz.org/), pour que sa sortie puisse être passée directement à la commande dot de Graphviz. Elle peut aussi émettre une page HTML avec du code Javascript pour afficher un « digramme d'accords » dans un navigateur Web, grâce à la bibliothèque d3.js (https://d3js.org/), ou émettre des requêtes Cypher pour construire un graphe dans une base de donnée de graphes supportant le langage de requêtes openCypher (http://www.opencypher.org/).  La syntaxe générale est :

     guix graph OPTIONS PAQUET...

Par exemple, la commande suivante génère un fichier PDF représentant le DAG du paquet pour GNU Core Utilities, qui montre ses dépendances à la compilation :

     guix graph coreutils | dot -Tpdf > dag.pdf

La sortie ressemble à ceci :

Graphe de dépendance de GNU Coreutils

Joli petit graphe, non ?

Mais il y a plus qu'un seul graphe !  Celui au-dessus est concis : c'est le graphe des objets paquets, en omettant les entrées implicites comme GCC, libc, grep, etc.  Il est souvent utile d'avoir ces graphes concis, mais parfois on veut voir plus de détails.  guix graph supporte plusieurs types de graphes, qui vous permettent de choisir le niveau de détails :

package
     C'est le type par défaut utilisé dans l'exemple plus haut.  Il montre le DAG des objets paquets, sans les dépendances implicites.  C'est concis, mais omet pas mal de détails.

reverse-package
     Cela montre le DAG inversé des paquets.  Par exemple :

          guix graph --type=reverse-package ocaml

     … montre le graphe des paquets qui dépendent de OCaml.

     Remarquez que pour les paquets du cœur de la distribution, cela crée des graphes énormes.  Si vous voulez seulement voir le nombre de paquets qui dépendent d'un paquet donnés, utilisez guix refresh --list-dependent (see --list-dependent).

bag-emerged
     C'est le DAG du paquet, avec les entrées implicites.

     Par exemple, la commande suivante :

          guix graph --type=bag-emerged coreutils | dot -Tpdf > dag.pdf

     … montre ce graphe plus gros :

     Graphe des dépendances détaillé de GNU Coreutils

     En bas du graphe, on voit toutes les entrées implicites de GNU-BUILD-SYSTEM (see gnu-build-system).

     Maintenant, remarquez que les dépendances de ces entrées implicites — c'est-à-dire les dépendances de bootstrap (see Bootstrapping) — ne sont pas affichées, pour rester concis.

bag
     Comme bag-emerged mais cette fois inclus toutes les dépendances de bootstrap.

bag-with-origins
     Comme bag, mais montre aussi les origines et leurs dépendances.

dérivation
     C'est la représentation lu plus détaillée : elle montre le DAG des dérivations (see Dérivations) et des éléments du dépôt.  Comparé à la représentation ci-dessus, beaucoup plus de nœuds sont visibles, dont les scripts de construction, les correctifs, les modules Guile, etc.

     Pour ce type de graphe, il est aussi possible de passer un nom de fichier .drv à la place d'un nom de paquet, comme dans :

          guix graph -t derivation `guix system build -d my-config.scm`

module
     C'est le graphe des modules de paquets (see Modules de paquets).  Par exemple, la commande suivante montre le graphe des modules de paquets qui définissent le paquet guile :

          guix graph -t module guile | dot -Tpdf > module-graph.pdf

Tous les types ci-dessus correspondent aux dépendances à la construction.  Le type de graphe suivant représente les dépendances à l'exécution :

references
     C'est le graphe des references d'une sortie d'un paquet, telles que renvoyées par guix gc --references (see Invoquer guix gc).

     Si la sortie du paquet donnée n'est pas disponible dans le dépôt, guix graph essayera d'obtenir les informations sur les dépendances à travers les substituts.

     Vous pouvez aussi passer un nom de fichier du dépôt plutôt qu'un nom de paquet.  Par exemple, la commande ci-dessous produit le graphe des références de votre profile (qui peut être gros !) :

          guix graph -t references `readlink -f ~/.guix-profile`

referrers
     C'est le graphe des référents d'un élément du dépôt, tels que renvoyés par guix gc --referrers (see Invoquer guix gc).

     Cela repose exclusivement sur les informations de votre dépôt.  Par exemple, supposons que Inkscape est actuellement disponible dans 10 profils sur votre machine ; guix graph -t referrers inkscape montrera le graphe dont la racine est Inkscape avec 10 profils qui y sont liés.

     Cela peut aider à déterminer ce qui empêche un élément du dépôt d'être glané.

Les options disponibles sont les suivante :

--type=TYPE
-t TYPE
     Produit un graphe en sortie de type TYPE où TYPE doit être l'un des types au-dessus.

--list-types
     Liste les types de graphes supportés.

--backend=MOTEUR
-b MOTEUR
     Produit un graphe avec le MOTEUR choisi.

--list-backends
     Liste les moteurs de graphes supportés.

     Actuellement les moteurs disponibles sont Graphviz et d3.js.

--expression=EXPR
-e EXPR
     Considérer le paquet évalué par EXPR.

     C'est utile pour précisément se référer à un paquet, comme dans cet exemple :

          guix graph -e '(@@ (gnu packages commencement) gnu-make-final)'

Invoquer guix environment
=========================

Le but de guix environment est d'assister les hackers dans la création d'environnements de développement reproductibles sans polluer leur profil de paquets.  L'outil guix environment prend un ou plusieurs paquets, construit leurs entrées et crée un environnement shell pour pouvoir les utiliser.

La syntaxe générale est :

     guix environment OPTIONS PAQUET...

L'exemple suivant crée un nouveau shell préparé pour le développement de GNU Guile :

     guix environment guile

Si les dépendances requises ne sont pas déjà construites, guix environment les construit automatiquement.  L'environnement du nouveau shell est une version améliorée de l'environnement dans lequel guix environment a été lancé.  Il contient les chemins de recherche nécessaires à la construction du paquet donné en plus des variables d'environnement existantes.  Pour créer un environnement « pur », dans lequel les variables d'environnement de départ ont été nettoyées, utilisez l'option --pure (Les utilisateurs ajoutent parfois à tord des valeurs supplémentaires dans les variables comme PATH dans leur ~/.bashrc.  En conséquence, lorsque guix environment le lance, Bash peut lire ~/.bashrc, ce qui produit des « impuretés » dans ces variables d'environnement.  C'est une erreur de définir ces variables d'environnement dans .bashrc ; à la place, elles devraient être définie dans .bash_profile, qui est sourcé uniquement par les shells de connexion.  See Bash Startup Files (The GNU Bash Reference Manual), pour des détails sur les fichiers de démarrage de Bash.).

guix environment définie la variable GUIX_ENVIRONMENT dans le shell qu'il crée ; sa valeur est le nom de fichier du profil de cet environnement.  Cela permet aux utilisateur, disons, de définir un prompt spécifique pour les environnement de développement dans leur .bashrc (see Bash Startup Files (The GNU Bash Reference Manual)) :

     if [ -n "$GUIX_ENVIRONMENT" ]
     then
         export PS1="\u@\h \w [dev]\$ "
     fi

… ou de naviguer dans le profil :

     $ ls "$GUIX_ENVIRONMENT/bin"

En plus, plus d'un paquet peut être spécifié, auquel cas l'union des entrées des paquets données est utilisée.  Par exemple, la commande ci-dessous crée un shell où toutes les dépendances de Guile et Emacs sont disponibles :

     guix environment guile emacs

Parfois, une session shell interactive est inutile.  On peut invoquer une commande arbitraire en plaçant le jeton -- pour séparer la commande du reste des arguments :

     guix environment guile -- make -j4

Dans d'autres situations, il est plus pratique de spécifier la liste des paquets requis dans l'environnement.  Par exemple, la commande suivante lance python dans un environnement contenant Python 2.7 et NumPy :

     guix environment --ad-hoc python2-numpy python-2.7 -- python

En plus, on peut vouloir les dépendance d'un paquet et aussi des paquets supplémentaires qui ne sont pas des dépendances à l'exécution ou à la construction, mais qui sont utiles au développement tout de même.  À cause de cela, le drapeau --ad-hoc est positionnel.  Les paquets qui apparaissent avant --ad-hoc sont interprétés comme les paquets dont les dépendances seront ajoutées à l'environnement.  Les paquets qui apparaissent après --ad-hoc sont interprétés comme les paquets à ajouter à l'environnement directement.  Par exemple, la commande suivante crée un environnement de développement pour Guix avec les paquets Git et strace en plus :

     guix environment guix --ad-hoc git strace

Parfois il est souhaitable d'isoler l'environnement le plus possible, pour une pureté et une reproductibilité maximale.  En particulier, lorsque vous utilisez Guix sur une distribution hôte qui n'est pas GuixSD, il est souhaitable d'éviter l'accès à /usr/bin et d'autres ressources du système depuis les environnements de développement.  Par exemple, la commande suivante crée un REPL Guile dans un « conteneur » où seuls le dépôt et le répertoire de travail actuel sont montés :

     guix environment --ad-hoc --container guile -- guile

     L'option --container requiert Linux-libre 3.19 ou supérieur.

Les options disponibles sont résumées ci-dessous.

--root=FICHIER
-r FICHIER
     Fait de FICHIER un lien symbolique vers le profil de cet environnement, et l'enregistre comme une racine du ramasse-miettes.

     C'est utile si vous souhaitez protéger votre environnement du ramasse-miettes, pour le rendre « persistent ».

     Lorsque cette option est omise, l'environnement n'est protégé du ramasse-miettes que le temps de la session guix environment.  Cela signifie que la prochaine fois que vous créerez le même environnement, vous pourriez avoir à reconstruire ou télécharger des paquets.  See Invoquer guix gc, pour plus d'informations sur les racines du GC.

--expression=EXPR
-e EXPR
     Crée un environnement pour le paquet ou la liste de paquets en lesquels s'évalue EXPR.

     Par exemple, lancer :

          guix environment -e '(@ (gnu packages maths) petsc-openmpi)'

     démarre un shell avec l'environnement pour cette variante spécifique du paquet PETSc.

     Lancer :

          guix environment --ad-hoc -e '(@ (gnu) %base-packages)'

     démarre un shell où tous les paquets de base de GuixSD sont disponibles.

     Les commande au-dessus n'utilisent que les sorties par défaut des paquets donnés.  Pour choisir d'autres sorties, on peut spécifier des pairs :

          guix environment --ad-hoc -e '(list (@ (gnu packages bash) bash) "include")'

--load=FICHIER
-l FICHIER
     Crée un environnement pour le paquet ou la liste de paquets en lesquels FICHIER s'évalue.

     Par exemple, FICHIER peut contenir une définition comme celle-ci (see Définition des paquets) :

               [file environment-gdb.scm not included]

--manifest=FICHIER
-m FICHIER
     Crée un environnement pour les paquets contenus dans l'objet manifeste renvoyé par le code Scheme dans FICHIER.

     C'est similaire à l'option de même nom de guix package (see --manifest) et utilise les même fichiers manifestes.

--ad-hoc
     Inclut tous les paquets spécifiés dans l'environnement qui en résulte, comme si un paquet ad hoc était spécifié, avec ces paquets comme entrées. Cette option est utile pour créer un environnement rapidement sans avoir à écrire une expression de paquet contenant les entrées désirées.

     Par exemple la commande :

          guix environment --ad-hoc guile guile-sdl -- guile

     lance guile dans un environnement où Guile et Guile-SDDL sont disponibles.

     Remarquez que cet exemple demande implicitement la sortie par défaut de guile et guile-sdl, mais il est possible de demander une sortie spécifique — p. ex. glib:bin demande la sortie bin de glib (see Des paquets avec plusieurs résultats).

     Cette option peut être composée avec le comportement par défaut de guix environment.  Les paquets qui apparaissent avant --ad-hoc sont interprétés comme les paquets dont les dépendances seront ajoutées à l'environnement, le comportement par défaut.  Les paquets qui apparaissent après --ad-hoc sont interprétés comme les paquets à ajouter à l'environnement directement.

--pure
     Nettoie les variables d'environnement existantes lors de la construction du nouvel environnement.  Cela a pour effet de créer un environnement dans lequel les chemins de recherche ne contiennent que des entrées de paquets.

--search-paths
     Affiche les définitions des variables d'environnement qui composent l'environnement.

--system=SYSTÈME
-s SYSTÈME
     Essaye de construire pour SYSTÈME — p. ex. i686-linux.

--container
-C
     Lance COMMANDE dans un conteneur isolé.  Le répertoire de travail actuel en dehors du conteneur est monté dans le conteneur.  En plus, à moins de le changer avec --user, un répertoire personnel fictif est créé pour correspondre à celui de l'utilisateur actuel et /etc/passwod est configuré en conséquence.  Le processus est lancé en tant que l'utilisateur actuel en dehors du conteneur, mais a les privilèges root dans le contexte du conteneur.

--network
-N
     Pour les conteneurs, partage l'espace de nom du réseau avec le système hôte.  Les conteneurs créés sans cette option n'ont accès qu'à l'interface de boucle locale.

--link-profile
-P
     Pour les conteneurs, lie le profil de l'environnement à ~/.guix-profile dans le conteneur.  C'est équivalent à lance la commande ln -s $GUIX_ENVIRONMENT ~/.guix-profile dans le conteneur.  La liaison échouera et annulera l'environnement si le répertoire existe déjà, ce qui sera sans doute le cas si guix environment est invoqué dans le répertoire personnel de l'utilisateur.

     Certains paquets sont configurés pour chercher des fichiers de configuration et des données dans ~/.guix-profile (Par exemple, le paquet fontconfig inspecte ~/.guix-profile/share/fonts pour trouver des polices supplémentaires.) ; --link-profile permet à ces programmes de se comporter comme attendu dans l'environnement.

--user=UTILISATEUR
-u UTILISATEUR
     Pour les conteneurs, utilise le nom d'utilisateur UTILISATEUR à la place de l'utilisateur actuel.  L'entrée générée dans /etc/passwod dans le conteneur contiendra le nom UTILISATEUR ; le répertoire personnel sera /home/UTILISATEUR ; et aucune donnée GECOS ne sera copiée.  UTILISATEUR n'a pas besoin d'exister sur le système.

     En plus, tous les chemins partagés ou exposés (voir --share et --expose respectivement) dont la cible est dans le répertoire personnel de l'utilisateur seront remontés relativement à /home/UTILISATEUR ; cela comprend le montage automatique du répertoire de travail actuel.

          # exposera les chemins comme /home/foo/wd, /home/foo/test et /home/foo/target
          cd $HOME/wd
          guix environment --container --user=foo \
               --expose=$HOME/test \
               --expose=/tmp/target=$HOME/target

     Bien que cela limite la fuite de l'identité de l'utilisateur à travers le chemin du répertoire personnel et des champs de l'utilisateur, ce n'est qu'un composant utile pour une solution d'anonymisation ou de préservation de la vie privée — pas une solution en elle-même.

--expose=SOURCE[=CIBLE]
     Pour les conteneurs, expose le système de fichiers SOURCE du système hôte comme un système de fichiers en lecture seule CIBLE dans le conteneur.  Si CIBLE n'est pas spécifiée, SOURCE est utilisé comme point de montage dans le conteneur.

     L'exemple ci-dessous crée un REPL Guile dans un conteneur dans lequel le répertoire personnel de l'utilisateur est accessible en lecture-seule via le répertoire /exchange :

          guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile

--share=SOURCE[=CIBLE]
     Pour les conteneurs, partage le système de fichiers SORUCE du système hôte comme un système de fichiers en lecture-écriture CIBLE dans le conteneur.  Si CIBLE n'est pas spécifiée, SOURCE est utilisée comme point de montage dans le conteneur.

     L'exemple ci-dessous crée un REPL Guile dans un conteneur dans lequel le répertoire personnel de l'utilisateur est accessible en lecture-écriture via le répertoire /exchange :

          guix environment --container --share=$HOME=/exchange --ad-hoc guile -- guile

guix environment supporte aussi toutes les options de construction que guix build supporte (see Options de construction communes).

Invoquer guix publish
=====================

Le but de guix publish est de vous permettre de partager facilement votre dépôt avec d'autres personnes qui peuvent ensuite l'utiliser comme serveur de substituts (see Substituts).

Lorsque guix publish est lancé, il crée un serveur HTTP qui permet à n'importe qui avec un accès réseau d'y récupérer des substituts.  Cela signifie que toutes les machines qui font tourner Guix peuvent aussi agir comme une ferme de construction, puisque l'interface HTTP est compatible avec Hydra, le logiciel derrière la ferme de construction hydra.gnu.org.

Pour des raisons de sécurité, chaque substitut est signé, ce qui permet aux destinataires de vérifier leur authenticité et leur intégrité (see Substituts). Comme guix publish utilise la clef de signature du système, qui n'est lisible que par l'administrateur système, il doit être lancé en root ; l'option --user lui fait baisser ses privilèges le plus tôt possible.

La pair de clefs pour les signatures doit être générée avant de lancer guix publish, avec guix archive --generate-key (see Invoquer guix archive).

La syntaxe générale est :

     guix publish OPTIONS...

Lancer guix publish sans arguments supplémentaires lancera un serveur HTTP sur le port 8080 :

     guix publish

Une fois qu'un serveur de publication a été autorisé (see Invoquer guix archive), le démon peut télécharger des substituts à partir de lui :

     guix-daemon --substitute-urls=http://example.org:8080

Par défaut, guix publish compresse les archives à la volée quand il les sert.  Ce mode « à la volée » est pratique puisqu'il ne demande aucune configuration et est disponible immédiatement.  Cependant, lorsqu'il s'agit de servir beaucoup de clients, nous recommandons d'utiliser l'option --cache, qui active le cache des archives avant de les envoyer aux clients — voir les détails plus bas.  La commande guix weather fournit un manière pratique de vérifier ce qu'un serveur fournit (see Invoquer guix weather).

En bonus, guix publish sert aussi un miroir adressé par le contenu des fichiers source référencées dans les enregistrements origin (see Référence d'origine).  Par exemple, en supposant que guix publish tourne sur example.org, l'URL suivante renverra le fichie brut hello-2.10.tar.gz avec le hash SHA256 donné (représenté sous le format nix-base32, see Invoquer guix hash) :

     http://example.org/file/hello-2.10.tar.gz/sha256/0ssi1...ndq1i

Évidemment, ces URL ne fonctionnent que pour des fichiers dans le dépôt ; dans les autres cas, elles renvoie une erreur 404 (« Introuvable »).

Les journaux de construction sont disponibles à partir des URL /log comme ceci :

     http://example.org/log/gwspk...-guile-2.2.3

Lorsque guix-daemon est configuré pour sauvegarder les journaux de construction compressés, comme c'est le cas par défaut (see Invoquer guix-daemon), les URL /log renvoient le journal compressé tel-quel, avec un en-tête Content-Type ou Content-Encoding approprié. Nous recommandons de lancer guix-daemon avec --log-compression=gzip pace que les navigateurs web les décompressent automatiquement, ce qui n'est pas le cas avec la compression bzip2.

Les options suivantes sont disponibles :

--port=PORT
-p PORT
     Écoute les requêtes HTTP sur le PORT

--listen=HÔTE
     Écoute sur l'interface réseau de HÔTE.  Par défaut, la commande accepte les connexions de n'importe quelle interface.

--user=UTILISATEUR
-u UTILISATEUR
     Charge les privilèges de UTILISATEUR le plus vite possible — c.-à-d. une fois que la socket du serveur est ouverte et que la clef de signature a été lue.

--compression[=NIVEAU]
-C [NIVEAU]
     Compresse les données au NIVEAU donné.  Lorsque le NIVEAU est zéro, désactive la compression.  L'intervalle 1 à 9 correspond aux différents niveaux de compression gzip : 1 est le plus rapide et 9 est la meilleure (mais gourmande en CPU).  Le niveau par défaut est 3.

     À moins que --cache ne soit utilisé, la compression se fait à la volée et les flux compressés ne sont pas cachés.  Ainsi, pour réduire la charge sur la machine qui fait tourner guix publish, c'est une bonne idée de choisir un niveau de compression faible, de lancer guix publish derrière un serveur de cache ou d'utiliser --cache.  Utilise --cache a l'avantage qu'il permet à guix publish d'ajouter l'en-tête HTTP Content-Length à sa réponse.

--cache=RÉPERTOIRE
-c RÉPERTOIRE
     Cache les archives et les métadonnées (les URL .narinfo) dans RÉPERTOIRE et ne sert que les archives dans ce cache.

     Lorsque cette option est omise, les archives et les métadonnées sont crées à la volée.  Cela réduit la bande passante disponible, surtout quand la compression est activée puisqu'elle pourrait être limitée par le CPU.  Un autre inconvénient au mode par défaut est que la taille des archives n'est pas connue à l'avance, donc guix publish n'ajoute pas l'en-tête Content-Length à ses résponses, ce qui empêche les clients de savoir la quantité de données à télécharger.

     À l'inverse, lorsque --cache est utilisée, la première requête pour un élément du dépôt (via une URL .narinfo) renvoie une erreur 404 et déclenche la création de l'archive — en calculant son .narinfo et en compressant l'archive au besoin.  Une fois l'archive cachée dans RÉPERTOIRE, les requêtes suivantes réussissent et sont servies directement depuis le cache, ce qui garanti que les clients ont la meilleure bande passante possible.

     Le processus de création est effectué par des threads de travail.  Par défaut, un thread par cœur du CPU est créé, mais cela peut être personnalisé.  Voir --workers plus bas.

     Lorsque l'option --ttl est utilisée, les entrées cachées sont automatiquement supprimées lorsqu'elles expirent.

--workers=N
     Lorsque --cache est utilisée, demande l'allocation de N thread de travail pour créer les archives.

--ttl=TTL
     Produit des en-têtes HTTP Cache-Control qui expriment une durée de vie (TTL) de TTL.  TTL peut dénoter une durée : 5d signifie 5 jours, 1m signifie un mois, etc.

     Cela permet au Guix de l'utilisateur de garder les informations en cache pendant TTL.  Cependant, remarquez que guix publish ne garanti pas lui-même que les éléments du dépôt qu'il fournit seront toujours disponible pendant la durée TTL.

     En plus, lorsque --cache est utilisée, les entrées cachées qui n'ont pas été demandé depuis TTL et n'ont pas d'élément correspondant dans le dépôt peuvent être supprimées.

--nar-path=CHEMIN
     Utilise CHEMIN comme préfixe des URL de fichier « nar » (see normalized archives).

     Par défaut, les nars sont présents à l'URL comme /nar/gzip/...-coreutils-8.25.  Cette option vous permet de changer la partie /nar en CHEMIN.

--public-key=FICHIER
--private-key=FICHIER
     Utilise les FICHIERs spécifiques comme pair de clefs utilisées pour signer les éléments avant de les publier.

     Les fichiers doivent correspondre à la même pair de clefs (la clef privée est utilisée pour signer et la clef publique est seulement ajouté aux métadonnées de la signature).  Ils doivent contenir les clefs dans le format s-expression canonique produit par guix archive --generate-key (see Invoquer guix archive).  Par défaut, /etc/guix/signing-key.pub et /etc/guix/signing-key.sec sont utilisés.

--repl[=PORT]
-r [PORT]
     Crée un serveur REPL Guile  (see REPL Servers (GNU Guile Reference Manual)) sur PPORT (37146 par défaut).  C'est surtout utile pour déboguer un serveur guix publish qui tourne.

Activer guix publish sur un système GuixSD est vraiment une seule ligne : instantiez simplement un service guix-publish-service-type dans le champs services de votre déclaration operating-system (see guix-publish-service-type).

Si vous avez installé Guix sur une « distro extérieure », suivez ces instructions :

  * Si votre distro hôte utilise le système d'init systemd :

          # ln -s ~root/.guix-profile/lib/systemd/system/guix-publish.service \
                  /etc/systemd/system/
          # systemctl start guix-publish && systemctl enable guix-publish

  * Si votre distribution hôte utilise le système d'initialisation Upstart :

          # ln -s ~root/.guix-profile/lib/upstart/system/guix-publish.conf /etc/init/
          # start guix-publish

  * Sinon, procédez de manière similaire avec votre système d'init de votre distro.

Invoquer guix challenge
=======================

Est-ce que les binaires fournis par ce serveur correspondent réellement au code source qu'il dit avoir construit ? Est-ce que le processus de construction d'un paquet est déterministe ? Ce sont les question auxquelles la commande guix challenge essaye de répondre.

La première question est évidemment importante : avant d'utiliser un serveur de substituts (see Substituts), il vaut mieux vérifier qu'il fournit les bons binaires et donc le défier. La deuxième est ce qui permet la première : si les constructions des paquets sont déterministes alors des constructions indépendantes du paquet devraient donner le même résultat, bit à bit ; si un serveur fournit un binaire différent de celui obtenu localement, il peut être soit corrompu, soit malveillant.

On sait que le hash qui apparaît dans /gnu/store est le hash de toutes les entrées du processus qui construit le fichier ou le répertoire — les compilateurs, les bibliothèques, les scripts de construction, etc. (see Introduction).  En supposant que les processus de construction sont déterministes, un nom de fichier dans le dépôt devrait correspondre exactement à une sortie de construction.  guix challenge vérifie si il y a bien effectivement une seule correspondance en comparant les sorties de plusieurs constructions indépendantes d'un élément du dépôt donné.

La sortie de la commande ressemble à :

     $ guix challenge --substitute-urls="https://hydra.gnu.org https://guix.example.org"
     mise à jour de la liste des substituts depuis 'https://hydra.gnu.org'... 100.0%
     mise à jour de la liste des substituts depuis 'https://guix.example.org'... 100.0%
     le contenu de /gnu/store/...-openssl-1.0.2d diffère :
       empreinte locale : 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q
       https://hydra.gnu.org/nar/...-openssl-1.0.2d : 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q
       https://guix.example.org/nar/...-openssl-1.0.2d : 1zy4fmaaqcnjrzzajkdn3f5gmjk754b43qkq47llbyak9z0qjyim
     le contenu de /gnu/store/...-git-2.5.0 diffère :
       empreinte locale : 00p3bmryhjxrhpn2gxs2fy0a15lnip05l97205pgbk5ra395hyha
       https://hydra.gnu.org/nar/...-git-2.5.0 : 069nb85bv4d4a6slrwjdy8v1cn4cwspm3kdbmyb81d6zckj3nq9f
       https://guix.example.org/nar/...-git-2.5.0 : 0mdqa9w1p6cmli6976v4wi0sw9r4p5prkj7lzfd1877wk11c9c73
     le contenu de /gnu/store/...-pius-2.1.1 diffère :
       empreinte locale : 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax
       https://hydra.gnu.org/nar/...-pius-2.1.1 : 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax
       https://guix.example.org/nar/...-pius-2.1.1 : 1cy25x1a4fzq5rk0pmvc8xhwyffnqz95h2bpvqsz2mpvlbccy0gs

     ...

     6,406 éléments du dépôt ont été analysés :
       - 4,749 (74.1%) étaient identiques
       - 525 (8.2%) étaient différents
       - 1,132 (17.7%) étaient impossibles à évaluer

Dans cet exemple, guix challenge scanne d'abord le dépôt pour déterminer l'ensemble des dérivations construites localement — en opposition aux éléments qui ont été téléchargées depuis un serveur de substituts — puis demande leur avis à tous les serveurs de substituts.  Il rapporte ensuite les éléments du dépôt pour lesquels les serveurs ont obtenu un résultat différent de la construction locale.

Dans l'exemple, guix.example.org obtient toujours une réponse différente.  Inversement, hydra.gnu.org est d'accord avec les constructions locale, sauf dans le cas de Git.  Cela peut indiquer que le processus de construction de Git est non-déterministe, ce qui signifie que sa sortie diffère en fonction de divers choses que Guix ne contrôle pas parfaitement, malgré l'isolation des constructions (see Fonctionnalités).  Les sources les plus communes de non-déterminisme comprennent l'ajout d'horodatage dans les résultats des constructions, l'inclusion de nombres aléatoires et des listes de fichiers ordonnés par numéro d'inœud.  Voir https://reproducible-builds.org/docs/, pour plus d'informations.

Pour trouver ce qui ne va pas avec le binaire de Git, on peut faire quelque chose comme cela (see Invoquer guix archive) :

     $ wget -q -O - https://hydra.gnu.org/nar/...-git-2.5.0 \
        | guix archive -x /tmp/git
     $ diff -ur --no-dereference /gnu/store/...-git.2.5.0 /tmp/git

Cette commande montre les différences entre les fichiers qui résultent de la construction locale et des fichiers qui résultent de la construction sur hydra.gnu.org (see Comparing and Merging Files).  La commande diff fonctionne bien avec des fichiers texte.  Lorsque des fichiers binaires diffèrent cependant, Diffoscope (https://diffoscope.org/) est une meilleure option.  C'est un outil qui aide à visualiser les différences entre toute sorte de fichiers.

Une fois que vous avez fait ce travail, vous pourrez dire si les différences sont dues au non-déterminisme du processus de construction ou à la malhonnêteté du serveur.  Nous avons fait beaucoup d'effort pour éliminer les sources de non-déterminisme dans les paquets pour rendre plus facile la vérification des substituts, mais bien sûr, c'est un processus qui n'implique pas que Guix, mais une grande partie de la communauté des logiciels libres.  Pendant ce temps, guix challenge est un outil pour aider à corriger le problème.

Si vous écrivez un paquet pour Guix, nous vous encourageons à vérifier si hydra.gnu.org et d'autres serveurs de substituts obtiennent le même résultat que vous avec :

     $ guix challenge PAQUET

où PAQUET est une spécification de paquet comme guile@2.0 ou glibc:debug.

La syntaxe générale est :

     guix challenge OPTIONS [PAQUETS...]

Lorsqu'une différence est trouvée entre l'empreinte d'un élément construit localement et celle d'un substitut fournit par un serveur, ou parmi les substituts fournis par différents serveurs, la commande l'affiche comme dans l'exemple ci-dessus et sa valeur de sortie est 2 (les autres valeurs différentes de 0 indiquent d'autres sortes d'erreurs).

L'option qui compte est :

--substitute-urls=URLS
     Considère URLS comme la liste des URL des sources de substituts séparés par des espaces avec lesquels comparer les paquets locaux.

--verbose
-v
     Montre des détails sur les correspondances (contenu identique) en plus des informations sur différences.

Invoquer guix copy
==================

La commande guix copy copie des éléments du dépôt d'une machine vers le dépôt d'une autre machine à travers une connexion SSH (Cette commande n'est disponible que si Guile-SSH est trouvé.  See Prérequis, pour des détails).  Par exemple, la commande suivante copie le paquet coreutils, le profil utilisateur et toutes leurs dépendances sur HÔTE, en tant qu'utilisateur UTILISATEUR :

     guix copy --to=UTILISATEUR@HÔTE \
               coreutils `readlink -f ~/.guix-profile`

Si certains éléments à copier sont déjà présents sur HÔTE, ils ne sont pas envoyés.

La commande ci-dessous récupère libreoffice et gimp depuis HÔTE, en supposant qu'ils y sont présents :

     guix copy --from=HÔTE libreoffice gimp

La connexion SSH est établie avec le client Guile-SSH, qui set compatible avec OpenSSH : il honore ~/.ssh/known_hosts et ~/.ssh/config et utilise l'agent SSH pour l'authentification.

La clef utilisée pour signer les éléments qui sont envoyés doit être acceptée par la machine distante.  De même, la clef utilisée pour la machine distante depuis laquelle vous récupérez des éléments doit être dans /etc/guix/acl pour qu'ils soient acceptés par votre propre démon. See Invoquer guix archive, pour plus d'informations sur l'authentification des éléments du dépôt.

La syntaxe générale est :

     guix copy [--to=SPEC|--from=SPEC] ITEMS...

Vous devez toujours spécifier l'une des options suivantes :

--to=SPEC
--from=SPEC
     Spécifie l'hôte où envoyer ou d'où recevoir les éléments.  SPEC doit être une spécification SSH comme example.org, charlie@example.org ou charlie@example.org:2222.

L'option ITEMS peut être des noms de paquets, comme gimp ou des éléments du dépôt comme /gnu/store/...-idutils-4.6.

Lorsque vous spécifiez le nom d'un paquet à envoyer, il est d'abord construit au besoin, sauf si l'option --dry-run est spécifiée.  Les options de construction communes sont supportées (see Options de construction communes).

Invoquer guix container
=======================

     À la version VERSION, cet outil est toujours expérimental. L'interface est sujette à changement radicaux dans le futur.

Le but de guix container est de manipuler des processus qui tournent dans un environnement séparé, connus sous le nom de « conteneur », typiquement créés par les commandes guix environment (see Invoquer guix environment) et guix system container (see Invoquer guix system).

La syntaxe générale est :

     guix container ACTION OPTIONS...

ACTION spécifie les opérations à effectuer avec un conteneur, et OPTIONS spécifie les arguments spécifiques au contexte pour l'action.

Les actions suivantes sont disponibles :

exec
     Exécute une commande dans le contexte d'un conteneur lancé.

     La syntaxe est :

          guix container exec PID PROGRAMME ARGUMENTS...

     PID spécifie le PID du conteneur lancé.  PROGRAMME spécifie le nom du fichier exécutable dans le système de fichiers racine du conteneur. ARGUMENTS sont les options supplémentairesà passer à PROGRAMME.

     La commande suivante lance un shell de connexion interactif dans un conteneur GuixSD, démarré par guix system container et dont le PID est 9001 :

          guix container exec 9001 /run/current-system/profile/bin/bash --login

     Remarquez que PID ne peut pas être le processus parent d'un conteneur.  Ce doit être le PID 1 du conteneur ou l'un de ses processus fils.

Invoquer guix weather
=====================

Vous pouvez parfois grogner lorsque les substituts ne sont pas disponibles et que vous devez construire les paquets vous-même (see Substituts). La commande guix weather rapporte la disponibilité des substituts sur les serveurs spécifiés pour que vous sachiez si vous allez raller aujourd'hui. Cela peut parfois être une information utile pour les utilisateurs, mais elle est surtout utile pour les personnes qui font tourner guix publish (see Invoquer guix publish).

Voici un exemple :

     $ guix weather --substitute-urls=https://guix.example.org
     calcul de 5,872 dérivations de paquets pour x86_64-linux…
     recherche de 6,128 éléments du dépôt sur https://guix.example.org…
     mise à jour de la liste des substituts depuis 'https://guix.example.org'... 100.0%
     https://guix.example.org
       43.4% substituts disponibles (2,658 sur 6,128)
       7,032.5 Mo de fichiers nar (compressés)
       19,824.2 Mo sur le disque (décompressés)
       0.030 secondes par requêtes (182.9 secondes au total)
       33.5 requêtes par seconde

       9.8% (342 sur 3,470) des éléments manquants sont dans la queue
       867 constructions dans la queue
           x86_64-linux : 518 (59.7%)
           i686-linux : 221 (25.5%)
           aarch64-linux : 128 (14.8%)
       vitesse de construction : 23.41 constructions par heure
           x86_64-linux : 11.16 constructions par heure
           i686-linux : 6.03 constructions par heure
           aarch64-linux : 6.41 constructions par heure

Comme vous pouvez le voir, elle rapporte le pourcentage des paquets pour lesquels des substituts sont disponibles sur le serveur — indépendamment du fait que les substituts soient activés, et indépendamment du fait que la clef de signature du serveur soit autorisée.  Elle rapporte aussi la taille des archives compressées fournies par le serveur, la taille des éléments du dépôt correspondant dans le dépôt (en supposant que la déduplication soit désactivée) et la vitesse du serveur.  La deuxième partie donne des statistiques sur l'intégration continue (CI), si le serveur le supporte.

Pour cela, guix weather récupère par HTTP(S) les métadonnées (narinfos de tous les éléments du dépôts pertinents.  Comme guix challenge, il ignore les signatures de ces substituts, ce qui n'est pas dangereux puisque la commande ne fait que récupérer des statistiques et n'installe pas ces substituts.

Entre autres choses, il est possible de demander des types de système particuliers et des ensembles de paquets particuliers.  Les options disponibles sont listées plus bas.

--substitute-urls=URLS
     URLS est la liste des URL des serveurs de substituts séparés par des espaces.  Lorsque cette option n'est pas renseignée, l'ensemble des serveurs de substituts par défaut est utilisé.

--system=SYSTÈME
-s SYSTÈME
     Effectue des requêtes pour les substituts SYSTÈME — p. ex. aarch64-linux.  Cette option peut être répétée, auquel cas guix weather demandera les substituts de plusieurs types de systèmes.

--manifest=FICHIER
     Plutôt que de demander des substituts pour tous les paquets, demande uniquement les paquets spécifiés dans FICHIER.  FICHIER doit contenir un manifeste comme avec l'option -m de guix package (see Invoquer guix package).

Distribution GNU
****************

Guix fournit aussi une distribution du système GNU contenant uniquement des logiciels libres (Le terme « libre » se réfère ici bien sûr à la liberté offerte à l'utilisateur de ces logiciels (http://www.gnu.org/philosophy/free-sw.fr.html).).  On peut installer la distribution elle-même (see Installation du système), mais on peut aussi installer Guix comme gestionnaire de paquets par dessus un système GNU/Linux déjà installé (see Installation).  Pour distinguer ces deux cas, on appelle la distribution autonome « Distribution Système Guix » ou GuixSD.

The distribution provides core GNU packages such as GNU libc, GCC, and Binutils, as well as many GNU and non-GNU applications.  The complete list of available packages can be browsed on-line (http://www.gnu.org/software/guix/packages) or by running guix package (see Invoquer guix package):

     guix package --list-available

Our goal is to provide a practical 100% free software distribution of Linux-based and other variants of GNU, with a focus on the promotion and tight integration of GNU components, and an emphasis on programs and tools that help users exert that freedom.

Packages are currently available on the following platforms:

x86_64-linux
     Intel/AMD x86_64 architecture, Linux-Libre kernel;

i686-linux
     Intel 32-bit architecture (IA32), Linux-Libre kernel;

armhf-linux
     ARMv7-A architecture with hard float, Thumb-2 and NEON, using the EABI hard-float application binary interface (ABI), and Linux-Libre kernel.

aarch64-linux
     little-endian 64-bit ARMv8-A processors, Linux-Libre kernel.  This is currently in an experimental stage, with limited support. See Contribuer, for how to help!

mips64el-linux
     little-endian 64-bit MIPS processors, specifically the Loongson series, n32 ABI, and Linux-Libre kernel.

GuixSD itself is currently only available on i686 and x86_64.

For information on porting to other architectures or kernels, see Porter.

Building this distribution is a cooperative effort, and you are invited to join! See Contribuer, for information about how you can help.

Installation du système
=======================

This section explains how to install the Guix System Distribution (GuixSD) on a machine.  The Guix package manager can also be installed on top of a running GNU/Linux system, see Installation.

     You are reading this documentation with an Info reader.  For details on how to use it, hit the RET key (``return'' or ``enter'') on the link that follows: see Info reader (Stand-alone GNU Info).  Hit l afterwards to come back here.

     Alternately, run info info in another tty to keep the manual available.

Limitations
-----------

As of version VERSION, the Guix System Distribution (GuixSD) is not production-ready.  It may contain bugs and lack important features.  Thus, if you are looking for a stable production system that respects your freedom as a computer user, a good solution at this point is to consider one of the more established GNU/Linux distributions (http://www.gnu.org/distros/free-distros.html).  We hope you can soon switch to the GuixSD without fear, of course.  In the meantime, you can also keep using your distribution and try out the package manager on top of it (see Installation).

Before you proceed with the installation, be aware of the following noteworthy limitations applicable to version VERSION:

  * The installation process does not include a graphical user interface and requires familiarity with GNU/Linux (see the following subsections to get a feel of what that means.)

  * Support for the Logical Volume Manager (LVM) is missing.

  * More and more system services are provided (see Services), but some may be missing.

  * More than 7,500 packages are available, but you might occasionally find that a useful package is missing.

  * GNOME, Xfce, LXDE, and Enlightenment are available (see Services de bureaux), as well as a number of X11 window managers.  However, some graphical applications may be missing, as well as KDE.

You have been warned! But more than a disclaimer, this is an invitation to report issues (and success stories!), and to join us in improving it. See Contribuer, for more info.

Considérations matérielles
--------------------------

GNU GuixSD focuses on respecting the user's computing freedom.  It builds around the kernel Linux-libre, which means that only hardware for which free software drivers and firmware exist is supported.  Nowadays, a wide range of off-the-shelf hardware is supported on GNU/Linux-libre---from keyboards to graphics cards to scanners and Ethernet controllers. Unfortunately, there are still areas where hardware vendors deny users control over their own computing, and such hardware is not supported on GuixSD.

One of the main areas where free drivers or firmware are lacking is WiFi devices.  WiFi devices known to work include those using Atheros chips (AR9271 and AR7010), which corresponds to the ath9k Linux-libre driver, and those using Broadcom/AirForce chips (BCM43xx with Wireless-Core Revision 5), which corresponds to the b43-open Linux-libre driver. Free firmware exists for both and is available out-of-the-box on GuixSD, as part of %BASE-FIRMWARE (see firmware).

The Free Software Foundation (https://www.fsf.org/) runs Respects Your Freedom (https://www.fsf.org/ryf) (RYF), a certification program for hardware products that respect your freedom and your privacy and ensure that you have control over your device.  We encourage you to check the list of RYF-certified devices.

Another useful resource is the H-Node (https://www.h-node.org/) web site.  It contains a catalog of hardware devices with information about their support in GNU/Linux.

Installation depuis une clef USB ou un DVD
------------------------------------------

An ISO-9660 installation image that can be written to a USB stick or burnt to a DVD can be downloaded from https://alpha.gnu.org/gnu/guix/guixsd-install-VERSION.SYSTEM.iso.xz, where SYSTEM is one of:

x86_64-linux
     for a GNU/Linux system on Intel/AMD-compatible 64-bit CPUs;

i686-linux
     for a 32-bit GNU/Linux system on Intel-compatible CPUs.

Make sure to download the associated .sig file and to verify the authenticity of the image against it, along these lines:

     $ wget https://alpha.gnu.org/gnu/guix/guixsd-install-VERSION.SYSTEM.iso.xz.sig
     $ gpg --verify guixsd-install-VERSION.SYSTEM.iso.xz.sig

Si cette commande échoue parce que vous n'avez pas la clef publique requise, lancez cette commande pour l'importer :

     $ gpg --keyserver pgp.mit.edu --recv-keys 3CE464558A84FDC69DB40CFB090B11993D9AEBB5

et relancez la commande gpg --verify.

This image contains the tools necessary for an installation.  It is meant to be copied as is to a large-enough USB stick or DVD.

Copying to a USB Stick
......................

To copy the image to a USB stick, follow these steps:

 1. Decompress the image using the xz command:

          xz -d guixsd-install-VERSION.SYSTEM.iso.xz

 2. Insert a USB stick of 1 GiB or more into your machine, and determine its device name.  Assuming that the USB stick is known as /dev/sdX, copy the image with:

          dd if=guixsd-install-VERSION.x86_64-linux.iso of=/dev/sdX
          sync

     Access to /dev/sdX usually requires root privileges.

Burning on a DVD
................

To copy the image to a DVD, follow these steps:

 1. Decompress the image using the xz command:

          xz -d guixsd-install-VERSION.SYSTEM.iso.xz

 2. Insert a blank DVD into your machine, and determine its device name. Assuming that the DVD drive is known as /dev/srX, copy the image with:

          growisofs -dvd-compat -Z /dev/srX=guixsd-install-VERSION.x86_64.iso

     Access to /dev/srX usually requires root privileges.

Booting
.......

Once this is done, you should be able to reboot the system and boot from the USB stick or DVD.  The latter usually requires you to get in the BIOS or UEFI boot menu, where you can choose to boot from the USB stick.

See Installer GuixSD dans une VM, if, instead, you would like to install GuixSD in a virtual machine (VM).

Préparer l'installation
-----------------------

Once you have successfully booted your computer using the installation medium, you should end up with a root prompt.  Several console TTYs are configured and can be used to run commands as root.  TTY2 shows this documentation, browsable using the Info reader commands (see Stand-alone GNU Info).  The installation system runs the GPM mouse daemon, which allows you to select text with the left mouse button and to paste it with the middle button.

     Installation requires access to the Internet so that any missing dependencies of your system configuration can be downloaded.  See the ``Networking'' section below.

The installation system includes many common tools needed for this task. But it is also a full-blown GuixSD system, which means that you can install additional packages, should you need it, using guix package (see Invoquer guix package).

Keyboard Layout
...............

The installation image uses the US qwerty keyboard layout.  If you want to change it, you can use the loadkeys command.  For example, the following command selects the Dvorak keyboard layout:

     loadkeys dvorak

See the files under /run/current-system/profile/share/keymaps for a list of available keyboard layouts.  Run man loadkeys for more information.

Networking
..........

Run the following command see what your network interfaces are called:

     ifconfig -a

... or, using the GNU/Linux-specific ip command:

     ip a

Wired interfaces have a name starting with e; for example, the interface corresponding to the first on-board Ethernet controller is called eno1.  Wireless interfaces have a name starting with w, like w1p2s0.

Wired connection
     To configure a wired network run the following command, substituting INTERFACE with the name of the wired interface you want to use.

          ifconfig INTERFACE up

Wireless connection
     To configure wireless networking, you can create a configuration file for the wpa_supplicant configuration tool (its location is not important) using one of the available text editors such as nano:

          nano wpa_supplicant.conf

     As an example, the following stanza can go to this file and will work for many wireless networks, provided you give the actual SSID and passphrase for the network you are connecting to:

          network={
            ssid="MY-SSID"
            key_mgmt=WPA-PSK
            psk="the network's secret passphrase"
          }

     Start the wireless service and run it in the background with the following command (substitute INTERFACE with the name of the network interface you want to use):

          wpa_supplicant -c wpa_supplicant.conf -i INTERFACE -B

     Run man wpa_supplicant for more information.

At this point, you need to acquire an IP address.  On a network where IP addresses are automatically assigned via DHCP, you can run:

     dhclient -v INTERFACE

Try to ping a server to see if networking is up and running:

     ping -c 3 gnu.org

Setting up network access is almost always a requirement because the image does not contain all the software and tools that may be needed.

If you want to, you can continue the installation remotely by starting an SSH server:

     herd start ssh-daemon

Make sure to either set a password with passwd, or configure OpenSSH public key authentication before logging in.

Disk Partitioning
.................

Unless this has already been done, the next step is to partition, and then format the target partition(s).

The installation image includes several partitioning tools, including Parted (see Overview (GNU Parted User Manual)), fdisk, and cfdisk.  Run it and set up your disk with the partition layout you want:

     cfdisk

If your disk uses the GUID Partition Table (GPT) format and you plan to install BIOS-based GRUB (which is the default), make sure a BIOS Boot Partition is available (see BIOS installation (GNU GRUB manual)).

If you instead wish to use EFI-based GRUB, a FAT32 EFI System Partition (ESP) is required.  This partition should be mounted at /boot/efi and must have the esp flag set.  E.g., for parted:

     parted /dev/sda set 1 esp on

     Unsure whether to use EFI- or BIOS-based GRUB? If the directory /sys/firmware/efi exists in the installation image, then you should probably perform an EFI installation, using grub-efi-bootloader. Otherwise you should use the BIOS-based GRUB, known as grub-bootloader.  See Configuration du chargeur d'amorçage, for more info on bootloaders.

Once you are done partitioning the target hard disk drive, you have to create a file system on the relevant partition(s) (Currently GuixSD only supports ext4 and btrfs file systems.  In particular, code that reads file system UUIDs and labels only works for these file system types.).  For the ESP, if you have one and assuming it is /dev/sda1, run:

     mkfs.fat -F32 /dev/sda1

Preferably, assign file systems a label so that you can easily and reliably refer to them in file-system declarations (see Systèmes de fichiers). This is typically done using the -L option of mkfs.ext4 and related commands.  So, assuming the target root partition lives at /dev/sda2, a file system with the label my-root can be created with:

     mkfs.ext4 -L my-root /dev/sda2

If you are instead planning to encrypt the root partition, you can use the Cryptsetup/LUKS utilities to do that (see man cryptsetup for more information.)  Assuming you want to store the root partition on /dev/sda2, the command sequence would be along these lines:

     cryptsetup luksFormat /dev/sda2
     cryptsetup open --type luks /dev/sda2 my-partition
     mkfs.ext4 -L my-root /dev/mapper/my-partition

Once that is done, mount the target file system under /mnt with a command like (again, assuming my-root is the label of the root file system):

     mount LABEL=my-root /mnt

Also mount any other file systems you would like to use on the target system relative to this path.  If you have /boot on a separate partition for example, mount it at /mnt/boot now so it is found by guix system init afterwards.

Finally, if you plan to use one or more swap partitions (see swap space (The GNU C Library Reference Manual)), make sure to initialize them with mkswap.  Assuming you have one swap partition on /dev/sda3, you would run:

     mkswap /dev/sda3
     swapon /dev/sda3

Alternatively, you may use a swap file.  For example, assuming that in the new system you want to use the file /swapfile as a swap file, you would run (This example will work for many types of file systems (e.g., ext4).  However, for copy-on-write file systems (e.g., btrfs), the required steps may be different.  For details, see the manual pages for mkswap and swapon.):

     # This is 10 GiB of swap space.  Adjust "count" to change the size.
     dd if=/dev/zero of=/mnt/swapfile bs=1MiB count=10240
     # For security, make the file readable and writable only by root.
     chmod 600 /mnt/swapfile
     mkswap /mnt/swapfile
     swapon /mnt/swapfile

Note that if you have encrypted the root partition and created a swap file in its file system as described above, then the encryption also protects the swap file, just like any other file in that file system.

Effectuer l'installation
------------------------

With the target partitions ready and the target root mounted on /mnt, we're ready to go.  First, run:

     herd start cow-store /mnt

This makes /gnu/store copy-on-write, such that packages added to it during the installation phase are written to the target disk on /mnt rather than kept in memory.  This is necessary because the first phase of the guix system init command (see below) entails downloads or builds to /gnu/store which, initially, is an in-memory file system.

Next, you have to edit a file and provide the declaration of the operating system to be installed.  To that end, the installation system comes with three text editors.  We recommend GNU nano (see GNU nano Manual), which supports syntax highlighting and parentheses matching; other editors include GNU Zile (an Emacs clone), and nvi (a clone of the original BSD vi editor).  We strongly recommend storing that file on the target root file system, say, as /mnt/etc/config.scm.  Failing to do that, you will have lost your configuration file once you have rebooted into the newly-installed system.

See Utiliser le système de configuration, for an overview of the configuration file.  The example configurations discussed in that section are available under /etc/configuration in the installation image.  Thus, to get started with a system configuration providing a graphical display server (a ``desktop'' system), you can run something along these lines:

     # mkdir /mnt/etc
     # cp /etc/configuration/desktop.scm /mnt/etc/config.scm
     # nano /mnt/etc/config.scm

You should pay attention to what your configuration file contains, and in particular:

  * Make sure the bootloader-configuration form refers to the target you want to install GRUB on.  It should mention grub-bootloader if you are installing GRUB in the legacy way, or grub-efi-bootloader for newer UEFI systems.  For legacy systems, the target field names a device, like /dev/sda; for UEFI systems it names a path to a mounted EFI partition, like /boot/efi, and do make sure the path is actually mounted.

  * Be sure that your file system labels match the value of their respective device fields in your file-system configuration, assuming your file-system configuration sets the value of title to 'label.

  * If there are encrypted or RAID partitions, make sure to add a mapped-devices field to describe them (see Périphériques mappés).

Once you are done preparing the configuration file, the new system must be initialized (remember that the target root file system is mounted under /mnt):

     guix system init /mnt/etc/config.scm /mnt

This copies all the necessary files and installs GRUB on /dev/sdX, unless you pass the --no-bootloader option.  For more information, see Invoquer guix system.  This command may trigger downloads or builds of missing packages, which can take some time.

Once that command has completed---and hopefully succeeded!---you can run reboot and boot into the new system.  The root password in the new system is initially empty; other users' passwords need to be initialized by running the passwd command as root, unless your configuration specifies otherwise (see user account passwords).

From then on, you can update GuixSD whenever you want by running guix pull as root (see Invoquer guix pull), and then running guix system reconfigure to build a new system generation with the latest packages and services (see Invoquer guix system).  We recommend doing that regularly so that your system includes the latest security updates (see Mises à jour de sécurité).

Join us on #guix on the Freenode IRC network or on guix-devel@gnu.org to share your experience---good or not so good.

Installing GuixSD in a Virtual Machine
--------------------------------------

If you'd like to install GuixSD in a virtual machine (VM) or on a virtual private server (VPS) rather than on your beloved machine, this section is for you.

To boot a QEMU (http://qemu.org/) VM for installing GuixSD in a disk image, follow these steps:

 1. First, retrieve and decompress the GuixSD installation image as described previously (see Installation depuis une clef USB ou un DVD).

 2. Create a disk image that will hold the installed system.  To make a qcow2-formatted disk image, use the qemu-img command:

          qemu-img create -f qcow2 guixsd.img 50G

     The resulting file will be much smaller than 50 GB (typically less than 1 MB), but it will grow as the virtualized storage device is filled up.

 3. Boot the USB installation image in an VM:

          qemu-system-x86_64 -m 1024 -smp 1 \
            -net user -net nic,model=virtio -boot menu=on \
            -drive file=guixsd-install-VERSION.SYSTEM.iso \
            -drive file=guixsd.img

     The ordering of the drives matters.

     In the VM console, quickly press the F12 key to enter the boot menu. Then press the 2 key and the RET key to validate your selection.

 4. You're now root in the VM, proceed with the installation process. See Préparer l'installation, and follow the instructions.

Once installation is complete, you can boot the system that's on your guixsd.img image.  See Lancer GuixSD dans une VM, for how to do that.

Construire l'image d'installation
---------------------------------

The installation image described above was built using the guix system command, specifically:

     guix system disk-image gnu/system/install.scm

Have a look at gnu/system/install.scm in the source tree, and see also Invoquer guix system for more information about the installation image.

Construire l'image d'installation pour les cartes ARM
-----------------------------------------------------

Many ARM boards require a specific variant of the U-Boot (http://www.denx.de/wiki/U-Boot/) bootloader.

If you build a disk image and the bootloader is not available otherwise (on another boot drive etc), it's advisable to build an image that includes the bootloader, specifically:

     guix system disk-image --system=armhf-linux -e '((@ (gnu system install) os-with-u-boot) (@ (gnu system install) installation-os) "A20-OLinuXino-Lime2")'

A20-OLinuXino-Lime2 is the name of the board.  If you specify an invalid board, a list of possible boards will be printed.

Configuration système
=====================

The Guix System Distribution supports a consistent whole-system configuration mechanism.  By that we mean that all aspects of the global system configuration---such as the available system services, timezone and locale settings, user accounts---are declared in a single place.  Such a system configuration can be instantiated---i.e., effected.

One of the advantages of putting all the system configuration under the control of Guix is that it supports transactional system upgrades, and makes it possible to roll back to a previous system instantiation, should something go wrong with the new one (see Fonctionnalités).  Another advantage is that it makes it easy to replicate the exact same configuration across different machines, or at different points in time, without having to resort to additional administration tools layered on top of the own tools of the system.

This section describes this mechanism.  First we focus on the system administrator's viewpoint---explaining how the system is configured and instantiated.  Then we show how this mechanism can be extended, for instance to support new system services.

Utiliser le système de configuration
------------------------------------

The operating system is configured by providing an operating-system declaration in a file that can then be passed to the guix system command (see Invoquer guix system).  A simple setup, with the default system services, the default Linux-Libre kernel, initial RAM disk, and boot loader looks like this:

          [file os-config-bare-bones.texi not included]

This example should be self-describing.  Some of the fields defined above, such as host-name and bootloader, are mandatory.  Others, such as packages and services, can be omitted, in which case they get a default value.

Below we discuss the effect of some of the most important fields (see Référence de système d'exploitation, for details about all the available fields), and how to instantiate the operating system using guix system.

Bootloader
..........

The bootloader field describes the method that will be used to boot your system.  Machines based on Intel processors can boot in ``legacy'' BIOS mode, as in the example above.  However, more recent machines rely instead on the Unified Extensible Firmware Interface (UEFI) to boot.  In that case, the bootloader field should contain something along these lines:

     (bootloader-configuration
       (bootloader grub-efi-bootloader)
       (target "/boot/efi"))

See Configuration du chargeur d'amorçage, for more information on the available configuration options.

Globally-Visible Packages
.........................

The packages field lists packages that will be globally visible on the system, for all user accounts---i.e., in every user's PATH environment variable---in addition to the per-user profiles (see Invoquer guix package).  The %BASE-PACKAGES variable provides all the tools one would expect for basic user and administrator tasks---including the GNU Core Utilities, the GNU Networking Utilities, the GNU Zile lightweight text editor, find, grep, etc.  The example above adds GNU Screen and OpenSSH to those, taken from the (gnu packages screen) and (gnu packages ssh) modules (see Modules de paquets). The (list package output) syntax can be used to add a specific output of a package:

     (use-modules (gnu packages))
     (use-modules (gnu packages dns))

     (operating-system
       ;; ...
       (packages (cons (list bind "utils")
                       %base-packages)))

Referring to packages by variable name, like bind above, has the advantage of being unambiguous; it also allows typos and such to be diagnosed right away as ``unbound variables''.  The downside is that one needs to know which module defines which package, and to augment the use-package-modules line accordingly.  To avoid that, one can use the specification->package procedure of the (gnu packages) module, which returns the best package for a given name or name and version:

     (use-modules (gnu packages))

     (operating-system
       ;; ...
       (packages (append (map specification->package
                              '("tcpdump" "htop" "gnupg@2.0"))
                         %base-packages)))

System Services
...............

The services field lists system services to be made available when the system starts (see Services).  The operating-system declaration above specifies that, in addition to the basic services, we want the lshd secure shell daemon listening on port 2222 (see lsh-service).  Under the hood, lsh-service arranges so that lshd is started with the right command-line options, possibly with supporting configuration files generated as needed (see Définir des services).

Occasionally, instead of using the base services as is, you will want to customize them.  To do this, use modify-services (see modify-services) to modify the list.

For example, suppose you want to modify guix-daemon and Mingetty (the console log-in) in the %BASE-SERVICES list (see %base-services).  To do that, you can write the following in your operating system declaration:

     (define %my-services
       ;; My very own list of services.
       (modify-services %base-services
         (guix-service-type config =>
                            (guix-configuration
                             (inherit config)
                             (use-substitutes? #f)
                             (extra-options '("--gc-keep-derivations"))))
         (mingetty-service-type config =>
                                (mingetty-configuration
                                 (inherit config)))))

     (operating-system
       ;; ...
       (services %my-services))

This changes the configuration---i.e., the service parameters---of the guix-service-type instance, and that of all the mingetty-service-type instances in the %BASE-SERVICES list. Observe how this is accomplished: first, we arrange for the original configuration to be bound to the identifier config in the BODY, and then we write the BODY so that it evaluates to the desired configuration.  In particular, notice how we use inherit to create a new configuration which has the same values as the old configuration, but with a few modifications.

The configuration for a typical ``desktop'' usage, with an encrypted root partition, the X11 display server, GNOME and Xfce (users can choose which of these desktop environments to use at the log-in screen by pressing F1), network management, power management, and more, would look like this:

          [file os-config-desktop.texi not included]

A graphical system with a choice of lightweight window managers instead of full-blown desktop environments would look like this:

          [file os-config-lightweight-desktop.texi not included]

This example refers to the /boot/efi file system by its UUID, 1234-ABCD.  Replace this UUID with the right UUID on your system, as returned by the blkid command.

See Services de bureaux, for the exact list of services provided by %DESKTOP-SERVICES.  See Certificats X.509, for background information about the nss-certs package that is used here.

Again, %DESKTOP-SERVICES is just a list of service objects.  If you want to remove services from there, you can do so using the procedures for list filtering (see SRFI-1 Filtering and Partitioning (GNU Guile Reference Manual)).  For instance, the following expression returns a list that contains all the services in %DESKTOP-SERVICES minus the Avahi service:

     (remove (lambda (service)
               (eq? (service-kind service) avahi-service-type))
             %desktop-services)

Instantiating the System
........................

Assuming the operating-system declaration is stored in the my-system-config.scm file, the guix system reconfigure my-system-config.scm command instantiates that configuration, and makes it the default GRUB boot entry (see Invoquer guix system).

The normal way to change the system configuration is by updating this file and re-running guix system reconfigure.  One should never have to touch files in /etc or to run commands that modify the system state such as useradd or grub-install.  In fact, you must avoid that since that would not only void your warranty but also prevent you from rolling back to previous versions of your system, should you ever need to.

Speaking of roll-back, each time you run guix system reconfigure, a new generation of the system is created---without modifying or deleting previous generations.  Old system generations get an entry in the bootloader boot menu, allowing you to boot them in case something went wrong with the latest generation.  Reassuring, no? The guix system list-generations command lists the system generations available on disk. It is also possible to roll back the system via the commands guix system roll-back and guix system switch-generation.

Although the command guix system reconfigure will not modify previous generations, must take care when the current generation is not the latest (e.g., after invoking guix system roll-back), since the operation might overwrite a later generation (see Invoquer guix system).

The Programming Interface
.........................

At the Scheme level, the bulk of an operating-system declaration is instantiated with the following monadic procedure (see La monad du dépôt):

 -- Monadic Procedure: operating-system-derivation os
     Return a derivation that builds OS, an operating-system object (see Dérivations).

     The output of the derivation is a single directory that refers to all the packages, configuration files, and other supporting files needed to instantiate OS.

This procedure is provided by the (gnu system) module.  Along with (gnu services) (see Services), this module contains the guts of GuixSD.  Make sure to visit it!

operating-system Reference
--------------------------

This section summarizes all the options available in operating-system declarations (see Utiliser le système de configuration).

 -- Data Type: operating-system
     This is the data type representing an operating system configuration.  By that, we mean all the global system configuration, not per-user configuration (see Utiliser le système de configuration).

     kernel (default: LINUX-LIBRE)
          The package object of the operating system kernel to use (Currently only the Linux-libre kernel is supported.  In the future, it will be possible to use the GNU Hurd.).

     kernel-arguments (default: '())
          List of strings or gexps representing additional arguments to pass on the command-line of the kernel---e.g., ("console=ttyS0").

     bootloader
          The system bootloader configuration object.  See Configuration du chargeur d'amorçage.

     initrd-modules (default: %base-initrd-modules)
          The list of Linux kernel modules that need to be available in the initial RAM disk.  See Disque de RAM initial.

     initrd (default: base-initrd)
          A monadic procedure that returns an initial RAM disk for the Linux kernel. This field is provided to support low-level customization and should rarely be needed for casual use.  See Disque de RAM initial.

     firmware (default: %BASE-FIRMWARE)
          List of firmware packages loadable by the operating system kernel.

          The default includes firmware needed for Atheros- and Broadcom-based WiFi devices (Linux-libre modules ath9k and b43-open, respectively).  See Considérations matérielles, for more info on supported hardware.

     host-name
          The host name.

     hosts-file
          A file-like object (see file-like objects) for use as /etc/hosts (see Host Names (The GNU C Library Reference Manual)).  The default is a file with entries for localhost and HOST-NAME.

     mapped-devices (default: '())
          A list of mapped devices.  See Périphériques mappés.

     file-systems
          A list of file systems.  See Systèmes de fichiers.

     swap-devices (default: '())
          A list of strings identifying devices or files to be used for ``swap space'' (see Memory Concepts (The GNU C Library Reference Manual)).  For example, '("/dev/sda3") or '("/swapfile").  It is possible to specify a swap file in a file system on a mapped device, provided that the necessary device mapping and file system are also specified.  See Périphériques mappés and Systèmes de fichiers.

     users (default: %base-user-accounts)
     groups (default: %BASE-GROUPS)
          List of user accounts and groups.  See Comptes utilisateurs.

          If the users list lacks a user account with UID 0, a ``root'' account with UID 0 is automatically added.

     skeletons (default: (default-skeletons))
          A list target file name/file-like object tuples (see file-like objects).  These are the skeleton files that will be added to the home directory of newly-created user accounts.

          For instance, a valid value may look like this:

               `((".bashrc" ,(plain-file "bashrc" "echo Hello\n"))
                 (".guile" ,(plain-file "guile"
                                        "(use-modules (ice-9 readline))
                                         (activate-readline)")))

     issue (default: %DEFAULT-ISSUE)
          A string denoting the contents of the /etc/issue file, which is displayed when users log in on a text console.

     packages (default: %BASE-PACKAGES)
          The set of packages installed in the global profile, which is accessible at /run/current-system/profile.

          The default set includes core utilities and it is good practice to install non-core utilities in user profiles (see Invoquer guix package).

     timezone
          A timezone identifying string---e.g., "Europe/Paris".

          You can run the tzselect command to find out which timezone string corresponds to your region.  Choosing an invalid timezone name causes guix system to fail.

     locale (default: "en_US.utf8")
          The name of the default locale (see Locale Names (The GNU C Library Reference Manual)).  See Régionalisation, for more information.

     locale-definitions (default: %DEFAULT-LOCALE-DEFINITIONS)
          The list of locale definitions to be compiled and that may be used at run time.  See Régionalisation.

     locale-libcs (default: (list GLIBC))
          The list of GNU libc packages whose locale data and tools are used to build the locale definitions.  See Régionalisation, for compatibility considerations that justify this option.

     name-service-switch (default: %DEFAULT-NSS)
          Configuration of the libc name service switch (NSS)---a <name-service-switch> object.  See Name Service Switch, for details.

     services (default: %BASE-SERVICES)
          A list of service objects denoting system services.  See Services.

     pam-services (default: (base-pam-services))
          Linux pluggable authentication module (PAM) services.

     setuid-programs (default: %SETUID-PROGRAMS)
          List of string-valued G-expressions denoting setuid programs.  See Programmes setuid.

     sudoers-file (default: %SUDOERS-SPECIFICATION)
          The contents of the /etc/sudoers file as a file-like object (see local-file and plain-file).

          This file specifies which users can use the sudo command, what they are allowed to do, and what privileges they may gain.  The default is that only root and members of the wheel group may use sudo.

Systèmes de fichiers
--------------------

The list of file systems to be mounted is specified in the file-systems field of the operating system declaration (see Utiliser le système de configuration).  Each file system is declared using the file-system form, like this:

     (file-system
       (mount-point "/home")
       (device "/dev/sda3")
       (type "ext4"))

As usual, some of the fields are mandatory---those shown in the example above---while others can be omitted.  These are described below.

 -- Data Type: file-system
     Objects of this type represent file systems to be mounted.  They contain the following members:

     type
          This is a string specifying the type of the file system---e.g., "ext4".

     mount-point
          This designates the place where the file system is to be mounted.

     device
          This names the ``source'' of the file system.  It can be one of three things: a file system label, a file system UUID, or the name of a /dev node.  Labels and UUIDs offer a way to refer to file systems without having to hard-code their actual device name (Note that, while it is tempting to use /dev/disk/by-uuid and similar device names to achieve the same result, this is not recommended: These special device nodes are created by the udev daemon and may be unavailable at the time the device is mounted.).

          File system labels are created using the file-system-label procedure, UUIDs are created using uuid, and /dev node are plain strings.  Here's an example of a file system referred to by its label, as shown by the e2label command:

               (file-system
                 (mount-point "/home")
                 (type "ext4")
                 (device (file-system-label "my-home")))

          UUIDs are converted from their string representation (as shown by the tune2fs -l command) using the uuid form (The uuid form expects 16-byte UUIDs as defined in RFC 4122 (https://tools.ietf.org/html/rfc4122).  This is the form of UUID used by the ext2 family of file systems and others, but it is different from ``UUIDs'' found in FAT file systems, for instance.), like this:

               (file-system
                 (mount-point "/home")
                 (type "ext4")
                 (device (uuid "4dab5feb-d176-45de-b287-9b0a6e4c01cb")))

          When the source of a file system is a mapped device (see Périphériques mappés), its device field must refer to the mapped device name---e.g., "/dev/mapper/root-partition".  This is required so that the system knows that mounting the file system depends on having the corresponding device mapping established.

     flags (default: '())
          This is a list of symbols denoting mount flags.  Recognized flags include read-only, bind-mount, no-dev (disallow access to special files), no-suid (ignore setuid and setgid bits), and no-exec (disallow program execution.)

     options (default: #f)
          This is either #f, or a string denoting mount options.

     mount? (default: #t)
          This value indicates whether to automatically mount the file system when the system is brought up.  When set to #f, the file system gets an entry in /etc/fstab (read by the mount command) but is not automatically mounted.

     needed-for-boot? (default: #f)
          This Boolean value indicates whether the file system is needed when booting.  If that is true, then the file system is mounted when the initial RAM disk (initrd) is loaded.  This is always the case, for instance, for the root file system.

     check? (default: #t)
          This Boolean indicates whether the file system needs to be checked for errors before being mounted.

     create-mount-point? (default: #f)
          When true, the mount point is created if it does not exist yet.

     dependencies (default: '())
          This is a list of <file-system> or <mapped-device> objects representing file systems that must be mounted or mapped devices that must be opened before (and unmounted or closed after) this one.

          As an example, consider a hierarchy of mounts: /sys/fs/cgroup is a dependency of /sys/fs/cgroup/cpu and /sys/fs/cgroup/memory.

          Another example is a file system that depends on a mapped device, for example for an encrypted partition (see Périphériques mappés).

The (gnu system file-systems) exports the following useful variables.

 -- Scheme Variable: %base-file-systems
     These are essential file systems that are required on normal systems, such as %PSEUDO-TERMINAL-FILE-SYSTEM and %IMMUTABLE-STORE (see below.)  Operating system declarations should always contain at least these.

 -- Scheme Variable: %pseudo-terminal-file-system
     This is the file system to be mounted as /dev/pts.  It supports pseudo-terminals created via openpty and similar functions (see Pseudo-Terminals (The GNU C Library Reference Manual)). Pseudo-terminals are used by terminal emulators such as xterm.

 -- Scheme Variable: %shared-memory-file-system
     This file system is mounted as /dev/shm and is used to support memory sharing across processes (see shm_open (The GNU C Library Reference Manual)).

 -- Scheme Variable: %immutable-store
     This file system performs a read-only ``bind mount'' of /gnu/store, making it read-only for all the users including root.  This prevents against accidental modification by software running as root or by system administrators.

     The daemon itself is still able to write to the store: it remounts it read-write in its own ``name space.''

 -- Scheme Variable: %binary-format-file-system
     The binfmt_misc file system, which allows handling of arbitrary executable file types to be delegated to user space.  This requires the binfmt.ko kernel module to be loaded.

 -- Scheme Variable: %fuse-control-file-system
     The fusectl file system, which allows unprivileged users to mount and unmount user-space FUSE file systems.  This requires the fuse.ko kernel module to be loaded.

Périphériques mappés
--------------------

The Linux kernel has a notion of device mapping: a block device, such as a hard disk partition, can be mapped into another device, usually in /dev/mapper/, with additional processing over the data that flows through it (Note that the GNU Hurd makes no difference between the concept of a ``mapped device'' and that of a file system: both boil down to translating input/output operations made on a file to operations on its backing store.  Thus, the Hurd implements mapped devices, like file systems, using the generic translator mechanism (see Translators (The GNU Hurd Reference Manual)).).  A typical example is encryption device mapping: all writes to the mapped device are encrypted, and all reads are deciphered, transparently.  Guix extends this notion by considering any device or set of devices that are transformed in some way to create a new device; for instance, RAID devices are obtained by assembling several other devices, such as hard disks or partitions, into a new one that behaves as one partition.  Other examples, not yet implemented, are LVM logical volumes.

Mapped devices are declared using the mapped-device form, defined as follows; for examples, see below.

 -- Data Type: mapped-device
     Objects of this type represent device mappings that will be made when the system boots up.

     source
          This is either a string specifying the name of the block device to be mapped, such as "/dev/sda3", or a list of such strings when several devices need to be assembled for creating a new one.

     target
          This string specifies the name of the resulting mapped device.  For kernel mappers such as encrypted devices of type luks-device-mapping, specifying "my-partition" leads to the creation of the "/dev/mapper/my-partition" device.  For RAID devices of type raid-device-mapping, the full device name such as "/dev/md0" needs to be given.

     type
          This must be a mapped-device-kind object, which specifies how SOURCE is mapped to TARGET.

 -- Scheme Variable: luks-device-mapping
     This defines LUKS block device encryption using the cryptsetup command from the package with the same name.  It relies on the dm-crypt Linux kernel module.

 -- Scheme Variable: raid-device-mapping
     This defines a RAID device, which is assembled using the mdadm command from the package with the same name.  It requires a Linux kernel module for the appropriate RAID level to be loaded, such as raid456 for RAID-4, RAID-5 or RAID-6, or raid10 for RAID-10.

The following example specifies a mapping from /dev/sda3 to /dev/mapper/home using LUKS---the Linux Unified Key Setup (https://gitlab.com/cryptsetup/cryptsetup), a standard mechanism for disk encryption.  The /dev/mapper/home device can then be used as the device of a file-system declaration (see Systèmes de fichiers).

     (mapped-device
       (source "/dev/sda3")
       (target "home")
       (type luks-device-mapping))

Alternatively, to become independent of device numbering, one may obtain the LUKS UUID (unique identifier) of the source device by a command like:

     cryptsetup luksUUID /dev/sda3

and use it as follows:

     (mapped-device
       (source (uuid "cb67fc72-0d54-4c88-9d4b-b225f30b0f44"))
       (target "home")
       (type luks-device-mapping))

It is also desirable to encrypt swap space, since swap space may contain sensitive data.  One way to accomplish that is to use a swap file in a file system on a device mapped via LUKS encryption.  In this way, the swap file is encrypted because the entire device is encrypted.  See Disk Partitioning, for an example.

A RAID device formed of the partitions /dev/sda1 and /dev/sdb1 may be declared as follows:

     (mapped-device
       (source (list "/dev/sda1" "/dev/sdb1"))
       (target "/dev/md0")
       (type raid-device-mapping))

The /dev/md0 device can then be used as the device of a file-system declaration (see Systèmes de fichiers).  Note that the RAID level need not be given; it is chosen during the initial creation and formatting of the RAID device and is determined automatically later.

Comptes utilisateurs
--------------------

User accounts and groups are entirely managed through the operating-system declaration.  They are specified with the user-account and user-group forms:

     (user-account
       (name "alice")
       (group "users")
       (supplementary-groups '("wheel"   ;allow use of sudo, etc.
                               "audio"   ;sound card
                               "video"   ;video devices such as webcams
                               "cdrom")) ;the good ol' CD-ROM
       (comment "Bob's sister")
       (home-directory "/home/alice"))

When booting or upon completion of guix system reconfigure, the system ensures that only the user accounts and groups specified in the operating-system declaration exist, and with the specified properties.  Thus, account or group creations or modifications made by directly invoking commands such as useradd are lost upon reconfiguration or reboot.  This ensures that the system remains exactly as declared.

 -- Data Type: user-account
     Objects of this type represent user accounts.  The following members may be specified:

     name
          The name of the user account.

     group
          This is the name (a string) or identifier (a number) of the user group this account belongs to.

     supplementary-groups (default: '())
          Optionally, this can be defined as a list of group names that this account belongs to.

     uid (default: #f)
          This is the user ID for this account (a number), or #f.  In the latter case, a number is automatically chosen by the system when the account is created.

     comment (default: "")
          A comment about the account, such as the account owner's full name.

     home-directory
          This is the name of the home directory for the account.

     create-home-directory? (default: #t)
          Indicates whether the home directory of this account should be created if it does not exist yet.

     shell (default: Bash)
          This is a G-expression denoting the file name of a program to be used as the shell (see G-Expressions).

     system? (default: #f)
          This Boolean value indicates whether the account is a ``system'' account. System accounts are sometimes treated specially; for instance, graphical login managers do not list them.

     password (default: #f)
          You would normally leave this field to #f, initialize user passwords as root with the passwd command, and then let users change it with passwd.  Passwords set with passwd are of course preserved across reboot and reconfiguration.

          If you do want to have a preset password for an account, then this field must contain the encrypted password, as a string.  See crypt (The GNU C Library Reference Manual), for more information on password encryption, and Encryption (GNU Guile Reference Manual), for information on Guile's crypt procedure.

User group declarations are even simpler:

     (user-group (name "students"))

 -- Data Type: user-group
     This type is for, well, user groups.  There are just a few fields:

     name
          The name of the group.

     id (default: #f)
          The group identifier (a number).  If #f, a new number is automatically allocated when the group is created.

     system? (default: #f)
          This Boolean value indicates whether the group is a ``system'' group. System groups have low numerical IDs.

     password (default: #f)
          What, user groups can have a password? Well, apparently yes.  Unless #f, this field specifies the password of the group.

For convenience, a variable lists all the basic user groups one may expect:

 -- Scheme Variable: %base-groups
     This is the list of basic user groups that users and/or packages expect to be present on the system.  This includes groups such as ``root'', ``wheel'', and ``users'', as well as groups used to control access to specific devices such as ``audio'', ``disk'', and ``cdrom''.

 -- Scheme Variable: %base-user-accounts
     This is the list of basic system accounts that programs may expect to find on a GNU/Linux system, such as the ``nobody'' account.

     Note that the ``root'' account is not included here.  It is a special-case and is automatically added whether or not it is specified.

Régionalisation
---------------

A locale defines cultural conventions for a particular language and region of the world (see Régionalisation (The GNU C Library Reference Manual)).  Each locale has a name that typically has the form LANGUAGE_TERRITORY.CODESET---e.g., fr_LU.utf8 designates the locale for the French language, with cultural conventions from Luxembourg, and using the UTF-8 encoding.

Usually, you will want to specify the default locale for the machine using the locale field of the operating-system declaration (see locale).

The selected locale is automatically added to the locale definitions known to the system if needed, with its codeset inferred from its name---e.g., bo_CN.utf8 will be assumed to use the UTF-8 codeset.  Additional locale definitions can be specified in the locale-definitions slot of operating-system---this is useful, for instance, if the codeset could not be inferred from the locale name. The default set of locale definitions includes some widely used locales, but not all the available locales, in order to save space.

For instance, to add the North Frisian locale for Germany, the value of that field may be:

     (cons (locale-definition
             (name "fy_DE.utf8") (source "fy_DE"))
           %default-locale-definitions)

Likewise, to save space, one might want locale-definitions to list only the locales that are actually used, as in:

     (list (locale-definition
             (name "ja_JP.eucjp") (source "ja_JP")
             (charset "EUC-JP")))

The compiled locale definitions are available at /run/current-system/locale/X.Y, where X.Y is the libc version, which is the default location where the GNU libc provided by Guix looks for locale data.  This can be overridden using the LOCPATH environment variable (see LOCPATH and locale packages).

The locale-definition form is provided by the (gnu system locale) module.  Details are given below.

 -- Data Type: locale-definition
     This is the data type of a locale definition.

     name
          The name of the locale.  See Locale Names (The GNU C Library Reference Manual), for more information on locale names.

     source
          The name of the source for that locale.  This is typically the LANGUAGE_TERRITORY part of the locale name.

     charset (default: "UTF-8")
          The ``character set'' or ``code set'' for that locale, as defined by IANA (http://www.iana.org/assignments/character-sets).

 -- Scheme Variable: %default-locale-definitions
     A list of commonly used UTF-8 locales, used as the default value of the locale-definitions field of operating-system declarations.

     These locale definitions use the normalized codeset for the part that follows the dot in the name (see normalized codeset (The GNU C Library Reference Manual)).  So for instance it has uk_UA.utf8 but not, say, uk_UA.UTF-8.

Locale Data Compatibility Considerations
........................................

operating-system declarations provide a locale-libcs field to specify the GNU libc packages that are used to compile locale declarations (see Référence de système d'exploitation).  ``Why would I care?'', you may ask.  Well, it turns out that the binary format of locale data is occasionally incompatible from one libc version to another.

For instance, a program linked against libc version 2.21 is unable to read locale data produced with libc 2.22; worse, that program aborts instead of simply ignoring the incompatible locale data (Versions 2.23 and later of GNU libc will simply skip the incompatible locale data, which is already an improvement.).  Similarly, a program linked against libc 2.22 can read most, but not all, of the locale data from libc 2.21 (specifically, LC_COLLATE data is incompatible); thus calls to setlocale may fail, but programs will not abort.

The ``problem'' in GuixSD is that users have a lot of freedom: They can choose whether and when to upgrade software in their profiles, and might be using a libc version different from the one the system administrator used to build the system-wide locale data.

Fortunately, unprivileged users can also install their own locale data and define GUIX_LOCPATH accordingly (see GUIX_LOCPATH and locale packages).

Still, it is best if the system-wide locale data at /run/current-system/locale is built for all the libc versions actually in use on the system, so that all the programs can access it---this is especially crucial on a multi-user system.  To do that, the administrator can specify several libc packages in the locale-libcs field of operating-system:

     (use-package-modules base)

     (operating-system
       ;; ...
       (locale-libcs (list glibc-2.21 (canonical-package glibc))))

This example would lead to a system containing locale definitions for both libc 2.21 and the current version of libc in /run/current-system/locale.

Services
--------

An important part of preparing an operating-system declaration is listing system services and their configuration (see Utiliser le système de configuration).  System services are typically daemons launched when the system boots, or other actions needed at that time---e.g., configuring network access.

GuixSD has a broad definition of ``service'' (see Composition de services), but many services are managed by the GNU Shepherd (see Services Shepherd).  On a running system, the herd command allows you to list the available services, show their status, start and stop them, or do other specific operations (see Jump Start (The GNU Shepherd Manual)).  For example:

     # herd status

The above command, run as root, lists the currently defined services.  The herd doc command shows a synopsis of the given service:

     # herd doc nscd
     Run libc's name service cache daemon (nscd).

The start, stop, and restart sub-commands have the effect you would expect.  For instance, the commands below stop the nscd service and restart the Xorg display server:

     # herd stop nscd
     Service nscd has been stopped.
     # herd restart xorg-server
     Service xorg-server has been stopped.
     Service xorg-server has been started.

The following sections document the available services, starting with the core services, that may be used in an operating-system declaration.

Services de base
................

The (gnu services base) module provides definitions for the basic services that one expects from the system.  The services exported by this module are listed below.

 -- Scheme Variable: %base-services
     This variable contains a list of basic services (see Types service et services, for more information on service objects) one would expect from the system: a login service (mingetty) on each tty, syslogd, the libc name service cache daemon (nscd), the udev device manager, and more.

     This is the default value of the services field of operating-system declarations.  Usually, when customizing a system, you will want to append services to %BASE-SERVICES, like this:

          (cons* (avahi-service) (lsh-service) %base-services)

 -- Scheme Variable: special-files-service-type
     This is the service that sets up ``special files'' such as /bin/sh; an instance of it is part of %base-services.

     The value associated with special-files-service-type services must be a list of tuples where the first element is the ``special file'' and the second element is its target.  By default it is:

          `(("/bin/sh" ,(file-append BASH "/bin/sh")))

     If you want to add, say, /usr/bin/env to your system, you can change it to:

          `(("/bin/sh" ,(file-append BASH "/bin/sh"))
            ("/usr/bin/env" ,(file-append COREUTILS "/bin/env")))

     Since this is part of %base-services, you can use modify-services to customize the set of special files (see modify-services).  But the simple way to add a special file is via the extra-special-file procedure (see below.)

 -- Scheme Procedure: extra-special-file FILE TARGET
     Use TARGET as the ``special file'' FILE.

     For example, adding the following lines to the services field of your operating system declaration leads to a /usr/bin/env symlink:

          (extra-special-file "/usr/bin/env"
                              (file-append coreutils "/bin/env"))

 -- Scheme Procedure: host-name-service NAME
     Return a service that sets the host name to NAME.

 -- Scheme Procedure: login-service CONFIG
     Return a service to run login according to CONFIG, a <login-configuration> object, which specifies the message of the day, among other things.

 -- Data Type: login-configuration
     This is the data type representing the configuration of login.

     motd
          A file-like object containing the ``message of the day''.

     allow-empty-passwords? (default: #t)
          Allow empty passwords by default so that first-time users can log in when the 'root' account has just been created.

 -- Scheme Procedure: mingetty-service CONFIG
     Return a service to run mingetty according to CONFIG, a <mingetty-configuration> object, which specifies the tty to run, among other things.

 -- Data Type: mingetty-configuration
     This is the data type representing the configuration of Mingetty, which provides the default implementation of virtual console log-in.

     tty
          The name of the console this Mingetty runs on---e.g., "tty1".

     auto-login (default: #f)
          When true, this field must be a string denoting the user name under which the system automatically logs in.  When it is #f, a user name and password must be entered to log in.

     login-program (default: #f)
          This must be either #f, in which case the default log-in program is used (login from the Shadow tool suite), or a gexp denoting the name of the log-in program.

     login-pause? (default: #f)
          When set to #t in conjunction with AUTO-LOGIN, the user will have to press a key before the log-in shell is launched.

     mingetty (default: MINGETTY)
          The Mingetty package to use.

 -- Scheme Procedure: agetty-service CONFIG
     Return a service to run agetty according to CONFIG, an <agetty-configuration> object, which specifies the tty to run, among other things.

 -- Data Type: agetty-configuration
     This is the data type representing the configuration of agetty, which implements virtual and serial console log-in.  See the agetty(8) man page for more information.

     tty
          The name of the console this agetty runs on, as a string---e.g., "ttyS0". This argument is optional, it will default to a reasonable default serial port used by the kernel Linux.

          For this, if there is a value for an option agetty.tty in the kernel command line, agetty will extract the device name of the serial port from it and use that.

          If not and if there is a value for an option console with a tty in the Linux command line, agetty will extract the device name of the serial port from it and use that.

          In both cases, agetty will leave the other serial device settings (baud rate etc.) alone---in the hope that Linux pinned them to the correct values.

     baud-rate (default: #f)
          A string containing a comma-separated list of one or more baud rates, in descending order.

     term (default: #f)
          A string containing the value used for the TERM environment variable.

     eight-bits? (default: #f)
          When #t, the tty is assumed to be 8-bit clean, and parity detection is disabled.

     auto-login (default: #f)
          When passed a login name, as a string, the specified user will be logged in automatically without prompting for their login name or password.

     no-reset? (default: #f)
          When #t, don't reset terminal cflags (control modes).

     host (default: #f)
          This accepts a string containing the "login_host", which will be written into the /var/run/utmpx file.

     remote? (default: #f)
          When set to #t in conjunction with HOST, this will add an -r fakehost option to the command line of the login program specified in LOGIN-PROGRAM.

     flow-control? (default: #f)
          When set to #t, enable hardware (RTS/CTS) flow control.

     no-issue? (default: #f)
          When set to #t, the contents of the /etc/issue file will not be displayed before presenting the login prompt.

     init-string (default: #f)
          This accepts a string that will be sent to the tty or modem before sending anything else.  It can be used to initialize a modem.

     no-clear? (default: #f)
          When set to #t, agetty will not clear the screen before showing the login prompt.

     login-program (default: (file-append shadow "/bin/login"))
          This must be either a gexp denoting the name of a log-in program, or unset, in which case the default value is the login from the Shadow tool suite.

     local-line (default: #f)
          Control the CLOCAL line flag.  This accepts one of three symbols as arguments, 'auto, 'always, or 'never. If #f, the default value chosen by agetty is 'auto.

     extract-baud? (default: #f)
          When set to #t, instruct agetty to try to extract the baud rate from the status messages produced by certain types of modems.

     skip-login? (default: #f)
          When set to #t, do not prompt the user for a login name.  This can be used with LOGIN-PROGRAM field to use non-standard login systems.

     no-newline? (default: #f)
          When set to #t, do not print a newline before printing the /etc/issue file.

     login-options (default: #f)
          This option accepts a string containing options that are passed to the login program.  When used with the LOGIN-PROGRAM, be aware that a malicious user could try to enter a login name containing embedded options that could be parsed by the login program.

     login-pause (default: #f)
          When set to #t, wait for any key before showing the login prompt. This can be used in conjunction with AUTO-LOGIN to save memory by lazily spawning shells.

     chroot (default: #f)
          Change root to the specified directory.  This option accepts a directory path as a string.

     hangup? (default: #f)
          Use the Linux system call vhangup to do a virtual hangup of the specified terminal.

     keep-baud? (default: #f)
          When set to #t, try to keep the existing baud rate.  The baud rates from BAUD-RATE are used when agetty receives a BREAK character.

     timeout (default: #f)
          When set to an integer value, terminate if no user name could be read within TIMEOUT seconds.

     detect-case? (default: #f)
          When set to #t, turn on support for detecting an uppercase-only terminal.  This setting will detect a login name containing only uppercase letters as indicating an uppercase-only terminal and turn on some upper-to-lower case conversions.  Note that this will not support Unicode characters.

     wait-cr? (default: #f)
          When set to #t, wait for the user or modem to send a carriage-return or linefeed character before displaying /etc/issue or login prompt. This is typically used with the INIT-STRING option.

     no-hints? (default: #f)
          When set to #t, do not print hints about Num, Caps, and Scroll locks.

     no-hostname? (default: #f)
          By default, the hostname is printed.  When this option is set to #t, no hostname will be shown at all.

     long-hostname? (default: #f)
          By default, the hostname is only printed until the first dot.  When this option is set to #t, the fully qualified hostname by gethostname or getaddrinfo is shown.

     erase-characters (default: #f)
          This option accepts a string of additional characters that should be interpreted as backspace when the user types their login name.

     kill-characters (default: #f)
          This option accepts a string that should be interpreted to mean "ignore all previous characters" (also called a "kill" character) when the types their login name.

     chdir (default: #f)
          This option accepts, as a string, a directory path that will be changed to before login.

     delay (default: #f)
          This options accepts, as an integer, the number of seconds to sleep before opening the tty and displaying the login prompt.

     nice (default: #f)
          This option accepts, as an integer, the nice value with which to run the login program.

     extra-options (default: '())
          This option provides an "escape hatch" for the user to provide arbitrary command-line arguments to agetty as a list of strings.

 -- Scheme Procedure: kmscon-service-type CONFIG
     Return a service to run kmscon (https://www.freedesktop.org/wiki/Software/kmscon) according to CONFIG, a <kmscon-configuration> object, which specifies the tty to run, among other things.

 -- Data Type: kmscon-configuration
     This is the data type representing the configuration of Kmscon, which implements virtual console log-in.

     virtual-terminal
          The name of the console this Kmscon runs on---e.g., "tty1".

     login-program (default: #~(string-append #$shadow "/bin/login"))
          A gexp denoting the name of the log-in program. The default log-in program is login from the Shadow tool suite.

     login-arguments (default: '("-p"))
          A list of arguments to pass to login.

     hardware-acceleration? (default: #f)
          Whether to use hardware acceleration.

     kmscon (default: KMSCON)
          The Kmscon package to use.

 -- Scheme Procedure: nscd-service [CONFIG] [#:glibc glibc]
     [#:name-services '()] Return a service that runs the libc name service cache
     daemon (nscd) with the given CONFIG---an <nscd-configuration> object.  See Name Service Switch, for an example.

 -- Scheme Variable: %nscd-default-configuration
     This is the default <nscd-configuration> value (see below) used by nscd-service.  It uses the caches defined by %NSCD-DEFAULT-CACHES; see below.

 -- Data Type: nscd-configuration
     This is the data type representing the name service cache daemon (nscd) configuration.

     name-services (default: '())
          List of packages denoting name services that must be visible to the nscd---e.g., (list NSS-MDNS).

     glibc (default: GLIBC)
          Package object denoting the GNU C Library providing the nscd command.

     log-file (default: "/var/log/nscd.log")
          Name of the nscd log file.  This is where debugging output goes when debug-level is strictly positive.

     debug-level (default: 0)
          Integer denoting the debugging levels.  Higher numbers mean that more debugging output is logged.

     caches (default: %NSCD-DEFAULT-CACHES)
          List of <nscd-cache> objects denoting things to be cached; see below.

 -- Data Type: nscd-cache
     Data type representing a cache database of nscd and its parameters.

     database
          This is a symbol representing the name of the database to be cached.  Valid values are passwd, group, hosts, and services, which designate the corresponding NSS database (see NSS Basics (The GNU C Library Reference Manual)).

     positive-time-to-live
     negative-time-to-live (default: 20)
          A number representing the number of seconds during which a positive or negative lookup result remains in cache.

     check-files? (default: #t)
          Whether to check for updates of the files corresponding to DATABASE.

          For instance, when DATABASE is hosts, setting this flag instructs nscd to check for updates in /etc/hosts and to take them into account.

     persistent? (default: #t)
          Whether the cache should be stored persistently on disk.

     shared? (default: #t)
          Whether the cache should be shared among users.

     max-database-size (default: 32 MiB)
          Maximum size in bytes of the database cache.

 -- Scheme Variable: %nscd-default-caches
     List of <nscd-cache> objects used by default by nscd-configuration (see above).

     It enables persistent and aggressive caching of service and host name lookups.  The latter provides better host name lookup performance, resilience in the face of unreliable name servers, and also better privacy---often the result of host name lookups is in local cache, so external name servers do not even need to be queried.

 -- Data Type: syslog-configuration
     This data type represents the configuration of the syslog daemon.

     syslogd (default: #~(string-append #$inetutils "/libexec/syslogd"))
          The syslog daemon to use.

     config-file (default: %default-syslog.conf)
          The syslog configuration file to use.

 -- Scheme Procedure: syslog-service CONFIG
     Return a service that runs a syslog daemon according to CONFIG.

     See syslogd invocation (GNU Inetutils), for more information on the configuration file syntax.

 -- Data Type: guix-configuration
     This data type represents the configuration of the Guix build daemon. See Invoquer guix-daemon, for more information.

     guix (default: GUIX)
          The Guix package to use.

     build-group (default: "guixbuild")
          Name of the group for build user accounts.

     build-accounts (default: 10)
          Number of build user accounts to create.

     authorize-key? (default: #t)
          Autoriser ou non les clefs de substituts listées dans authorize-keys — par défaut celle de hydra.gny.org (see Substituts).

     authorized-keys (default: %DEFAULT-AUTHORIZED-GUIX-KEYS)
          La liste des fichiers de clefs autorisées pour les imports d'archives, en tant que liste de gexps sous forme de chaînes (see Invoquer guix archive). Par défaut, elle contient celle de hydra.gnu.org (see Substituts).

     use-substitutes? (default: #t)
          Whether to use substitutes.

     substitute-urls (default: %DEFAULT-SUBSTITUTE-URLS)
          The list of URLs where to look for substitutes by default.

     max-silent-time (default: 0)
     timeout (default: 0)
          The number of seconds of silence and the number of seconds of activity, respectively, after which a build process times out.  A value of zero disables the timeout.

     log-compression (default: 'bzip2)
          The type of compression used for build logs---one of gzip, bzip2, or none.

     extra-options (default: '())
          List of extra command-line options for guix-daemon.

     log-file (default: "/var/log/guix-daemon.log")
          File where guix-daemon's standard output and standard error are written.

     http-proxy (default: #f)
          The HTTP proxy used for downloading fixed-output derivations and substitutes.

     tmpdir (default: #f)
          A directory path where the guix-daemon will perform builds.

 -- Scheme Procedure: guix-service CONFIG
     Return a service that runs the Guix build daemon according to CONFIG.

 -- Scheme Procedure: udev-service [#:udev EUDEV #:rules '()]
     Run UDEV, which populates the /dev directory dynamically.  udev rules can be provided as a list of files through the RULES variable. The procedures UDEV-RULE and FILE->UDEV-RULE from (gnu services base) simplify the creation of such rule files.

      -- Scheme Procedure: udev-rule [FILE-NAME CONTENTS]
          Return a udev-rule file named FILE-NAME containing the rules defined by the CONTENTS literal.

          In the following example, a rule for a USB device is defined to be stored in the file 90-usb-thing.rules.  The rule runs a script upon detecting a USB device with a given product identifier.

               (define %example-udev-rule
                 (udev-rule
                   "90-usb-thing.rules"
                   (string-append "ACTION==\"add\", SUBSYSTEM==\"usb\", "
                                  "ATTR{product}==\"Example\", "
                                  "RUN+=\"/path/to/script\"")))

     Here we show how the default UDEV-SERVICE can be extended with it.

          (operating-system
           ;; ...
           (services
           (modify-services %desktop-services
             (udev-service-type config =>
               (udev-configuration (inherit config)
                (rules (append (udev-configuration-rules config)
                               (list %example-udev-rule))))))))

      -- Scheme Procedure: file->udev-rule [FILE-NAME FILE]
          Return a udev file named FILE-NAME containing the rules defined within FILE, a file-like object.

          The following example showcases how we can use an existing rule file.

               (use-modules (guix download)     ;for url-fetch
                            (guix packages)     ;for origin
                            ;; ...)

               (define %android-udev-rules
                 (file->udev-rule
                   "51-android-udev.rules"
                   (let ((version "20170910"))
                     (origin
                      (method url-fetch)
                      (uri (string-append "https://raw.githubusercontent.com/M0Rf30/"
                                          "android-udev-rules/" version "/51-android.rules"))
                      (sha256
                       (base32 "0lmmagpyb6xsq6zcr2w1cyx9qmjqmajkvrdbhjx32gqf1d9is003"))))))

     Additionally, Guix package definitions can be included in RULES in order to extend the udev rules with the definitions found under their lib/udev/rules.d sub-directory.  In lieu of the previous FILE->UDEV-RULE example, we could have used the ANDROID-UDEV-RULES package which exists in Guix in the (gnu packages android) module.

     The following example shows how to use the ANDROID-UDEV-RULES package so that the Android tool adb can detect devices without root privileges.  It also details how to create the adbusers group, which is required for the proper functioning of the rules defined within the ANDROID-UDEV-RULES package.  To create such a group, we must define it both as part of the SUPPLEMENTARY-GROUPS of our USER-ACCOUNT declaration, as well as in the GROUPS field of the OPERATING-SYSTEM record.

          (use-modules (gnu packages android)  ;for android-udev-rules
                       (gnu system shadow)     ;for user-group
                       ;; ...)

          (operating-system
            ;; ...
            (users (cons (user-acount
                          ;; ...
                          (supplementary-groups
                           '("adbusers"   ;for adb
                             "wheel" "netdev" "audio" "video"))
                          ;; ...)))

            (groups (cons (user-group (system? #t) (name "adbusers"))
                          %base-groups))

            ;; ...

            (services
              (modify-services %desktop-services
                (udev-service-type config =>
                 (udev-configuration (inherit config)
                 (rules (cons* android-udev-rules
                        (udev-configuration-rules config))))))))

 -- Scheme Variable: urandom-seed-service-type
     Save some entropy in %RANDOM-SEED-FILE to seed /dev/urandom when rebooting.  It also tries to seed /dev/urandom from /dev/hwrng while booting, if /dev/hwrng exists and is readable.

 -- Scheme Variable: %random-seed-file
     This is the name of the file where some random bytes are saved by URANDOM-SEED-SERVICE to seed /dev/urandom when rebooting.  It defaults to /var/lib/random-seed.

 -- Scheme Procedure: console-keymap-service FILES ...
     Return a service to load console keymaps from FILES using loadkeys command.  Most likely, you want to load some default keymap, which can be done like this:

          (console-keymap-service "dvorak")

     Or, for example, for a Swedish keyboard, you may need to combine the following keymaps:

          (console-keymap-service "se-lat6" "se-fi-lat6")

     Also you can specify a full file name (or file names) of your keymap(s). See man loadkeys for details.

 -- Variable Scheme: gpm-service-type
     This is the type of the service that runs GPM, the general-purpose mouse daemon, which provides mouse support to the Linux console.  GPM allows users to use the mouse in the console, notably to select, copy, and paste text.

     The value for services of this type must be a gpm-configuration (see below).  This service is not part of %BASE-SERVICES.

 -- Type de donnée: gpm-configuration
     Type de données représentant la configuration de GPM.

     options (par défaut : %default-gpm-options)
          Command-line options passed to gpm.  The default set of options instruct gpm to listen to mouse events on /dev/input/mice. See Command Line (gpm manual), for more information.

     gpm (par défaut : gpm)
          Le paquet GPM à utiliser.

 -- Scheme Variable: guix-publish-service-type
     This is the service type for guix publish (see Invoquer guix publish).  Its value must be a guix-configuration object, as described below.

     This assumes that /etc/guix already contains a signing key pair as created by guix archive --generate-key (see Invoquer guix archive).  If that is not the case, the service will fail to start.

 -- Data Type: guix-publish-configuration
     Data type representing the configuration of the guix publish service.

     guix (default: guix)
          The Guix package to use.

     port (default: 80)
          The TCP port to listen for connections.

     host (default: "localhost")
          The host (and thus, network interface) to listen to.  Use "0.0.0.0" to listen on all the network interfaces.

     compression-level (par défaut : 3)
          The gzip compression level at which substitutes are compressed.  Use 0 to disable compression altogether, and 9 to get the best compression ratio at the expense of increased CPU usage.

     nar-path (default: "nar")
          The URL path at which ``nars'' can be fetched.  See --nar-path, for details.

     cache (default: #f)
          When it is #f, disable caching and instead generate archives on demand.  Otherwise, this should be the name of a directory---e.g., "/var/cache/guix/publish"---where guix publish caches archives and meta-data ready to be sent.  See --cache, for more information on the tradeoffs involved.

     workers (default: #f)
          When it is an integer, this is the number of worker threads used for caching; when #f, the number of processors is used.  See --workers, for more information.

     ttl (default: #f)
          When it is an integer, this denotes the time-to-live in seconds of the published archives.  See --ttl, for more information.

 -- Scheme Procedure: rngd-service [#:rng-tools RNG-TOOLS]
     [#:device "/dev/hwrng"] Return a service that runs the rngd
     program from RNG-TOOLS to add DEVICE to the kernel's entropy pool.  The service will fail if DEVICE does not exist.

 -- Scheme Procedure: pam-limits-service [#:limits '()]

     Return a service that installs a configuration file for the pam_limits module (http://linux-pam.org/Linux-PAM-html/sag-pam_limits.html).  The procedure optionally takes a list of pam-limits-entry values, which can be used to specify ulimit limits and nice priority limits to user sessions.

     The following limits definition sets two hard and soft limits for all login sessions of users in the realtime group:

          (pam-limits-service
           (list
            (pam-limits-entry "@realtime" 'both 'rtprio 99)
            (pam-limits-entry "@realtime" 'both 'memlock 'unlimited)))

     The first entry increases the maximum realtime priority for non-privileged processes; the second entry lifts any restriction of the maximum address space that can be locked in memory.  These settings are commonly used for real-time audio systems.

Exécution de tâches planifiées
..............................

The (gnu services mcron) module provides an interface to GNU mcron, a daemon to run jobs at scheduled times (see GNU mcron).  GNU mcron is similar to the traditional Unix cron daemon; the main difference is that it is implemented in Guile Scheme, which provides a lot of flexibility when specifying the scheduling of jobs and their actions.

The example below defines an operating system that runs the updatedb (see Invoking updatedb (Finding Files))  and the guix gc commands (see Invoquer guix gc) daily, as well as the mkid command on behalf of an unprivileged user (see mkid invocation (ID Database Utilities)).  It uses gexps to introduce job definitions that are passed to mcron (see G-Expressions).

     (use-modules (guix) (gnu) (gnu services mcron))
     (use-package-modules base idutils)

     (define updatedb-job
       ;; Run 'updatedb' at 3AM every day.  Here we write the
       ;; job's action as a Scheme procedure.
       #~(job '(next-hour '(3))
              (lambda ()
                (execl (string-append #$findutils "/bin/updatedb")
                       "updatedb"
                       "--prunepaths=/tmp /var/tmp /gnu/store"))))

     (define garbage-collector-job
       ;; Collect garbage 5 minutes after midnight every day.
       ;; The job's action is a shell command.
       #~(job "5 0 * * *"            ;Vixie cron syntax
              "guix gc -F 1G"))

     (define idutils-job
       ;; Update the index database as user "charlie" at 12:15PM
       ;; and 19:15PM.  This runs from the user's home directory.
       #~(job '(next-minute-from (next-hour '(12 19)) '(15))
              (string-append #$idutils "/bin/mkid src")
              #:user "charlie"))

     (operating-system
       ;; ...
       (services (cons (mcron-service (list garbage-collector-job
                                            updatedb-job
                                            idutils-job))
                       %base-services)))

See mcron job specifications (GNU mcron), for more information on mcron job specifications.  Below is the reference of the mcron service.

On a running system, you can use the schedule action of the service to visualize the mcron jobs that will be executed next:

     # herd schedule mcron

The example above lists the next five tasks that will be executed, but you can also specify the number of tasks to display:

     # herd schedule mcron 10

 -- Scheme Procedure: mcron-service JOBS [#:mcron MCRON]
     Return an mcron service running MCRON that schedules JOBS, a list of gexps denoting mcron job specifications.

     This is a shorthand for:

          (service mcron-service-type
                   (mcron-configuration (mcron mcron) (jobs jobs)))

 -- Scheme Variable: mcron-service-type
     This is the type of the mcron service, whose value is an mcron-configuration object.

     This service type can be the target of a service extension that provides it additional job specifications (see Composition de services).  In other words, it is possible to define services that provide additional mcron jobs to run.

 -- Data Type: mcron-configuration
     Data type representing the configuration of mcron.

     mcron (default: MCRON)
          The mcron package to use.

     jobs
          This is a list of gexps (see G-Expressions), where each gexp corresponds to an mcron job specification (see mcron job specifications (GNU mcron)).

Rotation des journaux
.....................

Log files such as those found in /var/log tend to grow endlessly, so it's a good idea to rotate them once in a while---i.e., archive their contents in separate files, possibly compressed.  The (gnu services admin) module provides an interface to GNU Rot[t]log, a log rotation tool (see GNU Rot[t]log Manual).

The example below defines an operating system that provides log rotation with the default settings, for commonly encountered log files.

     (use-modules (guix) (gnu))
     (use-service-modules admin mcron)
     (use-package-modules base idutils)

     (operating-system
       ;; ...
       (services (cons (service rottlog-service-type)
                       %base-services)))

 -- Scheme Variable: rottlog-service-type
     This is the type of the Rottlog service, whose value is a rottlog-configuration object.

     Other services can extend this one with new log-rotation objects (see below), thereby augmenting the set of files to be rotated.

     This service type can define mcron jobs (see Exécution de tâches planifiées) to run the rottlog service.

 -- Data Type: rottlog-configuration
     Data type representing the configuration of rottlog.

     rottlog (default: rottlog)
          The Rottlog package to use.

     rc-file (default: (file-append rottlog "/etc/rc"))
          The Rottlog configuration file to use (see Mandatory RC Variables (GNU Rot[t]log Manual)).

     rotations (default: %default-rotations)
          A list of log-rotation objects as defined below.

     jobs
          This is a list of gexps where each gexp corresponds to an mcron job specification (see Exécution de tâches planifiées).

 -- Data Type: log-rotation
     Data type representing the rotation of a group of log files.

     Taking an example from the Rottlog manual (see Period Related File Examples (GNU Rot[t]log Manual)), a log rotation might be defined like this:

          (log-rotation
            (frequency 'daily)
            (files '("/var/log/apache/*"))
            (options '("storedir apache-archives"
                       "rotate 6"
                       "notifempty"
                       "nocompress")))

     The list of fields is as follows:

     frequency (default: 'weekly)
          The log rotation frequency, a symbol.

     files
          The list of files or file glob patterns to rotate.

     options (default: '())
          The list of rottlog options for this rotation (see Configuration parameters (GNU Rot[t]lg Manual)).

     post-rotate (default: #f)
          Either #f or a gexp to execute once the rotation has completed.

 -- Scheme Variable: %default-rotations
     Specifies weekly rotation of %ROTATED-FILES and a couple of other files.

 -- Scheme Variable: %rotated-files
     The list of syslog-controlled files to be rotated.  By default it is: '("/var/log/messages" "/var/log/secure").

Services réseau
...............

The (gnu services networking) module provides services to configure the network interface.

 -- Scheme Procedure: dhcp-client-service [#:dhcp ISC-DHCP]
     Return a service that runs DHCP, a Dynamic Host Configuration Protocol (DHCP) client, on all the non-loopback network interfaces.

 -- Scheme Procedure: dhcpd-service-type
     This type defines a service that runs a DHCP daemon.  To create a service of this type, you must supply a <dhcpd-configuration>.  For example:

          (service dhcpd-service-type
                   (dhcpd-configuration
                    (config-file (local-file "my-dhcpd.conf"))
                    (interfaces '("enp0s25"))))

 -- Data Type: dhcpd-configuration

     package (default: isc-dhcp)
          The package that provides the DHCP daemon.  This package is expected to provide the daemon at sbin/dhcpd relative to its output directory. The default package is the ISC's DHCP server (http://www.isc.org/products/DHCP).

     config-file (default: #f)
          The configuration file to use.  This is required.  It will be passed to dhcpd via its -cf option.  This may be any ``file-like'' object (see file-like objects).  See man dhcpd.conf for details on the configuration file syntax.

     version (default: "4")
          The DHCP version to use.  The ISC DHCP server supports the values ``4'', ``6'', and ``4o6''.  These correspond to the dhcpd program options -4, -6, and -4o6.  See man dhcpd for details.

     run-directory (default: "/run/dhcpd")
          The run directory to use.  At service activation time, this directory will be created if it does not exist.

     pid-file (default: "/run/dhcpd/dhcpd.pid")
          The PID file to use.  This corresponds to the -pf option of dhcpd.  See man dhcpd for details.

     interfaces (default: '())
          The names of the network interfaces on which dhcpd should listen for broadcasts.  If this list is not empty, then its elements (which must be strings) will be appended to the dhcpd invocation when starting the daemon.  It may not be necessary to explicitly specify any interfaces here; see man dhcpd for details.

 -- Scheme Variable: static-networking-service-type
     This is the type for statically-configured network interfaces.

 -- Scheme Procedure: static-networking-service INTERFACE IP
     [#:netmask #f] [#:gateway #f] [#:name-servers '()]  [#:requirement
     '(udev)] Return a service that starts INTERFACE with address IP.  If NETMASK is true, use it as the network mask.  If GATEWAY is true, it must be a string specifying the default network gateway.  REQUIREMENT can be used to declare a dependency on another service before configuring the interface.

     This procedure can be called several times, one for each network interface of interest.  Behind the scenes what it does is extend static-networking-service-type with additional network interfaces to handle.

 -- Scheme Procedure: wicd-service [#:wicd WICD]
     Return a service that runs Wicd (https://launchpad.net/wicd), a network management daemon that aims to simplify wired and wireless networking.

     This service adds the WICD package to the global profile, providing several commands to interact with the daemon and configure networking: wicd-client, a graphical user interface, and the wicd-cli and wicd-curses user interfaces.

 -- Variable Scheme: modem-manager-service-type
     This is the service type for the ModemManager (https://wiki.gnome.org/Projects/ModemManager) service. The value for this service type is a modem-manager-configuration record.

     This service is part of %desktop-services (see Services de bureaux).

 -- Type de donnée: modem-manager-configuration
     Type de donnée représentant la configuration de ModemManager.

     modem-manager (par défaut : modem-manager)
          Le paquet ModemManager à utiliser.

 -- Scheme Variable: network-manager-service-type
     This is the service type for the NetworkManager (https://wiki.gnome.org/Projects/NetworkManager) service. The value for this service type is a network-manager-configuration record.

     This service is part of %desktop-services (see Services de bureaux).

 -- Data Type: network-manager-configuration
     Data type representing the configuration of NetworkManager.

     network-manager (default: network-manager)
          The NetworkManager package to use.

     dns (default: "default")
          Processing mode for DNS, which affects how NetworkManager uses the resolv.conf configuration file.

          default
               NetworkManager will update resolv.conf to reflect the nameservers provided by currently active connections.

          dnsmasq
               NetworkManager will run dnsmasq as a local caching nameserver, using a "split DNS" configuration if you are connected to a VPN, and then update resolv.conf to point to the local nameserver.

          none
               NetworkManager will not modify resolv.conf.

     vpn-plugins (default: '())
          This is the list of available plugins for virtual private networks (VPNs). An example of this is the network-manager-openvpn package, which allows NetworkManager to manage VPNs via OpenVPN.

 -- Scheme Variable: connman-service-type
     This is the service type to run Connman (https://01.org/connman), a network connection manager.

     Its value must be an connman-configuration record as in this example:

          (service connman-service-type
                   (connman-configuration
                     (disable-vpn? #t)))

     See below for details about connman-configuration.

 -- Data Type: connman-configuration
     Data Type representing the configuration of connman.

     connman (default: CONNMAN)
          The connman package to use.

     disable-vpn? (default: #f)
          When true, enable connman's vpn plugin.

 -- Scheme Variable: wpa-supplicant-service-type
     This is the service type to run WPA supplicant (https://w1.fi/wpa_supplicant/), an authentication daemon required to authenticate against encrypted WiFi or ethernet networks.  It is configured to listen for requests on D-Bus.

     The value of this service is the wpa-supplicant package to use. Thus, it can be instantiated like this:

          (use-modules (gnu services networking))

          (service wpa-supplicant-service-type)

 -- Scheme Procedure: ntp-service [#:ntp NTP]
     [#:servers %NTP-SERVERS]  [#:allow-large-adjustment? #f] Return a
     service that runs the daemon from NTP, the Network Time Protocol package (http://www.ntp.org).  The daemon will keep the system clock synchronized with that of SERVERS.  ALLOW-LARGE-ADJUSTMENT? determines whether ntpd is allowed to make an initial adjustment of more than 1,000 seconds.

 -- Scheme Variable: %ntp-servers
     List of host names used as the default NTP servers.

 -- Scheme Procedure: openntpd-service-type
     Run the ntpd, the Network Time Protocol (NTP) daemon, as implemented by OpenNTPD (http://www.openntpd.org).  The daemon will keep the system clock synchronized with that of the given servers.

          (service
           openntpd-service-type
           (openntpd-configuration
            (listen-on '("127.0.0.1" "::1"))
            (sensor '("udcf0 correction 70000"))
            (constraint-from '("www.gnu.org"))
            (constraints-from '("https://www.google.com/"))
            (allow-large-adjustment? #t)))

 -- Data Type: openntpd-configuration

     openntpd (default: (file-append openntpd "/sbin/ntpd"))
          The openntpd executable to use.

     listen-on (default: '("127.0.0.1" "::1"))
          A list of local IP addresses or hostnames the ntpd daemon should listen on.

     query-from (default: '())
          A list of local IP address the ntpd daemon should use for outgoing queries.

     sensor (default: '())
          Specify a list of timedelta sensor devices ntpd should use.  ntpd will listen to each sensor that acutally exists and ignore non-existant ones.  See upstream documentation (https://man.openbsd.org/ntpd.conf) for more information.

     server (default: %NTP-SERVERS)
          Specify a list of IP addresses or hostnames of NTP servers to synchronize to.

     servers (default: '())
          Specify a list of IP addresses or hostnames of NTP pools to synchronize to.

     constraint-from (default: '())
          ntpd can be configured to query the ‘Date’ from trusted HTTPS servers via TLS.  This time information is not used for precision but acts as an authenticated constraint, thereby reducing the impact of unauthenticated NTP man-in-the-middle attacks.  Specify a list of URLs, IP addresses or hostnames of HTTPS servers to provide a constraint.

     constraints-from (default: '())
          As with constraint from, specify a list of URLs, IP addresses or hostnames of HTTPS servers to provide a constraint.  Should the hostname resolve to multiple IP addresses, ntpd will calculate a median constraint from all of them.

     allow-large-adjustment? (default: #f)
          Determines if ntpd is allowed to make an initial adjustment of more than 180 seconds.

 -- Scheme variable: inetd-service-type
     This service runs the inetd (see inetd invocation (GNU Inetutils)) daemon.  inetd listens for connections on internet sockets, and lazily starts the specified server program when a connection is made on one of these sockets.

     The value of this service is an inetd-configuration object.  The following example configures the inetd daemon to provide the built-in echo service, as well as an smtp service which forwards smtp traffic over ssh to a server smtp-server behind a gateway hostname:

          (service
           inetd-service-type
           (inetd-configuration
            (entries (list
                      (inetd-entry
                       (name "echo")
                       (socket-type 'stream)
                       (protocol "tcp")
                       (wait? #f)
                       (user "root"))
                      (inetd-entry
                       (node "127.0.0.1")
                       (name "smtp")
                       (socket-type 'stream)
                       (protocol "tcp")
                       (wait? #f)
                       (user "root")
                       (program (file-append openssh "/bin/ssh"))
                       (arguments
                        '("ssh" "-qT" "-i" "/path/to/ssh_key"
                          "-W" "smtp-server:25" "user@hostname")))))

     See below for more details about inetd-configuration.

 -- Data Type: inetd-configuration
     Data type representing the configuration of inetd.

     program (default: (file-append inetutils "/libexec/inetd"))
          The inetd executable to use.

     entries (default: '())
          A list of inetd service entries.  Each entry should be created by the inetd-entry constructor.

 -- Data Type: inetd-entry
     Data type representing an entry in the inetd configuration.  Each entry corresponds to a socket where inetd will listen for requests.

     node (default: #f)
          Optional string, a comma-separated list of local addresses inetd should use when listening for this service.  See Configuration file (GNU Inetutils) for a complete description of all options.

     name
          A string, the name must correspond to an entry in /etc/services.

     socket-type
          One of 'stream, 'dgram, 'raw, 'rdm or 'seqpacket.

     protocol
          A string, must correspond to an entry in /etc/protocols.

     wait? (default: #t)
          Whether inetd should wait for the server to exit before listening to new service requests.

     user
          A string containing the user (and, optionally, group) name of the user as whom the server should run.  The group name can be specified in a suffix, separated by a colon or period, i.e. "user", "user:group" or "user.group".

     program (default: "internal")
          The server program which will serve the requests, or "internal" if inetd should use a built-in service.

     arguments (par défaut : '())
          A list strings or file-like objects, which are the server program's arguments, starting with the zeroth argument, i.e. the name of the program itself.  For inetd's internal services, this entry must be '() or '("internal").

     See Configuration file (GNU Inetutils) for a more detailed discussion of each configuration field.

 -- Scheme Procedure: tor-service [CONFIG-FILE] [#:tor TOR]
     Return a service to run the Tor (https://torproject.org) anonymous networking daemon.

     The daemon runs as the tor unprivileged user.  It is passed CONFIG-FILE, a file-like object, with an additional User tor line and lines for hidden services added via tor-hidden-service.  Run man tor for information about the configuration file.

 -- Scheme Procedure: tor-hidden-service NAME MAPPING
     Define a new Tor hidden service called NAME and implementing MAPPING.  MAPPING is a list of port/host tuples, such as:

           '((22 "127.0.0.1:22")
             (80 "127.0.0.1:8080"))

     In this example, port 22 of the hidden service is mapped to local port 22, and port 80 is mapped to local port 8080.

     This creates a /var/lib/tor/hidden-services/NAME directory, where the hostname file contains the .onion host name for the hidden service.

     See the Tor project's documentation (https://www.torproject.org/docs/tor-hidden-service.html.en) for more information.

The (gnu services rsync) module provides the following services:

You might want an rsync daemon if you have files that you want available so anyone (or just yourself) can download existing files or upload new files.

 -- Scheme Variable: rsync-service-type
     This is the type for the rsync (https://rsync.samba.org) rsync daemon, rsync-configuration record as in this example:

          (service rsync-service-type)

     See below for details about rsync-configuration.

 -- Data Type: rsync-configuration
     Data type representing the configuration for rsync-service.

     package (default: RSYNC)
          rsync package to use.

     port-number (default: 873)
          TCP port on which rsync listens for incoming connections.  If port is less than 1024 rsync needs to be started as the root user and group.

     pid-file (default: "/var/run/rsyncd/rsyncd.pid")
          Name of the file where rsync writes its PID.

     lock-file (default: "/var/run/rsyncd/rsyncd.lock")
          Name of the file where rsync writes its lock file.

     log-file (default: "/var/log/rsyncd.log")
          Name of the file where rsync writes its log file.

     use-chroot? (default: #T)
          Whether to use chroot for rsync shared directory.

     share-path (default: /srv/rsync)
          Location of the rsync shared directory.

     share-comment (default: "Rsync share")
          Comment of the rsync shared directory.

     read-only? (default: #F)
          Read-write permissions to shared directory.

     timeout (default: 300)
          I/O timeout in seconds.

     user (default: "ROOT")
          Owner of the rsync process.

     group (default: "ROOT")
          Group of the rsync process.

     uid (default: "RSYNCD")
          User name or user ID that file transfers to and from that module should take place as when the daemon was run as root.

     gid (default: "RSYNCD")
          Group name or group ID that will be used when accessing the module.

Furthermore, (gnu services ssh) provides the following services.

 -- Scheme Procedure: lsh-service [#:host-key "/etc/lsh/host-key"]
     [#:daemonic? #t] [#:interfaces '()] [#:port-number 22]
     [#:allow-empty-passwords? #f] [#:root-login? #f]  [#:syslog-output? #t]
     [#:x11-forwarding? #t]  [#:tcp/ip-forwarding? #t] [#:password-authentication? #t]  [#:public-key-authentication? #t] [#:initialize? #t] Run the lshd program from LSH to listen on port PORT-NUMBER.  HOST-KEY must designate a file containing the host key, and readable only by root.

     When DAEMONIC? is true, lshd will detach from the controlling terminal and log its output to syslogd, unless one sets SYSLOG-OUTPUT? to false.  Obviously, it also makes lsh-service depend on existence of syslogd service.  When PID-FILE? is true, lshd writes its PID to the file called PID-FILE.

     When INITIALIZE? is true, automatically create the seed and host key upon service activation if they do not exist yet.  This may take long and require interaction.

     When INITIALIZE? is false, it is up to the user to initialize the randomness generator (see lsh-make-seed (LSH Manual)), and to create a key pair with the private key stored in file HOST-KEY (see lshd basics (LSH Manual)).

     When INTERFACES is empty, lshd listens for connections on all the network interfaces; otherwise, INTERFACES must be a list of host names or addresses.

     ALLOW-EMPTY-PASSWORDS? specifies whether to accept log-ins with empty passwords, and ROOT-LOGIN? specifies whether to accept log-ins as root.

     The other options should be self-descriptive.

 -- Scheme Variable: openssh-service-type
     This is the type for the OpenSSH (http://www.openssh.org) secure shell daemon, sshd.  Its value must be an openssh-configuration record as in this example:

          (service openssh-service-type
                   (openssh-configuration
                     (x11-forwarding? #t)
                     (permit-root-login 'without-password)
                     (authorized-keys
                       `(("alice" ,(local-file "alice.pub"))
                         ("bob" ,(local-file "bob.pub"))))))

     See below for details about openssh-configuration.

     This service can be extended with extra authorized keys, as in this example:

          (service-extension openssh-service-type
                             (const `(("charlie"
                                       ,(local-file "charlie.pub")))))

 -- Data Type: openssh-configuration
     This is the configuration record for OpenSSH's sshd.

     pid-file (default: "/var/run/sshd.pid")
          Name of the file where sshd writes its PID.

     port-number (default: 22)
          TCP port on which sshd listens for incoming connections.

     permit-root-login (default: #f)
          This field determines whether and when to allow logins as root.  If #f, root logins are disallowed; if #t, they are allowed.  If it's the symbol 'without-password, then root logins are permitted but not with password-based authentication.

     allow-empty-passwords? (default: #f)
          When true, users with empty passwords may log in.  When false, they may not.

     password-authentication? (default: #t)
          When true, users may log in with their password.  When false, they have other authentication methods.

     public-key-authentication? (default: #t)
          When true, users may log in using public key authentication.  When false, users have to use other authentication method.

          Authorized public keys are stored in ~/.ssh/authorized_keys.  This is used only by protocol version 2.

     x11-forwarding? (default: #f)
          When true, forwarding of X11 graphical client connections is enabled---in other words, ssh options -X and -Y will work.

     allow-agent-forwarding? (default: #t)
          Whether to allow agent forwarding.

     allow-tcp-forwarding? (default: #t)
          Whether to allow TCP forwarding.

     gateway-ports? (default: #f)
          Whether to allow gateway ports.

     challenge-response-authentication? (default: #f)
          Specifies whether challenge response authentication is allowed (e.g. via PAM).

     use-pam? (default: #t)
          Enables the Pluggable Authentication Module interface.  If set to #t, this will enable PAM authentication using challenge-response-authentication? and password-authentication?, in addition to PAM account and session module processing for all authentication types.

          Because PAM challenge response authentication usually serves an equivalent role to password authentication, you should disable either challenge-response-authentication? or password-authentication?.

     print-last-log? (default: #t)
          Specifies whether sshd should print the date and time of the last user login when a user logs in interactively.

     subsystems (default: '(("sftp" "internal-sftp")))
          Configures external subsystems (e.g. file transfer daemon).

          This is a list of two-element lists, each of which containing the subsystem name and a command (with optional arguments) to execute upon subsystem request.

          The command internal-sftp implements an in-process SFTP server. Alternately, one can specify the sftp-server command:

               (service openssh-service-type
                        (openssh-configuration
                         (subsystems
                          `(("sftp" ,(file-append openssh "/libexec/sftp-server"))))))

     accepted-environment (default: '())
          List of strings describing which environment variables may be exported.

          Each string gets on its own line.  See the AcceptEnv option in man sshd_config.

          This example allows ssh-clients to export the COLORTERM variable.  It is set by terminal emulators, which support colors.  You can use it in your shell's ressource file to enable colors for the prompt and commands if this variable is set.

               (service openssh-service-type
                        (openssh-configuration
                          (accepted-environment '("COLORTERM"))))

     authorized-keys (default: '())
          This is the list of authorized keys.  Each element of the list is a user name followed by one or more file-like objects that represent SSH public keys.  For example:

               (openssh-configuration
                 (authorized-keys
                   `(("rekado" ,(local-file "rekado.pub"))
                     ("chris" ,(local-file "chris.pub"))
                     ("root" ,(local-file "rekado.pub") ,(local-file "chris.pub")))))

          registers the specified public keys for user accounts rekado, chris, and root.

          Additional authorized keys can be specified via service-extension.

          Note that this does not interfere with the use of ~/.ssh/authorized_keys.

 -- Scheme Procedure: dropbear-service [CONFIG]
     Run the Dropbear SSH daemon (https://matt.ucc.asn.au/dropbear/dropbear.html) with the given CONFIG, a <dropbear-configuration> object.

     For example, to specify a Dropbear service listening on port 1234, add this call to the operating system's services field:

          (dropbear-service (dropbear-configuration
                              (port-number 1234)))

 -- Data Type: dropbear-configuration
     This data type represents the configuration of a Dropbear SSH daemon.

     dropbear (default: DROPBEAR)
          The Dropbear package to use.

     port-number (default: 22)
          The TCP port where the daemon waits for incoming connections.

     syslog-output? (default: #t)
          Whether to enable syslog output.

     pid-file (default: "/var/run/dropbear.pid")
          File name of the daemon's PID file.

     root-login? (default: #f)
          Whether to allow root logins.

     allow-empty-passwords? (default: #f)
          Whether to allow empty passwords.

     password-authentication? (default: #t)
          Whether to enable password-based authentication.

 -- Scheme Variable: %facebook-host-aliases
     This variable contains a string for use in /etc/hosts (see Host Names (The GNU C Library Reference Manual)).  Each line contains a entry that maps a known server name of the Facebook on-line service---e.g., www.facebook.com---to the local host---127.0.0.1 or its IPv6 equivalent, ::1.

     This variable is typically used in the hosts-file field of an operating-system declaration (see /etc/hosts):

          (use-modules (gnu) (guix))

          (operating-system
            (host-name "mymachine")
            ;; ...
            (hosts-file
              ;; Create a /etc/hosts file with aliases for "localhost"
              ;; and "mymachine", as well as for Facebook servers.
              (plain-file "hosts"
                          (string-append (local-host-aliases host-name)
                                         %facebook-host-aliases))))

     This mechanism can prevent programs running locally, such as Web browsers, from accessing Facebook.

The (gnu services avahi) provides the following definition.

 -- Scheme Procedure: avahi-service [#:avahi AVAHI]
     [#:host-name #f] [#:publish? #t] [#:ipv4? #t]  [#:ipv6? #t] [#:wide-area?
     #f]  [#:domains-to-browse '()] [#:debug? #f] Return a service that runs avahi-daemon, a system-wide mDNS/DNS-SD responder that allows for service discovery and "zero-configuration" host name lookups (see http://avahi.org/), and extends the name service cache daemon (nscd) so that it can resolve .local host names using nss-mdns (http://0pointer.de/lennart/projects/nss-mdns/). Additionally, add the AVAHI package to the system profile so that commands such as avahi-browse are directly usable.

     If HOST-NAME is different from #f, use that as the host name to publish for this machine; otherwise, use the machine's actual host name.

     When PUBLISH? is true, publishing of host names and services is allowed; in particular, avahi-daemon will publish the machine's host name and IP address via mDNS on the local network.

     When WIDE-AREA? is true, DNS-SD over unicast DNS is enabled.

     Boolean values IPV4? and IPV6? determine whether to use IPv4/IPv6 sockets.

 -- Scheme Variable: openvswitch-service-type
     This is the type of the Open vSwitch (http://www.openvswitch.org) service, whose value should be an openvswitch-configuration object.

 -- Data Type: openvswitch-configuration
     Data type representing the configuration of Open vSwitch, a multilayer virtual switch which is designed to enable massive network automation through programmatic extension.

     package (default: OPENVSWITCH)
          Package object of the Open vSwitch.

Système de fenêtrage X
......................

Support for the X Window graphical display system---specifically Xorg---is provided by the (gnu services xorg) module.  Note that there is no xorg-service procedure.  Instead, the X server is started by the login manager, by default SLiM.

To use X11, you must install at least one window manager---for example the windowmaker or openbox packages---preferably by adding it to the packages field of your operating system definition (see system-wide packages).

 -- Scheme Variable: slim-service-type
     This is the type for the SLiM graphical login manager for X11.

     SLiM looks for session types described by the .desktop files in /run/current-system/profile/share/xsessions and allows users to choose a session from the log-in screen using F1.  Packages such as xfce, sawfish, and ratpoison provide .desktop files; adding them to the system-wide set of packages automatically makes them available at the log-in screen.

     In addition, ~/.xsession files are honored.  When available, ~/.xsession must be an executable that starts a window manager and/or other X clients.

 -- Data Type: slim-configuration
     Data type representing the configuration of slim-service-type.

     allow-empty-passwords? (default: #t)
          Whether to allow logins with empty passwords.

     auto-login? (default: #f)
     default-user (default: "")
          When auto-login? is false, SLiM presents a log-in screen.

          When auto-login? is true, SLiM logs in directly as default-user.

     theme (default: %default-slim-theme)
     theme-name (default: %default-slim-theme-name)
          The graphical theme to use and its name.

     auto-login-session (default: #f)
          If true, this must be the name of the executable to start as the default session---e.g., (file-append windowmaker "/bin/windowmaker").

          If false, a session described by one of the available .desktop files in /run/current-system/profile and ~/.guix-profile will be used.

               You must install at least one window manager in the system profile or in your user profile.  Failing to do that, if auto-login-session is false, you will be unable to log in.

     startx (default: (xorg-start-command))
          The command used to start the X11 graphical server.

     xauth (default: xauth)
          The XAuth package to use.

     shepherd (default: shepherd)
          The Shepherd package used when invoking halt and reboot.

     sessreg (default: sessreg)
          The sessreg package used in order to register the session.

     slim (default: slim)
          The SLiM package to use.

 -- Scheme Variable: %default-theme
 -- Scheme Variable: %default-theme-name
     The default SLiM theme and its name.

 -- Data Type: sddm-configuration
     This is the data type representing the sddm service configuration.

     display-server (default: "x11")
          Select display server to use for the greeter. Valid values are "x11" or "wayland".

     numlock (default: "on")
          Valid values are "on", "off" or "none".

     halt-command (default #~(string-apppend #$shepherd "/sbin/halt"))
          Command to run when halting.

     reboot-command (default #~(string-append #$shepherd "/sbin/reboot"))
          Command to run when rebooting.

     theme (default "maldives")
          Theme to use. Default themes provided by SDDM are "elarun" or "maldives".

     themes-directory (default "/run/current-system/profile/share/sddm/themes")
          Directory to look for themes.

     faces-directory (default "/run/current-system/profile/share/sddm/faces")
          Directory to look for faces.

     default-path (default "/run/current-system/profile/bin")
          Default PATH to use.

     minimum-uid (default 1000)
          Minimum UID to display in SDDM.

     maximum-uid (default 2000)
          Maximum UID to display in SDDM

     remember-last-user? (default #t)
          Remember last user.

     remember-last-session? (default #t)
          Remember last session.

     hide-users (default "")
          Usernames to hide from SDDM greeter.

     hide-shells (default #~(string-append #$shadow "/sbin/nologin"))
          Users with shells listed will be hidden from the SDDM greeter.

     session-command (default #~(string-append #$sddm "/share/sddm/scripts/wayland-session"))
          Script to run before starting a wayland session.

     sessions-directory (default "/run/current-system/profile/share/wayland-sessions")
          Directory to look for desktop files starting wayland sessions.

     xorg-server-path (default xorg-start-command)
          Path to xorg-server.

     xauth-path (default #~(string-append #$xauth "/bin/xauth"))
          Path to xauth.

     xephyr-path (default #~(string-append #$xorg-server "/bin/Xephyr"))
          Path to Xephyr.

     xdisplay-start (default #~(string-append #$sddm "/share/sddm/scripts/Xsetup"))
          Script to run after starting xorg-server.

     xdisplay-stop (default #~(string-append #$sddm "/share/sddm/scripts/Xstop"))
          Script to run before stopping xorg-server.

     xsession-command (par défaut : xinitrc)
          Script to run before starting a X session.

     xsessions-directory (default: "/run/current-system/profile/share/xsessions")
          Directory to look for desktop files starting X sessions.

     minimum-vt (default: 7)
          Minimum VT to use.

     xserver-arguments (default "-nolisten tcp")
          Arguments to pass to xorg-server.

     auto-login-user (default "")
          User to use for auto-login.

     auto-login-session (default "")
          Desktop file to use for auto-login.

     relogin? (default #f)
          Relogin after logout.

 -- Scheme Procedure: sddm-service config
     Return a service that spawns the SDDM graphical login manager for config of type <sddm-configuration>.

            (sddm-service (sddm-configuration
                           (auto-login-user "Alice")
                           (auto-login-session "xfce.desktop")))

 -- Scheme Procedure: xorg-start-command [#:guile]
     [#:modules %default-xorg-modules]  [#:fonts %default-xorg-fonts]
     [#:configuration-file (xorg-configuration-file ...)]  [#:xorg-server
     XORG-SERVER] Return a startx script in which MODULES, a list of X module packages, and FONTS, a list of X font directories, are available.  See xorg-wrapper for more details on the arguments. The result should be used in place of startx.

     Usually the X server is started by a login manager.

 -- Scheme Procedure: xorg-configuration-file
     [#:modules %default-xorg-modules]  [#:fonts %default-xorg-fonts]
     [#:drivers '()] [#:resolutions '()] [#:extra-config '()] Return a
     configuration file for the Xorg server containing search paths for all the common drivers.

     MODULES must be a list of module packages loaded by the Xorg server---e.g., xf86-video-vesa, xf86-input-keyboard, and so on.  FONTS must be a list of font directories to add to the server's font path.

     DRIVERS must be either the empty list, in which case Xorg chooses a graphics driver automatically, or a list of driver names that will be tried in this order---e.g., ("modesetting" "vesa").

     Likewise, when RESOLUTIONS is the empty list, Xorg chooses an appropriate screen resolution; otherwise, it must be a list of resolutions---e.g., ((1024 768) (640 480)).

     Last, EXTRA-CONFIG is a list of strings or objects appended to the configuration file.  It is used to pass extra text to be added verbatim to the configuration file.

     This procedure is especially useful to configure a different keyboard layout than the default US keymap.  For instance, to use the ``bépo'' keymap by default on the display manager:

          (define bepo-evdev
            "Section \"InputClass\"
                  Identifier \"evdev keyboard catchall\"
                  Driver \"evdev\"
                  MatchIsKeyboard \"on\"
                  Option \"xkb_layout\" \"fr\"
                  Option \"xkb_variant\" \"bepo\"
          EndSection")

          (operating-system
            ...
            (services
              (modify-services %desktop-services
                (slim-service-type config =>
                  (slim-configuration
                    (inherit config)
                    (startx (xorg-start-command
                             #:configuration-file
                             (xorg-configuration-file
                               #:extra-config
                               (list bepo-evdev)))))))))

     The MatchIsKeyboard line specifies that we only apply the configuration to keyboards.  Without this line, other devices such as touchpad may not work correctly because they will be attached to the wrong driver.  In this example, the user typically used setxkbmap fr bepo to set their favorite keymap once logged in.  The first argument corresponds to the layout, while the second argument corresponds to the variant.  The xkb_variant line can be omitted to select the default variant.

 -- Scheme Procedure: screen-locker-service PACKAGE [PROGRAM]
     Add PACKAGE, a package for a screen locker or screen saver whose command is PROGRAM, to the set of setuid programs and add a PAM entry for it.  For example:

          (screen-locker-service xlockmore "xlock")

     makes the good ol' XlockMore usable.

Services d'impression
.....................

The (gnu services cups) module provides a Guix service definition for the CUPS printing service.  To add printer support to a GuixSD system, add a cups-service to the operating system definition:

 -- Scheme Variable: cups-service-type
     The service type for the CUPS print server.  Its value should be a valid CUPS configuration (see below).  To use the default settings, simply write:

          (service cups-service-type)

The CUPS configuration controls the basic things about your CUPS installation: what interfaces it listens on, what to do if a print job fails, how much logging to do, and so on.  To actually add a printer, you have to visit the http://localhost:631 URL, or use a tool such as GNOME's printer configuration services.  By default, configuring a CUPS service will generate a self-signed certificate if needed, for secure connections to the print server.

Suppose you want to enable the Web interface of CUPS and also add support for Epson printers via the escpr package and for HP printers via the hplip-minimal package.  You can do that directly, like this (you need to use the (gnu packages cups) module):

     (service cups-service-type
              (cups-configuration
                (web-interface? #t)
                (extensions
                  (list cups-filters escpr hplip-minimal))))

Note: If you wish to use the Qt5 based GUI which comes with the hplip package then it is suggested that you install the hplip package, either in your OS configuration file or as your user.

The available configuration parameters follow.  Each parameter definition is preceded by its type; for example, string-list foo indicates that the foo parameter should be specified as a list of strings.  There is also a way to specify the configuration as a string, if you have an old cupsd.conf file that you want to port over from some other system; see the end for more details.

Available cups-configuration fields are:

 -- cups-configuration parameter: package cups
     The CUPS package.

 -- cups-configuration parameter: package-list extensions
     Drivers and other extensions to the CUPS package.

 -- cups-configuration parameter: files-configuration files-configuration
     Configuration of where to write logs, what directories to use for print spools, and related privileged configuration parameters.

     Available files-configuration fields are:

      -- files-configuration parameter: log-location access-log
          Defines the access log filename.  Specifying a blank filename disables access log generation.  The value stderr causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.  The value syslog causes log entries to be sent to the system log daemon. The server name may be included in filenames using the string %s, as in /var/log/cups/%s-access_log.

          Defaults to "/var/log/cups/access_log".

      -- files-configuration parameter: file-name cache-dir
          Where CUPS should cache data.

          Defaults to "/var/cache/cups".

      -- files-configuration parameter: string config-file-perm
          Specifies the permissions for all configuration files that the scheduler writes.

          Note that the permissions for the printers.conf file are currently masked to only allow access from the scheduler user (typically root).  This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system.  There is no way to disable this security feature.

          Defaults to "0640".

      -- files-configuration parameter: log-location error-log
          Defines the error log filename.  Specifying a blank filename disables access log generation.  The value stderr causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.  The value syslog causes log entries to be sent to the system log daemon.  The server name may be included in filenames using the string %s, as in /var/log/cups/%s-error_log.

          Defaults to "/var/log/cups/error_log".

      -- files-configuration parameter: string fatal-errors
          Specifies which errors are fatal, causing the scheduler to exit.  The kind strings are:

          none
               No errors are fatal.

          all
               All of the errors below are fatal.

          browse
               Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon.

          config
               Configuration file syntax errors are fatal.

          listen
               Listen or Port errors are fatal, except for IPv6 failures on the loopback or any addresses.

          log
               Log file creation or write errors are fatal.

          permissions
               Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions.

          Defaults to "all -browse".

      -- files-configuration parameter: boolean file-device?
          Specifies whether the file pseudo-device can be used for new printer queues.  The URI file:///dev/null is always allowed.

          Defaults to #f.

      -- files-configuration parameter: string group
          Specifies the group name or ID that will be used when executing external programs.

          Defaults to "lp".

      -- files-configuration parameter: string log-file-perm
          Specifies the permissions for all log files that the scheduler writes.

          Defaults to "0644".

      -- files-configuration parameter: log-location page-log
          Defines the page log filename.  Specifying a blank filename disables access log generation.  The value stderr causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.  The value syslog causes log entries to be sent to the system log daemon.  The server name may be included in filenames using the string %s, as in /var/log/cups/%s-page_log.

          Defaults to "/var/log/cups/page_log".

      -- files-configuration parameter: string remote-root
          Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user.  The default is remroot.

          Defaults to "remroot".

      -- files-configuration parameter: file-name request-root
          Specifies the directory that contains print jobs and other HTTP request data.

          Defaults to "/var/spool/cups".

      -- files-configuration parameter: sandboxing sandboxing
          Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler; either relaxed or strict.  This directive is currently only used/supported on macOS.

          Defaults to strict.

      -- files-configuration parameter: file-name server-keychain
          Specifies the location of TLS certificates and private keys.  CUPS will look for public and private keys in this directory: a .crt files for PEM-encoded certificates and corresponding .key files for PEM-encoded private keys.

          Defaults to "/etc/cups/ssl".

      -- files-configuration parameter: file-name server-root
          Specifies the directory containing the server configuration files.

          Defaults to "/etc/cups".

      -- files-configuration parameter: boolean sync-on-close?
          Specifies whether the scheduler calls fsync(2) after writing configuration or state files.

          Defaults to #f.

      -- files-configuration parameter: space-separated-string-list system-group
          Specifies the group(s) to use for @SYSTEM group authentication.

      -- files-configuration parameter: file-name temp-dir
          Specifies the directory where temporary files are stored.

          Defaults to "/var/spool/cups/tmp".

      -- files-configuration parameter: string user
          Specifies the user name or ID that is used when running external programs.

          Defaults to "lp".

 -- cups-configuration parameter: access-log-level access-log-level
     Specifies the logging level for the AccessLog file.  The config level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated.  The actions level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for config.  The all level logs all requests.

     Defaults to actions.

 -- cups-configuration parameter: boolean auto-purge-jobs?
     Specifies whether to purge job history data automatically when it is no longer required for quotas.

     Defaults to #f.

 -- cups-configuration parameter: browse-local-protocols browse-local-protocols
     Specifies which protocols to use for local printer sharing.

     Defaults to dnssd.

 -- cups-configuration parameter: boolean browse-web-if?
     Specifies whether the CUPS web interface is advertised.

     Defaults to #f.

 -- cups-configuration parameter: boolean browsing?
     Specifies whether shared printers are advertised.

     Defaults to #f.

 -- cups-configuration parameter: string classification
     Specifies the security classification of the server.  Any valid banner name can be used, including "classified", "confidential", "secret", "topsecret", and "unclassified", or the banner can be omitted to disable secure printing functions.

     Defaults to "".

 -- cups-configuration parameter: boolean classify-override?
     Specifies whether users may override the classification (cover page) of individual print jobs using the job-sheets option.

     Defaults to #f.

 -- cups-configuration parameter: default-auth-type default-auth-type
     Specifies the default type of authentication to use.

     Defaults to Basic.

 -- cups-configuration parameter: default-encryption default-encryption
     Specifies whether encryption will be used for authenticated requests.

     Defaults to Required.

 -- cups-configuration parameter: string default-language
     Specifies the default language to use for text and web content.

     Defaults to "en".

 -- cups-configuration parameter: string default-paper-size
     Specifies the default paper size for new print queues.  "Auto" uses a locale-specific default, while "None" specifies there is no default paper size.  Specific size names are typically "Letter" or "A4".

     Defaults to "Auto".

 -- cups-configuration parameter: string default-policy
     Specifies the default access policy to use.

     Defaults to "default".

 -- cups-configuration parameter: boolean default-shared?
     Specifies whether local printers are shared by default.

     Defaults to #t.

 -- cups-configuration parameter: non-negative-integer dirty-clean-interval
     Specifies the delay for updating of configuration and state files, in seconds.  A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds.

     Defaults to 30.

 -- cups-configuration parameter: error-policy error-policy
     Specifies what to do when an error occurs.  Possible values are abort-job, which will discard the failed print job; retry-job, which will retry the job at a later time; retry-this-job, which retries the failed job immediately; and stop-printer, which stops the printer.

     Defaults to stop-printer.

 -- cups-configuration parameter: non-negative-integer filter-limit
     Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems.  A limit of 0 disables filter limiting.  An average print to a non-PostScript printer needs a filter limit of about 200.  A PostScript printer needs about half that (100).  Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time.

     Defaults to 0.

 -- cups-configuration parameter: non-negative-integer filter-nice
     Specifies the scheduling priority of filters that are run to print a job. The nice value ranges from 0, the highest priority, to 19, the lowest priority.

     Defaults to 0.

 -- cups-configuration parameter: host-name-lookups host-name-lookups
     Specifies whether to do reverse lookups on connecting clients.  The double setting causes cupsd to verify that the hostname resolved from the address matches one of the addresses returned for that hostname.  Double lookups also prevent clients with unregistered addresses from connecting to your server.  Only set this option to #t or double if absolutely required.

     Defaults to #f.

 -- cups-configuration parameter: non-negative-integer job-kill-delay
     Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.

     Defaults to 30.

 -- cups-configuration parameter: non-negative-integer job-retry-interval
     Specifies the interval between retries of jobs in seconds.  This is typically used for fax queues but can also be used with normal print queues whose error policy is retry-job or retry-current-job.

     Defaults to 30.

 -- cups-configuration parameter: non-negative-integer job-retry-limit
     Specifies the number of retries that are done for jobs.  This is typically used for fax queues but can also be used with normal print queues whose error policy is retry-job or retry-current-job.

     Defaults to 5.

 -- cups-configuration parameter: boolean keep-alive?
     Specifies whether to support HTTP keep-alive connections.

     Defaults to #t.

 -- cups-configuration parameter: non-negative-integer keep-alive-timeout
     Specifies how long an idle client connection remains open, in seconds.

     Defaults to 30.

 -- cups-configuration parameter: non-negative-integer limit-request-body
     Specifies the maximum size of print files, IPP requests, and HTML form data.  A limit of 0 disables the limit check.

     Defaults to 0.

 -- cups-configuration parameter: multiline-string-list listen
     Listens on the specified interfaces for connections.  Valid values are of the form ADDRESS:PORT, where ADDRESS is either an IPv6 address enclosed in brackets, an IPv4 address, or * to indicate all addresses.  Values can also be file names of local UNIX domain sockets.  The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks.

 -- cups-configuration parameter: non-negative-integer listen-back-log
     Specifies the number of pending connections that will be allowed.  This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections.  When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones.

     Defaults to 128.

 -- cups-configuration parameter: location-access-control-list location-access-controls
     Specifies a set of additional access controls.

     Available location-access-controls fields are:

      -- location-access-controls parameter: file-name path
          Specifies the URI path to which the access control applies.

      -- location-access-controls parameter: access-control-list access-controls
          Access controls for all access to this path, in the same format as the access-controls of operation-access-control.

          Defaults to ().

      -- location-access-controls parameter: method-access-control-list method-access-controls
          Access controls for method-specific access to this path.

          Defaults to ().

          Available method-access-controls fields are:

           -- method-access-controls parameter: boolean reverse?
               If #t, apply access controls to all methods except the listed methods.  Otherwise apply to only the listed methods.

               Defaults to #f.

           -- method-access-controls parameter: method-list methods
               Methods to which this access control applies.

               Defaults to ().

           -- method-access-controls parameter: access-control-list access-controls
               Access control directives, as a list of strings.  Each string should be one directive, such as "Order allow,deny".

               Defaults to ().

 -- cups-configuration parameter: non-negative-integer log-debug-history
     Specifies the number of debugging messages that are retained for logging if an error occurs in a print job.  Debug messages are logged regardless of the LogLevel setting.

     Defaults to 100.

 -- cups-configuration parameter: log-level log-level
     Specifies the level of logging for the ErrorLog file.  The value none stops all logging while debug2 logs everything.

     Defaults to info.

 -- cups-configuration parameter: log-time-format log-time-format
     Specifies the format of the date and time in the log files.  The value standard logs whole seconds while usecs logs microseconds.

     Defaults to standard.

 -- cups-configuration parameter: non-negative-integer max-clients
     Specifies the maximum number of simultaneous clients that are allowed by the scheduler.

     Defaults to 100.

 -- cups-configuration parameter: non-negative-integer max-clients-per-host
     Specifies the maximum number of simultaneous clients that are allowed from a single address.

     Defaults to 100.

 -- cups-configuration parameter: non-negative-integer max-copies
     Specifies the maximum number of copies that a user can print of each job.

     Defaults to 9999.

 -- cups-configuration parameter: non-negative-integer max-hold-time
     Specifies the maximum time a job may remain in the indefinite hold state before it is canceled.  A value of 0 disables cancellation of held jobs.

     Defaults to 0.

 -- cups-configuration parameter: non-negative-integer max-jobs
     Specifies the maximum number of simultaneous jobs that are allowed.  Set to 0 to allow an unlimited number of jobs.

     Defaults to 500.

 -- cups-configuration parameter: non-negative-integer max-jobs-per-printer
     Specifies the maximum number of simultaneous jobs that are allowed per printer.  A value of 0 allows up to MaxJobs jobs per printer.

     Defaults to 0.

 -- cups-configuration parameter: non-negative-integer max-jobs-per-user
     Specifies the maximum number of simultaneous jobs that are allowed per user.  A value of 0 allows up to MaxJobs jobs per user.

     Defaults to 0.

 -- cups-configuration parameter: non-negative-integer max-job-time
     Specifies the maximum time a job may take to print before it is canceled, in seconds.  Set to 0 to disable cancellation of "stuck" jobs.

     Defaults to 10800.

 -- cups-configuration parameter: non-negative-integer max-log-size
     Specifies the maximum size of the log files before they are rotated, in bytes.  The value 0 disables log rotation.

     Defaults to 1048576.

 -- cups-configuration parameter: non-negative-integer multiple-operation-timeout
     Specifies the maximum amount of time to allow between files in a multiple file print job, in seconds.

     Defaults to 300.

 -- cups-configuration parameter: string page-log-format
     Specifies the format of PageLog lines.  Sequences beginning with percent (%) characters are replaced with the corresponding information, while all other characters are copied literally.  The following percent sequences are recognized:

     %%
          insert a single percent character

     %{name}
          insert the value of the specified IPP attribute

     %C
          insert the number of copies for the current page

     %P
          insert the current page number

     %T
          insert the current date and time in common log format

     %j
          insert the job ID

     %p
          insert the printer name

     %u
          insert the username

     A value of the empty string disables page logging.  The string %p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides} creates a page log with the standard items.

     Defaults to "".

 -- cups-configuration parameter: environment-variables environment-variables
     Passes the specified environment variable(s) to child processes; a list of strings.

     Defaults to ().

 -- cups-configuration parameter: policy-configuration-list policies
     Specifies named access control policies.

     Available policy-configuration fields are:

      -- policy-configuration parameter: string name
          Name of the policy.

      -- policy-configuration parameter: string job-private-access
          Specifies an access list for a job's private values.  @ACL maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.  @OWNER maps to the job's owner.  @SYSTEM maps to the groups listed for the system-group field of the files-config configuration, which is reified into the cups-files.conf(5) file.  Other possible elements of the access list include specific user names, and @GROUP to indicate members of a specific group.  The access list may also be simply all or default.

          Defaults to "@OWNER @SYSTEM".

      -- policy-configuration parameter: string job-private-values
          Specifies the list of job values to make private, or all, default, or none.

          Defaults to "job-name job-originating-host-name job-originating-user-name phone".

      -- policy-configuration parameter: string subscription-private-access
          Specifies an access list for a subscription's private values.  @ACL maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.  @OWNER maps to the job's owner.  @SYSTEM maps to the groups listed for the system-group field of the files-config configuration, which is reified into the cups-files.conf(5) file.  Other possible elements of the access list include specific user names, and @GROUP to indicate members of a specific group.  The access list may also be simply all or default.

          Defaults to "@OWNER @SYSTEM".

      -- policy-configuration parameter: string subscription-private-values
          Specifies the list of job values to make private, or all, default, or none.

          Defaults to "notify-events notify-pull-method notify-recipient-uri notify-subscriber-user-name notify-user-data".

      -- policy-configuration parameter: operation-access-control-list access-controls
          Access control by IPP operation.

          Defaults to ().

 -- cups-configuration parameter: boolean-or-non-negative-integer preserve-job-files
     Specifies whether job files (documents) are preserved after a job is printed.  If a numeric value is specified, job files are preserved for the indicated number of seconds after printing.  Otherwise a boolean value applies indefinitely.

     Defaults to 86400.

 -- cups-configuration parameter: boolean-or-non-negative-integer preserve-job-history
     Specifies whether the job history is preserved after a job is printed.  If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing.  If #t, the job history is preserved until the MaxJobs limit is reached.

     Defaults to #t.

 -- cups-configuration parameter: non-negative-integer reload-timeout
     Specifies the amount of time to wait for job completion before restarting the scheduler.

     Defaults to 30.

 -- cups-configuration parameter: string rip-cache
     Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.

     Defaults to "128m".

 -- cups-configuration parameter: string server-admin
     Specifies the email address of the server administrator.

     Defaults to "root@localhost.localdomain".

 -- cups-configuration parameter: host-name-list-or-* server-alias
     The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces.  Using the special name * can expose your system to known browser-based DNS rebinding attacks, even when accessing sites through a firewall.  If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using *.

     Defaults to *.

 -- cups-configuration parameter: string server-name
     Specifies the fully-qualified host name of the server.

     Defaults to "localhost".

 -- cups-configuration parameter: server-tokens server-tokens
     Specifies what information is included in the Server header of HTTP responses.  None disables the Server header.  ProductOnly reports CUPS.  Major reports CUPS 2.  Minor reports CUPS 2.0.  Minimal reports CUPS 2.0.0. OS reports CUPS 2.0.0 (UNAME) where UNAME is the output of the uname command.  Full reports CUPS 2.0.0 (UNAME) IPP/2.0.

     Defaults to Minimal.

 -- cups-configuration parameter: string set-env
     Set the specified environment variable to be passed to child processes.

     Defaults to "variable value".

 -- cups-configuration parameter: multiline-string-list ssl-listen
     Listens on the specified interfaces for encrypted connections.  Valid values are of the form ADDRESS:PORT, where ADDRESS is either an IPv6 address enclosed in brackets, an IPv4 address, or * to indicate all addresses.

     Defaults to ().

 -- cups-configuration parameter: ssl-options ssl-options
     Sets encryption options.  By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.  The AllowRC4 option enables the 128-bit RC4 cipher suites, which are required for some older clients that do not implement newer ones.  The AllowSSL3 option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.

     Defaults to ().

 -- cups-configuration parameter: boolean strict-conformance?
     Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications.

     Defaults to #f.

 -- cups-configuration parameter: non-negative-integer timeout
     Specifies the HTTP request timeout, in seconds.

     Defaults to 300.

 -- cups-configuration parameter: boolean web-interface?
     Specifies whether the web interface is enabled.

     Defaults to #f.

At this point you're probably thinking ``oh dear, Guix manual, I like you but you can stop already with the configuration options''.  Indeed. However, one more point: it could be that you have an existing cupsd.conf that you want to use.  In that case, you can pass an opaque-cups-configuration as the configuration of a cups-service-type.

Available opaque-cups-configuration fields are:

 -- opaque-cups-configuration parameter: package cups
     The CUPS package.

 -- opaque-cups-configuration parameter: string cupsd.conf
     The contents of the cupsd.conf, as a string.

 -- opaque-cups-configuration parameter: string cups-files.conf
     The contents of the cups-files.conf file, as a string.

For example, if your cupsd.conf and cups-files.conf are in strings of the same name, you could instantiate a CUPS service like this:

     (service cups-service-type
              (opaque-cups-configuration
                (cupsd.conf cupsd.conf)
                (cups-files.conf cups-files.conf)))

Services de bureaux
...................

The (gnu services desktop) module provides services that are usually useful in the context of a ``desktop'' setup---that is, on a machine running a graphical display server, possibly with graphical user interfaces, etc. It also defines services that provide specific desktop environments like GNOME, XFCE or MATE.

To simplify things, the module defines a variable containing the set of services that users typically expect on a machine with a graphical environment and networking:

 -- Scheme Variable: %desktop-services
     This is a list of services that builds upon %BASE-SERVICES and adds or adjusts services for a typical ``desktop'' setup.

     In particular, it adds a graphical login manager (see slim-service), screen lockers, a network management tool (see network-manager-service-type), energy and color management services, the elogind login and seat manager, the Polkit privilege service, the GeoClue location service, the AccountsService daemon that allows authorized users change system passwords, an NTP client (see Services réseau), the Avahi daemon, and has the name service switch service configured to be able to use nss-mdns (see mDNS).

The %DESKTOP-SERVICES variable can be used as the services field of an operating-system declaration (see services).

Additionally, the gnome-desktop-service, xfce-desktop-service, mate-desktop-service and enlightenment-desktop-service-type procedures can add GNOME, XFCE, MATE and/or Enlightenment to a system.  To ``add GNOME'' means that system-level services like the backlight adjustment helpers and the power management utilities are added to the system, extending polkit and dbus appropriately, allowing GNOME to operate with elevated privileges on a limited number of special-purpose system interfaces.  Additionally, adding a service made by gnome-desktop-service adds the GNOME metapackage to the system profile.  Likewise, adding the XFCE service not only adds the xfce metapackage to the system profile, but it also gives the Thunar file manager the ability to open a ``root-mode'' file management window, if the user authenticates using the administrator's password via the standard polkit graphical interface.  To ``add MATE'' means that polkit and dbus are extended appropriately, allowing MATE to operate with elevated privileges on a limited number of special-purpose system interfaces.  Additionally, adding a service made by mate-desktop-service adds the MATE metapackage to the system profile.  ``Adding ENLIGHTENMENT'' means that dbus is extended appropriately, and several of Enlightenment's binaries are set as setuid, allowing Enlightenment's screen locker and other functionality to work as expetected.

The desktop environments in Guix use the Xorg display server by default.  If you'd like to use the newer display server protocol called Wayland, you need to use the sddm-service instead of the slim-service for the graphical login manager.  You should then select the ``GNOME (Wayland)'' session in SDDM.  Alternatively you can also try starting GNOME on Wayland manually from a TTY with the command ``XDG_SESSION_TYPE=wayland exec dbus-run-session gnome-session``.  Currently only GNOME has support for Wayland.

 -- Scheme Procedure: gnome-desktop-service
     Return a service that adds the gnome package to the system profile, and extends polkit with the actions from gnome-settings-daemon.

 -- Scheme Procedure: xfce-desktop-service
     Return a service that adds the xfce package to the system profile, and extends polkit with the ability for thunar to manipulate the file system as root from within a user session, after the user has authenticated with the administrator's password.

 -- Scheme Procedure: mate-desktop-service
     Return a service that adds the mate package to the system profile, and extends polkit with the actions from mate-settings-daemon.

 -- Procédure Scheme: enlightenment-desktop-service-type
     Return a service that adds the enlightenment package to the system profile, and extends dbus with actions from efl.

 -- Data Type: enlightenment-desktop-service-configuration

     enlightenment (par défaut : enlightenment)
          Le paquet enlightenment à utiliser.

Because the GNOME, XFCE and MATE desktop services pull in so many packages, the default %desktop-services variable doesn't include any of them by default.  To add GNOME, XFCE or MATE, just cons them onto %desktop-services in the services field of your operating-system:

     (use-modules (gnu))
     (use-service-modules desktop)
     (operating-system
       ...
       ;; cons* adds items to the list given as its last argument.
       (services (cons* (gnome-desktop-service)
                        (xfce-desktop-service)
                        %desktop-services))
       ...)

These desktop environments will then be available as options in the graphical login window.

The actual service definitions included in %desktop-services and provided by (gnu services dbus) and (gnu services desktop) are described below.

 -- Scheme Procedure: dbus-service [#:dbus DBUS] [#:services '()]
     Return a service that runs the ``system bus'', using DBUS, with support for SERVICES.

     D-Bus (http://dbus.freedesktop.org/) is an inter-process communication facility.  Its system bus is used to allow system services to communicate and to be notified of system-wide events.

     SERVICES must be a list of packages that provide an etc/dbus-1/system.d directory containing additional D-Bus configuration and policy files.  For example, to allow avahi-daemon to use the system bus, SERVICES must be equal to (list avahi).

 -- Scheme Procedure: elogind-service [#:config CONFIG]
     Return a service that runs the elogind login and seat management daemon.  Elogind (https://github.com/elogind/elogind) exposes a D-Bus interface that can be used to know which users are logged in, know what kind of sessions they have open, suspend the system, inhibit system suspend, reboot the system, and other tasks.

     Elogind handles most system-level power events for a computer, for example suspending the system when a lid is closed, or shutting it down when the power button is pressed.

     The CONFIG keyword argument specifies the configuration for elogind, and should be the result of an (elogind-configuration (PARAMETER VALUE)...) invocation.  Available parameters and their default values are:

     kill-user-processes?
          #f

     kill-only-users
          ()

     kill-exclude-users
          ("root")

     inhibit-delay-max-seconds
          5

     handle-power-key
          poweroff

     handle-suspend-key
          suspend

     handle-hibernate-key
          hibernate

     handle-lid-switch
          suspend

     handle-lid-switch-docked
          ignore

     power-key-ignore-inhibited?
          #f

     suspend-key-ignore-inhibited?
          #f

     hibernate-key-ignore-inhibited?
          #f

     lid-switch-ignore-inhibited?
          #t

     holdoff-timeout-seconds
          30

     idle-action
          ignore

     idle-action-seconds
          (* 30 60)

     runtime-directory-size-percent
          10

     runtime-directory-size
          #f

     remove-ipc?
          #t

     suspend-state
          ("mem" "standby" "freeze")

     suspend-mode
          ()

     hibernate-state
          ("disk")

     hibernate-mode
          ("platform" "shutdown")

     hybrid-sleep-state
          ("disk")

     hybrid-sleep-mode
          ("suspend" "platform" "shutdown")

 -- Scheme Procedure: accountsservice-service
     [#:accountsservice ACCOUNTSSERVICE] Return a service that runs
     AccountsService, a system service that can list available accounts, change their passwords, and so on.  AccountsService integrates with PolicyKit to enable unprivileged users to acquire the capability to modify their system configuration. the accountsservice web site (https://www.freedesktop.org/wiki/Software/AccountsService/) for more information.

     The ACCOUNTSSERVICE keyword argument is the accountsservice package to expose as a service.

 -- Scheme Procedure: polkit-service
     [#:polkit POLKIT] Return a service that runs the
     Polkit privilege management service (http://www.freedesktop.org/wiki/Software/polkit/), which allows system administrators to grant access to privileged operations in a structured way.  By querying the Polkit service, a privileged system component can know when it should grant additional capabilities to ordinary users.  For example, an ordinary user can be granted the capability to suspend the system if the user is logged in locally.

 -- Scheme Procedure: upower-service [#:upower UPOWER]
     [#:watts-up-pro? #f]  [#:poll-batteries? #t]  [#:ignore-lid? #f]
     [#:use-percentage-for-policy? #f]  [#:percentage-low 10]
     [#:percentage-critical 3]  [#:percentage-action 2]  [#:time-low 1200]
     [#:time-critical 300]  [#:time-action 120]  [#:critical-power-action
     'hybrid-sleep] Return a service that runs upowerd (http://upower.freedesktop.org/), a system-wide monitor for power consumption and battery levels, with the given configuration settings.  It implements the org.freedesktop.UPower D-Bus interface, and is notably used by GNOME.

 -- Scheme Procedure: udisks-service [#:udisks UDISKS]
     Return a service for UDisks (http://udisks.freedesktop.org/docs/latest/), a disk management daemon that provides user interfaces with notifications and ways to mount/unmount disks.  Programs that talk to UDisks include the udisksctl command, part of UDisks, and GNOME Disks.

 -- Scheme Procedure: colord-service [#:colord COLORD]
     Return a service that runs colord, a system service with a D-Bus interface to manage the color profiles of input and output devices such as screens and scanners.  It is notably used by the GNOME Color Manager graphical tool.  See the colord web site (http://www.freedesktop.org/software/colord/) for more information.

 -- Scheme Procedure: geoclue-application name [#:allowed? #t] [#:system? #f] [#:users '()]
     Return a configuration allowing an application to access GeoClue location data.  NAME is the Desktop ID of the application, without the .desktop part.  If ALLOWED? is true, the application will have access to location information by default.  The boolean SYSTEM? value indicates whether an application is a system component or not.  Finally USERS is a list of UIDs of all users for which this application is allowed location info access.  An empty users list means that all users are allowed.

 -- Scheme Variable: %standard-geoclue-applications
     The standard list of well-known GeoClue application configurations, granting authority to the GNOME date-and-time utility to ask for the current location in order to set the time zone, and allowing the IceCat and Epiphany web browsers to request location information.  IceCat and Epiphany both query the user before allowing a web page to know the user's location.

 -- Scheme Procedure: geoclue-service [#:colord COLORD]
     [#:whitelist '()]  [#:wifi-geolocation-url
     "https://location.services.mozilla.com/v1/geolocate?key=geoclue"] [#:submit-data? #f] [#:wifi-submission-url "https://location.services.mozilla.com/v1/submit?key=geoclue"] [#:submission-nick "geoclue"]  [#:applications %standard-geoclue-applications] Return a service that runs the GeoClue location service.  This service provides a D-Bus interface to allow applications to request access to a user's physical location, and optionally to add information to online location databases.  See the GeoClue web site (https://wiki.freedesktop.org/www/Software/GeoClue/) for more information.

 -- Scheme Procedure: bluetooth-service [#:bluez BLUEZ]
     [#:auto-enable? #f] Return a service that runs the bluetoothd
     daemon, which manages all the Bluetooth devices and provides a number of D-Bus interfaces.  When AUTO-ENABLE? is true, the bluetooth controller is powered automatically at boot, which can be useful when using a bluetooth keyboard or mouse.

     Users need to be in the lp group to access the D-Bus service.

Services de son
...............

The (gnu services sound) module provides a service to configure the Advanced Linux Sound Architecture (ALSA) system, which making PulseAudio the prefered ALSA output driver.

 -- Variable Scheme: alsa-service-type
     This is the type for the Advanced Linux Sound Architecture (https://alsa-project.org/) (ALSA) system, which generates the /etc/asound.conf configuration file.  The value for this type is a alsa-configuration record as in this example:

          (service alsa-service-type)

     See below for details about alsa-configuration.

 -- Type de donnée: alsa-configuration
     Data type representing the configuration for alsa-service.

     alsa-plugins (default: ALSA-PLUGINS)
          alsa-plugins package to use.

     pulseaudio? (par défaut : #t)
          Whether ALSA applications should transparently be made to use the PulseAudio (http://www.pulseaudio.org/) sound server.

          Using PulseAudio allows you to run several sound-producing applications at the same time and to individual control them via pavucontrol, among other things.

     extra-options (par défaut : "")
          String to append to the /etc/asound.conf file.

Individual users who want to override the system configuration of ALSA can do it with the ~/.asoundrc file:

     # In guix, we have to specify the absolute path for plugins.
     pcm_type.jack {
       lib "/home/alice/.guix-profile/lib/alsa-lib/libasound_module_pcm_jack.so"
     }

     # Routing ALSA to jack:
     # <http://jackaudio.org/faq/routing_alsa.html>.
     pcm.rawjack {
       type jack
       playback_ports {
         0 system:playback_1
         1 system:playback_2
       }

       capture_ports {
         0 system:capture_1
         1 system:capture_2
       }
     }

     pcm.!default {
       type plug
       slave {
         pcm "rawjack"
       }
     }

See https://www.alsa-project.org/main/index.php/Asoundrc for the details.

Services de bases de données
............................

The (gnu services databases) module provides the following services.

 -- Scheme Procedure: postgresql-service [#:postgresql postgresql]
     [#:config-file] [#:data-directory ``/var/lib/postgresql/data'']  [#:port
     5432] [#:locale ``en_US.utf8''] Return a service that runs POSTGRESQL, the PostgreSQL database server.

     The PostgreSQL daemon loads its runtime configuration from CONFIG-FILE, creates a database cluster with LOCALE as the default locale, stored in DATA-DIRECTORY.  It then listens on PORT.

 -- Scheme Procedure: mysql-service [#:config (mysql-configuration)]
     Return a service that runs mysqld, the MySQL or MariaDB database server.

     The optional CONFIG argument specifies the configuration for mysqld, which should be a <mysql-configuration> object.

 -- Data Type: mysql-configuration
     Data type representing the configuration of MYSQL-SERVICE.

     mysql (default: MARIADB)
          Package object of the MySQL database server, can be either MARIADB or MYSQL.

          For MySQL, a temporary root password will be displayed at activation time. For MariaDB, the root password is empty.

     port (default: 3306)
          TCP port on which the database server listens for incoming connections.

 -- Scheme Variable: memcached-service-type
     This is the service type for the Memcached (https://memcached.org/) service, which provides a distributed in memory cache.  The value for the service type is a memcached-configuration object.

     (service memcached-service-type)

 -- Data Type: memcached-configuration
     Data type representing the configuration of memcached.

     memcached (default: memcached)
          The Memcached package to use.

     interfaces (default: '("0.0.0.0"))
          Network interfaces on which to listen.

     tcp-port (default: 11211)
          Port on which to accept connections on,

     udp-port (default: 11211)
          Port on which to accept UDP connections on, a value of 0 will disable listening on a UDP socket.

     additional-options (default: '())
          Additional command line options to pass to memcached.

 -- Scheme Variable: mongodb-service-type
     This is the service type for MongoDB (https://www.mongodb.com/).  The value for the service type is a mongodb-configuration object.

     (service mongodb-service-type)

 -- Data Type: mongodb-configuration
     Data type representing the configuration of mongodb.

     mongodb (default: mongodb)
          The MongoDB package to use.

     config-file (default: %default-mongodb-configuration-file)
          The configuration file for MongoDB.

     data-directory (default: "/var/lib/mongodb")
          This value is used to create the directory, so that it exists and is owned by the mongodb user.  It should match the data-directory which MongoDB is configured to use through the configuration file.

 -- Scheme Variable: redis-service-type
     This is the service type for the Redis (https://redis.io/) key/value store, whose value is a redis-configuration object.

 -- Data Type: redis-configuration
     Data type representing the configuration of redis.

     redis (default: redis)
          The Redis package to use.

     bind (default: "127.0.0.1")
          Network interface on which to listen.

     port (default: 6379)
          Port on which to accept connections on, a value of 0 will disable listening on a TCP socket.

     working-directory (default: "/var/lib/redis")
          Directory in which to store the database and related files.

Services de courriels
.....................

The (gnu services mail) module provides Guix service definitions for email services: IMAP, POP3, and LMTP servers, as well as mail transport agents (MTAs).  Lots of acronyms! These services are detailed in the subsections below.

Dovecot Service
...............

 -- Scheme Procedure: dovecot-service [#:config (dovecot-configuration)]
     Return a service that runs the Dovecot IMAP/POP3/LMTP mail server.

By default, Dovecot does not need much configuration; the default configuration object created by (dovecot-configuration) will suffice if your mail is delivered to ~/Maildir.  A self-signed certificate will be generated for TLS-protected connections, though Dovecot will also listen on cleartext ports by default.  There are a number of options, though, which mail administrators might need to change, and as is the case with other services, Guix allows the system administrator to specify these parameters via a uniform Scheme interface.

For example, to specify that mail is located at maildir~/.mail, one would instantiate the Dovecot service like this:

     (dovecot-service #:config
                      (dovecot-configuration
                       (mail-location "maildir:~/.mail")))

The available configuration parameters follow.  Each parameter definition is preceded by its type; for example, string-list foo indicates that the foo parameter should be specified as a list of strings.  There is also a way to specify the configuration as a string, if you have an old dovecot.conf file that you want to port over from some other system; see the end for more details.

Available dovecot-configuration fields are:

 -- dovecot-configuration parameter: package dovecot
     The dovecot package.

 -- dovecot-configuration parameter: comma-separated-string-list listen
     A list of IPs or hosts where to listen for connections.  * listens on all IPv4 interfaces, :: listens on all IPv6 interfaces.  If you want to specify non-default ports or anything more complex, customize the address and port fields of the inet-listener of the specific services you are interested in.

 -- dovecot-configuration parameter: protocol-configuration-list protocols
     List of protocols we want to serve.  Available protocols include imap, pop3, and lmtp.

     Available protocol-configuration fields are:

      -- protocol-configuration parameter: string name
          The name of the protocol.

      -- protocol-configuration parameter: string auth-socket-path
          UNIX socket path to the master authentication server to find users.  This is used by imap (for shared users) and lda.  It defaults to "/var/run/dovecot/auth-userdb".

      -- protocol-configuration parameter: space-separated-string-list mail-plugins
          Space separated list of plugins to load.

      -- protocol-configuration parameter: non-negative-integer mail-max-userip-connections
          Maximum number of IMAP connections allowed for a user from each IP address. NOTE: The username is compared case-sensitively.  Defaults to 10.

 -- dovecot-configuration parameter: service-configuration-list services
     List of services to enable.  Available services include imap, imap-login, pop3, pop3-login, auth, and lmtp.

     Available service-configuration fields are:

      -- service-configuration parameter: string kind
          The service kind.  Valid values include director, imap-login, pop3-login, lmtp, imap, pop3, auth, auth-worker, dict, tcpwrap, quota-warning, or anything else.

      -- service-configuration parameter: listener-configuration-list listeners
          Listeners for the service.  A listener is either a unix-listener-configuration, a fifo-listener-configuration, or an inet-listener-configuration.  Defaults to ().

          Available unix-listener-configuration fields are:

           -- unix-listener-configuration parameter: string path
               Path to the file, relative to base-dir field.  This is also used as the section name.

           -- unix-listener-configuration parameter: string mode
               The access mode for the socket.  Defaults to "0600".

           -- unix-listener-configuration parameter: string user
               The user to own the socket.  Defaults to "".

           -- unix-listener-configuration parameter: string group
               The group to own the socket.  Defaults to "".

          Available fifo-listener-configuration fields are:

           -- fifo-listener-configuration parameter: string path
               Path to the file, relative to base-dir field.  This is also used as the section name.

           -- fifo-listener-configuration parameter: string mode
               The access mode for the socket.  Defaults to "0600".

           -- fifo-listener-configuration parameter: string user
               The user to own the socket.  Defaults to "".

           -- fifo-listener-configuration parameter: string group
               The group to own the socket.  Defaults to "".

          Available inet-listener-configuration fields are:

           -- inet-listener-configuration parameter: string protocol
               The protocol to listen for.

           -- inet-listener-configuration parameter: string address
               The address on which to listen, or empty for all addresses.  Defaults to "".

           -- inet-listener-configuration parameter: non-negative-integer port
               The port on which to listen.

           -- inet-listener-configuration parameter: boolean ssl?
               Whether to use SSL for this service; yes, no, or required.  Defaults to #t.

      -- service-configuration parameter: non-negative-integer service-count
          Number of connections to handle before starting a new process.  Typically the only useful values are 0 (unlimited) or 1.  1 is more secure, but 0 is faster.  <doc/wiki/LoginProcess.txt>.  Defaults to 1.

      -- service-configuration parameter: non-negative-integer process-min-avail
          Number of processes to always keep waiting for more connections.  Defaults to 0.

      -- service-configuration parameter: non-negative-integer vsz-limit
          If you set service-count 0, you probably need to grow this.  Defaults to 256000000.

 -- dovecot-configuration parameter: dict-configuration dict
     Dict configuration, as created by the dict-configuration constructor.

     Available dict-configuration fields are:

      -- dict-configuration parameter: free-form-fields entries
          A list of key-value pairs that this dict should hold.  Defaults to ().

 -- dovecot-configuration parameter: passdb-configuration-list passdbs
     A list of passdb configurations, each one created by the passdb-configuration constructor.

     Available passdb-configuration fields are:

      -- passdb-configuration parameter: string driver
          The driver that the passdb should use.  Valid values include pam, passwd, shadow, bsdauth, and static.  Defaults to "pam".

      -- passdb-configuration parameter: space-separated-string-list args
          Space separated list of arguments to the passdb driver.  Defaults to "".

 -- dovecot-configuration parameter: userdb-configuration-list userdbs
     List of userdb configurations, each one created by the userdb-configuration constructor.

     Available userdb-configuration fields are:

      -- userdb-configuration parameter: string driver
          The driver that the userdb should use.  Valid values include passwd and static.  Defaults to "passwd".

      -- userdb-configuration parameter: space-separated-string-list args
          Space separated list of arguments to the userdb driver.  Defaults to "".

      -- userdb-configuration parameter: free-form-args override-fields
          Override fields from passwd.  Defaults to ().

 -- dovecot-configuration parameter: plugin-configuration plugin-configuration
     Plug-in configuration, created by the plugin-configuration constructor.

 -- dovecot-configuration parameter: list-of-namespace-configuration namespaces
     List of namespaces.  Each item in the list is created by the namespace-configuration constructor.

     Available namespace-configuration fields are:

      -- namespace-configuration parameter: string name
          Name for this namespace.

      -- namespace-configuration parameter: string type
          Namespace type: private, shared or public.  Defaults to "private".

      -- namespace-configuration parameter: string separator
          Hierarchy separator to use. You should use the same separator for all namespaces or some clients get confused.  / is usually a good one. The default however depends on the underlying mail storage format.  Defaults to "".

      -- namespace-configuration parameter: string prefix
          Prefix required to access this namespace.  This needs to be different for all namespaces. For example Public/.  Defaults to "".

      -- namespace-configuration parameter: string location
          Physical location of the mailbox. This is in the same format as mail_location, which is also the default for it.  Defaults to "".

      -- namespace-configuration parameter: boolean inbox?
          There can be only one INBOX, and this setting defines which namespace has it.  Defaults to #f.

      -- namespace-configuration parameter: boolean hidden?
          If namespace is hidden, it's not advertised to clients via NAMESPACE extension. You'll most likely also want to set list? #f.  This is mostly useful when converting from another server with different namespaces which you want to deprecate but still keep working.  For example you can create hidden namespaces with prefixes ~/mail/, ~%u/mail/ and mail/.  Defaults to #f.

      -- namespace-configuration parameter: boolean list?
          Show the mailboxes under this namespace with the LIST command. This makes the namespace visible for clients that do not support the NAMESPACE extension.  The special children value lists child mailboxes, but hides the namespace prefix.  Defaults to #t.

      -- namespace-configuration parameter: boolean subscriptions?
          Namespace handles its own subscriptions.  If set to #f, the parent namespace handles them.  The empty prefix should always have this as #t).  Defaults to #t.

      -- namespace-configuration parameter: mailbox-configuration-list mailboxes
          List of predefined mailboxes in this namespace.  Defaults to ().

          Available mailbox-configuration fields are:

           -- mailbox-configuration parameter: string name
               Name for this mailbox.

           -- mailbox-configuration parameter: string auto
               create will automatically create this mailbox.  subscribe will both create and subscribe to the mailbox.  Defaults to "no".

           -- mailbox-configuration parameter: space-separated-string-list special-use
               List of IMAP SPECIAL-USE attributes as specified by RFC 6154.  Valid values are \All, \Archive, \Drafts, \Flagged, \Junk, \Sent, and \Trash.  Defaults to ().

 -- dovecot-configuration parameter: file-name base-dir
     Base directory where to store runtime data.  Defaults to "/var/run/dovecot/".

 -- dovecot-configuration parameter: string login-greeting
     Greeting message for clients.  Defaults to "Dovecot ready.".

 -- dovecot-configuration parameter: space-separated-string-list login-trusted-networks
     List of trusted network ranges.  Connections from these IPs are allowed to override their IP addresses and ports (for logging and for authentication checks).  disable-plaintext-auth is also ignored for these networks. Typically you would specify your IMAP proxy servers here.  Defaults to ().

 -- dovecot-configuration parameter: space-separated-string-list login-access-sockets
     List of login access check sockets (e.g. tcpwrap).  Defaults to ().

 -- dovecot-configuration parameter: boolean verbose-proctitle?
     Show more verbose process titles (in ps).  Currently shows user name and IP address.  Useful for seeing who is actually using the IMAP processes (e.g. shared mailboxes or if the same uid is used for multiple accounts). Defaults to #f.

 -- dovecot-configuration parameter: boolean shutdown-clients?
     Should all processes be killed when Dovecot master process shuts down. Setting this to #f means that Dovecot can be upgraded without forcing existing client connections to close (although that could also be a problem if the upgrade is e.g. due to a security fix).  Defaults to #t.

 -- dovecot-configuration parameter: non-negative-integer doveadm-worker-count
     If non-zero, run mail commands via this many connections to doveadm server, instead of running them directly in the same process.  Defaults to 0.

 -- dovecot-configuration parameter: string doveadm-socket-path
     UNIX socket or host:port used for connecting to doveadm server.  Defaults to "doveadm-server".

 -- dovecot-configuration parameter: space-separated-string-list import-environment
     List of environment variables that are preserved on Dovecot startup and passed down to all of its child processes.  You can also give key=value pairs to always set specific settings.

 -- dovecot-configuration parameter: boolean disable-plaintext-auth?
     Disable LOGIN command and all other plaintext authentications unless SSL/TLS is used (LOGINDISABLED capability).  Note that if the remote IP matches the local IP (i.e. you're connecting from the same computer), the connection is considered secure and plaintext authentication is allowed.  See also ssl=required setting.  Defaults to #t.

 -- dovecot-configuration parameter: non-negative-integer auth-cache-size
     Authentication cache size (e.g. #e10e6).  0 means it's disabled. Note that bsdauth, PAM and vpopmail require cache-key to be set for caching to be used.  Defaults to 0.

 -- dovecot-configuration parameter: string auth-cache-ttl
     Time to live for cached data.  After TTL expires the cached record is no longer used, *except* if the main database lookup returns internal failure. We also try to handle password changes automatically: If user's previous authentication was successful, but this one wasn't, the cache isn't used. For now this works only with plaintext authentication.  Defaults to "1 hour".

 -- dovecot-configuration parameter: string auth-cache-negative-ttl
     TTL for negative hits (user not found, password mismatch).  0 disables caching them completely.  Defaults to "1 hour".

 -- dovecot-configuration parameter: space-separated-string-list auth-realms
     List of realms for SASL authentication mechanisms that need them.  You can leave it empty if you don't want to support multiple realms.  Many clients simply use the first one listed here, so keep the default realm first. Defaults to ().

 -- dovecot-configuration parameter: string auth-default-realm
     Default realm/domain to use if none was specified.  This is used for both SASL realms and appending @domain to username in plaintext logins. Defaults to "".

 -- dovecot-configuration parameter: string auth-username-chars
     List of allowed characters in username.  If the user-given username contains a character not listed in here, the login automatically fails.  This is just an extra check to make sure user can't exploit any potential quote escaping vulnerabilities with SQL/LDAP databases.  If you want to allow all characters, set this value to empty.  Defaults to "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@".

 -- dovecot-configuration parameter: string auth-username-translation
     Username character translations before it's looked up from databases.  The value contains series of from -> to characters.  For example #@/@ means that # and / characters are translated to @. Defaults to "".

 -- dovecot-configuration parameter: string auth-username-format
     Username formatting before it's looked up from databases.  You can use the standard variables here, e.g. %Lu would lowercase the username, %n would drop away the domain if it was given, or %n-AT-%d would change the @ into -AT-.  This translation is done after auth-username-translation changes.  Defaults to "%Lu".

 -- dovecot-configuration parameter: string auth-master-user-separator
     If you want to allow master users to log in by specifying the master username within the normal username string (i.e. not using SASL mechanism's support for it), you can specify the separator character here.  The format is then <username><separator><master username>.  UW-IMAP uses * as the separator, so that could be a good choice.  Defaults to "".

 -- dovecot-configuration parameter: string auth-anonymous-username
     Username to use for users logging in with ANONYMOUS SASL mechanism. Defaults to "anonymous".

 -- dovecot-configuration parameter: non-negative-integer auth-worker-max-count
     Maximum number of dovecot-auth worker processes.  They're used to execute blocking passdb and userdb queries (e.g. MySQL and PAM).  They're automatically created and destroyed as needed.  Defaults to 30.

 -- dovecot-configuration parameter: string auth-gssapi-hostname
     Host name to use in GSSAPI principal names.  The default is to use the name returned by gethostname().  Use $ALL (with quotes) to allow all keytab entries.  Defaults to "".

 -- dovecot-configuration parameter: string auth-krb5-keytab
     Kerberos keytab to use for the GSSAPI mechanism.  Will use the system default (usually /etc/krb5.keytab) if not specified.  You may need to change the auth service to run as root to be able to read this file. Defaults to "".

 -- dovecot-configuration parameter: boolean auth-use-winbind?
     Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon and ntlm-auth helper.  <doc/wiki/Authentication/Mechanisms/Winbind.txt>. Defaults to #f.

 -- dovecot-configuration parameter: file-name auth-winbind-helper-path
     Path for Samba's ntlm-auth helper binary.  Defaults to "/usr/bin/ntlm_auth".

 -- dovecot-configuration parameter: string auth-failure-delay
     Time to delay before replying to failed authentications.  Defaults to "2 secs".

 -- dovecot-configuration parameter: boolean auth-ssl-require-client-cert?
     Require a valid SSL client certificate or the authentication fails. Defaults to #f.

 -- dovecot-configuration parameter: boolean auth-ssl-username-from-cert?
     Take the username from client's SSL certificate, using X509_NAME_get_text_by_NID() which returns the subject's DN's CommonName.  Defaults to #f.

 -- dovecot-configuration parameter: space-separated-string-list auth-mechanisms
     List of wanted authentication mechanisms.  Supported mechanisms are: plain, login, digest-md5, cram-md5, ntlm, rpa, apop, anonymous, gssapi, otp, skey, and gss-spnego.  NOTE: See also disable-plaintext-auth setting.

 -- dovecot-configuration parameter: space-separated-string-list director-servers
     List of IPs or hostnames to all director servers, including ourself.  Ports can be specified as ip:port.  The default port is the same as what director service's inet-listener is using.  Defaults to ().

 -- dovecot-configuration parameter: space-separated-string-list director-mail-servers
     List of IPs or hostnames to all backend mail servers.  Ranges are allowed too, like 10.0.0.10-10.0.0.30.  Defaults to ().

 -- dovecot-configuration parameter: string director-user-expire
     How long to redirect users to a specific server after it no longer has any connections.  Defaults to "15 min".

 -- dovecot-configuration parameter: string director-username-hash
     How the username is translated before being hashed.  Useful values include %Ln if user can log in with or without @domain, %Ld if mailboxes are shared within domain.  Defaults to "%Lu".

 -- dovecot-configuration parameter: string log-path
     Log file to use for error messages.  syslog logs to syslog, /dev/stderr logs to stderr.  Defaults to "syslog".

 -- dovecot-configuration parameter: string info-log-path
     Log file to use for informational messages.  Defaults to log-path. Defaults to "".

 -- dovecot-configuration parameter: string debug-log-path
     Log file to use for debug messages.  Defaults to info-log-path. Defaults to "".

 -- dovecot-configuration parameter: string syslog-facility
     Syslog facility to use if you're logging to syslog.  Usually if you don't want to use mail, you'll use local0..local7.  Also other standard facilities are supported.  Defaults to "mail".

 -- dovecot-configuration parameter: boolean auth-verbose?
     Log unsuccessful authentication attempts and the reasons why they failed. Defaults to #f.

 -- dovecot-configuration parameter: boolean auth-verbose-passwords?
     In case of password mismatches, log the attempted password.  Valid values are no, plain and sha1.  sha1 can be useful for detecting brute force password attempts vs.  user simply trying the same password over and over again.  You can also truncate the value to n chars by appending ":n" (e.g. sha1:6).  Defaults to #f.

 -- dovecot-configuration parameter: boolean auth-debug?
     Even more verbose logging for debugging purposes.  Shows for example SQL queries.  Defaults to #f.

 -- dovecot-configuration parameter: boolean auth-debug-passwords?
     In case of password mismatches, log the passwords and used scheme so the problem can be debugged.  Enabling this also enables auth-debug. Defaults to #f.

 -- dovecot-configuration parameter: boolean mail-debug?
     Enable mail process debugging.  This can help you figure out why Dovecot isn't finding your mails.  Defaults to #f.

 -- dovecot-configuration parameter: boolean verbose-ssl?
     Show protocol level SSL errors.  Defaults to #f.

 -- dovecot-configuration parameter: string log-timestamp
     Prefix for each line written to log file.  % codes are in strftime(3) format.  Defaults to "\"%b %d %H:%M:%S \"".

 -- dovecot-configuration parameter: space-separated-string-list login-log-format-elements
     List of elements we want to log.  The elements which have a non-empty variable value are joined together to form a comma-separated string.

 -- dovecot-configuration parameter: string login-log-format
     Login log format.  %s contains login-log-format-elements string, %$ contains the data we want to log.  Defaults to "%$: %s".

 -- dovecot-configuration parameter: string mail-log-prefix
     Log prefix for mail processes.  See doc/wiki/Variables.txt for list of possible variables you can use.  Defaults to "\"%s(%u)<%{pid}><%{session}>: \"".

 -- dovecot-configuration parameter: string deliver-log-format
     Format to use for logging mail deliveries.  You can use variables:

     %$
          Delivery status message (e.g. saved to INBOX)

     %m
          Message-ID

     %s
          Subject

     %f
          From address

     %p
          Physical size

     %w
          Virtual size.

     Defaults to "msgid=%m: %$".

 -- dovecot-configuration parameter: string mail-location
     Location for users' mailboxes.  The default is empty, which means that Dovecot tries to find the mailboxes automatically.  This won't work if the user doesn't yet have any mail, so you should explicitly tell Dovecot the full location.

     If you're using mbox, giving a path to the INBOX file (e.g. /var/mail/%u) isn't enough.  You'll also need to tell Dovecot where the other mailboxes are kept.  This is called the "root mail directory", and it must be the first path given in the mail-location setting.

     There are a few special variables you can use, eg.:

     %u
          username

     %n
          user part in user@domain, same as %u if there's no domain

     %d
          domain part in user@domain, empty if there's no domain

     %h
          home director

     See doc/wiki/Variables.txt for full list.  Some examples:

     maildir:~/Maildir

     mbox:~/mail:INBOX=/var/mail/%u

     mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%

     Defaults to "".

 -- dovecot-configuration parameter: string mail-uid
     System user and group used to access mails.  If you use multiple, userdb can override these by returning uid or gid fields.  You can use either numbers or names.  <doc/wiki/UserIds.txt>.  Defaults to "".

 -- dovecot-configuration parameter: string mail-gid

     Defaults to "".

 -- dovecot-configuration parameter: string mail-privileged-group
     Group to enable temporarily for privileged operations.  Currently this is used only with INBOX when either its initial creation or dotlocking fails. Typically this is set to "mail" to give access to /var/mail.  Defaults to "".

 -- dovecot-configuration parameter: string mail-access-groups
     Grant access to these supplementary groups for mail processes.  Typically these are used to set up access to shared mailboxes.  Note that it may be dangerous to set these if users can create symlinks (e.g. if "mail" group is set here, ln -s /var/mail ~/mail/var could allow a user to delete others' mailboxes, or ln -s /secret/shared/box ~/mail/mybox would allow reading it).  Defaults to "".

 -- dovecot-configuration parameter: boolean mail-full-filesystem-access?
     Allow full file system access to clients.  There's no access checks other than what the operating system does for the active UID/GID.  It works with both maildir and mboxes, allowing you to prefix mailboxes names with e.g. /path/ or ~user/.  Defaults to #f.

 -- dovecot-configuration parameter: boolean mmap-disable?
     Don't use mmap() at all.  This is required if you store indexes to shared file systems (NFS or clustered file system).  Defaults to #f.

 -- dovecot-configuration parameter: boolean dotlock-use-excl?
     Rely on O_EXCL to work when creating dotlock files.  NFS supports O_EXCL since version 3, so this should be safe to use nowadays by default.  Defaults to #t.

 -- dovecot-configuration parameter: string mail-fsync
     When to use fsync() or fdatasync() calls:

     optimized
          Whenever necessary to avoid losing important data

     always
          Useful with e.g. NFS when write()s are delayed

     never
          Never use it (best performance, but crashes can lose data).

     Defaults to "optimized".

 -- dovecot-configuration parameter: boolean mail-nfs-storage?
     Mail storage exists in NFS.  Set this to yes to make Dovecot flush NFS caches whenever needed.  If you're using only a single mail server this isn't needed.  Defaults to #f.

 -- dovecot-configuration parameter: boolean mail-nfs-index?
     Mail index files also exist in NFS.  Setting this to yes requires mmap-disable? #t and fsync-disable? #f.  Defaults to #f.

 -- dovecot-configuration parameter: string lock-method
     Locking method for index files.  Alternatives are fcntl, flock and dotlock. Dotlocking uses some tricks which may create more disk I/O than other locking methods.  NFS users: flock doesn't work, remember to change mmap-disable.  Defaults to "fcntl".

 -- dovecot-configuration parameter: file-name mail-temp-dir
     Directory in which LDA/LMTP temporarily stores incoming mails >128 kB. Defaults to "/tmp".

 -- dovecot-configuration parameter: non-negative-integer first-valid-uid
     Valid UID range for users.  This is mostly to make sure that users can't log in as daemons or other system users.  Note that denying root logins is hardcoded to dovecot binary and can't be done even if first-valid-uid is set to 0.  Defaults to 500.

 -- dovecot-configuration parameter: non-negative-integer last-valid-uid

     Defaults to 0.

 -- dovecot-configuration parameter: non-negative-integer first-valid-gid
     Valid GID range for users.  Users having non-valid GID as primary group ID aren't allowed to log in.  If user belongs to supplementary groups with non-valid GIDs, those groups are not set.  Defaults to 1.

 -- dovecot-configuration parameter: non-negative-integer last-valid-gid

     Defaults to 0.

 -- dovecot-configuration parameter: non-negative-integer mail-max-keyword-length
     Maximum allowed length for mail keyword name.  It's only forced when trying to create new keywords.  Defaults to 50.

 -- dovecot-configuration parameter: colon-separated-file-name-list valid-chroot-dirs
     List of directories under which chrooting is allowed for mail processes (i.e. /var/mail will allow chrooting to /var/mail/foo/bar too).  This setting doesn't affect login-chroot mail-chroot or auth chroot settings.  If this setting is empty, "/./" in home dirs are ignored. WARNING: Never add directories here which local users can modify, that may lead to root exploit.  Usually this should be done only if you don't allow shell access for users.  <doc/wiki/Chrooting.txt>.  Defaults to ().

 -- dovecot-configuration parameter: string mail-chroot
     Default chroot directory for mail processes.  This can be overridden for specific users in user database by giving /./ in user's home directory (e.g. /home/./user chroots into /home).  Note that usually there is no real need to do chrooting, Dovecot doesn't allow users to access files outside their mail directory anyway.  If your home directories are prefixed with the chroot directory, append "/." to mail-chroot. <doc/wiki/Chrooting.txt>.  Defaults to "".

 -- dovecot-configuration parameter: file-name auth-socket-path
     UNIX socket path to master authentication server to find users.  This is used by imap (for shared users) and lda.  Defaults to "/var/run/dovecot/auth-userdb".

 -- dovecot-configuration parameter: file-name mail-plugin-dir
     Directory where to look up mail plugins.  Defaults to "/usr/lib/dovecot".

 -- dovecot-configuration parameter: space-separated-string-list mail-plugins
     List of plugins to load for all services.  Plugins specific to IMAP, LDA, etc. are added to this list in their own .conf files.  Defaults to ().

 -- dovecot-configuration parameter: non-negative-integer mail-cache-min-mail-count
     The minimum number of mails in a mailbox before updates are done to cache file.  This allows optimizing Dovecot's behavior to do less disk writes at the cost of more disk reads.  Defaults to 0.

 -- dovecot-configuration parameter: string mailbox-idle-check-interval
     When IDLE command is running, mailbox is checked once in a while to see if there are any new mails or other changes.  This setting defines the minimum time to wait between those checks.  Dovecot can also use dnotify, inotify and kqueue to find out immediately when changes occur.  Defaults to "30 secs".

 -- dovecot-configuration parameter: boolean mail-save-crlf?
     Save mails with CR+LF instead of plain LF.  This makes sending those mails take less CPU, especially with sendfile() syscall with Linux and FreeBSD. But it also creates a bit more disk I/O which may just make it slower.  Also note that if other software reads the mboxes/maildirs, they may handle the extra CRs wrong and cause problems.  Defaults to #f.

 -- dovecot-configuration parameter: boolean maildir-stat-dirs?
     By default LIST command returns all entries in maildir beginning with a dot.  Enabling this option makes Dovecot return only entries which are directories.  This is done by stat()ing each entry, so it causes more disk I/O.  (For systems setting struct dirent->d_type this check is free and it's done always regardless of this setting).  Defaults to #f.

 -- dovecot-configuration parameter: boolean maildir-copy-with-hardlinks?
     When copying a message, do it with hard links whenever possible.  This makes the performance much better, and it's unlikely to have any side effects. Defaults to #t.

 -- dovecot-configuration parameter: boolean maildir-very-dirty-syncs?
     Assume Dovecot is the only MUA accessing Maildir: Scan cur/ directory only when its mtime changes unexpectedly or when we can't find the mail otherwise.  Defaults to #f.

 -- dovecot-configuration parameter: space-separated-string-list mbox-read-locks
     Which locking methods to use for locking mbox.  There are four available:

     dotlock
          Create <mailbox>.lock file.  This is the oldest and most NFS-safe solution. If you want to use /var/mail/ like directory, the users will need write access to that directory.

     dotlock-try
          Same as dotlock, but if it fails because of permissions or because there isn't enough disk space, just skip it.

     fcntl
          Use this if possible.  Works with NFS too if lockd is used.

     flock
          May not exist in all systems.  Doesn't work with NFS.

     lockf
          May not exist in all systems.  Doesn't work with NFS.

     You can use multiple locking methods; if you do the order they're declared in is important to avoid deadlocks if other MTAs/MUAs are using multiple locking methods as well.  Some operating systems don't allow using some of them simultaneously.

 -- dovecot-configuration parameter: space-separated-string-list mbox-write-locks

 -- dovecot-configuration parameter: string mbox-lock-timeout
     Maximum time to wait for lock (all of them) before aborting.  Defaults to "5 mins".

 -- dovecot-configuration parameter: string mbox-dotlock-change-timeout
     If dotlock exists but the mailbox isn't modified in any way, override the lock file after this much time.  Defaults to "2 mins".

 -- dovecot-configuration parameter: boolean mbox-dirty-syncs?
     When mbox changes unexpectedly we have to fully read it to find out what changed.  If the mbox is large this can take a long time.  Since the change is usually just a newly appended mail, it'd be faster to simply read the new mails.  If this setting is enabled, Dovecot does this but still safely fallbacks to re-reading the whole mbox file whenever something in mbox isn't how it's expected to be.  The only real downside to this setting is that if some other MUA changes message flags, Dovecot doesn't notice it immediately.  Note that a full sync is done with SELECT, EXAMINE, EXPUNGE and CHECK commands.  Defaults to #t.

 -- dovecot-configuration parameter: boolean mbox-very-dirty-syncs?
     Like mbox-dirty-syncs, but don't do full syncs even with SELECT, EXAMINE, EXPUNGE or CHECK commands.  If this is set, mbox-dirty-syncs is ignored.  Defaults to #f.

 -- dovecot-configuration parameter: boolean mbox-lazy-writes?
     Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK commands and when closing the mailbox).  This is especially useful for POP3 where clients often delete all mails.  The downside is that our changes aren't immediately visible to other MUAs.  Defaults to #t.

 -- dovecot-configuration parameter: non-negative-integer mbox-min-index-size
     If mbox size is smaller than this (e.g. 100k), don't write index files.  If an index file already exists it's still read, just not updated.  Defaults to 0.

 -- dovecot-configuration parameter: non-negative-integer mdbox-rotate-size
     Maximum dbox file size until it's rotated.  Defaults to 10000000.

 -- dovecot-configuration parameter: string mdbox-rotate-interval
     Maximum dbox file age until it's rotated.  Typically in days.  Day begins from midnight, so 1d = today, 2d = yesterday, etc.  0 = check disabled. Defaults to "1d".

 -- dovecot-configuration parameter: boolean mdbox-preallocate-space?
     When creating new mdbox files, immediately preallocate their size to mdbox-rotate-size.  This setting currently works only in Linux with some file systems (ext4, xfs).  Defaults to #f.

 -- dovecot-configuration parameter: string mail-attachment-dir
     sdbox and mdbox support saving mail attachments to external files, which also allows single instance storage for them.  Other backends don't support this for now.

     WARNING: This feature hasn't been tested much yet.  Use at your own risk.

     Directory root where to store mail attachments.  Disabled, if empty. Defaults to "".

 -- dovecot-configuration parameter: non-negative-integer mail-attachment-min-size
     Attachments smaller than this aren't saved externally.  It's also possible to write a plugin to disable saving specific attachments externally. Defaults to 128000.

 -- dovecot-configuration parameter: string mail-attachment-fs
     File system backend to use for saving attachments:

     posix
          No SiS done by Dovecot (but this might help FS's own deduplication)

     sis posix
          SiS with immediate byte-by-byte comparison during saving

     sis-queue posix
          SiS with delayed comparison and deduplication.

     Defaults to "sis posix".

 -- dovecot-configuration parameter: string mail-attachment-hash
     Hash format to use in attachment filenames.  You can add any text and variables: %{md4}, %{md5}, %{sha1}, %{sha256}, %{sha512}, %{size}.  Variables can be truncated, e.g. %{sha256:80} returns only first 80 bits.  Defaults to "%{sha1}".

 -- dovecot-configuration parameter: non-negative-integer default-process-limit

     Defaults to 100.

 -- dovecot-configuration parameter: non-negative-integer default-client-limit

     Defaults to 1000.

 -- dovecot-configuration parameter: non-negative-integer default-vsz-limit
     Default VSZ (virtual memory size) limit for service processes.  This is mainly intended to catch and kill processes that leak memory before they eat up everything.  Defaults to 256000000.

 -- dovecot-configuration parameter: string default-login-user
     Login user is internally used by login processes.  This is the most untrusted user in Dovecot system.  It shouldn't have access to anything at all.  Defaults to "dovenull".

 -- dovecot-configuration parameter: string default-internal-user
     Internal user is used by unprivileged processes.  It should be separate from login user, so that login processes can't disturb other processes.  Defaults to "dovecot".

 -- dovecot-configuration parameter: string ssl?
     SSL/TLS support: yes, no, required.  <doc/wiki/SSL.txt>.  Defaults to "required".

 -- dovecot-configuration parameter: string ssl-cert
     PEM encoded X.509 SSL/TLS certificate (public key).  Defaults to "</etc/dovecot/default.pem".

 -- dovecot-configuration parameter: string ssl-key
     PEM encoded SSL/TLS private key.  The key is opened before dropping root privileges, so keep the key file unreadable by anyone but root.  Defaults to "</etc/dovecot/private/default.pem".

 -- dovecot-configuration parameter: string ssl-key-password
     If key file is password protected, give the password here.  Alternatively give it when starting dovecot with -p parameter.  Since this file is often world-readable, you may want to place this setting instead to a different. Defaults to "".

 -- dovecot-configuration parameter: string ssl-ca
     PEM encoded trusted certificate authority.  Set this only if you intend to use ssl-verify-client-cert? #t.  The file should contain the CA certificate(s) followed by the matching CRL(s).  (e.g. ssl-ca </etc/ssl/certs/ca.pem).  Defaults to "".

 -- dovecot-configuration parameter: boolean ssl-require-crl?
     Require that CRL check succeeds for client certificates.  Defaults to #t.

 -- dovecot-configuration parameter: boolean ssl-verify-client-cert?
     Request client to send a certificate.  If you also want to require it, set auth-ssl-require-client-cert? #t in auth section.  Defaults to #f.

 -- dovecot-configuration parameter: string ssl-cert-username-field
     Which field from certificate to use for username.  commonName and x500UniqueIdentifier are the usual choices.  You'll also need to set auth-ssl-username-from-cert? #t.  Defaults to "commonName".

 -- dovecot-configuration parameter: string ssl-min-protocol
     Minimum SSL protocol version to accept.  Defaults to "TLSv1".

 -- dovecot-configuration parameter: string ssl-cipher-list
     SSL ciphers to use.  Defaults to "ALL:!kRSA:!SRP:!kDHd:!DSS:!aNULL:!eNULL:!EXPORT:!DES:!3DES:!MD5:!PSK:!RC4:!ADH:!LOW@STRENGTH".

 -- dovecot-configuration parameter: string ssl-crypto-device
     SSL crypto device to use, for valid values run "openssl engine".  Defaults to "".

 -- dovecot-configuration parameter: string postmaster-address
     Address to use when sending rejection mails.  %d expands to recipient domain.  Defaults to "postmaster@%d".

 -- dovecot-configuration parameter: string hostname
     Hostname to use in various parts of sent mails (e.g. in Message-Id)  and in LMTP replies.  Default is the system's real hostname@domain.  Defaults to "".

 -- dovecot-configuration parameter: boolean quota-full-tempfail?
     If user is over quota, return with temporary failure instead of bouncing the mail.  Defaults to #f.

 -- dovecot-configuration parameter: file-name sendmail-path
     Binary to use for sending mails.  Defaults to "/usr/sbin/sendmail".

 -- dovecot-configuration parameter: string submission-host
     If non-empty, send mails via this SMTP host[:port] instead of sendmail. Defaults to "".

 -- dovecot-configuration parameter: string rejection-subject
     Subject: header to use for rejection mails.  You can use the same variables as for rejection-reason below.  Defaults to "Rejected: %s".

 -- dovecot-configuration parameter: string rejection-reason
     Human readable error message for rejection mails.  You can use variables:

     %n
          CRLF

     %r
          reason

     %s
          original subject

     %t
          recipient

     Defaults to "Your message to <%t> was automatically rejected:%n%r".

 -- dovecot-configuration parameter: string recipient-delimiter
     Delimiter character between local-part and detail in email address. Defaults to "+".

 -- dovecot-configuration parameter: string lda-original-recipient-header
     Header where the original recipient address (SMTP's RCPT TO: address) is taken from if not available elsewhere.  With dovecot-lda -a parameter overrides this.  A commonly used header for this is X-Original-To.  Defaults to "".

 -- dovecot-configuration parameter: boolean lda-mailbox-autocreate?
     Should saving a mail to a nonexistent mailbox automatically create it?. Defaults to #f.

 -- dovecot-configuration parameter: boolean lda-mailbox-autosubscribe?
     Should automatically created mailboxes be also automatically subscribed?. Defaults to #f.

 -- dovecot-configuration parameter: non-negative-integer imap-max-line-length
     Maximum IMAP command line length.  Some clients generate very long command lines with huge mailboxes, so you may need to raise this if you get "Too long argument" or "IMAP command line too large" errors often.  Defaults to 64000.

 -- dovecot-configuration parameter: string imap-logout-format
     IMAP logout format string:

     %i
          total number of bytes read from client

     %o
          total number of bytes sent to client.

     See doc/wiki/Variables.txt for a list of all the variables you can use.  Defaults to "in=%i out=%o deleted=%{deleted} expunged=%{expunged} trashed=%{trashed} hdr_count=%{fetch_hdr_count} hdr_bytes=%{fetch_hdr_bytes} body_count=%{fetch_body_count} body_bytes=%{fetch_body_bytes}".

 -- dovecot-configuration parameter: string imap-capability
     Override the IMAP CAPABILITY response.  If the value begins with '+', add the given capabilities on top of the defaults (e.g. +XFOO XBAR).  Defaults to "".

 -- dovecot-configuration parameter: string imap-idle-notify-interval
     How long to wait between "OK Still here" notifications when client is IDLEing.  Defaults to "2 mins".

 -- dovecot-configuration parameter: string imap-id-send
     ID field names and values to send to clients.  Using * as the value makes Dovecot use the default value.  The following fields have default values currently: name, version, os, os-version, support-url, support-email. Defaults to "".

 -- dovecot-configuration parameter: string imap-id-log
     ID fields sent by client to log.  * means everything.  Defaults to "".

 -- dovecot-configuration parameter: space-separated-string-list imap-client-workarounds
     Workarounds for various client bugs:

     delay-newmail
          Send EXISTS/RECENT new mail notifications only when replying to NOOP and CHECK commands.  Some clients ignore them otherwise, for example OSX Mail (<v2.1).  Outlook Express breaks more badly though, without this it may show user "Message no longer in server" errors.  Note that OE6 still breaks even with this workaround if synchronization is set to "Headers Only".

     tb-extra-mailbox-sep
          Thunderbird gets somehow confused with LAYOUT=fs (mbox and dbox) and adds extra / suffixes to mailbox names.  This option causes Dovecot to ignore the extra / instead of treating it as invalid mailbox name.

     tb-lsub-flags
          Show \Noselect flags for LSUB replies with LAYOUT=fs (e.g. mbox).  This makes Thunderbird realize they aren't selectable and show them greyed out, instead of only later giving "not selectable" popup error.

     Defaults to ().

 -- dovecot-configuration parameter: string imap-urlauth-host
     Host allowed in URLAUTH URLs sent by client.  "*" allows all.  Defaults to "".

Whew! Lots of configuration options.  The nice thing about it though is that GuixSD has a complete interface to Dovecot's configuration language.  This allows not only a nice way to declare configurations, but also offers reflective capabilities as well: users can write code to inspect and transform configurations from within Scheme.

However, it could be that you just want to get a dovecot.conf up and running.  In that case, you can pass an opaque-dovecot-configuration as the #:config parameter to dovecot-service.  As its name indicates, an opaque configuration does not have easy reflective capabilities.

Available opaque-dovecot-configuration fields are:

 -- opaque-dovecot-configuration parameter: package dovecot
     The dovecot package.

 -- opaque-dovecot-configuration parameter: string string
     The contents of the dovecot.conf, as a string.

For example, if your dovecot.conf is just the empty string, you could instantiate a dovecot service like this:

     (dovecot-service #:config
                      (opaque-dovecot-configuration
                       (string "")))

OpenSMTPD Service
.................

 -- Scheme Variable: opensmtpd-service-type
     This is the type of the OpenSMTPD (https://www.opensmtpd.org) service, whose value should be an opensmtpd-configuration object as in this example:

          (service opensmtpd-service-type
                   (opensmtpd-configuration
                     (config-file (local-file "./my-smtpd.conf"))))

 -- Data Type: opensmtpd-configuration
     Data type representing the configuration of opensmtpd.

     package (default: OPENSMTPD)
          Package object of the OpenSMTPD SMTP server.

     config-file (default: %DEFAULT-OPENSMTPD-FILE)
          File-like object of the OpenSMTPD configuration file to use.  By default it listens on the loopback network interface, and allows for mail from users and daemons on the local machine, as well as permitting email to remote servers.  Run man smtpd.conf for more information.

Exim Service
............

 -- Scheme Variable: exim-service-type
     This is the type of the Exim (https://exim.org) mail transfer agent (MTA), whose value should be an exim-configuration object as in this example:

          (service exim-service-type
                   (exim-configuration
                     (config-file (local-file "./my-exim.conf"))))

In order to use an exim-service-type service you must also have a mail-aliases-service-type service present in your operating-system (even if it has no aliases).

 -- Data Type: exim-configuration
     Data type representing the configuration of exim.

     package (default: EXIM)
          Package object of the Exim server.

     config-file (default: #f)
          File-like object of the Exim configuration file to use. If its value is #f then use the default configuration file from the package provided in package. The resulting configuration file is loaded after setting the exim_user and exim_group configuration variables.

Mail Aliases Service
....................

 -- Scheme Variable: mail-aliases-service-type
     This is the type of the service which provides /etc/aliases, specifying how to deliver mail to users on this system.

          (service mail-aliases-service-type
                   '(("postmaster" "bob")
                     ("bob" "bob@example.com" "bob@example2.com")))

The configuration for a mail-aliases-service-type service is an association list denoting how to deliver mail that comes to this system. Each entry is of the form (alias addresses ...), with alias specifying the local alias and addresses specifying where to deliver this user's mail.

The aliases aren't required to exist as users on the local system. In the above example, there doesn't need to be a postmaster entry in the operating-system's user-accounts in order to deliver the postmaster mail to bob (which subsequently would deliver mail to bob@example.com and bob@example2.com).

Services de messagerie
......................

The (gnu services messaging) module provides Guix service definitions for messaging services: currently only Prosody is supported.

Prosody Service
...............

 -- Scheme Variable: prosody-service-type
     This is the type for the Prosody XMPP communication server (https://prosody.im).  Its value must be a prosody-configuration record as in this example:

          (service prosody-service-type
                   (prosody-configuration
                    (modules-enabled (cons "groups" "mam" %default-modules-enabled))
                    (int-components
                     (list
                      (int-component-configuration
                       (hostname "conference.example.net")
                       (plugin "muc")
                       (mod-muc (mod-muc-configuration)))))
                    (virtualhosts
                     (list
                      (virtualhost-configuration
                       (domain "example.net"))))))

     See below for details about prosody-configuration.

By default, Prosody does not need much configuration.  Only one virtualhosts field is needed: it specifies the domain you wish Prosody to serve.

You can perform various sanity checks on the generated configuration with the prosodyctl check command.

Prosodyctl will also help you to import certificates from the letsencrypt directory so that the prosody user can access them.  See https://prosody.im/doc/letsencrypt.

     prosodyctl --root cert import /etc/letsencrypt/live

The available configuration parameters follow.  Each parameter definition is preceded by its type; for example, string-list foo indicates that the foo parameter should be specified as a list of strings.  Types starting with maybe- denote parameters that won't show up in prosody.cfg.lua when their value is 'disabled.

There is also a way to specify the configuration as a string, if you have an old prosody.cfg.lua file that you want to port over from some other system; see the end for more details.

The file-object type designates either a file-like object (see file-like objects) or a file name.

Available prosody-configuration fields are:

 -- prosody-configuration parameter: package prosody
     The Prosody package.

 -- prosody-configuration parameter: file-name data-path
     Location of the Prosody data storage directory.  See https://prosody.im/doc/configure.  Defaults to "/var/lib/prosody".

 -- prosody-configuration parameter: file-object-list plugin-paths
     Additional plugin directories.  They are searched in all the specified paths in order.  See https://prosody.im/doc/plugins_directory.  Defaults to ().

 -- prosody-configuration parameter: file-name certificates
     Every virtual host and component needs a certificate so that clients and servers can securely verify its identity.  Prosody will automatically load certificates/keys from the directory specified here.  Defaults to "/etc/prosody/certs".

 -- prosody-configuration parameter: string-list admins
     This is a list of accounts that are admins for the server.  Note that you must create the accounts separately.  See https://prosody.im/doc/admins and https://prosody.im/doc/creating_accounts.  Example: (admins '("user1@example.com" "user2@example.net")) Defaults to ().

 -- prosody-configuration parameter: boolean use-libevent?
     Enable use of libevent for better performance under high load.  See https://prosody.im/doc/libevent.  Defaults to #f.

 -- prosody-configuration parameter: module-list modules-enabled
     This is the list of modules Prosody will load on startup.  It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.  Documentation on modules can be found at: https://prosody.im/doc/modules.  Defaults to ("roster" "saslauth" "tls" "dialback" "disco" "carbons" "private" "blocklist" "vcard" "version" "uptime" "time" "ping" "pep" "register" "admin_adhoc").

 -- prosody-configuration parameter: string-list modules-disabled
     "offline", "c2s" and "s2s" are auto-loaded, but should you want to disable them then add them to this list.  Defaults to ().

 -- prosody-configuration parameter: file-object groups-file
     Path to a text file where the shared groups are defined.  If this path is empty then mod_groups does nothing.  See https://prosody.im/doc/modules/mod_groups.  Defaults to "/var/lib/prosody/sharedgroups.txt".

 -- prosody-configuration parameter: boolean allow-registration?
     Disable account creation by default, for security.  See https://prosody.im/doc/creating_accounts.  Defaults to #f.

 -- prosody-configuration parameter: maybe-ssl-configuration ssl
     These are the SSL/TLS-related settings.  Most of them are disabled so to use Prosody's defaults.  If you do not completely understand these options, do not add them to your config, it is easy to lower the security of your server using them.  See https://prosody.im/doc/advanced_ssl_config.

     Available ssl-configuration fields are:

      -- ssl-configuration parameter: maybe-string protocol
          This determines what handshake to use.

      -- ssl-configuration parameter: maybe-file-name key
          Path to your private key file.

      -- ssl-configuration parameter: maybe-file-name certificate
          Path to your certificate file.

      -- ssl-configuration parameter: file-object capath
          Path to directory containing root certificates that you wish Prosody to trust when verifying the certificates of remote servers.  Defaults to "/etc/ssl/certs".

      -- ssl-configuration parameter: maybe-file-object cafile
          Path to a file containing root certificates that you wish Prosody to trust. Similar to capath but with all certificates concatenated together.

      -- ssl-configuration parameter: maybe-string-list verify
          A list of verification options (these mostly map to OpenSSL's set_verify() flags).

      -- ssl-configuration parameter: maybe-string-list options
          A list of general options relating to SSL/TLS.  These map to OpenSSL's set_options().  For a full list of options available in LuaSec, see the LuaSec source.

      -- ssl-configuration parameter: maybe-non-negative-integer depth
          How long a chain of certificate authorities to check when looking for a trusted root certificate.

      -- ssl-configuration parameter: maybe-string ciphers
          An OpenSSL cipher string.  This selects what ciphers Prosody will offer to clients, and in what order.

      -- ssl-configuration parameter: maybe-file-name dhparam
          A path to a file containing parameters for Diffie-Hellman key exchange.  You can create such a file with: openssl dhparam -out /etc/prosody/certs/dh-2048.pem 2048

      -- ssl-configuration parameter: maybe-string curve
          Curve for Elliptic curve Diffie-Hellman. Prosody's default is "secp384r1".

      -- ssl-configuration parameter: maybe-string-list verifyext
          A list of "extra" verification options.

      -- ssl-configuration parameter: maybe-string password
          Password for encrypted private keys.

 -- prosody-configuration parameter: boolean c2s-require-encryption?
     Whether to force all client-to-server connections to be encrypted or not. See https://prosody.im/doc/modules/mod_tls.  Defaults to #f.

 -- prosody-configuration parameter: string-list disable-sasl-mechanisms
     Set of mechanisms that will never be offered.  See https://prosody.im/doc/modules/mod_saslauth.  Defaults to ("DIGEST-MD5").

 -- prosody-configuration parameter: boolean s2s-require-encryption?
     Whether to force all server-to-server connections to be encrypted or not. See https://prosody.im/doc/modules/mod_tls.  Defaults to #f.

 -- prosody-configuration parameter: boolean s2s-secure-auth?
     Whether to require encryption and certificate authentication.  This provides ideal security, but requires servers you communicate with to support encryption AND present valid, trusted certificates.  See https://prosody.im/doc/s2s#security.  Defaults to #f.

 -- prosody-configuration parameter: string-list s2s-insecure-domains
     Many servers don't support encryption or have invalid or self-signed certificates.  You can list domains here that will not be required to authenticate using certificates.  They will be authenticated using DNS.  See https://prosody.im/doc/s2s#security.  Defaults to ().

 -- prosody-configuration parameter: string-list s2s-secure-domains
     Even if you leave s2s-secure-auth? disabled, you can still require valid certificates for some domains by specifying a list here.  See https://prosody.im/doc/s2s#security.  Defaults to ().

 -- prosody-configuration parameter: string authentication
     Select the authentication backend to use.  The default provider stores passwords in plaintext and uses Prosody's configured data storage to store the authentication data.  If you do not trust your server please see https://prosody.im/doc/modules/mod_auth_internal_hashed for information about using the hashed backend.  See also https://prosody.im/doc/authentication Defaults to "internal_plain".

 -- prosody-configuration parameter: maybe-string log
     Set logging options.  Advanced logging configuration is not yet supported by the GuixSD Prosody Service.  See https://prosody.im/doc/logging. Defaults to "*syslog".

 -- prosody-configuration parameter: file-name pidfile
     File to write pid in.  See https://prosody.im/doc/modules/mod_posix. Defaults to "/var/run/prosody/prosody.pid".

 -- prosody-configuration parameter: maybe-non-negative-integer http-max-content-size
     Maximum allowed size of the HTTP body (in bytes).

 -- prosody-configuration parameter: maybe-string http-external-url
     Some modules expose their own URL in various ways.  This URL is built from the protocol, host and port used.  If Prosody sits behind a proxy, the public URL will be http-external-url instead.  See https://prosody.im/doc/http#external_url.

 -- prosody-configuration parameter: virtualhost-configuration-list virtualhosts
     A host in Prosody is a domain on which user accounts can be created.  For example if you want your users to have addresses like "john.smith@example.com" then you need to add a host "example.com".  All options in this list will apply only to this host.

     Note: the name "virtual" host is used in configuration to avoid confusion with the actual physical host that Prosody is installed on.  A single Prosody instance can serve many domains, each one defined as a VirtualHost entry in Prosody's configuration.  Conversely a server that hosts a single domain would have just one VirtualHost entry.

     See https://prosody.im/doc/configure#virtual_host_settings.

     Available virtualhost-configuration fields are:

     all these prosody-configuration fields: admins, use-libevent?, modules-enabled, modules-disabled, groups-file, allow-registration?, ssl, c2s-require-encryption?, disable-sasl-mechanisms, s2s-require-encryption?, s2s-secure-auth?, s2s-insecure-domains, s2s-secure-domains, authentication, log, http-max-content-size, http-external-url, raw-content, plus:
      -- virtualhost-configuration parameter: string domain
          Domain you wish Prosody to serve.

 -- prosody-configuration parameter: int-component-configuration-list int-components
     Components are extra services on a server which are available to clients, usually on a subdomain of the main server (such as "mycomponent.example.com").  Example components might be chatroom servers, user directories, or gateways to other protocols.

     Internal components are implemented with Prosody-specific plugins.  To add an internal component, you simply fill the hostname field, and the plugin you wish to use for the component.

     See https://prosody.im/doc/components.  Defaults to ().

     Available int-component-configuration fields are:

     all these prosody-configuration fields: admins, use-libevent?, modules-enabled, modules-disabled, groups-file, allow-registration?, ssl, c2s-require-encryption?, disable-sasl-mechanisms, s2s-require-encryption?, s2s-secure-auth?, s2s-insecure-domains, s2s-secure-domains, authentication, log, http-max-content-size, http-external-url, raw-content, plus:
      -- int-component-configuration parameter: string hostname
          Hostname of the component.

      -- int-component-configuration parameter: string plugin
          Plugin you wish to use for the component.

      -- int-component-configuration parameter: maybe-mod-muc-configuration mod-muc
          Multi-user chat (MUC) is Prosody's module for allowing you to create hosted chatrooms/conferences for XMPP users.

          General information on setting up and using multi-user chatrooms can be found in the "Chatrooms" documentation (https://prosody.im/doc/chatrooms), which you should read if you are new to XMPP chatrooms.

          See also https://prosody.im/doc/modules/mod_muc.

          Available mod-muc-configuration fields are:

           -- mod-muc-configuration parameter: string name
               The name to return in service discovery responses.  Defaults to "Prosody Chatrooms".

           -- mod-muc-configuration parameter: string-or-boolean restrict-room-creation
               If #t, this will only allow admins to create new chatrooms. Otherwise anyone can create a room.  The value "local" restricts room creation to users on the service's parent domain. E.g. user@example.com can create rooms on rooms.example.com. The value "admin" restricts to service administrators only.  Defaults to #f.

           -- mod-muc-configuration parameter: non-negative-integer max-history-messages
               Maximum number of history messages that will be sent to the member that has just joined the room.  Defaults to 20.

 -- prosody-configuration parameter: ext-component-configuration-list ext-components
     External components use XEP-0114, which most standalone components support. To add an external component, you simply fill the hostname field.  See https://prosody.im/doc/components.  Defaults to ().

     Available ext-component-configuration fields are:

     all these prosody-configuration fields: admins, use-libevent?, modules-enabled, modules-disabled, groups-file, allow-registration?, ssl, c2s-require-encryption?, disable-sasl-mechanisms, s2s-require-encryption?, s2s-secure-auth?, s2s-insecure-domains, s2s-secure-domains, authentication, log, http-max-content-size, http-external-url, raw-content, plus:
      -- ext-component-configuration parameter: string component-secret
          Password which the component will use to log in.

      -- ext-component-configuration parameter: string hostname
          Hostname of the component.

 -- prosody-configuration parameter: non-negative-integer-list component-ports
     Port(s) Prosody listens on for component connections.  Defaults to (5347).

 -- prosody-configuration parameter: string component-interface
     Interface Prosody listens on for component connections.  Defaults to "127.0.0.1".

 -- prosody-configuration parameter: maybe-raw-content raw-content
     Raw content that will be added to the configuration file.

It could be that you just want to get a prosody.cfg.lua up and running.  In that case, you can pass an opaque-prosody-configuration record as the value of prosody-service-type.  As its name indicates, an opaque configuration does not have easy reflective capabilities. Available opaque-prosody-configuration fields are:

 -- opaque-prosody-configuration parameter: package prosody
     The prosody package.

 -- opaque-prosody-configuration parameter: string prosody.cfg.lua
     The contents of the prosody.cfg.lua to use.

For example, if your prosody.cfg.lua is just the empty string, you could instantiate a prosody service like this:

     (service prosody-service-type
              (opaque-prosody-configuration
               (prosody.cfg.lua "")))

BitlBee Service
...............

BitlBee (http://bitlbee.org) is a gateway that provides an IRC interface to a variety of messaging protocols such as XMPP.

 -- Scheme Variable: bitlbee-service-type
     This is the service type for the BitlBee (http://bitlbee.org) IRC gateway daemon.  Its value is a bitlbee-configuration (see below).

     To have BitlBee listen on port 6667 on localhost, add this line to your services:

          (service bitlbee-service-type)

 -- Data Type: bitlbee-configuration
     This is the configuration for BitlBee, with the following fields:

     interface (default: "127.0.0.1")
     port (default: 6667)
          Listen on the network interface corresponding to the IP address specified in INTERFACE, on PORT.

          When INTERFACE is 127.0.0.1, only local clients can connect; when it is 0.0.0.0, connections can come from any networking interface.

     package (default: bitlbee)
          The BitlBee package to use.

     plugins (par défaut : '())
          List of plugin packages to use---e.g., bitlbee-discord.

     extra-settings (default: "")
          Configuration snippet added as-is to the BitlBee configuration file.

Services de téléphonie
......................

This section describes how to set up and run a Murmur server.  Murmur is the server of the Mumble (https://mumble.info) voice-over-IP (VoIP) suite.

 -- Data Type: murmur-configuration
     The service type for the Murmur server.  An example configuration can look like this:

          (service murmur-service-type
                   (murmur-configuration
                    (welcome-text
                      "Welcome to this Mumble server running on GuixSD!")
                    (cert-required? #t) ;disallow text password logins
                    (ssl-cert "/etc/letsencrypt/live/mumble.example.com/fullchain.pem")
                    (ssl-key "/etc/letsencrypt/live/mumble.example.com/privkey.pem")))

     After reconfiguring your system, you can manually set the murmur SuperUser password with the command that is printed during the activation phase.

     It is recommended to register a normal Mumble user account and grant it admin or moderator rights.  You can use the mumble client to login as new normal user, register yourself, and log out.  For the next step login with the name SuperUser use the SuperUser password that you set previously, and grant your newly registered mumble user administrator or moderator rights and create some channels.

     Available murmur-configuration fields are:

     package (default: mumble)
          Package that contains bin/murmurd.

     user (default: "murmur")
          User who will run the Murmur server.

     group (default: "murmur")
          Group of the user who will run the murmur server.

     port (default: 64738)
          Port on which the server will listen.

     welcome-text (default: "")
          Welcome text sent to clients when they connect.

     server-password (default: "")
          Password the clients have to enter in order to connect.

     max-users (default: 100)
          Maximum of users that can be connected to the server at once.

     max-user-bandwidth (default: #f)
          Maximum voice traffic a user can send per second.

     database-file (default: "/var/lib/murmur/db.sqlite")
          File name of the sqlite database.  The service's user will become the owner of the directory.

     log-file (default: "/var/log/murmur/murmur.log")
          File name of the log file.  The service's user will become the owner of the directory.

     autoban-attempts (default: 10)
          Maximum number of logins a user can make in autoban-timeframe without getting auto banned for autoban-time.

     autoban-timeframe (default: 120)
          Timeframe for autoban in seconds.

     autoban-time (default: 300)
          Amount of time in seconds for which a client gets banned when violating the autoban limits.

     opus-threshold (default: 100)
          Percentage of clients that need to support opus before switching over to opus audio codec.

     channel-nesting-limit (default: 10)
          How deep channels can be nested at maximum.

     channelname-regex (default: #f)
          A string in from of a Qt regular expression that channel names must conform to.

     username-regex (default: #f)
          A string in from of a Qt regular expression that user names must conform to.

     text-message-length (default: 5000)
          Maximum size in bytes that a user can send in one text chat message.

     image-message-length (default: (* 128 1024))
          Maximum size in bytes that a user can send in one image message.

     cert-required? (default: #f)
          If it is set to #t clients that use weak password authentification will not be accepted. Users must have completed the certificate wizard to join.

     remember-channel? (defualt #f)
          Should murmur remember the last channel each user was in when they disconnected and put them into the remembered channel when they rejoin.

     allow-html? (default: #f)
          Should html be allowed in text messages, user comments, and channel descriptions.

     allow-ping? (default: #f)
          Setting to true exposes the current user count, the maximum user count, and the server's maximum bandwidth per client to unauthenticated users. In the Mumble client, this information is shown in the Connect dialog.

          Disabling this setting will prevent public listing of the server.

     bonjour? (default: #f)
          Should the server advertise itself in the local network through the bonjour protocol.

     send-version? (default: #f)
          Should the murmur server version be exposed in ping requests.

     log-days (default: 31)
          Murmur also stores logs in the database, which are accessible via RPC.  The default is 31 days of months, but you can set this setting to 0 to keep logs forever, or -1 to disable logging to the database.

     obfuscate-ips? (default #t)
          Should logged ips be obfuscated to protect the privacy of users.

     ssl-cert (default: #f)
          File name of the SSL/TLS certificate used for encrypted connections.

               (ssl-cert "/etc/letsencrypt/live/example.com/fullchain.pem")

     ssl-key (default: #f)
          Filepath to the ssl private key used for encrypted connections.

               (ssl-key "/etc/letsencrypt/live/example.com/privkey.pem")

     ssl-dh-params (default: #f)
          File name of a PEM-encoded file with Diffie-Hellman parameters for the SSL/TLS encryption.  Alternatively you set it to "@ffdhe2048", "@ffdhe3072", "@ffdhe4096", "@ffdhe6144" or "@ffdhe8192" to use bundled parameters from RFC 7919.

     ssl-ciphers (default: #f)
          The ssl-ciphers option chooses the cipher suites to make available for use in SSL/TLS.

          This option is specified using OpenSSL cipher list notation (https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT).

          It is recommended that you try your cipher string using 'openssl ciphers <string>' before setting it here, to get a feel for which cipher suites you will get.  After setting this option, it is recommend that you inspect your Murmur log to ensure that Murmur is using the cipher suites that you expected it to.

          Note: Changing this option may impact the backwards compatibility of your Murmur server, and can remove the ability for older Mumble clients to be able to connect to it.

     public-registration (default: #f)
          Must be a <murmur-public-registration-configuration> record or #f.

          You can optionally register your server in the public server list that the mumble client shows on startup.  You cannot register your server if you have set a server-password, or set allow-ping to #f.

          It might take a few hours until it shows up in the public list.

     file (default: #f)
          Optional alternative override for this configuration.

 -- Data Type: murmur-public-registration-configuration
     Configuration for public registration of a murmur service.

     name
          This is a display name for your server. Not to be confused with the hostname.

     password
          A password to identify your registration.  Subsequent updates will need the same password. Don't lose your password.

     url
          This should be a http:// or https:// link to your web site.

     hostname (default: #f)
          By default your server will be listed by its IP address.  If it is set your server will be linked by this host name instead.

Services de surveillance
........................

Tailon Service
..............

Tailon (https://tailon.readthedocs.io/) is a web application for viewing and searching log files.

The following example will configure the service with default values.  By default, Tailon can be accessed on port 8080 (http://localhost:8080).

     (service tailon-service-type)

The following example customises more of the Tailon configuration, adding sed to the list of allowed commands.

     (service tailon-service-type
              (tailon-configuration
                (config-file
                  (tailon-configuration-file
                    (allowed-commands '("tail" "grep" "awk" "sed"))))))

 -- Data Type: tailon-configuration
     Data type representing the configuration of Tailon.  This type has the following parameters:

     config-file (default: (tailon-configuration-file))
          The configuration file to use for Tailon. This can be set to a tailon-configuration-file record value, or any gexp (see G-Expressions).

          For example, to instead use a local file, the local-file function can be used:

               (service tailon-service-type
                        (tailon-configuration
                          (config-file (local-file "./my-tailon.conf"))))

     package (default: tailon)
          The tailon package to use.

 -- Data Type: tailon-configuration-file
     Data type representing the configuration options for Tailon.  This type has the following parameters:

     files (default: (list "/var/log"))
          List of files to display. The list can include strings for a single file or directory, or a list, where the first item is the name of a subsection, and the remaining items are the files or directories in that subsection.

     bind (default: "localhost:8080")
          Address and port to which Tailon should bind on.

     relative-root (default: #f)
          URL path to use for Tailon, set to #f to not use a path.

     allow-transfers? (default: #t)
          Allow downloading the log files in the web interface.

     follow-names? (default: #t)
          Allow tailing of not-yet existent files.

     tail-lines (default: 200)
          Number of lines to read initially from each file.

     allowed-commands (default: (list "tail" "grep" "awk"))
          Commands to allow running. By default, sed is disabled.

     debug? (default: #f)
          Set debug? to #t to show debug messages.

     wrap-lines (default: #t)
          Initial line wrapping state in the web interface. Set to #t to initially wrap lines (the default), or to #f to initially not wrap lines.

     http-auth (default: #f)
          HTTP authentication type to use. Set to #f to disable authentication (the default). Supported values are "digest" or "basic".

     users (default: #f)
          If HTTP authentication is enabled (see http-auth), access will be restricted to the credentials provided here. To configure users, use a list of pairs, where the first element of the pair is the username, and the 2nd element of the pair is the password.

               (tailon-configuration-file
                 (http-auth "basic")
                 (users     '(("user1" . "password1")
                              ("user2" . "password2"))))

Darkstat Service
................

Darkstat is a packet sniffer that captures network traffic, calculates statistics about usage, and serves reports over HTTP.

 -- Variable: Scheme Variable darkstat-service-type
     This is the service type for the darkstat (https://unix4lyfe.org/darkstat/) service, its value must be a darkstat-configuration record as in this example:

          (service darkstat-service-type
                   (darkstat-configuration
                     (interface "eno1")))

 -- Data Type: darkstat-configuration
     Data type representing the configuration of darkstat.

     package (default: darkstat)
          The darkstat package to use.

     interface
          Capture traffic on the specified network interface.

     port (default: "667")
          Bind the web interface to the specified port.

     bind-address (default: "127.0.0.1")
          Bind the web interface to the specified address.

     base (default: "/")
          Specify the path of the base URL.  This can be useful if darkstat is accessed via a reverse proxy.

Prometheus Node Exporter Service
................................

The Prometheus ``node exporter'' makes hardware and operating system statistics provided by the Linux kernel available for the Prometheus monitoring system.  This service should be deployed on all physical nodes and virtual machines, where monitoring these statistics is desirable.

 -- Variable: Scheme variable prometheus-node-exporter-service-type
     This is the service type for the prometheus-node-exporter (https://github.com/prometheus/node_exporter/) service, its value must be a prometheus-node-exporter-configuration record as in this example:

          (service prometheus-node-exporter-service-type
                   (prometheus-node-exporter-configuration
                     (web-listen-address ":9100")))

 -- Data Type: prometheus-node-exporter-configuration
     Data type representing the configuration of node_exporter.

     package (default: go-github-com-prometheus-node-exporter)
          The prometheus-node-exporter package to use.

     web-listen-address (default: ":9100")
          Bind the web interface to the specified address.

Services Kerberos
.................

The (gnu services kerberos) module provides services relating to the authentication protocol Kerberos.

Krb5 Service
............

Programs using a Kerberos client library normally expect a configuration file in /etc/krb5.conf.  This service generates such a file from a definition provided in the operating system declaration.  It does not cause any daemon to be started.

No ``keytab'' files are provided by this service---you must explicitly create them.  This service is known to work with the MIT client library, mit-krb5.  Other implementations have not been tested.

 -- Scheme Variable: krb5-service-type
     A service type for Kerberos 5 clients.

Here is an example of its use:

     (service krb5-service-type
              (krb5-configuration
               (default-realm "EXAMPLE.COM")
               (allow-weak-crypto? #t)
               (realms (list
                        (krb5-realm
                         (name "EXAMPLE.COM")
                         (admin-server "groucho.example.com")
                         (kdc "karl.example.com"))
                        (krb5-realm
                         (name "ARGRX.EDU")
                         (admin-server "kerb-admin.argrx.edu")
                         (kdc "keys.argrx.edu"))))))

This example provides a Kerberos 5 client configuration which:

  * Recognizes two realms, viz: ``EXAMPLE.COM'' and ``ARGRX.EDU'', both of which have distinct administration servers and key distribution centers;

  * Will default to the realm ``EXAMPLE.COM'' if the realm is not explicitly specified by clients;

  * Accepts services which only support encryption types known to be weak.

The krb5-realm and krb5-configuration types have many fields. Only the most commonly used ones are described here.  For a full list, and more detailed explanation of each, see the MIT krb5.conf documentation.

 -- Data Type: krb5-realm

     name
          This field is a string identifying the name of the realm.  A common convention is to use the fully qualified DNS name of your organization, converted to upper case.

     admin-server
          This field is a string identifying the host where the administration server is running.

     kdc
          This field is a string identifying the key distribution center for the realm.

 -- Data Type: krb5-configuration

     allow-weak-crypto? (default: #f)
          If this flag is #t then services which only offer encryption algorithms known to be weak will be accepted.

     default-realm (default: #f)
          This field should be a string identifying the default Kerberos realm for the client.  You should set this field to the name of your Kerberos realm.  If this value is #f then a realm must be specified with every Kerberos principal when invoking programs such as kinit.

     realms
          This should be a non-empty list of krb5-realm objects, which clients may access.  Normally, one of them will have a name field matching the default-realm field.

PAM krb5 Service
................

The pam-krb5 service allows for login authentication and password management via Kerberos.  You will need this service if you want PAM enabled applications to authenticate users using Kerberos.

 -- Scheme Variable: pam-krb5-service-type
     A service type for the Kerberos 5 PAM module.

 -- Data Type: pam-krb5-configuration
     Data type representing the configuration of the Kerberos 5 PAM module This type has the following parameters:

     pam-krb5 (default: pam-krb5)
          The pam-krb5 package to use.

     minimum-uid (default: 1000)
          The smallest user ID for which Kerberos authentications should be attempted.  Local accounts with lower values will silently fail to authenticate.

Services web
............

The (gnu services web) module provides the Apache HTTP Server, the nginx web server, and also a fastcgi wrapper daemon.

Apache HTTP Server
..................

 -- Scheme Variable: httpd-service-type
     Service type for the Apache HTTP (https://httpd.apache.org/) server (httpd).  The value for this service type is a https-configuration record.

     A simple example configuration is given below.

          (service httpd-service-type
                   (httpd-configuration
                     (config
                       (httpd-config-file
                         (server-name "www.example.com")
                         (document-root "/srv/http/www.example.com")))))

     Other services can also extend the httpd-service-type to add to the configuration.

          (simple-service 'my-extra-server httpd-service-type
                          (list
                            (httpd-virtualhost
                              "*:80"
                              (list (string-append
                                     "ServerName "www.example.com
                                      DocumentRoot \"/srv/http/www.example.com\"")))))

The details for the httpd-configuration, httpd-module, httpd-config-file and httpd-virtualhost record types are given below.

 -- Data Type: httpd-configuration
     This data type represents the configuration for the httpd service.

     package (default: httpd)
          The httpd package to use.

     pid-file (default: "/var/run/httpd")
          The pid file used by the shepherd-service.

     config (default: (httpd-config-file))
          The configuration file to use with the httpd service. The default value is a httpd-config-file record, but this can also be a different G-expression that generates a file, for example a plain-file. A file outside of the store can also be specified through a string.

 -- Data Type: httpd-module
     This data type represents a module for the httpd service.

     name
          The name of the module.

     file
          The file for the module. This can be relative to the httpd package being used, the absolute location of a file, or a G-expression for a file within the store, for example (file-append mod-wsgi "/modules/mod_wsgi.so").

 -- Data Type: httpd-config-file
     This data type represents a configuration file for the httpd service.

     modules (default: %default-httpd-modules)
          The modules to load. Additional modules can be added here, or loaded by additional configuration.

     server-root (default: httpd)
          The ServerRoot in the configuration file, defaults to the httpd package. Directives including Include and LoadModule are taken as relative to the server root.

     server-name (default: #f)
          The ServerName in the configuration file, used to specify the request scheme, hostname and port that the server uses to identify itself.

          This doesn't need to be set in the server config, and can be specifyed in virtual hosts. The default is #f to not specify a ServerName.

     document-root (default: "/srv/http")
          The DocumentRoot from which files will be served.

     listen (default: '("80"))
          The list of values for the Listen directives in the config file. The value should be a list of strings, when each string can specify the port number to listen on, and optionally the IP address and protocol to use.

     pid-file (default: "/var/run/httpd")
          The PidFile to use. This should match the pid-file set in the httpd-configuration so that the Shepherd service is configured correctly.

     error-log (default: "/var/log/httpd/error_log")
          The ErrorLog to which the server will log errors.

     user (default: "httpd")
          The User which the server will answer requests as.

     group (default: "httpd")
          The Group which the server will answer requests as.

     extra-config (default: (list "TypesConfig etc/httpd/mime.types"))
          A flat list of strings and G-expressions which will be added to the end of the configuration file.

          Any values which the service is extended with will be appended to this list.

 -- Data Type: httpd-virtualhost
     This data type represents a virtualhost configuration block for the httpd service.

     These should be added to the extra-config for the httpd-service.

          (simple-service 'my-extra-server httpd-service-type
                          (list
                            (httpd-virtualhost
                              "*:80"
                              (list (string-append
                                     "ServerName "www.example.com
                                      DocumentRoot \"/srv/http/www.example.com\"")))))

     addresses-and-ports
          The addresses and ports for the VirtualHost directive.

     contents
          The contents of the VirtualHost directive, this should be a list of strings and G-expressions.

NGINX
.....

 -- Scheme Variable: nginx-service-type
     Service type for the NGinx (https://nginx.org/) web server.  The value for this service type is a <nginx-configuration> record.

     A simple example configuration is given below.

          (service nginx-service-type
                   (nginx-configuration
                     (server-blocks
                       (list (nginx-server-configuration
                               (server-name '("www.example.com"))
                               (root "/srv/http/www.example.com"))))))

     In addition to adding server blocks to the service configuration directly, this service can be extended by other services to add server blocks, as in this example:

          (simple-service 'my-extra-server nginx-service-type
                          (list (nginx-server-configuration
                                  (root "/srv/http/extra-website")
                                  (try-files (list "$uri" "$uri/index.html")))))

At startup, nginx has not yet read its configuration file, so it uses a default file to log error messages.  If it fails to load its configuration file, that is where error messages are logged.  After the configuration file is loaded, the default error log file changes as per configuration.  In our case, startup error messages can be found in /var/run/nginx/logs/error.log, and after configuration in /var/log/nginx/error.log.  The second location can be changed with the LOG-DIRECTORY configuration option.

 -- Data Type: nginx-configuration
     This data type represents the configuration for NGinx. Some configuration can be done through this and the other provided record types, or alternatively, a config file can be provided.

     nginx (default: nginx)
          The nginx package to use.

     log-directory (default: "/var/log/nginx")
          The directory to which NGinx will write log files.

     run-directory (default: "/var/run/nginx")
          The directory in which NGinx will create a pid file, and write temporary files.

     server-blocks (default: '())
          A list of server blocks to create in the generated configuration file, the elements should be of type <nginx-server-configuration>.

          The following example would setup NGinx to serve www.example.com from the /srv/http/www.example.com directory, without using HTTPS.

               (service nginx-service-type
                        (nginx-configuration
                          (server-blocks
                            (list (nginx-server-configuration
                                    (server-name '("www.example.com"))
                                    (root "/srv/http/www.example.com"))))))

     upstream-blocks (default: '())
          A list of upstream blocks to create in the generated configuration file, the elements should be of type <nginx-upstream-configuration>.

          Configuring upstreams through the upstream-blocks can be useful when combined with locations in the <nginx-server-configuration> records.  The following example creates a server configuration with one location configuration, that will proxy requests to a upstream configuration, which will handle requests with two servers.

               (service
                 nginx-service-type
                 (nginx-configuration
                   (server-blocks
                     (list (nginx-server-configuration
                             (server-name '("www.example.com"))
                             (root "/srv/http/www.example.com")
                             (locations
                               (list
                                 (nginx-location-configuration
                                 (uri "/path1")
                                 (body '("proxy_pass http://server-proxy;"))))))))
                   (upstream-blocks
                     (list (nginx-upstream-configuration
                             (name "server-proxy")
                             (servers (list "server1.example.com"
                                            "server2.example.com")))))))

     file (default: #f)
          If a configuration FILE is provided, this will be used, rather than generating a configuration file from the provided log-directory, run-directory, server-blocks and upstream-blocks.  For proper operation, these arguments should match what is in FILE to ensure that the directories are created when the service is activated.

          This can be useful if you have an existing configuration file, or it's not possible to do what is required through the other parts of the nginx-configuration record.

     server-names-hash-bucket-size (default: #f)
          Bucket size for the server names hash tables, defaults to #f to use the size of the processors cache line.

     server-names-hash-bucket-max-size (default: #f)
          Maximum bucket size for the server names hash tables.

     extra-content (par défaut : "")
          Extra content for the http block.  Should be string or a string valued G-expression.

 -- Data Type: nginx-server-configuration
     Data type representing the configuration of an nginx server block.  This type has the following parameters:

     listen (default: '("80" "443 ssl"))
          Each listen directive sets the address and port for IP, or the path for a UNIX-domain socket on which the server will accept requests.  Both address and port, or only address or only port can be specified.  An address may also be a hostname, for example:

               '("127.0.0.1:8000" "127.0.0.1" "8000" "*:8000" "localhost:8000")

     server-name (default: (list 'default))
          A list of server names this server represents. 'default represents the default server for connections matching no other server.

     root (default: "/srv/http")
          Root of the website nginx will serve.

     locations (default: '())
          A list of nginx-location-configuration or nginx-named-location-configuration records to use within this server block.

     index (default: (list "index.html"))
          Index files to look for when clients ask for a directory.  If it cannot be found, Nginx will send the list of files in the directory.

     try-files (default: '())
          A list of files whose existence is checked in the specified order. nginx will use the first file it finds to process the request.

     ssl-certificate (default: #f)
          Where to find the certificate for secure connections.  Set it to #f if you don't have a certificate or you don't want to use HTTPS.

     ssl-certificate-key (default: #f)
          Where to find the private key for secure connections.  Set it to #f if you don't have a key or you don't want to use HTTPS.

     server-tokens? (default: #f)
          Whether the server should add its configuration to response.

     raw-content (default: '())
          A list of raw lines added to the server block.

 -- Data Type: nginx-upstream-configuration
     Data type representing the configuration of an nginx upstream block. This type has the following parameters:

     name
          Name for this group of servers.

     servers
          Specify the addresses of the servers in the group.  The address can be specified as a IP address (e.g. 127.0.0.1), domain name (e.g. backend1.example.com) or a path to a UNIX socket using the prefix unix:.  For addresses using an IP address or domain name, the default port is 80, and a different port can be specified explicitly.

 -- Data Type: nginx-location-configuration
     Data type representing the configuration of an nginx location block. This type has the following parameters:

     uri
          URI which this location block matches.

     body
          Body of the location block, specified as a list of strings. This can contain many configuration directives.  For example, to pass requests to a upstream server group defined using an nginx-upstream-configuration block, the following directive would be specified in the body (list "proxy_pass http://upstream-name;").

 -- Data Type: nginx-named-location-configuration
     Data type representing the configuration of an nginx named location block. Named location blocks are used for request redirection, and not used for regular request processing.  This type has the following parameters:

     name
          Name to identify this location block.

     body
          See nginx-location-configuration body, as the body for named location blocks can be used in a similar way to the nginx-location-configuration body.  One restriction is that the body of a named location block cannot contain location blocks.

FastCGI is an interface between the front-end and the back-end of a web service.  It is a somewhat legacy facility; new web services should generally just talk HTTP between the front-end and the back-end.  However there are a number of back-end services such as PHP or the optimized HTTP Git repository access that use FastCGI, so we have support for it in Guix.

To use FastCGI, you configure the front-end web server (e.g., nginx) to dispatch some subset of its requests to the fastcgi backend, which listens on a local TCP or UNIX socket.  There is an intermediary fcgiwrap program that sits between the actual backend process and the web server. The front-end indicates which backend program to run, passing that information to the fcgiwrap process.

 -- Scheme Variable: fcgiwrap-service-type
     A service type for the fcgiwrap FastCGI proxy.

 -- Data Type: fcgiwrap-configuration
     Data type representing the configuration of the fcgiwrap serice. This type has the following parameters:

     package (default: fcgiwrap)
          The fcgiwrap package to use.

     socket (default: tcp:127.0.0.1:9000)
          The socket on which the fcgiwrap process should listen, as a string. Valid SOCKET values include unix:/PATH/TO/UNIX/SOCKET, tcp:DOT.TED.QU.AD:PORT and tcp6:[IPV6_ADDR]:port.

     user (default: fcgiwrap)
     group (default: fcgiwrap)
          The user and group names, as strings, under which to run the fcgiwrap process.  The fastcgi service will ensure that if the user asks for the specific user or group names fcgiwrap that the corresponding user and/or group is present on the system.

          It is possible to configure a FastCGI-backed web service to pass HTTP authentication information from the front-end to the back-end, and to allow fcgiwrap to run the back-end process as a corresponding local user. To enable this capability on the back-end., run fcgiwrap as the root user and group.  Note that this capability also has to be configured on the front-end as well.

PHP-FPM (FastCGI Process Manager) is an alternative PHP FastCGI implementation with some additional features useful for sites of any size.

These features include:

  * Adaptive process spawning

  * Basic statistics (similar to Apache's mod_status)

  * Advanced process management with graceful stop/start

  * Ability to start workers with different uid/gid/chroot/environment and different php.ini (replaces safe_mode)

  * Stdout & stderr logging

  * Emergency restart in case of accidental opcode cache destruction

  * Accelerated upload support

  * Support for a "slowlog"

  * Enhancements to FastCGI, such as fastcgi_finish_request() - a special function to finish request & flush all data while continuing to do something time-consuming (video converting, stats processing, etc.)

... and much more.

 -- Scheme Variable: php-fpm-service-type
     A Service type for php-fpm.

 -- Data Type: php-fpm-configuration
     Data Type for php-fpm service configuration.

     php (default: php)
          The php package to use.

     socket (default: (string-append "/var/run/php" (version-major (package-version php)) "-fpm.sock"))
          The address on which to accept FastCGI requests.  Valid syntaxes are:

          "ip.add.re.ss:port"
               Listen on a TCP socket to a specific address on a specific port.

          "port"
               Listen on a TCP socket to all addresses on a specific port.

          "/path/to/unix/socket"
               Listen on a unix socket.

     user (default: php-fpm)
          User who will own the php worker processes.

     group (default: php-fpm)
          Group of the worker processes.

     socket-user (default: php-fpm)
          User who can speak to the php-fpm socket.

     socket-group (default: php-fpm)
          Group that can speak to the php-fpm socket.

     pid-file (default: (string-append "/var/run/php" (version-major (package-version php)) "-fpm.pid"))
          The process id of the php-fpm process is written to this file once the service has started.

     log-file (default: (string-append "/var/log/php" (version-major (package-version php)) "-fpm.log"))
          Log for the php-fpm master process.

     process-manager (default: (php-fpm-dynamic-process-manager-configuration))
          Detailed settings for the php-fpm process manager.  Must be either:

          <php-fpm-dynamic-process-manager-configuration>

          <php-fpm-static-process-manager-configuration>

          <php-fpm-on-demand-process-manager-configuration>

     display-errors (default #f)
          Determines whether php errors and warning should be sent to clients and displayed in their browsers.  This is useful for local php development, but a security risk for public sites, as error messages can reveal passwords and personal data.

     workers-logfile (default (string-append "/var/log/php" (version-major (package-version php)) "-fpm.www.log"))
          This file will log the stderr outputs of php worker processes.  Can be set to #f to disable logging.

     file (default #f)
          An optional override of the whole configuration.  You can use the mixed-text-file function or an absolute filepath for it.

 -- Data type: php-fpm-dynamic-process-manager-configuration
     Data Type for the dynamic php-fpm process manager.  With the dynamic process manager, spare worker processes are kept around based on it's configured limits.

     max-children (default: 5)
          Maximum of worker processes.

     start-servers (default: 2)
          How many worker processes should be started on start-up.

     min-spare-servers (default: 1)
          How many spare worker processes should be kept around at minimum.

     max-spare-servers (default: 3)
          How many spare worker processes should be kept around at maximum.

 -- Data type: php-fpm-static-process-manager-configuration
     Data Type for the static php-fpm process manager.  With the static process manager, an unchanging number of worker processes are created.

     max-children (default: 5)
          Maximum of worker processes.

 -- Data type: php-fpm-on-demand-process-manager-configuration
     Data Type for the on-demand php-fpm process manager.  With the on-demand process manager, worker processes are only created as requests arrive.

     max-children (default: 5)
          Maximum of worker processes.

     process-idle-timeout (default: 10)
          The time in seconds after which a process with no requests is killed.

 -- Scheme Procedure: nginx-php-fpm-location
     [#:nginx-package nginx]  [socket (string-append "/var/run/php"
     (version-major (package-version php))  "-fpm.sock")] A helper function to
     quickly add php to an nginx-server-configuration.

A simple services setup for nginx with php can look like this:

     (services (cons* (dhcp-client-service)
                      (service php-fpm-service-type)
                      (service nginx-service-type
                               (nginx-server-configuration
                                (server-name '("example.com"))
                                (root "/srv/http/")
                                (locations
                                 (list (nginx-php-location)))
                                (https-port #f)
                                (ssl-certificate #f)
                                (ssl-certificate-key #f)))
                      %base-services))

The cat avatar generator is a simple service to demonstrate the use of php-fpm in Nginx.  It is used to generate cat avatar from a seed, for instance the hash of a user's email address.

 -- Scheme Procedure: cat-avatar-generator-serice
     [#:cache-dir "/var/cache/cat-avatar-generator"]  [#:package
     cat-avatar-generator]  [#:configuration (nginx-server-configuration)] Returns an nginx-server-configuration that inherits configuration. It extends the nginx configuration to add a server block that serves package, a version of cat-avatar-generator.  During execution, cat-avatar-generator will be able to use cache-dir as its cache directory.

A simple setup for cat-avatar-generator can look like this:

     (services (cons* (cat-avatar-generator-service
                       #:configuration
                       (nginx-server-configuration
                         (server-name '("example.com"))))
                      ...
                      %base-services))

Hpcguix-web
...........

The https://github.com/UMCUGenetics/hpcguix-web/ (hpcguix-web) program is a customizable web interface to browse Guix packages, initially designed for users of high-performance computing (HPC)  clusters.

 -- Variable Scheme: hpcguix-web-service-type
     The service type for hpcguix-web.

 -- Type de donnée: hpcguix-web-configuration
     Data type for the hpcguix-web service configuration.

     specs
          A gexp (see G-Expressions) specifying the hpcguix-web service configuration.  The main items available in this spec are:

          title-prefix (par défaut : "hpcguix | ")
               Le préfixe du titre des pages.

          guix-command (par défaut : "guix")
               La commande guix

          package-filter-proc (par défaut : (const #t))
               Une procédure qui spécifie comment filtrer les paquets qui seront affichés.

          package-page-extension-procinputs (par défaut : (const '()))
               Extension package for hpcguix-web.

          menu (par défaut : '())
               Additional entry in page menu.

          See the hpcguix-web repository for a complete example (https://github.com/UMCUGenetics/hpcguix-web/blob/master/hpcweb-configuration.scm).

     packages (par défaut : hpcguix-web)
          Le paquet hpcguix-web à utiliser.

A typical hpcguix-web service declaration looks like this:

     (service hpcguix-web-service-type
              (hpcguix-web-configuration
               (specs
                #~(define site-config
                    (hpcweb-configuration
                     (title-prefix "Guix-HPC - ")
                     (menu '(("/about" "ABOUT"))))))))

Services de certificats
.......................

The (gnu services certbot) module provides a service to automatically obtain a valid TLS certificate from the Let's Encrypt certificate authority.  These certificates can then be used to serve content securely over HTTPS or other TLS-based protocols, with the knowledge that the client will be able to verify the server's authenticity.

Let's Encrypt (https://letsencrypt.org/) provides the certbot tool to automate the certification process.  This tool first securely generates a key on the server.  It then makes a request to the Let's Encrypt certificate authority (CA) to sign the key.  The CA checks that the request originates from the host in question by using a challenge-response protocol, requiring the server to provide its response over HTTP.  If that protocol completes successfully, the CA signs the key, resulting in a certificate. That certificate is valid for a limited period of time, and therefore to continue to provide TLS services, the server needs to periodically ask the CA to renew its signature.

The certbot service automates this process: the initial key generation, the initial certification request to the Let's Encrypt service, the web server challenge/response integration, writing the certificate to disk, the automated periodic renewals, and the deployment tasks associated with the renewal (e.g. reloading services, copying keys with different permissions).

Certbot is run twice a day, at a random minute within the hour.  It won't do anything until your certificates are due for renewal or revoked, but running it regularly would give your service a chance of staying online in case a Let's Encrypt-initiated revocation happened for some reason.

By using this service, you agree to the ACME Subscriber Agreement, which can be found there: https://acme-v01.api.letsencrypt.org/directory.

 -- Scheme Variable: certbot-service-type
     A service type for the certbot Let's Encrypt client.  Its value must be a certbot-configuration record as in this example:

          (define %nginx-deploy-hook
            (program-file
             "nginx-deploy-hook"
             #~(let ((pid (call-with-input-file "/var/run/nginx/pid" read)))
                 (kill pid SIGHUP))))

          (service certbot-service-type
                   (certbot-configuration
                    (email "foo@example.net")
                    (certificates
                     (list
                      (certificate-configuration
                       (domains '("example.net" "www.example.net"))
                       (deploy-hook %nginx-deploy-hook))
                      (certificate-configuration
                       (domains '("bar.example.net")))))))

     See below for details about certbot-configuration.

 -- Data Type: certbot-configuration
     Data type representing the configuration of the certbot service. This type has the following parameters:

     package (default: certbot)
          The certbot package to use.

     webroot (default: /var/www)
          The directory from which to serve the Let's Encrypt challenge/response files.

     certificates (default: ())
          A list of certificates-configurations for which to generate certificates and request signatures.  Each certificate has a name and several domains.

     email
          Mandatory email used for registration, recovery contact, and important account notifications.

     rsa-key-size (default: 2048)
          Size of the RSA key.

     default-location (default: see below)
          The default nginx-location-configuration.  Because certbot needs to be able to serve challenges and responses, it needs to be able to run a web server.  It does so by extending the nginx web service with an nginx-server-configuration listening on the DOMAINS on port 80, and which has a nginx-location-configuration for the /.well-known/ URI path subspace used by Let's Encrypt.  See Services web, for more on these nginx configuration data types.

          Requests to other URL paths will be matched by the default-location, which if present is added to all nginx-server-configurations.

          By default, the default-location will issue a redirect from http://DOMAIN/... to https://DOMAIN/..., leaving you to define what to serve on your site via https.

          Pass #f to not issue a default location.

 -- Data Type: certificate-configuration
     Data type representing the configuration of a certificate.  This type has the following parameters:

     name (default: see below)
          This name is used by Certbot for housekeeping and in file paths; it doesn't affect the content of the certificate itself.  To see certificate names, run certbot certificates.

          Its default is the first provided domain.

     domains (default: ())
          The first domain provided will be the subject CN of the certificate, and all domains will be Subject Alternative Names on the certificate.

     deploy-hook (default: #f)
          Command to be run in a shell once for each successfully issued certificate. For this command, the shell variable $RENEWED_LINEAGE will point to the config live subdirectory (for example, "/etc/letsencrypt/live/example.com") containing the new certificates and keys; the shell variable $RENEWED_DOMAINS will contain a space-delimited list of renewed certificate domains (for example, "example.com www.example.com".

For each certificate-configuration, the certificate is saved to /etc/letsencrypt/live/NAME/fullchain.pem and the key is saved to /etc/letsencrypt/live/NAME/privkey.pem.

Services DNS
............

The (gnu services dns) module provides services related to the domain name system (DNS).  It provides a server service for hosting an authoritative DNS server for multiple zones, slave or master.  This service uses Knot DNS (https://www.knot-dns.cz/).  And also a caching and forwarding DNS server for the LAN, which uses dnsmasq (http://www.thekelleys.org.uk/dnsmasq/doc.html).

Service Knot
............

An example configuration of an authoritative server for two zones, one master and one slave, is:

     (define-zone-entries example.org.zone
     ;; Name TTL Class Type Data
       ("@"  ""  "IN"  "A"  "127.0.0.1")
       ("@"  ""  "IN"  "NS" "ns")
       ("ns" ""  "IN"  "A"  "127.0.0.1"))

     (define master-zone
       (knot-zone-configuration
         (domain "example.org")
         (zone (zone-file
                 (origin "example.org")
                 (entries example.org.zone)))))

     (define slave-zone
       (knot-zone-configuration
         (domain "plop.org")
         (dnssec-policy "default")
         (master (list "plop-master"))))

     (define plop-master
       (knot-remote-configuration
         (id "plop-master")
         (address (list "208.76.58.171"))))

     (operating-system
       ;; ...
       (services (cons* (service knot-service-type
                          (knot-configuration
                            (remotes (list plop-master))
                            (zones (list master-zone slave-zone))))
                        ;; ...
                        %base-services)))

 -- Scheme Variable: knot-service-type
     This is the type for the Knot DNS server.

     Knot DNS is an authoritative DNS server, meaning that it can serve multiple zones, that is to say domain names you would buy from a registrar.  This server is not a resolver, meaning that it can only resolve names for which it is authoritative.  This server can be configured to serve zones as a master server or a slave server as a per-zone basis.  Slave zones will get their data from masters, and will serve it as an authoritative server.  From the point of view of a resolver, there is no difference between master and slave.

     The following data types are used to configure the Knot DNS server:

 -- Data Type: knot-key-configuration
     Data type representing a key.  This type has the following parameters:

     id (default: "")
          An identifier for other configuration fields to refer to this key. IDs must be unique and must not be empty.

     algorithm (default: #f)
          The algorithm to use.  Choose between #f, 'hmac-md5, 'hmac-sha1, 'hmac-sha224, 'hmac-sha256, 'hmac-sha384 and 'hmac-sha512.

     secret (default: "")
          The secret key itself.

 -- Data Type: knot-acl-configuration
     Data type representing an Access Control List (ACL) configuration.  This type has the following parameters:

     id (default: "")
          An identifier for ether configuration fields to refer to this key. IDs must be unique and must not be empty.

     address (default: '())
          An ordered list of IP addresses, network subnets, or network ranges represented with strings.  The query must match one of them.  Empty value means that address match is not required.

     key (default: '())
          An ordered list of references to keys represented with strings.  The string must match a key ID defined in a knot-key-configuration.  No key means that a key is not require to match that ACL.

     action (default: '())
          An ordered list of actions that are permitted or forbidden by this ACL. Possible values are lists of zero or more elements from 'transfer, 'notify and 'update.

     deny? (default: #f)
          When true, the ACL defines restrictions.  Listed actions are forbidden. When false, listed actions are allowed.

 -- Data Type: zone-entry
     Data type represnting a record entry in a zone file.  This type has the following parameters:

     name (default: "@")
          The name of the record.  "@" refers to the origin of the zone. Names are relative to the origin of the zone.  For example, in the example.org zone, "ns.example.org" actually refers to ns.example.org.example.org.  Names ending with a dot are absolute, which means that "ns.example.org." refers to ns.example.org.

     ttl (default: "")
          The Time-To-Live (TTL) of this record.  If not set, the default TTL is used.

     class (default: "IN")
          The class of the record.  Knot currently supports only "IN" and partially "CH".

     type (default: "A")
          The type of the record.  Common types include A (IPv4 address), AAAA (IPv6 address), NS (Name Server) and MX (Mail eXchange).  Many other types are defined.

     data (default: "")
          The data contained in the record.  For instance an IP address associated with an A record, or a domain name associated with an NS record.  Remember that domain names are relative to the origin unless they end with a dot.

 -- Data Type: zone-file
     Data type representing the content of a zone file.  This type has the following parameters:

     entries (default: '())
          The list of entries.  The SOA record is taken care of, so you don't need to put it in the list of entries.  This list should probably contain an entry for your primary authoritative DNS server.  Other than using a list of entries directly, you can use define-zone-entries to define a object containing the list of entries more easily, that you can later pass to the entries field of the zone-file.

     origin (default: "")
          The name of your zone.  This parameter cannot be empty.

     ns (default: "ns")
          The domain of your primary authoritative DNS server.  The name is relative to the origin, unless it ends with a dot.  It is mandatory that this primary DNS server corresponds to an NS record in the zone and that it is associated to an IP address in the list of entries.

     mail (default: "hostmaster")
          An email address people can contact you at, as the owner of the zone.  This is translated as <mail>@<origin>.

     serial (default: 1)
          The serial number of the zone.  As this is used to keep track of changes by both slaves and resolvers, it is mandatory that it never decreases. Always increment it when you make a change in your zone.

     refresh (default: (* 2 24 3600))
          The frequency at which slaves will do a zone transfer.  This value is a number of seconds.  It can be computed by multiplications or with (string->duration).

     retry (default: (* 15 60))
          The period after which a slave will retry to contact its master when it fails to do so a first time.

     expiry (default: (* 14 24 3600))
          Default TTL of records.  Existing records are considered correct for at most this amount of time.  After this period, resolvers will invalidate their cache and check again that it still exists.

     nx (default: 3600)
          Default TTL of inexistant records.  This delay is usually short because you want your new domains to reach everyone quickly.

 -- Data Type: knot-remote-configuration
     Data type representing a remote configuration.  This type has the following parameters:

     id (default: "")
          An identifier for other configuration fields to refer to this remote. IDs must be unique and must not be empty.

     address (default: '())
          An ordered list of destination IP addresses.  Addresses are tried in sequence.  An optional port can be given with the @ separator.  For instance: (list "1.2.3.4" "2.3.4.5@53").  Default port is 53.

     via (default: '())
          An ordered list of source IP addresses.  An empty list will have Knot choose an appropriate source IP.  An optional port can be given with the @ separator.  The default is to choose at random.

     key (default: #f)
          A reference to a key, that is a string containing the identifier of a key defined in a knot-key-configuration field.

 -- Data Type: knot-keystore-configuration
     Data type representing a keystore to hold dnssec keys.  This type has the following parameters:

     id (default: "")
          The id of the keystore.  It must not be empty.

     backend (default: 'pem)
          The backend to store the keys in.  Can be 'pem or 'pkcs11.

     config (default: "/var/lib/knot/keys/keys")
          The configuration string of the backend.  An example for the PKCS#11 is: "pkcs11:token=knot;pin-value=1234 /gnu/store/.../lib/pkcs11/libsofthsm2.so".  For the pem backend, the string reprensents a path in the file system.

 -- Data Type: knot-policy-configuration
     Data type representing a dnssec policy.  Knot DNS is able to automatically sign your zones.  It can either generate and manage your keys automatically or use keys that you generate.

     Dnssec is usually implemented using two keys: a Key Signing Key (KSK) that is used to sign the second, and a Zone Signing Key (ZSK) that is used to sign the zone.  In order to be trusted, the KSK needs to be present in the parent zone (usually a top-level domain).  If your registrar supports dnssec, you will have to send them your KSK's hash so they can add a DS record in their zone.  This is not automated and need to be done each time you change your KSK.

     The policy also defines the lifetime of keys.  Usually, ZSK can be changed easily and use weaker cryptographic functions (they use lower parameters) in order to sign records quickly, so they are changed often.  The KSK however requires manual interaction with the registrar, so they are changed less often and use stronger parameters because they sign only one record.

     This type has the following parameters:

     id (default: "")
          The id of the policy.  It must not be empty.

     keystore (default: "default")
          A reference to a keystore, that is a string containing the identifier of a keystore defined in a knot-keystore-configuration field.  The "default" identifier means the default keystore (a kasp database that was setup by this service).

     manual? (default: #f)
          Whether the key management is manual or automatic.

     single-type-signing? (default: #f)
          When #t, use the Single-Type Signing Scheme.

     algorithm (default: "ecdsap256sha256")
          An algorithm of signing keys and issued signatures.

     ksk-size (default: 256)
          The length of the KSK.  Note that this value is correct for the default algorithm, but would be unsecure for other algorithms.

     zsk-size (default: 256)
          The length of the ZSK.  Note that this value is correct for the default algorithm, but would be unsecure for other algorithms.

     dnskey-ttl (default: 'default)
          The TTL value for DNSKEY records added into zone apex.  The special 'default value means same as the zone SOA TTL.

     zsk-lifetime (default: (* 30 24 3600))
          The period between ZSK publication and the next rollover initiation.

     propagation-delay (default: (* 24 3600))
          An extra delay added for each key rollover step.  This value should be high enough to cover propagation of data from the master server to all slaves.

     rrsig-lifetime (default: (* 14 24 3600))
          A validity period of newly issued signatures.

     rrsig-refresh (default: (* 7 24 3600))
          A period how long before a signature expiration the signature will be refreshed.

     nsec3? (default: #f)
          When #t, NSEC3 will be used instead of NSEC.

     nsec3-iterations (default: 5)
          The number of additional times the hashing is performed.

     nsec3-salt-length (default: 8)
          The length of a salt field in octets, which is appended to the original owner name before hashing.

     nsec3-salt-lifetime (default: (* 30 24 3600))
          The validity period of newly issued salt field.

 -- Data Type: knot-zone-configuration
     Data type representing a zone served by Knot.  This type has the following parameters:

     domain (default: "")
          The domain served by this configuration.  It must not be empty.

     file (default: "")
          The file where this zone is saved.  This parameter is ignored by master zones.  Empty means default location that depends on the domain name.

     zone (default: (zone-file))
          The content of the zone file.  This parameter is ignored by slave zones.  It must contain a zone-file record.

     master (default: '())
          A list of master remotes.  When empty, this zone is a master.  When set, this zone is a slave.  This is a list of remotes identifiers.

     ddns-master (default: #f)
          The main master.  When empty, it defaults to the first master in the list of masters.

     notify (default: '())
          A list of slave remote identifiers.

     acl (default: '())
          A list of acl identifiers.

     semantic-checks? (default: #f)
          When set, this adds more semantic checks to the zone.

     disable-any? (default: #f)
          When set, this forbids queries of the ANY type.

     zonefile-sync (default: 0)
          The delay between a modification in memory and on disk.  0 means immediate synchronization.

     serial-policy (default: 'increment)
          A policy between 'increment and 'unixtime.

 -- Data Type: knot-configuration
     Data type representing the Knot configuration.  This type has the following parameters:

     knot (default: knot)
          The Knot package.

     run-directory (default: "/var/run/knot")
          The run directory.  This directory will be used for pid file and sockets.

     listen-v4 (default: "0.0.0.0")
          An ip address on which to listen.

     listen-v6 (default: "::")
          An ip address on which to listen.

     listen-port (default: 53)
          A port on which to listen.

     keys (default: '())
          The list of knot-key-configuration used by this configuration.

     acls (default: '())
          The list of knot-acl-configuration used by this configuration.

     remotes (default: '())
          The list of knot-remote-configuration used by this configuration.

     zones (default: '())
          The list of knot-zone-configuration used by this configuration.

Services Dnsmasq
................

 -- Variable Scheme: dnsmasq-service-type
     This is the type of the dnsmasq service, whose value should be an dnsmasq-configuration object as in this example:

          (service dnsmasq-service-type
                   (dnsmasq-configuration
                     (no-resolv? #t)
                     (servers '("192.168.1.1"))))

 -- Type de donnée: dnsmasq-configuration
     Type de données qui représente la configuration de dnsmasq.

     package (par défaut : dnsmasq)
          Package object of the dnsmasq server.

     no-hosts? (par défaut : #f)
          When true, don't read the hostnames in /etc/hosts.

     port (par défaut : 53)
          The port to listen on.  Setting this to zero completely disables DNS funtion, leaving only DHCP and/or TFTP.

     local-service? (par défaut : #t)
          Accept DNS queries only from hosts whose address is on a local subnet, ie a subnet for which an interface exists on the server.

     listen-addresses (par défaut : '())
          Listen on the given IP addresses.

     resolv-file (par défaut : "/etc/resolv.conf")
          The file to read the IP address of the upstream nameservers from.

     no-resolv? (par défaut : #f)
          When true, don't read RESOLV-FILE.

     servers (default: '())
          Specify IP address of upstream servers directly.

     cache-size (par défaut : 150)
          Set the size of dnsmasq's cache.  Setting the cache size to zero disables caching.

     negative-cache? (par défaut : #t)
          When false, disable negative caching.

Services VPN
............

The (gnu services vpn) module provides services related to virtual private networks (VPNs).  It provides a client service for your machine to connect to a VPN, and a servire service for your machine to host a VPN.  Both services use OpenVPN (https://openvpn.net/).

 -- Scheme Procedure: openvpn-client-service
     [#:config (openvpn-client-configuration)]

     Return a service that runs openvpn, a VPN daemon, as a client.

 -- Scheme Procedure: openvpn-server-service
     [#:config (openvpn-server-configuration)]

     Return a service that runs openvpn, a VPN daemon, as a server.

     Both can be run simultaneously.

Available openvpn-client-configuration fields are:

 -- openvpn-client-configuration parameter: package openvpn
     The OpenVPN package.

 -- openvpn-client-configuration parameter: string pid-file
     The OpenVPN pid file.

     Defaults to "/var/run/openvpn/openvpn.pid".

 -- openvpn-client-configuration parameter: proto proto
     The protocol (UDP or TCP) used to open a channel between clients and servers.

     Defaults to udp.

 -- openvpn-client-configuration parameter: dev dev
     The device type used to represent the VPN connection.

     Defaults to tun.

 -- openvpn-client-configuration parameter: string ca
     The certificate authority to check connections against.

     Defaults to "/etc/openvpn/ca.crt".

 -- openvpn-client-configuration parameter: string cert
     The certificate of the machine the daemon is running on.  It should be signed by the authority given in ca.

     Defaults to "/etc/openvpn/client.crt".

 -- openvpn-client-configuration parameter: string key
     The key of the machine the daemon is running on.  It must be the key whose certificate is cert.

     Defaults to "/etc/openvpn/client.key".

 -- openvpn-client-configuration parameter: boolean comp-lzo?
     Whether to use the lzo compression algorithm.

     Defaults to #t.

 -- openvpn-client-configuration parameter: boolean persist-key?
     Don't re-read key files across SIGUSR1 or --ping-restart.

     Defaults to #t.

 -- openvpn-client-configuration parameter: boolean persist-tun?
     Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 or --ping-restart restarts.

     Defaults to #t.

 -- openvpn-client-configuration parameter: number verbosity
     Verbosity level.

     Defaults to 3.

 -- openvpn-client-configuration parameter: tls-auth-client tls-auth
     Add an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.

     Defaults to #f.

 -- openvpn-client-configuration parameter: key-usage verify-key-usage?
     Whether to check the server certificate has server usage extension.

     Defaults to #t.

 -- openvpn-client-configuration parameter: bind bind?
     Bind to a specific local port number.

     Defaults to #f.

 -- openvpn-client-configuration parameter: resolv-retry resolv-retry?
     Retry resolving server address.

     Defaults to #t.

 -- openvpn-client-configuration parameter: openvpn-remote-list remote
     A list of remote servers to connect to.

     Defaults to ().

     Available openvpn-remote-configuration fields are:

      -- openvpn-remote-configuration parameter: string name
          Server name.

          Defaults to "my-server".

      -- openvpn-remote-configuration parameter: number port
          Port number the server listens to.

          Defaults to 1194.

Available openvpn-server-configuration fields are:

 -- openvpn-server-configuration parameter: package openvpn
     The OpenVPN package.

 -- openvpn-server-configuration parameter: string pid-file
     The OpenVPN pid file.

     Defaults to "/var/run/openvpn/openvpn.pid".

 -- openvpn-server-configuration parameter: proto proto
     The protocol (UDP or TCP) used to open a channel between clients and servers.

     Defaults to udp.

 -- openvpn-server-configuration parameter: dev dev
     The device type used to represent the VPN connection.

     Defaults to tun.

 -- openvpn-server-configuration parameter: string ca
     The certificate authority to check connections against.

     Defaults to "/etc/openvpn/ca.crt".

 -- openvpn-server-configuration parameter: string cert
     The certificate of the machine the daemon is running on.  It should be signed by the authority given in ca.

     Defaults to "/etc/openvpn/client.crt".

 -- openvpn-server-configuration parameter: string key
     The key of the machine the daemon is running on.  It must be the key whose certificate is cert.

     Defaults to "/etc/openvpn/client.key".

 -- openvpn-server-configuration parameter: boolean comp-lzo?
     Whether to use the lzo compression algorithm.

     Defaults to #t.

 -- openvpn-server-configuration parameter: boolean persist-key?
     Don't re-read key files across SIGUSR1 or --ping-restart.

     Defaults to #t.

 -- openvpn-server-configuration parameter: boolean persist-tun?
     Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 or --ping-restart restarts.

     Defaults to #t.

 -- openvpn-server-configuration parameter: number verbosity
     Verbosity level.

     Defaults to 3.

 -- openvpn-server-configuration parameter: tls-auth-server tls-auth
     Add an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.

     Defaults to #f.

 -- openvpn-server-configuration parameter: number port
     Specifies the port number on which the server listens.

     Defaults to 1194.

 -- openvpn-server-configuration parameter: ip-mask server
     An ip and mask specifying the subnet inside the virtual network.

     Defaults to "10.8.0.0 255.255.255.0".

 -- openvpn-server-configuration parameter: cidr6 server-ipv6
     A CIDR notation specifying the IPv6 subnet inside the virtual network.

     Defaults to #f.

 -- openvpn-server-configuration parameter: string dh
     The Diffie-Hellman parameters file.

     Defaults to "/etc/openvpn/dh2048.pem".

 -- openvpn-server-configuration parameter: string ifconfig-pool-persist
     The file that records client IPs.

     Defaults to "/etc/openvpn/ipp.txt".

 -- openvpn-server-configuration parameter: gateway redirect-gateway?
     When true, the server will act as a gateway for its clients.

     Defaults to #f.

 -- openvpn-server-configuration parameter: boolean client-to-client?
     When true, clients are allowed to talk to each other inside the VPN.

     Defaults to #f.

 -- openvpn-server-configuration parameter: keepalive keepalive
     Causes ping-like messages to be sent back and forth over the link so that each side knows when the other side has gone down.  keepalive requires a pair.  The first element is the period of the ping sending, and the second element is the timeout before considering the other side down.

 -- openvpn-server-configuration parameter: number max-clients
     The maximum number of clients.

     Defaults to 100.

 -- openvpn-server-configuration parameter: string status
     The status file.  This file shows a small report on current connection.  It is truncated and rewritten every minute.

     Defaults to "/var/run/openvpn/status".

 -- openvpn-server-configuration parameter: openvpn-ccd-list client-config-dir
     The list of configuration for some clients.

     Defaults to ().

     Available openvpn-ccd-configuration fields are:

      -- openvpn-ccd-configuration parameter: string name
          Client name.

          Defaults to "client".

      -- openvpn-ccd-configuration parameter: ip-mask iroute
          Client own network

          Defaults to #f.

      -- openvpn-ccd-configuration parameter: ip-mask ifconfig-push
          Client VPN IP.

          Defaults to #f.

Système de fichiers en réseau
.............................

The (gnu services nfs) module provides the following services, which are most commonly used in relation to mounting or exporting directory trees as network file systems (NFS).

RPC Bind Service
................

The RPC Bind service provides a facility to map program numbers into universal addresses.  Many NFS related services use this facility.  Hence it is automatically started when a dependent service starts.

 -- Scheme Variable: rpcbind-service-type
     A service type for the RPC portmapper daemon.

 -- Data Type: rpcbind-configuration
     Data type representing the configuration of the RPC Bind Service.  This type has the following parameters:

     rpcbind (default: rpcbind)
          The rpcbind package to use.

     warm-start? (default: #t)
          If this parameter is #t, then the daemon will read a state file on startup thus reloading state information saved by a previous instance.

Pipefs Pseudo File System
.........................

The pipefs file system is used to transfer NFS related data between the kernel and user space programs.

 -- Scheme Variable: pipefs-service-type
     A service type for the pipefs pseudo file system.

 -- Data Type: pipefs-configuration
     Data type representing the configuration of the pipefs pseudo file system service.  This type has the following parameters:

     mount-point (default: "/var/lib/nfs/rpc_pipefs")
          The directory to which the file system is to be attached.

GSS Daemon Service
..................

The global security system (GSS) daemon provides strong security for RPC based protocols.  Before exchanging RPC requests an RPC client must establish a security context.  Typically this is done using the Kerberos command kinit or automatically at login time using PAM services (see Services Kerberos).

 -- Scheme Variable: gss-service-type
     A service type for the Global Security System (GSS) daemon.

 -- Data Type: gss-configuration
     Data type representing the configuration of the GSS daemon service.  This type has the following parameters:

     nfs-utils (default: nfs-utils)
          The package in which the rpc.gssd command is to be found.

     pipefs-directory (default: "/var/lib/nfs/rpc_pipefs")
          The directory where the pipefs file system is mounted.

IDMAP Daemon Service
....................

The idmap daemon service provides mapping between user IDs and user names. Typically it is required in order to access file systems mounted via NFSv4.

 -- Scheme Variable: idmap-service-type
     A service type for the Identity Mapper (IDMAP) daemon.

 -- Data Type: idmap-configuration
     Data type representing the configuration of the IDMAP daemon service.  This type has the following parameters:

     nfs-utils (default: nfs-utils)
          The package in which the rpc.idmapd command is to be found.

     pipefs-directory (default: "/var/lib/nfs/rpc_pipefs")
          The directory where the pipefs file system is mounted.

     domain (default: #f)
          The local NFSv4 domain name.  This must be a string or #f.  If it is #f then the daemon will use the host's fully qualified domain name.

Intégration continue
....................

Cuirass (https://git.savannah.gnu.org/cgit/guix/guix-cuirass.git) is a continuous integration tool for Guix.  It can be used both for development and for providing substitutes to others (see Substituts).

The (gnu services cuirass) module provides the following service.

 -- Scheme Procedure: cuirass-service-type
     The type of the Cuirass service.  Its value must be a cuirass-configuration object, as described below.

To add build jobs, you have to set the specifications field of the configuration.  Here is an example of a service defining a build job based on a specification that can be found in Cuirass source tree.  This service polls the Guix repository and builds a subset of the Guix packages, as prescribed in the gnu-system.scm example spec:

     (let ((spec #~((#:name . "guix")
                    (#:url . "git://git.savannah.gnu.org/guix.git")
                    (#:load-path . ".")
                    (#:file . "build-aux/cuirass/gnu-system.scm")
                    (#:proc . cuirass-jobs)
                    (#:arguments (subset . "hello"))
                    (#:branch . "master"))))
       (service cuirass-service-type
                (cuirass-configuration
                 (specifications #~(list '#$spec)))))

While information related to build jobs is located directly in the specifications, global settings for the cuirass process are accessible in other cuirass-configuration fields.

 -- Data Type: cuirass-configuration
     Data type representing the configuration of Cuirass.

     log-file (default: "/var/log/cuirass.log")
          Location of the log file.

     cache-directory (default: "/var/cache/cuirass")
          Location of the repository cache.

     user (default: "cuirass")
          Owner of the cuirass process.

     group (default: "cuirass")
          Owner's group of the cuirass process.

     interval (default: 60)
          Number of seconds between the poll of the repositories followed by the Cuirass jobs.

     database (default: "/var/run/cuirass/cuirass.db")
          Location of sqlite database which contains the build results and previously added specifications.

     port (default: 8081)
          Port number used by the HTTP server.

     --listen=HÔTE
          Listen on the network interface for HOST.  The default is to accept connections from localhost.

     specifications (default: #~'())
          A gexp (see G-Expressions) that evaluates to a list of specifications, where a specification is an association list (see Associations Lists (GNU Guile Reference Manual)) whose keys are keywords (#:keyword-example) as shown in the example above.

     use-substitutes? (default: #f)
          This allows using substitutes to avoid building every dependencies of a job from source.

     one-shot? (default: #f)
          Only evaluate specifications and build derivations once.

     fallback? (default: #f)
          When substituting a pre-built binary fails, fall back to building packages locally.

     cuirass (default: cuirass)
          The Cuirass package to use.

Power Management Services
.........................

TLP daemon
..........

The (gnu services pm) module provides a Guix service definition for the Linux power management tool TLP.

TLP enables various powersaving modes in userspace and kernel.  Contrary to upower-service, it is not a passive, monitoring tool, as it will apply custom settings each time a new power source is detected.  More information can be found at TLP home page (http://linrunner.de/en/tlp/tlp.html).

 -- Scheme Variable: tlp-service-type
     The service type for the TLP tool.  Its value should be a valid TLP configuration (see below).  To use the default settings, simply write:

          (service tlp-service-type)

By default TLP does not need much configuration but most TLP parameters can be tweaked using tlp-configuration.

Each parameter definition is preceded by its type; for example, boolean foo indicates that the foo parameter should be specified as a boolean.  Types starting with maybe- denote parameters that won't show up in TLP config file when their value is 'disabled.

Available tlp-configuration fields are:

 -- tlp-configuration parameter: package tlp
     The TLP package.

 -- tlp-configuration parameter: boolean tlp-enable?
     Set to true if you wish to enable TLP.

     Defaults to #t.

 -- tlp-configuration parameter: string tlp-default-mode
     Default mode when no power supply can be detected.  Alternatives are AC and BAT.

     Defaults to "AC".

 -- tlp-configuration parameter: non-negative-integer disk-idle-secs-on-ac
     Number of seconds Linux kernel has to wait after the disk goes idle, before syncing on AC.

     Defaults to 0.

 -- tlp-configuration parameter: non-negative-integer disk-idle-secs-on-bat
     Same as disk-idle-ac but on BAT mode.

     Defaults to 2.

 -- tlp-configuration parameter: non-negative-integer max-lost-work-secs-on-ac
     Dirty pages flushing periodicity, expressed in seconds.

     Defaults to 15.

 -- tlp-configuration parameter: non-negative-integer max-lost-work-secs-on-bat
     Same as max-lost-work-secs-on-ac but on BAT mode.

     Defaults to 60.

 -- tlp-configuration parameter: maybe-space-separated-string-list cpu-scaling-governor-on-ac
     CPU frequency scaling governor on AC mode.  With intel_pstate driver, alternatives are powersave and performance.  With acpi-cpufreq driver, alternatives are ondemand, powersave, performance and conservative.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-space-separated-string-list cpu-scaling-governor-on-bat
     Same as cpu-scaling-governor-on-ac but on BAT mode.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-non-negative-integer cpu-scaling-min-freq-on-ac
     Set the min available frequency for the scaling governor on AC.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-non-negative-integer cpu-scaling-max-freq-on-ac
     Set the max available frequency for the scaling governor on AC.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-non-negative-integer cpu-scaling-min-freq-on-bat
     Set the min available frequency for the scaling governor on BAT.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-non-negative-integer cpu-scaling-max-freq-on-bat
     Set the max available frequency for the scaling governor on BAT.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-non-negative-integer cpu-min-perf-on-ac
     Limit the min P-state to control the power dissipation of the CPU, in AC mode.  Values are stated as a percentage of the available performance.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-non-negative-integer cpu-max-perf-on-ac
     Limit the max P-state to control the power dissipation of the CPU, in AC mode.  Values are stated as a percentage of the available performance.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-non-negative-integer cpu-min-perf-on-bat
     Same as cpu-min-perf-on-ac on BAT mode.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-non-negative-integer cpu-max-perf-on-bat
     Same as cpu-max-perf-on-ac on BAT mode.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-boolean cpu-boost-on-ac?
     Enable CPU turbo boost feature on AC mode.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-boolean cpu-boost-on-bat?
     Same as cpu-boost-on-ac? on BAT mode.

     Defaults to disabled.

 -- tlp-configuration parameter: boolean sched-powersave-on-ac?
     Allow Linux kernel to minimize the number of CPU cores/hyper-threads used under light load conditions.

     Defaults to #f.

 -- tlp-configuration parameter: boolean sched-powersave-on-bat?
     Same as sched-powersave-on-ac? but on BAT mode.

     Defaults to #t.

 -- tlp-configuration parameter: boolean nmi-watchdog?
     Enable Linux kernel NMI watchdog.

     Defaults to #f.

 -- tlp-configuration parameter: maybe-string phc-controls
     For Linux kernels with PHC patch applied, change CPU voltages.  An example value would be "F:V F:V F:V F:V".

     Defaults to disabled.

 -- tlp-configuration parameter: string energy-perf-policy-on-ac
     Set CPU performance versus energy saving policy on AC.  Alternatives are performance, normal, powersave.

     Defaults to "performance".

 -- tlp-configuration parameter: string energy-perf-policy-on-bat
     Same as energy-perf-policy-ac but on BAT mode.

     Defaults to "powersave".

 -- tlp-configuration parameter: space-separated-string-list disks-devices
     Hard disk devices.

 -- tlp-configuration parameter: space-separated-string-list disk-apm-level-on-ac
     Hard disk advanced power management level.

 -- tlp-configuration parameter: space-separated-string-list disk-apm-level-on-bat
     Same as disk-apm-bat but on BAT mode.

 -- tlp-configuration parameter: maybe-space-separated-string-list disk-spindown-timeout-on-ac
     Hard disk spin down timeout.  One value has to be specified for each declared hard disk.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-space-separated-string-list disk-spindown-timeout-on-bat
     Same as disk-spindown-timeout-on-ac but on BAT mode.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-space-separated-string-list disk-iosched
     Select IO scheduler for disk devices.  One value has to be specified for each declared hard disk.  Example alternatives are cfq, deadline and noop.

     Defaults to disabled.

 -- tlp-configuration parameter: string sata-linkpwr-on-ac
     SATA aggressive link power management (ALPM) level.  Alternatives are min_power, medium_power, max_performance.

     Defaults to "max_performance".

 -- tlp-configuration parameter: string sata-linkpwr-on-bat
     Same as sata-linkpwr-ac but on BAT mode.

     Defaults to "min_power".

 -- tlp-configuration parameter: maybe-string sata-linkpwr-blacklist
     Exclude specified SATA host devices for link power management.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-on-off-boolean ahci-runtime-pm-on-ac?
     Enable Runtime Power Management for AHCI controller and disks on AC mode.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-on-off-boolean ahci-runtime-pm-on-bat?
     Same as ahci-runtime-pm-on-ac on BAT mode.

     Defaults to disabled.

 -- tlp-configuration parameter: non-negative-integer ahci-runtime-pm-timeout
     Seconds of inactivity before disk is suspended.

     Defaults to 15.

 -- tlp-configuration parameter: string pcie-aspm-on-ac
     PCI Express Active State Power Management level.  Alternatives are default, performance, powersave.

     Defaults to "performance".

 -- tlp-configuration parameter: string pcie-aspm-on-bat
     Same as pcie-aspm-ac but on BAT mode.

     Defaults to "powersave".

 -- tlp-configuration parameter: string radeon-power-profile-on-ac
     Radeon graphics clock speed level.  Alternatives are low, mid, high, auto, default.

     Defaults to "high".

 -- tlp-configuration parameter: string radeon-power-profile-on-bat
     Same as radeon-power-ac but on BAT mode.

     Defaults to "low".

 -- tlp-configuration parameter: string radeon-dpm-state-on-ac
     Radeon dynamic power management method (DPM).  Alternatives are battery, performance.

     Defaults to "performance".

 -- tlp-configuration parameter: string radeon-dpm-state-on-bat
     Same as radeon-dpm-state-ac but on BAT mode.

     Defaults to "battery".

 -- tlp-configuration parameter: string radeon-dpm-perf-level-on-ac
     Radeon DPM performance level.  Alternatives are auto, low, high.

     Defaults to "auto".

 -- tlp-configuration parameter: string radeon-dpm-perf-level-on-bat
     Same as radeon-dpm-perf-ac but on BAT mode.

     Defaults to "auto".

 -- tlp-configuration parameter: on-off-boolean wifi-pwr-on-ac?
     Wifi power saving mode.

     Defaults to #f.

 -- tlp-configuration parameter: on-off-boolean wifi-pwr-on-bat?
     Same as wifi-power-ac? but on BAT mode.

     Defaults to #t.

 -- tlp-configuration parameter: y-n-boolean wol-disable?
     Disable wake on LAN.

     Defaults to #t.

 -- tlp-configuration parameter: non-negative-integer sound-power-save-on-ac
     Timeout duration in seconds before activating audio power saving on Intel HDA and AC97 devices.  A value of 0 disables power saving.

     Defaults to 0.

 -- tlp-configuration parameter: non-negative-integer sound-power-save-on-bat
     Same as sound-powersave-ac but on BAT mode.

     Defaults to 1.

 -- tlp-configuration parameter: y-n-boolean sound-power-save-controller?
     Disable controller in powersaving mode on Intel HDA devices.

     Defaults to #t.

 -- tlp-configuration parameter: boolean bay-poweroff-on-bat?
     Enable optical drive in UltraBay/MediaBay on BAT mode.  Drive can be powered on again by releasing (and reinserting) the eject lever or by pressing the disc eject button on newer models.

     Defaults to #f.

 -- tlp-configuration parameter: string bay-device
     Name of the optical drive device to power off.

     Defaults to "sr0".

 -- tlp-configuration parameter: string runtime-pm-on-ac
     Runtime Power Management for PCI(e) bus devices.  Alternatives are on and auto.

     Defaults to "on".

 -- tlp-configuration parameter: string runtime-pm-on-bat
     Same as runtime-pm-ac but on BAT mode.

     Defaults to "auto".

 -- tlp-configuration parameter: boolean runtime-pm-all?
     Runtime Power Management for all PCI(e) bus devices, except blacklisted ones.

     Defaults to #t.

 -- tlp-configuration parameter: maybe-space-separated-string-list runtime-pm-blacklist
     Exclude specified PCI(e) device addresses from Runtime Power Management.

     Defaults to disabled.

 -- tlp-configuration parameter: space-separated-string-list runtime-pm-driver-blacklist
     Exclude PCI(e) devices assigned to the specified drivers from Runtime Power Management.

 -- tlp-configuration parameter: boolean usb-autosuspend?
     Enable USB autosuspend feature.

     Defaults to #t.

 -- tlp-configuration parameter: maybe-string usb-blacklist
     Exclude specified devices from USB autosuspend.

     Defaults to disabled.

 -- tlp-configuration parameter: boolean usb-blacklist-wwan?
     Exclude WWAN devices from USB autosuspend.

     Defaults to #t.

 -- tlp-configuration parameter: maybe-string usb-whitelist
     Include specified devices into USB autosuspend, even if they are already excluded by the driver or via usb-blacklist-wwan?.

     Defaults to disabled.

 -- tlp-configuration parameter: maybe-boolean usb-autosuspend-disable-on-shutdown?
     Enable USB autosuspend before shutdown.

     Defaults to disabled.

 -- tlp-configuration parameter: boolean restore-device-state-on-startup?
     Restore radio device state (bluetooth, wifi, wwan) from previous shutdown on system startup.

     Defaults to #f.

Thermald daemon
...............

The (gnu services pm) module provides an interface to thermald, a CPU frequency scaling service which helps prevent overheating.

 -- Scheme Variable: thermald-service-type
     This is the service type for thermald (https://01.org/linux-thermal-daemon/), the Linux Thermal Daemon, which is responsible for controlling the thermal state of processors and preventing overheating.

 -- Data Type: thermald-configuration
     Data type representing the configuration of thermald-service-type.

     ignore-cpuid-check? (default: #f)
          Ignore cpuid check for supported CPU models.

     thermald (default: THERMALD)
          Package object of thermald.

Services audio
..............

The (gnu services audio) module provides a service to start MPD (the Music Player Daemon).

Music Player Daemon
...................

The Music Player Daemon (MPD) is a service that can play music while being controlled from the local machine or over the network by a variety of clients.

The following example shows how one might run mpd as user "bob" on port 6666.  It uses pulseaudio for output.

     (service mpd-service-type
              (mpd-configuration
               (user "bob")
               (port "6666")))

 -- Scheme Variable: mpd-service-type
     The service type for mpd

 -- Data Type: mpd-configuration
     Data type representing the configuration of mpd.

     user (default: "mpd")
          The user to run mpd as.

     music-dir (default: "~/Music")
          The directory to scan for music files.

     playlist-dir (default: "~/.mpd/playlists")
          The directory to store playlists.

     port (default: "6600")
          The port to run mpd on.

     address (default: "any")
          The address that mpd will bind to.  To use a Unix domain socket, an absolute path can be specified here.

Virtualization services
.......................

The (gnu services virtualization) module provides services for the libvirt and virtlog daemons, as well as other virtualization-related services.

Libvirt daemon
..............

libvirtd is the server side daemon component of the libvirt virtualization management system. This daemon runs on host servers and performs required management tasks for virtualized guests.

 -- Scheme Variable: libvirt-service-type
     This is the type of the libvirt daemon (https://libvirt.org).  Its value must be a libvirt-configuration.

          (service libvirt-service-type
                   (libvirt-configuration
                    (unix-sock-group "libvirt")
                    (tls-port "16555")))

Available libvirt-configuration fields are:

 -- libvirt-configuration parameter: package libvirt
     Libvirt package.

 -- libvirt-configuration parameter: boolean listen-tls?
     Flag listening for secure TLS connections on the public TCP/IP port.  must set listen for this to have any effect.

     It is necessary to setup a CA and issue server certificates before using this capability.

     Defaults to #t.

 -- libvirt-configuration parameter: boolean listen-tcp?
     Listen for unencrypted TCP connections on the public TCP/IP port.  must set listen for this to have any effect.

     Using the TCP socket requires SASL authentication by default.  Only SASL mechanisms which support data encryption are allowed.  This is DIGEST_MD5 and GSSAPI (Kerberos5)

     Defaults to #f.

 -- libvirt-configuration parameter: string tls-port
     Port for accepting secure TLS connections This can be a port number, or service name

     Defaults to "16514".

 -- libvirt-configuration parameter: string tcp-port
     Port for accepting insecure TCP connections This can be a port number, or service name

     Defaults to "16509".

 -- libvirt-configuration parameter: string listen-addr
     IP address or hostname used for client connections.

     Defaults to "0.0.0.0".

 -- libvirt-configuration parameter: boolean mdns-adv?
     Flag toggling mDNS advertisement of the libvirt service.

     Alternatively can disable for all services on a host by stopping the Avahi daemon.

     Defaults to #f.

 -- libvirt-configuration parameter: string mdns-name
     Default mDNS advertisement name.  This must be unique on the immediate broadcast network.

     Defaults to "Virtualization Host <hostname>".

 -- libvirt-configuration parameter: string unix-sock-group
     UNIX domain socket group ownership.  This can be used to allow a 'trusted' set of users access to management capabilities without becoming root.

     Defaults to "root".

 -- libvirt-configuration parameter: string unix-sock-ro-perms
     UNIX socket permissions for the R/O socket.  This is used for monitoring VM status only.

     Defaults to "0777".

 -- libvirt-configuration parameter: string unix-sock-rw-perms
     UNIX socket permissions for the R/W socket.  Default allows only root.  If PolicyKit is enabled on the socket, the default will change to allow everyone (eg, 0777)

     Defaults to "0770".

 -- libvirt-configuration parameter: string unix-sock-admin-perms
     UNIX socket permissions for the admin socket.  Default allows only owner (root), do not change it unless you are sure to whom you are exposing the access to.

     Defaults to "0777".

 -- libvirt-configuration parameter: string unix-sock-dir
     The directory in which sockets will be found/created.

     Defaults to "/var/run/libvirt".

 -- libvirt-configuration parameter: string auth-unix-ro
     Authentication scheme for UNIX read-only sockets.  By default socket permissions allow anyone to connect

     Defaults to "polkit".

 -- libvirt-configuration parameter: string auth-unix-rw
     Authentication scheme for UNIX read-write sockets.  By default socket permissions only allow root.  If PolicyKit support was compiled into libvirt, the default will be to use 'polkit' auth.

     Defaults to "polkit".

 -- libvirt-configuration parameter: string auth-tcp
     Authentication scheme for TCP sockets.  If you don't enable SASL, then all TCP traffic is cleartext.  Don't do this outside of a dev/test scenario.

     Defaults to "sasl".

 -- libvirt-configuration parameter: string auth-tls
     Authentication scheme for TLS sockets.  TLS sockets already have encryption provided by the TLS layer, and limited authentication is done by certificates.

     It is possible to make use of any SASL authentication mechanism as well, by using 'sasl' for this option

     Defaults to "none".

 -- libvirt-configuration parameter: optional-list access-drivers
     API access control scheme.

     By default an authenticated user is allowed access to all APIs.  Access drivers can place restrictions on this.

     Defaults to ().

 -- libvirt-configuration parameter: string key-file
     Server key file path.  If set to an empty string, then no private key is loaded.

     Defaults to "".

 -- libvirt-configuration parameter: string cert-file
     Server key file path.  If set to an empty string, then no certificate is loaded.

     Defaults to "".

 -- libvirt-configuration parameter: string ca-file
     Server key file path.  If set to an empty string, then no CA certificate is loaded.

     Defaults to "".

 -- libvirt-configuration parameter: string crl-file
     Certificate revocation list path.  If set to an empty string, then no CRL is loaded.

     Defaults to "".

 -- libvirt-configuration parameter: boolean tls-no-sanity-cert
     Disable verification of our own server certificates.

     When libvirtd starts it performs some sanity checks against its own certificates.

     Defaults to #f.

 -- libvirt-configuration parameter: boolean tls-no-verify-cert
     Disable verification of client certificates.

     Client certificate verification is the primary authentication mechanism. Any client which does not present a certificate signed by the CA will be rejected.

     Defaults to #f.

 -- libvirt-configuration parameter: optional-list tls-allowed-dn-list
     Whitelist of allowed x509 Distinguished Name.

     Defaults to ().

 -- libvirt-configuration parameter: optional-list sasl-allowed-usernames
     Whitelist of allowed SASL usernames.  The format for username depends on the SASL authentication mechanism.

     Defaults to ().

 -- libvirt-configuration parameter: string tls-priority
     Override the compile time default TLS priority string.  The default is usually "NORMAL" unless overridden at build time.  Only set this is it is desired for libvirt to deviate from the global default settings.

     Defaults to "NORMAL".

 -- libvirt-configuration parameter: integer max-clients
     Maximum number of concurrent client connections to allow over all sockets combined.

     Defaults to 5000.

 -- libvirt-configuration parameter: integer max-queued-clients
     Maximum length of queue of connections waiting to be accepted by the daemon.  Note, that some protocols supporting retransmission may obey this so that a later reattempt at connection succeeds.

     Defaults to 1000.

 -- libvirt-configuration parameter: integer max-anonymous-clients
     Maximum length of queue of accepted but not yet authenticated clients.  Set this to zero to turn this feature off

     Defaults to 20.

 -- libvirt-configuration parameter: integer min-workers
     Number of workers to start up initially.

     Defaults to 5.

 -- libvirt-configuration parameter: integer max-workers
     Maximum number of worker threads.

     If the number of active clients exceeds min-workers, then more threads are spawned, up to max_workers limit.  Typically you'd want max_workers to equal maximum number of clients allowed.

     Defaults to 20.

 -- libvirt-configuration parameter: integer prio-workers
     Number of priority workers.  If all workers from above pool are stuck, some calls marked as high priority (notably domainDestroy) can be executed in this pool.

     Defaults to 5.

 -- libvirt-configuration parameter: integer max-requests
     Total global limit on concurrent RPC calls.

     Defaults to 20.

 -- libvirt-configuration parameter: integer max-client-requests
     Limit on concurrent requests from a single client connection.  To avoid one client monopolizing the server this should be a small fraction of the global max_requests and max_workers parameter.

     Defaults to 5.

 -- libvirt-configuration parameter: integer admin-min-workers
     Same as min-workers but for the admin interface.

     Defaults to 1.

 -- libvirt-configuration parameter: integer admin-max-workers
     Same as max-workers but for the admin interface.

     Defaults to 5.

 -- libvirt-configuration parameter: integer admin-max-clients
     Same as max-clients but for the admin interface.

     Defaults to 5.

 -- libvirt-configuration parameter: integer admin-max-queued-clients
     Same as max-queued-clients but for the admin interface.

     Defaults to 5.

 -- libvirt-configuration parameter: integer admin-max-client-requests
     Same as max-client-requests but for the admin interface.

     Defaults to 5.

 -- libvirt-configuration parameter: integer log-level
     Logging level.  4 errors, 3 warnings, 2 information, 1 debug.

     Defaults to 3.

 -- libvirt-configuration parameter: string log-filters
     Logging filters.

     A filter allows to select a different logging level for a given category of logs The format for a filter is one of:

       * x:name

       * x:+name

     where name is a string which is matched against the category given in the VIR_LOG_INIT() at the top of each libvirt source file, e.g., "remote", "qemu", or "util.json" (the name in the filter can be a substring of the full category name, in order to match multiple similar categories), the optional "+" prefix tells libvirt to log stack trace for each message matching name, and x is the minimal level where matching messages should be logged:

       * 1: DEBUG

       * 2: INFO

       * 3: WARNING

       * 4: ERROR

     Multiple filters can be defined in a single filters statement, they just need to be separated by spaces.

     Defaults to "3:remote 4:event".

 -- libvirt-configuration parameter: string log-outputs
     Logging outputs.

     An output is one of the places to save logging information The format for an output can be:

     x:stderr
          output goes to stderr

     x:syslog:name
          use syslog for the output and use the given name as the ident

     x:file:file_path
          output to a file, with the given filepath

     x:journald
          output to journald logging system

     In all case the x prefix is the minimal level, acting as a filter

       * 1: DEBUG

       * 2: INFO

       * 3: WARNING

       * 4: ERROR

     Multiple outputs can be defined, they just need to be separated by spaces.

     Defaults to "3:stderr".

 -- libvirt-configuration parameter: integer audit-level
     Allows usage of the auditing subsystem to be altered

       * 0: disable all auditing

       * 1: enable auditing, only if enabled on host

       * 2: enable auditing, and exit if disabled on host.

     Defaults to 1.

 -- libvirt-configuration parameter: boolean audit-logging
     Send audit messages via libvirt logging infrastructure.

     Defaults to #f.

 -- libvirt-configuration parameter: optional-string host-uuid
     Host UUID.  UUID must not have all digits be the same.

     Defaults to "".

 -- libvirt-configuration parameter: string host-uuid-source
     Source to read host UUID.

       * smbios: fetch the UUID from dmidecode -s system-uuid

       * machine-id: fetch the UUID from /etc/machine-id

     If dmidecode does not provide a valid UUID a temporary UUID will be generated.

     Defaults to "smbios".

 -- libvirt-configuration parameter: integer keepalive-interval
     A keepalive message is sent to a client after keepalive_interval seconds of inactivity to check if the client is still responding.  If set to -1, libvirtd will never send keepalive requests; however clients can still send them and the daemon will send responses.

     Defaults to 5.

 -- libvirt-configuration parameter: integer keepalive-count
     Maximum number of keepalive messages that are allowed to be sent to the client without getting any response before the connection is considered broken.

     In other words, the connection is automatically closed approximately after keepalive_interval * (keepalive_count + 1) seconds since the last message received from the client.  When keepalive-count is set to 0, connections will be automatically closed after keepalive-interval seconds of inactivity without sending any keepalive messages.

     Defaults to 5.

 -- libvirt-configuration parameter: integer admin-keepalive-interval
     Same as above but for admin interface.

     Defaults to 5.

 -- libvirt-configuration parameter: integer admin-keepalive-count
     Same as above but for admin interface.

     Defaults to 5.

 -- libvirt-configuration parameter: integer ovs-timeout
     Timeout for Open vSwitch calls.

     The ovs-vsctl utility is used for the configuration and its timeout option is set by default to 5 seconds to avoid potential infinite waits blocking libvirt.

     Defaults to 5.

Virtlog daemon
..............

The virtlogd service is a server side daemon component of libvirt that is used to manage logs from virtual machine consoles.

This daemon is not used directly by libvirt client applications, rather it is called on their behalf by libvirtd. By maintaining the logs in a standalone daemon, the main libvirtd daemon can be restarted without risk of losing logs. The virtlogd daemon has the ability to re-exec() itself upon receiving SIGUSR1, to allow live upgrades without downtime.

 -- Scheme Variable: virtlog-service-type
     This is the type of the virtlog daemon.  Its value must be a virtlog-configuration.

          (service virtlog-service-type
                   (virtlog-configuration
                    (max-clients 1000)))

 -- virtlog-configuration parameter: integer log-level
     Logging level.  4 errors, 3 warnings, 2 information, 1 debug.

     Defaults to 3.

 -- virtlog-configuration parameter: string log-filters
     Logging filters.

     A filter allows to select a different logging level for a given category of logs The format for a filter is one of:

       * x:name

       * x:+name

     where name is a string which is matched against the category given in the VIR_LOG_INIT() at the top of each libvirt source file, e.g., "remote", "qemu", or "util.json" (the name in the filter can be a substring of the full category name, in order to match multiple similar categories), the optional "+" prefix tells libvirt to log stack trace for each message matching name, and x is the minimal level where matching messages should be logged:

       * 1: DEBUG

       * 2: INFO

       * 3: WARNING

       * 4: ERROR

     Multiple filters can be defined in a single filters statement, they just need to be separated by spaces.

     Defaults to "3:remote 4:event".

 -- virtlog-configuration parameter: string log-outputs
     Logging outputs.

     An output is one of the places to save logging information The format for an output can be:

     x:stderr
          output goes to stderr

     x:syslog:name
          use syslog for the output and use the given name as the ident

     x:file:file_path
          output to a file, with the given filepath

     x:journald
          output to journald logging system

     In all case the x prefix is the minimal level, acting as a filter

       * 1: DEBUG

       * 2: INFO

       * 3: WARNING

       * 4: ERROR

     Multiple outputs can be defined, they just need to be separated by spaces.

     Defaults to "3:stderr".

 -- virtlog-configuration parameter: integer max-clients
     Maximum number of concurrent client connections to allow over all sockets combined.

     Defaults to 1024.

 -- virtlog-configuration parameter: integer max-size
     Maximum file size before rolling over.

     Defaults to 2MB

 -- virtlog-configuration parameter: integer max-backups
     Maximum number of backup files to keep.

     Defaults to 3

Transparent Emulation with QEMU
...............................

qemu-binfmt-service-type provides support for transparent emulation of program binaries built for different architectures---e.g., it allows you to transparently execute an ARMv7 program on an x86_64 machine.  It achieves this by combining the QEMU (https://www.qemu.org) emulator and the binfmt_misc feature of the kernel Linux.

 -- Scheme Variable: qemu-binfmt-service-type
     This is the type of the QEMU/binfmt service for transparent emulation.  Its value must be a qemu-binfmt-configuration object, which specifies the QEMU package to use as well as the architecture we want to emulated:

          (service qemu-binfmt-service-type
                   (qemu-binfmt-configuration
                     (platforms (lookup-qemu-platforms "arm" "aarch64" "ppc"))))

     In this example, we enable transparent emulation for the ARM and aarch64 platforms.  Running herd stop qemu-binfmt turns it off, and running herd start qemu-binfmt turns it back on (see the herd command (The GNU Shepherd Manual)).

 -- Data Type: qemu-binfmt-configuration
     This is the configuration for the qemu-binfmt service.

     platforms (default: '())
          The list of emulated QEMU platforms.  Each item must be a platform object as returned by lookup-qemu-platforms (see below).

     guix-support? (default: #f)
          When it is true, QEMU and all its dependencies are added to the build environment of guix-daemon (see --chroot-directory option).  This allows the binfmt_misc handlers to be used within the build environment, which in turn means that you can transparently build programs for another architecture.

          For example, let's suppose you're on an x86_64 machine and you have this service:

               (service qemu-binfmt-service-type
                        (qemu-binfmt-configuration
                          (platforms (lookup-qemu-platforms "arm"))
                          (guix-support? #t)))

          You can run:

               guix build -s armhf-linux inkscape

          and it will build Inkscape for ARMv7 as if it were a native build, transparently using QEMU to emulate the ARMv7 CPU.  Pretty handy if you'd like to test a package build for an architecture you don't have access to!

     qemu (default: qemu)
          The QEMU package to use.

 -- Scheme Procedure: lookup-qemu-platforms PLATFORMS...
     Return the list of QEMU platform objects corresponding to PLATFORMS....  PLATFORMS must be a list of strings corresponding to platform names, such as "arm", "sparc", "mips64el", and so on.

 -- Scheme Procedure: qemu-platform? OBJ
     Return true if OBJ is a platform object.

 -- Scheme Procedure: qemu-platform-name PLATFORM
     Return the name of PLATFORM---a string such as "arm".

Services de contrôle de version
...............................

The (gnu services version-control) module provides a service to allow remote access to local Git repositories.  There are three options: the git-daemon-service, which provides access to repositories via the git:// unsecured TCP-based protocol, extending the nginx web server to proxy some requests to git-http-backend, or providing a web interface with cgit-service-type.

 -- Scheme Procedure: git-daemon-service [#:config (git-daemon-configuration)]

     Return a service that runs git daemon, a simple TCP server to expose repositories over the Git protocol for anonymous access.

     The optional CONFIG argument should be a <git-daemon-configuration> object, by default it allows read-only access to exported (By creating the magic file "git-daemon-export-ok" in the repository directory.) repositories under /srv/git.

 -- Data Type: git-daemon-configuration
     Data type representing the configuration for git-daemon-service.

     package (default: GIT)
          Package object of the Git distributed version control system.

     export-all? (default: #F)
          Whether to allow access for all Git repositories, even if they do not have the git-daemon-export-ok file.

     base-path (default: /srv/git)
          Whether to remap all the path requests as relative to the given path.  If you run git daemon with (BASE-PATH "/SRV/GIT") on example.com, then if you later try to pull git://example.com/hello.git, git daemon will interpret the path as /srv/git/hello.git.

     user-path (default: #F)
          Whether to allow ~user notation to be used in requests.  When specified with empty string, requests to git://host/~alice/foo is taken as a request to access foo repository in the home directory of user alice.  If (USER-PATH "PATH") is specified, the same request is taken as a request to access path/foo repository in the home directory of user alice.

     listen (default: '())
          Whether to listen on specific IP addresses or hostnames, defaults to all.

     port (default: #F)
          Whether to listen on an alternative port, which defaults to 9418.

     whitelist (default: '())
          If not empty, only allow access to this list of directories.

     extra-options (default: '())
          Extra options will be passed to git daemon, please run man git-daemon for more information.

The git:// protocol lacks authentication.  When you pull from a repository fetched via git://, you don't know that the data you receive was modified is really coming from the specified host, and you have your connection is subject to eavesdropping.  It's better to use an authenticated and encrypted transport, such as https.  Although Git allows you to serve repositories using unsophisticated file-based web servers, there is a faster protocol implemented by the git-http-backend program.  This program is the back-end of a proper Git web service.  It is designed to sit behind a FastCGI proxy.  See Services web, for more on running the necessary fcgiwrap daemon.

Guix has a separate configuration data type for serving Git repositories over HTTP.

 -- Data Type: git-http-configuration
     Data type representing the configuration for git-http-service.

     package (default: GIT)
          Package object of the Git distributed version control system.

     git-root (default: /srv/git)
          Directory containing the Git repositories to expose to the world.

     export-all? (default: #F)
          Whether to expose access for all Git repositories in GIT-ROOT, even if they do not have the git-daemon-export-ok file.

     uri-path (default: /git/)
          Path prefix for Git access.  With the default /git/ prefix, this will map http://SERVER/git/REPO.git to /srv/git/REPO.git.  Requests whose URI paths do not begin with this prefix are not passed on to this Git instance.

     fcgiwrap-socket (default: 127.0.0.1:9000)
          The socket on which the fcgiwrap daemon is listening.  See Services web.

There is no git-http-service-type, currently; instead you can create an nginx-location-configuration from a git-http-configuration and then add that location to a web server.

 -- Scheme Procedure: git-http-nginx-location-configuration
     [config=(git-http-configuration)] Compute an
     nginx-location-configuration that corresponds to the given Git http configuration.  An example nginx service definition to serve the default /srv/git over HTTPS might be:

          (service nginx-service-type
                   (nginx-configuration
                    (server-blocks
                     (list
                      (nginx-server-configuration
                       (listen '("443 ssl"))
                       (server-name "git.my-host.org")
                       (ssl-certificate
                        "/etc/letsencrypt/live/git.my-host.org/fullchain.pem")
                       (ssl-certificate-key
                        "/etc/letsencrypt/live/git.my-host.org/privkey.pem")
                       (locations
                        (list
                         (git-http-nginx-location-configuration
                          (git-http-configuration (uri-path "/"))))))))))

     This example assumes that you are using Let's Encrypt to get your TLS certificate.  See Services de certificats.  The default certbot service will redirect all HTTP traffic on git.my-host.org to HTTPS. You will also need to add an fcgiwrap proxy to your system services. See Services web.

Cgit Service
............

Cgit (https://git.zx2c4.com/cgit/) is a web frontend for Git repositories written in C.

The following example will configure the service with default values.  By default, Cgit can be accessed on port 80 (http://localhost:80).

     (service cgit-service-type)

The file-object type designates either a file-like object (see file-like objects) or a string.

Available cgit-configuration fields are:

 -- cgit-configuration parameter: package package
     The CGIT package.

 -- cgit-configuration parameter: nginx-server-configuration-list nginx
     NGINX configuration.

 -- cgit-configuration parameter: file-object about-filter
     Specifies a command which will be invoked to format the content of about pages (both top-level and for each repository).

     Defaults to "".

 -- cgit-configuration parameter: string agefile
     Specifies a path, relative to each repository path, which can be used to specify the date and time of the youngest commit in the repository.

     Defaults to "".

 -- cgit-configuration parameter: file-object auth-filter
     Specifies a command that will be invoked for authenticating repository access.

     Defaults to "".

 -- cgit-configuration parameter: string branch-sort
     Flag which, when set to age, enables date ordering in the branch ref list, and when set name enables ordering by branch name.

     Defaults to "name".

 -- cgit-configuration parameter: string cache-root
     Path used to store the cgit cache entries.

     Defaults to "/var/cache/cgit".

 -- cgit-configuration parameter: integer cache-static-ttl
     Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed with a fixed SHA1.

     Defaults to -1.

 -- cgit-configuration parameter: integer cache-dynamic-ttl
     Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed without a fixed SHA1.

     Defaults to 5.

 -- cgit-configuration parameter: integer cache-repo-ttl
     Number which specifies the time-to-live, in minutes, for the cached version of the repository summary page.

     Defaults to 5.

 -- cgit-configuration parameter: integer cache-root-ttl
     Number which specifies the time-to-live, in minutes, for the cached version of the repository index page.

     Defaults to 5.

 -- cgit-configuration parameter: integer cache-scanrc-ttl
     Number which specifies the time-to-live, in minutes, for the result of scanning a path for Git repositories.

     Defaults to 15.

 -- cgit-configuration parameter: integer cache-about-ttl
     Number which specifies the time-to-live, in minutes, for the cached version of the repository about page.

     Defaults to 15.

 -- cgit-configuration parameter: integer cache-snapshot-ttl
     Number which specifies the time-to-live, in minutes, for the cached version of snapshots.

     Defaults to 5.

 -- cgit-configuration parameter: integer cache-size
     The maximum number of entries in the cgit cache.  When set to 0, caching is disabled.

     Defaults to 0.

 -- cgit-configuration parameter: boolean case-sensitive-sort?
     Sort items in the repo list case sensitively.

     Defaults to #t.

 -- cgit-configuration parameter: list clone-prefix
     List of common prefixes which, when combined with a repository URL, generates valid clone URLs for the repository.

     Defaults to ().

 -- cgit-configuration parameter: list clone-url
     List of clone-url templates.

     Defaults to ().

 -- cgit-configuration parameter: file-object commit-filter
     Command which will be invoked to format commit messages.

     Defaults to "".

 -- cgit-configuration parameter: string commit-sort
     Flag which, when set to date, enables strict date ordering in the commit log, and when set to topo enables strict topological ordering.

     Defaults to "git log".

 -- cgit-configuration parameter: file-object css
     URL which specifies the css document to include in all cgit pages.

     Defaults to "/share/cgit/cgit.css".

 -- cgit-configuration parameter: file-object email-filter
     Specifies a command which will be invoked to format names and email address of committers, authors, and taggers, as represented in various places throughout the cgit interface.

     Defaults to "".

 -- cgit-configuration parameter: boolean embedded?
     Flag which, when set to #t, will make cgit generate a HTML fragment suitable for embedding in other HTML pages.

     Defaults to #f.

 -- cgit-configuration parameter: boolean enable-commit-graph?
     Flag which, when set to #t, will make cgit print an ASCII-art commit history graph to the left of the commit messages in the repository log page.

     Defaults to #f.

 -- cgit-configuration parameter: boolean enable-filter-overrides?
     Flag which, when set to #t, allows all filter settings to be overridden in repository-specific cgitrc files.

     Defaults to #f.

 -- cgit-configuration parameter: boolean enable-follow-links?
     Flag which, when set to #t, allows users to follow a file in the log view.

     Defaults to #f.

 -- cgit-configuration parameter: boolean enable-http-clone?
     If set to #t, cgit will act as an dumb HTTP endpoint for Git clones.

     Defaults to #t.

 -- cgit-configuration parameter: boolean enable-index-links?
     Flag which, when set to #t, will make cgit generate extra links "summary", "commit", "tree" for each repo in the repository index.

     Defaults to #f.

 -- cgit-configuration parameter: boolean enable-index-owner?
     Flag which, when set to #t, will make cgit display the owner of each repo in the repository index.

     Defaults to #t.

 -- cgit-configuration parameter: boolean enable-log-filecount?
     Flag which, when set to #t, will make cgit print the number of modified files for each commit on the repository log page.

     Defaults to #f.

 -- cgit-configuration parameter: boolean enable-log-linecount?
     Flag which, when set to #t, will make cgit print the number of added and removed lines for each commit on the repository log page.

     Defaults to #f.

 -- cgit-configuration parameter: boolean enable-remote-branches?
     Flag which, when set to #t, will make cgit display remote branches in the summary and refs views.

     Defaults to #f.

 -- cgit-configuration parameter: boolean enable-subject-links?
     Flag which, when set to 1, will make cgit use the subject of the parent commit as link text when generating links to parent commits in commit view.

     Defaults to #f.

 -- cgit-configuration parameter: boolean enable-html-serving?
     Flag which, when set to #t, will make cgit use the subject of the parent commit as link text when generating links to parent commits in commit view.

     Defaults to #f.

 -- cgit-configuration parameter: boolean enable-tree-linenumbers?
     Flag which, when set to #t, will make cgit generate linenumber links for plaintext blobs printed in the tree view.

     Defaults to #t.

 -- cgit-configuration parameter: boolean enable-git-config?
     Flag which, when set to #f, will allow cgit to use Git config to set any repo specific settings.

     Defaults to #f.

 -- cgit-configuration parameter: file-object favicon
     URL used as link to a shortcut icon for cgit.

     Defaults to "/favicon.ico".

 -- cgit-configuration parameter: string footer
     The content of the file specified with this option will be included verbatim at the bottom of all pages (i.e.  it replaces the standard "generated by..." message).

     Defaults to "".

 -- cgit-configuration parameter: string head-include
     The content of the file specified with this option will be included verbatim in the HTML HEAD section on all pages.

     Defaults to "".

 -- cgit-configuration parameter: string header
     The content of the file specified with this option will be included verbatim at the top of all pages.

     Defaults to "".

 -- cgit-configuration parameter: file-object include
     Name of a configfile to include before the rest of the current config- file is parsed.

     Defaults to "".

 -- cgit-configuration parameter: string index-header
     The content of the file specified with this option will be included verbatim above the repository index.

     Defaults to "".

 -- cgit-configuration parameter: string index-info
     The content of the file specified with this option will be included verbatim below the heading on the repository index page.

     Defaults to "".

 -- cgit-configuration parameter: boolean local-time?
     Flag which, if set to #t, makes cgit print commit and tag times in the servers timezone.

     Defaults to #f.

 -- cgit-configuration parameter: file-object logo
     URL which specifies the source of an image which will be used as a logo on all cgit pages.

     Defaults to "/share/cgit/cgit.png".

 -- cgit-configuration parameter: string logo-link
     URL loaded when clicking on the cgit logo image.

     Defaults to "".

 -- cgit-configuration parameter: file-object owner-filter
     Command which will be invoked to format the Owner column of the main page.

     Defaults to "".

 -- cgit-configuration parameter: integer max-atom-items
     Number of items to display in atom feeds view.

     Defaults to 10.

 -- cgit-configuration parameter: integer max-commit-count
     Number of entries to list per page in "log" view.

     Defaults to 50.

 -- cgit-configuration parameter: integer max-message-length
     Number of commit message characters to display in "log" view.

     Defaults to 80.

 -- cgit-configuration parameter: integer max-repo-count
     Specifies the number of entries to list per page on the repository index page.

     Defaults to 50.

 -- cgit-configuration parameter: integer max-repodesc-length
     Specifies the maximum number of repo description characters to display on the repository index page.

     Defaults to 80.

 -- cgit-configuration parameter: integer max-blob-size
     Specifies the maximum size of a blob to display HTML for in KBytes.

     Defaults to 0.

 -- cgit-configuration parameter: string max-stats
     Maximum statistics period.  Valid values are week,month, quarter and year.

     Defaults to "".

 -- cgit-configuration parameter: mimetype-alist mimetype
     Mimetype for the specified filename extension.

     Defaults to ((gif "image/gif") (html "text/html") (jpg "image/jpeg") (jpeg "image/jpeg") (pdf "application/pdf") (png "image/png") (svg "image/svg+xml")).

 -- cgit-configuration parameter: file-object mimetype-file
     Specifies the file to use for automatic mimetype lookup.

     Defaults to "".

 -- cgit-configuration parameter: string module-link
     Text which will be used as the formatstring for a hyperlink when a submodule is printed in a directory listing.

     Defaults to "".

 -- cgit-configuration parameter: boolean nocache?
     If set to the value #t caching will be disabled.

     Defaults to #f.

 -- cgit-configuration parameter: boolean noplainemail?
     If set to #t showing full author email addresses will be disabled.

     Defaults to #f.

 -- cgit-configuration parameter: boolean noheader?
     Flag which, when set to #t, will make cgit omit the standard header on all pages.

     Defaults to #f.

 -- cgit-configuration parameter: project-list project-list
     A list of subdirectories inside of repository-directory, relative to it, that should loaded as Git repositories.  An empty list means that all subdirectories will be loaded.

     Defaults to ().

 -- cgit-configuration parameter: file-object readme
     Text which will be used as default value for cgit-repo-readme.

     Defaults to "".

 -- cgit-configuration parameter: boolean remove-suffix?
     If set to #t and repository-directory is enabled, if any repositories are found with a suffix of .git, this suffix will be removed for the URL and name.

     Defaults to #f.

 -- cgit-configuration parameter: integer renamelimit
     Maximum number of files to consider when detecting renames.

     Defaults to -1.

 -- cgit-configuration parameter: string repository-sort
     The way in which repositories in each section are sorted.

     Defaults to "".

 -- cgit-configuration parameter: robots-list robots
     Text used as content for the robots meta-tag.

     Defaults to ("noindex" "nofollow").

 -- cgit-configuration parameter: string root-desc
     Text printed below the heading on the repository index page.

     Defaults to "a fast webinterface for the git dscm".

 -- cgit-configuration parameter: string root-readme
     The content of the file specified with this option will be included verbatim below thef "about" link on the repository index page.

     Defaults to "".

 -- cgit-configuration parameter: string root-title
     Text printed as heading on the repository index page.

     Defaults to "".

 -- cgit-configuration parameter: boolean scan-hidden-path
     If set to #t and repository-directory is enabled, repository-directory will recurse into directories whose name starts with a period.  Otherwise, repository-directory will stay away from such directories, considered as "hidden".  Note that this does not apply to the ".git" directory in non-bare repos.

     Defaults to #f.

 -- cgit-configuration parameter: list snapshots
     Text which specifies the default set of snapshot formats that cgit generates links for.

     Defaults to ().

 -- cgit-configuration parameter: repository-directory repository-directory
     Name of the directory to scan for repositories (represents scan-path).

     Defaults to "/srv/git".

 -- cgit-configuration parameter: string section
     The name of the current repository section - all repositories defined after this option will inherit the current section name.

     Defaults to "".

 -- cgit-configuration parameter: string section-sort
     Flag which, when set to 1, will sort the sections on the repository listing by name.

     Defaults to "".

 -- cgit-configuration parameter: integer section-from-path
     A number which, if defined prior to repository-directory, specifies how many path elements from each repo path to use as a default section name.

     Defaults to 0.

 -- cgit-configuration parameter: boolean side-by-side-diffs?
     If set to #t shows side-by-side diffs instead of unidiffs per default.

     Defaults to #f.

 -- cgit-configuration parameter: file-object source-filter
     Specifies a command which will be invoked to format plaintext blobs in the tree view.

     Defaults to "".

 -- cgit-configuration parameter: integer summary-branches
     Specifies the number of branches to display in the repository "summary" view.

     Defaults to 10.

 -- cgit-configuration parameter: integer summary-log
     Specifies the number of log entries to display in the repository "summary" view.

     Defaults to 10.

 -- cgit-configuration parameter: integer summary-tags
     Specifies the number of tags to display in the repository "summary" view.

     Defaults to 10.

 -- cgit-configuration parameter: string strict-export
     Filename which, if specified, needs to be present within the repository for cgit to allow access to that repository.

     Defaults to "".

 -- cgit-configuration parameter: string virtual-root
     URL which, if specified, will be used as root for all cgit links.

     Defaults to "/".

 -- cgit-configuration parameter: repository-cgit-configuration-list repositories
     A list of cgit-repo records to use with config.

     Defaults to ().

     Available repository-cgit-configuration fields are:

      -- repository-cgit-configuration parameter: repo-list snapshots
          A mask of snapshot formats for this repo that cgit generates links for, restricted by the global snapshots setting.

          Defaults to ().

      -- repository-cgit-configuration parameter: repo-file-object source-filter
          Override the default source-filter.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string url
          The relative URL used to access the repository.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-file-object about-filter
          Override the default about-filter.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string branch-sort
          Flag which, when set to age, enables date ordering in the branch ref list, and when set to name enables ordering by branch name.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-list clone-url
          A list of URLs which can be used to clone repo.

          Defaults to ().

      -- repository-cgit-configuration parameter: repo-file-object commit-filter
          Override the default commit-filter.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string commit-sort
          Flag which, when set to date, enables strict date ordering in the commit log, and when set to topo enables strict topological ordering.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string defbranch
          The name of the default branch for this repository.  If no such branch exists in the repository, the first branch name (when sorted) is used as default instead.  By default branch pointed to by HEAD, or "master" if there is no suitable HEAD.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string desc
          The value to show as repository description.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string homepage
          The value to show as repository homepage.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-file-object email-filter
          Override the default email-filter.

          Defaults to "".

      -- repository-cgit-configuration parameter: maybe-repo-boolean enable-commit-graph?
          A flag which can be used to disable the global setting enable-commit-graph?.

          Defaults to disabled.

      -- repository-cgit-configuration parameter: maybe-repo-boolean enable-log-filecount?
          A flag which can be used to disable the global setting enable-log-filecount?.

          Defaults to disabled.

      -- repository-cgit-configuration parameter: maybe-repo-boolean enable-log-linecount?
          A flag which can be used to disable the global setting enable-log-linecount?.

          Defaults to disabled.

      -- repository-cgit-configuration parameter: maybe-repo-boolean enable-remote-branches?
          Flag which, when set to #t, will make cgit display remote branches in the summary and refs views.

          Defaults to disabled.

      -- repository-cgit-configuration parameter: maybe-repo-boolean enable-subject-links?
          A flag which can be used to override the global setting enable-subject-links?.

          Defaults to disabled.

      -- repository-cgit-configuration parameter: maybe-repo-boolean enable-html-serving?
          A flag which can be used to override the global setting enable-html-serving?.

          Defaults to disabled.

      -- repository-cgit-configuration parameter: repo-boolean hide?
          Flag which, when set to #t, hides the repository from the repository index.

          Defaults to #f.

      -- repository-cgit-configuration parameter: repo-boolean ignore?
          Flag which, when set to #t, ignores the repository.

          Defaults to #f.

      -- repository-cgit-configuration parameter: repo-file-object logo
          URL which specifies the source of an image which will be used as a logo on this repo’s pages.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string logo-link
          URL loaded when clicking on the cgit logo image.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-file-object owner-filter
          Override the default owner-filter.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string module-link
          Text which will be used as the formatstring for a hyperlink when a submodule is printed in a directory listing.  The arguments for the formatstring are the path and SHA1 of the submodule commit.

          Defaults to "".

      -- repository-cgit-configuration parameter: module-link-path module-link-path
          Text which will be used as the formatstring for a hyperlink when a submodule with the specified subdirectory path is printed in a directory listing.

          Defaults to ().

      -- repository-cgit-configuration parameter: repo-string max-stats
          Override the default maximum statistics period.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string name
          The value to show as repository name.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string owner
          A value used to identify the owner of the repository.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string path
          An absolute path to the repository directory.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string readme
          A path (relative to repo) which specifies a file to include verbatim as the "About" page for this repo.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-string section
          The name of the current repository section - all repositories defined after this option will inherit the current section name.

          Defaults to "".

      -- repository-cgit-configuration parameter: repo-list extra-options
          Extra options will be appended to cgitrc file.

          Defaults to ().

 -- cgit-configuration parameter: list extra-options
     Extra options will be appended to cgitrc file.

     Defaults to ().

However, it could be that you just want to get a cgitrc up and running.  In that case, you can pass an opaque-cgit-configuration as a record to cgit-service-type.  As its name indicates, an opaque configuration does not have easy reflective capabilities.

Available opaque-cgit-configuration fields are:

 -- opaque-cgit-configuration parameter: package cgit
     The cgit package.

 -- opaque-cgit-configuration parameter: string string
     The contents of the cgitrc, as a string.

For example, if your cgitrc is just the empty string, you could instantiate a cgit service like this:

     (service cgit-service-type
              (opaque-cgit-configuration
               (cgitrc "")))

Services de jeu
...............

The Battle for Wesnoth Service
..............................

The Battle for Wesnoth (https://wesnoth.org) is a fantasy, turn based tactical strategy game, with several single player campaigns, and multiplayer games (both networked and local).

 -- Variable: Scheme Variable wesnothd-service-type
     Service type for the wesnothd service.  Its value must be a wesnothd-configuration object.  To run wesnothd in the default configuration, instantiate it as:

          (service wesnothd-service-type)

 -- Data Type: wesnothd-configuration
     Data type representing the configuration of wesnothd.

     package (default: wesnoth-server)
          The wesnoth server package to use.

     port (default: 15000)
          The port to bind the server to.

Services divers
...............

Fingerprint Service
...................

The (gnu services fingerprint) module provides a DBus service to read and identify fingerprints via a fingerprint sensor.

 -- Scheme Variable: fprintd-service-type
     The service type for fprintd, which provides the fingerprint reading capability.

          (service fprintd-service-type)

System Control Service
......................

The (gnu services sysctl) provides a service to configure kernel parameters at boot.

 -- Scheme Variable: sysctl-service-type
     The service type for sysctl, which modifies kernel parameters under /proc/sys/.  To enable IPv4 forwarding, it can be instantiated as:

          (service sysctl-service-type
                   (sysctl-configuration
                     (settings '(("net.ipv4.ip_forward" . "1")))))

 -- Data Type: sysctl-configuration
     The data type representing the configuration of sysctl.

     sysctl (default: (file-append procps "/sbin/sysctl")
          The sysctl executable to use.

     settings (default: '())
          An association list specifies kernel parameters and their values.

Lirc Service
............

The (gnu services lirc) module provides the following service.

 -- Scheme Procedure: lirc-service [#:lirc lirc]
     [#:device #f] [#:driver #f] [#:config-file #f]  [#:extra-options '()]
     Return a service that runs LIRC (http://www.lirc.org), a daemon that decodes infrared signals from remote controls.

     Optionally, DEVICE, DRIVER and CONFIG-FILE (configuration file name) may be specified.  See lircd manual for details.

     Finally, EXTRA-OPTIONS is a list of additional command-line options passed to lircd.

Spice Service
.............

The (gnu services spice) module provides the following service.

 -- Scheme Procedure: spice-vdagent-service [#:spice-vdagent]
     Returns a service that runs VDAGENT (http://www.spice-space.org), a daemon that enables sharing the clipboard with a vm and setting the guest display resolution when the graphical console window resizes.

Dictionary Services
...................

The (gnu services dict) module provides the following service:

 -- Scheme Procedure: dicod-service [#:config (dicod-configuration)]
     Return a service that runs the dicod daemon, an implementation of DICT server (see Dicod (GNU Dico Manual)).

     The optional CONFIG argument specifies the configuration for dicod, which should be a <dicod-configuration> object, by default it serves the GNU Collaborative International Dictonary of English.

     You can add open localhost to your ~/.dico file to make localhost the default server for dico client (see Initialization File (GNU Dico Manual)).

 -- Data Type: dicod-configuration
     Data type representing the configuration of dicod.

     dico (default: DICO)
          Package object of the GNU Dico dictionary server.

     interfaces (default: '("LOCALHOST"))
          This is the list of IP addresses and ports and possibly socket file names to listen to (see listen directive (GNU Dico Manual)).

     handlers (default: '())
          List of <dicod-handler> objects denoting handlers (module instances).

     databases (default: (LIST %DICOD-DATABASE:GCIDE))
          List of <dicod-database> objects denoting dictionaries to be served.

 -- Data Type: dicod-handler
     Data type representing a dictionary handler (module instance).

     name
          Name of the handler (module instance).

     module (default: #F)
          Name of the dicod module of the handler (instance).  If it is #f, the module has the same name as the handler.  (see Modules (GNU Dico Manual)).

     options
          List of strings or gexps representing the arguments for the module handler

 -- Data Type: dicod-database
     Data type representing a dictionary database.

     name
          Name of the database, will be used in DICT commands.

     handler
          Name of the dicod handler (module instance) used by this database (see Handlers (GNU Dico Manual)).

     complex? (default: #F)
          Whether the database configuration complex.  The complex configuration will need a corresponding <dicod-handler> object, otherwise not.

     options
          List of strings or gexps representing the arguments for the database (see Databases (GNU Dico Manual)).

 -- Scheme Variable: %dicod-database:gcide
     A <dicod-database> object serving the GNU Collaborative International Dictionary of English using the gcide package.

The following is an example dicod-service configuration.

     (dicod-service #:config
       (dicod-configuration
        (handlers (list (dicod-handler
                         (name "wordnet")
                         (module "dictorg")
                         (options
                          (list #~(string-append "dbdir=" #$wordnet))))))
        (databases (list (dicod-database
                          (name "wordnet")
                          (complex? #t)
                          (handler "wordnet")
                          (options '("database=wn")))
                         %dicod-database:gcide))))

Programmes setuid
-----------------

Some programs need to run with ``root'' privileges, even when they are launched by unprivileged users.  A notorious example is the passwd program, which users can run to change their password, and which needs to access the /etc/passwd and /etc/shadow files---something normally restricted to root, for obvious security reasons.  To address that, these executables are setuid-root, meaning that they always run with root privileges (see How Change Persona (The GNU C Library Reference Manual), for more info about the setuid mechanism.)

The store itself cannot contain setuid programs: that would be a security issue since any user on the system can write derivations that populate the store (see Le dépôt).  Thus, a different mechanism is used: instead of changing the setuid bit directly on files that are in the store, we let the system administrator declare which programs should be setuid root.

The setuid-programs field of an operating-system declaration contains a list of G-expressions denoting the names of programs to be setuid-root (see Utiliser le système de configuration).  For instance, the passwd program, which is part of the Shadow package, can be designated by this G-expression (see G-Expressions):

     #~(string-append #$shadow "/bin/passwd")

A default set of setuid programs is defined by the %setuid-programs variable of the (gnu system) module.

 -- Scheme Variable: %setuid-programs
     A list of G-expressions denoting common programs that are setuid-root.

     The list includes commands such as passwd, ping, su, and sudo.

Under the hood, the actual setuid programs are created in the /run/setuid-programs directory at system activation time.  The files in this directory refer to the ``real'' binaries, which are in the store.

Certificats X.509
-----------------

Web servers available over HTTPS (that is, HTTP over the transport-layer security mechanism, TLS) send client programs an X.509 certificate that the client can then use to authenticate the server.  To do that, clients verify that the server's certificate is signed by a so-called certificate authority (CA).  But to verify the CA's signature, clients must have first acquired the CA's certificate.

Web browsers such as GNU IceCat include their own set of CA certificates, such that they are able to verify CA signatures out-of-the-box.

However, most other programs that can talk HTTPS---wget, git, w3m, etc.---need to be told where CA certificates can be found.

In GuixSD, this is done by adding a package that provides certificates to the packages field of the operating-system declaration (see Référence de système d'exploitation).  GuixSD includes one such package, nss-certs, which is a set of CA certificates provided as part of Mozilla's Network Security Services.

Note that it is not part of %BASE-PACKAGES, so you need to explicitly add it.  The /etc/ssl/certs directory, which is where most applications and libraries look for certificates by default, points to the certificates installed globally.

Unprivileged users, including users of Guix on a foreign distro, can also install their own certificate package in their profile.  A number of environment variables need to be defined so that applications and libraries know where to find them.  Namely, the OpenSSL library honors the SSL_CERT_DIR and SSL_CERT_FILE variables.  Some applications add their own environment variables; for instance, the Git version control system honors the certificate bundle pointed to by the GIT_SSL_CAINFO environment variable.  Thus, you would typically run something like:

     $ guix package -i nss-certs
     $ export SSL_CERT_DIR="$HOME/.guix-profile/etc/ssl/certs"
     $ export SSL_CERT_FILE="$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt"
     $ export GIT_SSL_CAINFO="$SSL_CERT_FILE"

As another example, R requires the CURL_CA_BUNDLE environment variable to point to a certificate bundle, so you would have to run something like this:

     $ guix package -i nss-certs
     $ export CURL_CA_BUNDLE="$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt"

For other applications you may want to look up the required environment variable in the relevant documentation.

Name Service Switch
-------------------

The (gnu system nss) module provides bindings to the configuration file of the libc name service switch or NSS (see NSS Configuration File (The GNU C Library Reference Manual)).  In a nutshell, the NSS is a mechanism that allows libc to be extended with new ``name'' lookup methods for system databases, which includes host names, service names, user accounts, and more (see System Databases and Name Service Switch (The GNU C Library Reference Manual)).

The NSS configuration specifies, for each system database, which lookup method is to be used, and how the various methods are chained together---for instance, under which circumstances NSS should try the next method in the list.  The NSS configuration is given in the name-service-switch field of operating-system declarations (see name-service-switch).

As an example, the declaration below configures the NSS to use the nss-mdns back-end (http://0pointer.de/lennart/projects/nss-mdns/), which supports host name lookups over multicast DNS (mDNS)  for host names ending in .local:

     (name-service-switch
        (hosts (list %files    ;first, check /etc/hosts

                     ;; If the above did not succeed, try
                     ;; with 'mdns_minimal'.
                     (name-service
                       (name "mdns_minimal")

                       ;; 'mdns_minimal' is authoritative for
                       ;; '.local'.  When it returns "not found",
                       ;; no need to try the next methods.
                       (reaction (lookup-specification
                                  (not-found => return))))

                     ;; Then fall back to DNS.
                     (name-service
                       (name "dns"))

                     ;; Finally, try with the "full" 'mdns'.
                     (name-service
                       (name "mdns")))))

Do not worry: the %mdns-host-lookup-nss variable (see below) contains this configuration, so you will not have to type it if all you want is to have .local host lookup working.

Note that, in this case, in addition to setting the name-service-switch of the operating-system declaration, you also need to use avahi-service (see avahi-service), or %DESKTOP-SERVICES, which includes it (see Services de bureaux).  Doing this makes nss-mdns accessible to the name service cache daemon (see nscd-service).

For convenience, the following variables provide typical NSS configurations.

 -- Scheme Variable: %default-nss
     This is the default name service switch configuration, a name-service-switch object.

 -- Scheme Variable: %mdns-host-lookup-nss
     This is the name service switch configuration with support for host name lookup over multicast DNS (mDNS) for host names ending in .local.

The reference for name service switch configuration is given below.  It is a direct mapping of the configuration file format of the C library , so please refer to the C library manual for more information (see NSS Configuration File (The GNU C Library Reference Manual)).  Compared to the configuration file format of libc NSS, it has the advantage not only of adding this warm parenthetic feel that we like, but also static checks: you will know about syntax errors and typos as soon as you run guix system.

 -- Data Type: name-service-switch

     This is the data type representation the configuration of libc's name service switch (NSS).  Each field below represents one of the supported system databases.

     aliases
     ethers
     group
     gshadow
     hosts
     initgroups
     netgroup
     networks
     password
     public-key
     rpc
     services
     shadow
          The system databases handled by the NSS.  Each of these fields must be a list of <name-service> objects (see below).

 -- Data Type: name-service

     This is the data type representing an actual name service and the associated lookup action.

     name
          A string denoting the name service (see Services in the NSS configuration (The GNU C Library Reference Manual)).

          Note that name services listed here must be visible to nscd.  This is achieved by passing the #:name-services argument to nscd-service the list of packages providing the needed name services (see nscd-service).

     reaction
          An action specified using the lookup-specification macro (see Actions in the NSS configuration (The GNU C Library Reference Manual)).  For example:

               (lookup-specification (unavailable => continue)
                                     (success => return))

Disque de RAM initial
---------------------

For bootstrapping purposes, the Linux-Libre kernel is passed an initial RAM disk, or initrd.  An initrd contains a temporary root file system as well as an initialization script.  The latter is responsible for mounting the real root file system, and for loading any kernel modules that may be needed to achieve that.

The initrd-modules field of an operating-system declaration allows you to specify Linux-libre kernel modules that must be available in the initrd.  In particular, this is where you would list modules needed to actually drive the hard disk where your root partition is---although the default value of initrd-modules should cover most use cases.  For example, assuming you need the megaraid_sas module in addition to the default modules to be able to access your root file system, you would write:

     (operating-system
       ;; ...
       (initrd-modules (cons "megaraid_sas" %base-initrd-modules)))

 -- Scheme Variable: %base-initrd-modules
     This is the list of kernel modules included in the initrd by default.

Furthermore, if you need lower-level customization, the initrd field of an operating-system declaration allows you to specify which initrd you would like to use.  The (gnu system linux-initrd) module provides three ways to build an initrd: the high-level base-initrd procedure and the low-level raw-initrd and expression->initrd procedures.

The base-initrd procedure is intended to cover most common uses.  For example, if you want to add a bunch of kernel modules to be loaded at boot time, you can define the initrd field of the operating system declaration like this:

     (initrd (lambda (file-systems . rest)
               ;; Create a standard initrd but set up networking
               ;; with the parameters QEMU expects by default.
               (apply base-initrd file-systems
                      #:qemu-networking? #t
                      rest)))

The base-initrd procedure also handles common use cases that involves using the system as a QEMU guest, or as a ``live'' system with volatile root file system.

The base-initrd procedure is built from raw-initrd procedure. Unlike base-initrd, raw-initrd doesn't do anything high-level, such as trying to guess which kernel modules and packages should be included to the initrd. An example use of raw-initrd is when a user has a custom Linux kernel configuration and default kernel modules included by base-initrd are not available.

The initial RAM disk produced by base-initrd or raw-initrd honors several options passed on the Linux kernel command line (that is, arguments passed via the linux command of GRUB, or the -append option of QEMU), notably:

--load=BOOT
     Tell the initial RAM disk to load BOOT, a file containing a Scheme program, once it has mounted the root file system.

     GuixSD uses this option to yield control to a boot program that runs the service activation programs and then spawns the GNU Shepherd, the initialization system.

--root=ROOT
     Mount ROOT as the root file system.  ROOT can be a device name like /dev/sda1, a file system label, or a file system UUID.

--system=SYSTÈME
     Have /run/booted-system and /run/current-system point to SYSTEM.

modprobe.blacklist=MODULES...
     Instruct the initial RAM disk as well as the modprobe command (from the kmod package) to refuse to load MODULES.  MODULES must be a comma-separated list of module names---e.g., usbkbd,9pnet.

--repl
     Start a read-eval-print loop (REPL) from the initial RAM disk before it tries to load kernel modules and to mount the root file system.  Our marketing team calls it boot-to-Guile.  The Schemer in you will love it.  See Using Guile Interactively (GNU Guile Reference Manual), for more information on Guile's REPL.

Now that you know all the features that initial RAM disks produced by base-initrd and raw-initrd provide, here is how to use it and customize it further.

 -- Monadic Procedure: raw-initrd FILE-SYSTEMS
     [#:linux-modules '()] [#:mapped-devices '()]  [#:helper-packages '()]
     [#:qemu-networking? #f] [#:volatile-root? #f] Return a monadic derivation that builds a raw initrd.  FILE-SYSTEMS is a list of file systems to be mounted by the initrd, possibly in addition to the root file system specified on the kernel command line via --root.  LINUX-MODULES is a list of kernel modules to be loaded at boot time.  MAPPED-DEVICES is a list of device mappings to realize before FILE-SYSTEMS are mounted (see Périphériques mappés).  HELPER-PACKAGES is a list of packages to be copied in the initrd. It may include e2fsck/static or other packages needed by the initrd to check the root file system.

     When QEMU-NETWORKING? is true, set up networking with the standard QEMU parameters.  When VIRTIO? is true, load additional modules so that the initrd can be used as a QEMU guest with para-virtualized I/O drivers.

     When VOLATILE-ROOT? is true, the root file system is writable but any changes to it are lost.

 -- Monadic Procedure: base-initrd FILE-SYSTEMS
     [#:mapped-devices '()] [#:qemu-networking? #f] [#:volatile-root? #f]
     [#:linux-modules '()] Return a monadic derivation that builds a generic
     initrd, with kernel modules taken from LINUX.  FILE-SYSTEMS is a list of file-systems to be mounted by the initrd, possibly in addition to the root file system specified on the kernel command line via --root.  MAPPED-DEVICES is a list of device mappings to realize before FILE-SYSTEMS are mounted.

     QEMU-NETWORKING? and VOLATILE-ROOT? behaves as in raw-initrd.

     The initrd is automatically populated with all the kernel modules necessary for FILE-SYSTEMS and for the given options.  Additional kernel modules can be listed in LINUX-MODULES.  They will be added to the initrd, and loaded at boot time in the order in which they appear.

Needless to say, the initrds we produce and use embed a statically-linked Guile, and the initialization program is a Guile program.  That gives a lot of flexibility.  The expression->initrd procedure builds such an initrd, given the program to run in that initrd.

 -- Monadic Procedure: expression->initrd EXP
     [#:guile %guile-static-stripped] [#:name "guile-initrd"] Return a derivation
     that builds a Linux initrd (a gzipped cpio archive)  containing GUILE and that evaluates EXP, a G-expression, upon booting.  All the derivations referenced by EXP are automatically copied to the initrd.

Configuration du chargeur d'amorçage
------------------------------------

The operating system supports multiple bootloaders.  The bootloader is configured using bootloader-configuration declaration.  All the fields of this structure are bootloader agnostic except for one field, bootloader that indicates the bootloader to be configured and installed.

Some of the bootloaders do not honor every field of bootloader-configuration.  For instance, the extlinux bootloader does not support themes and thus ignores the theme field.

 -- Data Type: bootloader-configuration
     The type of a bootloader configuration declaration.

     bootloader
          The bootloader to use, as a bootloader object. For now grub-bootloader, grub-efi-bootloader, extlinux-bootloader and u-boot-bootloader are supported.

          grub-efi-bootloader allows to boot on modern systems using the Unified Extensible Firmware Interface (UEFI).  This is what you should use if the installation image contains a /sys/firmware/efi directory when you boot it on your system.

          grub-bootloader allows you to boot in particular Intel-based machines in ``legacy'' BIOS mode.

          Available bootloaders are described in (gnu bootloader ...) modules.  In particular, (gnu bootloader u-boot) contains definitions of bootloaders for a wide range of ARM and AArch64 systems, using the U-Boot bootloader (http://www.denx.de/wiki/U-Boot/).

     target
          This is a string denoting the target onto which to install the bootloader.

          The interpretation depends on the bootloader in question.  For grub-bootloader, for example, it should be a device name understood by the bootloader installer command, such as /dev/sda or (hd0) (see Invoking grub-install (GNU GRUB Manual)).  For grub-efi-bootloader, it should be the mount point of the EFI file system, usually /boot/efi.

     menu-entries (default: ())
          A possibly empty list of menu-entry objects (see below), denoting entries to appear in the bootloader menu, in addition to the current system entry and the entry pointing to previous system generations.

     default-entry (default: 0)
          The index of the default boot menu entry.  Index 0 is for the entry of the current system.

     timeout (default: 5)
          The number of seconds to wait for keyboard input before booting.  Set to 0 to boot immediately, and to -1 to wait indefinitely.

     theme (default: #F)
          The bootloader theme object describing the theme to use.  If no theme is provided, some bootloaders might use a default theme, that's true for GRUB.

     terminal-outputs (default: 'gfxterm)
          The output terminals used for the bootloader boot menu, as a list of symbols.  GRUB accepts the values: console, serial, serial_{0-3}, gfxterm, vga_text, mda_text, morse, and pkmodem.  This field corresponds to the GRUB variable GRUB_TERMINAL_OUTPUT (see Simple configuration (GNU GRUB manual)).

     terminal-inputs (default: '())
          The input terminals used for the bootloader boot menu, as a list of symbols.  For GRUB, the default is the native platform terminal as determined at run-time.  GRUB accepts the values: console, serial, serial_{0-3}, at_keyboard, and usb_keyboard.  This field corresponds to the GRUB variable GRUB_TERMINAL_INPUT (see Simple configuration (GNU GRUB manual)).

     serial-unit (default: #f)
          The serial unit used by the bootloader, as an integer from 0 to 3.  For GRUB, it is chosen at run-time; currently GRUB chooses 0, which corresponds to COM1 (see Serial terminal (GNU GRUB manual)).

     serial-speed (default: #f)
          The speed of the serial interface, as an integer.  For GRUB, the default value is chosen at run-time; currently GRUB chooses 9600 bps (see Serial terminal (GNU GRUB manual)).

Should you want to list additional boot menu entries via the menu-entries field above, you will need to create them with the menu-entry form.  For example, imagine you want to be able to boot another distro (hard to imagine!), you can define a menu entry along these lines:

     (menu-entry
       (label "The Other Distro")
       (linux "/boot/old/vmlinux-2.6.32")
       (linux-arguments '("root=/dev/sda2"))
       (initrd "/boot/old/initrd"))

Details below.

 -- Data Type: menu-entry
     The type of an entry in the bootloader menu.

     label
          The label to show in the menu---e.g., "GNU".

     linux
          The Linux kernel image to boot, for example:

               (file-append linux-libre "/bzImage")

          For GRUB, it is also possible to specify a device explicitly in the file path using GRUB's device naming convention (see Naming convention (GNU GRUB manual)), for example:

               "(hd0,msdos1)/boot/vmlinuz"

          If the device is specified explicitly as above, then the device field is ignored entirely.

     linux-arguments (default: ())
          The list of extra Linux kernel command-line arguments---e.g., ("console=ttyS0").

     initrd
          A G-Expression or string denoting the file name of the initial RAM disk to use (see G-Expressions).

     device (default: #f)
          The device where the kernel and initrd are to be found---i.e., for GRUB, root for this menu entry (see root (GNU GRUB manual)).

          This may be a file system label (a string), a file system UUID (a bytevector, see Systèmes de fichiers), or #f, in which case the bootloader will search the device containing the file specified by the linux field (see search (GNU GRUB manual)).  It must not be an OS device name such as /dev/sda1.

Fow now only GRUB has theme support. GRUB themes are created using the grub-theme form, which is not documented yet.

 -- Scheme Variable: %default-theme
     This is the default GRUB theme used by the operating system if no theme field is specified in bootloader-configuration record.

     It comes with a fancy background image displaying the GNU and Guix logos.

Invoking guix system
--------------------

Once you have written an operating system declaration as seen in the previous section, it can be instantiated using the guix system command.  The synopsis is:

     guix system OPTIONS... ACTION FILE

FILE must be the name of a file containing an operating-system declaration.  ACTION specifies how the operating system is instantiated.  Currently the following values are supported:

search
     Display available service type definitions that match the given regular expressions, sorted by relevance:

          $ guix system search console font
          name: console-fonts
          location: gnu/services/base.scm:729:2
          extends: shepherd-root
          description: Install the given fonts on the specified ttys (fonts are
          + per virtual console on GNU/Linux).  The value of this service is a list
          + of tty/font pairs like:
          +
          +      '(("tty1" . "LatGrkCyr-8x16"))
          relevance: 20

          name: mingetty
          location: gnu/services/base.scm:1048:2
          extends: shepherd-root
          description: Provide console login using the `mingetty' program.
          relevance: 2

          name: login
          location: gnu/services/base.scm:775:2
          extends: pam
          description: Provide a console log-in service as specified by its
          + configuration value, a `login-configuration' object.
          relevance: 2

          ...

     As for guix package --search, the result is written in recutils format, which makes it easy to filter the output (see GNU recutils databases (GNU recutils manual)).

reconfigure
     Build the operating system described in FILE, activate it, and switch to it (This action (and the related actions switch-generation and roll-back) are usable only on systems already running GuixSD.).

     This effects all the configuration specified in FILE: user accounts, system services, global package list, setuid programs, etc.  The command starts system services specified in FILE that are not currently running; if a service is currently running, it does not attempt to upgrade it since this would not be possible without stopping it first.

     This command creates a new generation whose number is one greater than the current generation (as reported by guix system list-generations). If that generation already exists, it will be overwritten.  This behavior mirrors that of guix package (see Invoquer guix package).

     It also adds a bootloader menu entry for the new OS configuration, ---unless --no-bootloader is passed.  For GRUB, it moves entries for older configurations to a submenu, allowing you to choose an older system generation at boot time should you need it.

          It is highly recommended to run guix pull once before you run guix system reconfigure for the first time (see Invoquer guix pull).  Failing to do that you would see an older version of Guix once reconfigure has completed.

switch-generation
     Switch to an existing system generation.  This action atomically switches the system profile to the specified system generation.  It also rearranges the system's existing bootloader menu entries.  It makes the menu entry for the specified system generation the default, and it moves the entries for the other generatiors to a submenu, if supported by the bootloader being used.  The next time the system boots, it will use the specified system generation.

     The bootloader itself is not being reinstalled when using this command. Thus, the installed bootloader is used with an updated configuration file.

     The target generation can be specified explicitly by its generation number. For example, the following invocation would switch to system generation 7:

          guix system switch-generation 7

     The target generation can also be specified relative to the current generation with the form +N or -N, where +3 means ``3 generations ahead of the current generation,'' and -1 means ``1 generation prior to the current generation.'' When specifying a negative value such as -1, you must precede it with -- to prevent it from being parsed as an option.  For example:

          guix system switch-generation -- -1

     Currently, the effect of invoking this action is only to switch the system profile to an existing generation and rearrange the bootloader menu entries.  To actually start using the target system generation, you must reboot after running this action.  In the future, it will be updated to do the same things as reconfigure, like activating and deactivating services.

     This action will fail if the specified generation does not exist.

roll-back
     Switch to the preceding system generation.  The next time the system boots, it will use the preceding system generation.  This is the inverse of reconfigure, and it is exactly the same as invoking switch-generation with an argument of -1.

     Currently, as with switch-generation, you must reboot after running this action to actually start using the preceding system generation.

build
     Build the derivation of the operating system, which includes all the configuration files and programs needed to boot and run the system.  This action does not actually install anything.

init
     Populate the given directory with all the files necessary to run the operating system specified in FILE.  This is useful for first-time installations of GuixSD.  For instance:

          guix system init my-os-config.scm /mnt

     copies to /mnt all the store items required by the configuration specified in my-os-config.scm.  This includes configuration files, packages, and so on.  It also creates other essential files needed for the system to operate correctly---e.g., the /etc, /var, and /run directories, and the /bin/sh file.

     This command also installs bootloader on the target specified in my-os-config, unless the --no-bootloader option was passed.

vm
     Build a virtual machine that contains the operating system declared in FILE, and return a script to run that virtual machine (VM).  Arguments given to the script are passed to QEMU as in the example below, which enables networking and requests 1 GiB of RAM for the emulated machine:

          $ /gnu/store/...-run-vm.sh -m 1024 -net user

     The VM shares its store with the host system.

     Additional file systems can be shared between the host and the VM using the --share and --expose command-line options: the former specifies a directory to be shared with write access, while the latter provides read-only access to the shared directory.

     The example below creates a VM in which the user's home directory is accessible read-only, and where the /exchange directory is a read-write mapping of $HOME/tmp on the host:

          guix system vm my-config.scm \
             --expose=$HOME --share=$HOME/tmp=/exchange

     On GNU/Linux, the default is to boot directly to the kernel; this has the advantage of requiring only a very tiny root disk image since the store of the host can then be mounted.

     The --full-boot option forces a complete boot sequence, starting with the bootloader.  This requires more disk space since a root image containing at least the kernel, initrd, and bootloader data files must be created.  The --image-size option can be used to specify the size of the image.

vm-image
disk-image
docker-image
     Return a virtual machine, disk image, or Docker image of the operating system declared in FILE that stands alone.  By default, guix system estimates the size of the image needed to store the system, but you can use the --image-size option to specify a value.  Docker images are built to contain exactly what they need, so the --image-size option is ignored in the case of docker-image.

     You can specify the root file system type by using the --file-system-type option.  It defaults to ext4.

     When using vm-image, the returned image is in qcow2 format, which the QEMU emulator can efficiently use. See Lancer GuixSD dans une VM, for more information on how to run the image in a virtual machine.

     When using disk-image, a raw disk image is produced; it can be copied as is to a USB stick, for instance.  Assuming /dev/sdc is the device corresponding to a USB stick, one can copy the image to it using the following command:

          # dd if=$(guix system disk-image my-os.scm) of=/dev/sdc

     When using docker-image, a Docker image is produced.  Guix builds the image from scratch, not from a pre-existing Docker base image.  As a result, it contains exactly what you define in the operating system configuration file.  You can then load the image and launch a Docker container using commands like the following:

          image_id="$(docker load < guixsd-docker-image.tar.gz)"
          docker run -e GUIX_NEW_SYSTEM=/var/guix/profiles/system \\
              --entrypoint /var/guix/profiles/system/profile/bin/guile \\
              $image_id /var/guix/profiles/system/boot

     This command starts a new Docker container from the specified image.  It will boot the GuixSD system in the usual manner, which means it will start any services you have defined in the operating system configuration. Depending on what you run in the Docker container, it may be necessary to give the container additional permissions.  For example, if you intend to build software using Guix inside of the Docker container, you may need to pass the --privileged option to docker run.

conteneur
     Return a script to run the operating system declared in FILE within a container.  Containers are a set of lightweight isolation mechanisms provided by the kernel Linux-libre.  Containers are substantially less resource-demanding than full virtual machines since the kernel, shared objects, and other resources can be shared with the host system; this also means they provide thinner isolation.

     Currently, the script must be run as root in order to support more than a single user and group.  The container shares its store with the host system.

     As with the vm action (see guix system vm), additional file systems to be shared between the host and container can be specified using the --share and --expose options:

          guix system container my-config.scm \
             --expose=$HOME --share=$HOME/tmp=/exchange

          This option requires Linux-libre 3.19 or newer.

OPTIONS can contain any of the common build options (see Options de construction communes).  In addition, OPTIONS can contain one of the following:

--expression=EXPR
-e EXPR
     Consider the operating-system EXPR evaluates to.  This is an alternative to specifying a file which evaluates to an operating system. This is used to generate the GuixSD installer see Construire l'image d'installation).

--system=SYSTÈME
-s SYSTÈME
     Attempt to build for SYSTEM instead of the host system type.  This works as per guix build (see Invoquer guix build).

--derivation
-d
     Return the derivation file name of the given operating system without building anything.

--file-system-type=TYPE
-t TYPE
     For the disk-image action, create a file system of the given TYPE on the image.

     When this option is omitted, guix system uses ext4.

     --file-system-type=iso9660 produces an ISO-9660 image, suitable for burning on CDs and DVDs.

--image-size=SIZE
     For the vm-image and disk-image actions, create an image of the given SIZE.  SIZE may be a number of bytes, or it may include a unit as a suffix (see size specifications (GNU Coreutils)).

     When this option is omitted, guix system computes an estimate of the image size as a function of the size of the system declared in FILE.

--root=FICHIER
-r FICHIER
     Fait de FICHIER un lien symbolique vers le résultat, et l'enregistre en tant que racine du ramasse-miettes.

--skip-checks
     Skip pre-installation safety checks.

     By default, guix system init and guix system reconfigure perform safety checks: they make sure the file systems that appear in the operating-system declaration actually exist (see Systèmes de fichiers), and that any Linux kernel modules that may be needed at boot time are listed in initrd-modules (see Disque de RAM initial).  Passing this option skips these tests altogether.

--on-error=STRATEGY
     Apply STRATEGY when an error occurs when reading FILE. STRATEGY may be one of the following:

     nothing-special
          Report the error concisely and exit.  This is the default strategy.

     backtrace
          Likewise, but also display a backtrace.

     debug
          Report the error and enter Guile's debugger.  From there, you can run commands such as ,bt to get a backtrace, ,locals to display local variable values, and more generally inspect the state of the program. See Debug Commands (GNU Guile Reference Manual), for a list of available debugging commands.

     All the actions above, except build and init, can use KVM support in the Linux-libre kernel.  Specifically, if the machine has hardware virtualization support, the corresponding KVM kernel module should be loaded, and the /dev/kvm device node must exist and be readable and writable by the user and by the build users of the daemon (see Réglages de l'environnement de construction).

Once you have built, configured, re-configured, and re-re-configured your GuixSD installation, you may find it useful to list the operating system generations available on disk---and that you can choose from the bootloader boot menu:

list-generations
     List a summary of each generation of the operating system available on disk, in a human-readable way.  This is similar to the --list-generations option of guix package (see Invoquer guix package).

     Optionally, one can specify a pattern, with the same syntax that is used in guix package --list-generations, to restrict the list of generations displayed.  For instance, the following command displays generations that are up to 10 days old:

          $ guix system list-generations 10d

The guix system command has even more to offer! The following sub-commands allow you to visualize how your system services relate to each other:

extension-graph
     Emit in Dot/Graphviz format to standard output the service extension graph of the operating system defined in FILE (see Composition de services, for more information on service extensions.)

     The command:

          $ guix system extension-graph FILE | dot -Tpdf > services.pdf

     produces a PDF file showing the extension relations among services.

shepherd-graph
     Emit in Dot/Graphviz format to standard output the dependency graph of shepherd services of the operating system defined in FILE. See Services Shepherd, for more information and for an example graph.

Running GuixSD in a Virtual Machine
-----------------------------------

To run GuixSD in a virtual machine (VM), one can either use the pre-built GuixSD VM image distributed at https://alpha.gnu.org/gnu/guix/guixsd-vm-image-VERSION.SYSTEM.xz , or build their own virtual machine image using guix system vm-image (see Invoquer guix system).  The returned image is in qcow2 format, which the QEMU emulator (http://qemu.org/) can efficiently use.

If you built your own image, you must copy it out of the store (see Le dépôt) and give yourself permission to write to the copy before you can use it.  When invoking QEMU, you must choose a system emulator that is suitable for your hardware platform.  Here is a minimal QEMU invocation that will boot the result of guix system vm-image on x86_64 hardware:

     $ qemu-system-x86_64 \
        -net user -net nic,model=virtio \
        -enable-kvm -m 256 /tmp/qemu-image

Here is what each of these options means:

qemu-system-x86_64
     This specifies the hardware platform to emulate.  This should match the host.

-net user
     Enable the unprivileged user-mode network stack.  The guest OS can access the host but not vice versa.  This is the simplest way to get the guest OS online.

-net nic,model=virtio
     You must create a network interface of a given model.  If you do not create a NIC, the boot will fail.  Assuming your hardware platform is x86_64, you can get a list of available NIC models by running qemu-system-x86_64 -net nic,model=help.

-enable-kvm
     If your system has hardware virtualization extensions, enabling the virtual machine support (KVM) of the Linux kernel will make things run faster.

-m 256
     RAM available to the guest OS, in mebibytes.  Defaults to 128 MiB, which may be insufficient for some operations.

/tmp/qemu-image
     The file name of the qcow2 image.

The default run-vm.sh script that is returned by an invocation of guix system vm does not add a -net user flag by default.  To get network access from within the vm add the (dhcp-client-service) to your system definition and start the VM using `guix system vm config.scm` -net user.  An important caveat of using -net user for networking is that ping will not work, because it uses the ICMP protocol.  You'll have to use a different command to check for network connectivity, for example guix download.

Connecting Through SSH
......................

To enable SSH inside a VM you need to add a SSH server like (dropbear-service) or (lsh-service) to your VM.  The (lsh-service) doesn't currently boot unsupervised.  It requires you to type some characters to initialize the randomness generator.  In addition you need to forward the SSH port, 22 by default, to the host.  You can do this with

     `guix system vm config.scm` -net user,hostfwd=tcp::10022-:22

To connect to the VM you can run

     ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 10022

The -p tells ssh the port you want to connect to. -o UserKnownHostsFile=/dev/null prevents ssh from complaining every time you modify your config.scm file and the -o StrictHostKeyChecking=no prevents you from having to allow a connection to an unknown host every time you connect.

Using virt-viewer with Spice
............................

As an alternative to the default qemu graphical client you can use the remote-viewer from the virt-viewer package.  To connect pass the -spice port=5930,disable-ticketing flag to qemu.  See previous section for further information on how to do this.

Spice also allows you to do some nice stuff like share your clipboard with your VM.  To enable that you'll also have to pass the following flags to qemu:

     -device virtio-serial-pci,id=virtio-serial0,max_ports=16,bus=pci.0,addr=0x5
     -chardev spicevmc,name=vdagent,id=vdagent
     -device virtserialport,nr=1,bus=virtio-serial0.0,chardev=vdagent,
     name=com.redhat.spice.0

You'll also need to add the see Spice service.

Définir des services
--------------------

The previous sections show the available services and how one can combine them in an operating-system declaration.  But how do we define them in the first place? And what is a service anyway?

Composition de services
.......................

Here we define a service as, broadly, something that extends the functionality of the operating system.  Often a service is a process---a daemon---started when the system boots: a secure shell server, a Web server, the Guix build daemon, etc.  Sometimes a service is a daemon whose execution can be triggered by another daemon---e.g., an FTP server started by inetd or a D-Bus service activated by dbus-daemon. Occasionally, a service does not map to a daemon.  For instance, the ``account'' service collects user accounts and makes sure they exist when the system runs; the ``udev'' service collects device management rules and makes them available to the eudev daemon; the /etc service populates the /etc directory of the system.

GuixSD services are connected by extensions.  For instance, the secure shell service extends the Shepherd---the GuixSD initialization system, running as PID 1---by giving it the command lines to start and stop the secure shell daemon (see lsh-service); the UPower service extends the D-Bus service by passing it its .service specification, and extends the udev service by passing it device management rules (see upower-service); the Guix daemon service extends the Shepherd by passing it the command lines to start and stop the daemon, and extends the account service by passing it a list of required build user accounts (see Services de base).

All in all, services and their ``extends'' relations form a directed acyclic graph (DAG).  If we represent services as boxes and extensions as arrows, a typical system might provide something like this:

Typical service extension graph.

At the bottom, we see the system service, which produces the directory containing everything to run and boot the system, as returned by the guix system build command.  See Référence de service, to learn about the other service types shown here.  See the guix system extension-graph command, for information on how to generate this representation for a particular operating system definition.

Technically, developers can define service types to express these relations.  There can be any number of services of a given type on the system---for instance, a system running two instances of the GNU secure shell server (lsh) has two instances of LSH-SERVICE-TYPE, with different parameters.

The following section describes the programming interface for service types and services.

Types service et services
.........................

A service type is a node in the DAG described above.  Let us start with a simple example, the service type for the Guix build daemon (see Invoquer guix-daemon):

     (define guix-service-type
       (service-type
        (name 'guix)
        (extensions
         (list (service-extension shepherd-root-service-type guix-shepherd-service)
               (service-extension account-service-type guix-accounts)
               (service-extension activation-service-type guix-activation)))
        (default-value (guix-configuration))))

It defines three things:

 1. A name, whose sole purpose is to make inspection and debugging easier.

 2. A list of service extensions, where each extension designates the target service type and a procedure that, given the parameters of the service, returns a list of objects to extend the service of that type.

     Every service type has at least one service extension.  The only exception is the boot service type, which is the ultimate service.

 3. Optionally, a default value for instances of this type.

In this example, GUIX-SERVICE-TYPE extends three services:

shepherd-root-service-type
     The GUIX-SHEPHERD-SERVICE procedure defines how the Shepherd service is extended.  Namely, it returns a <shepherd-service> object that defines how guix-daemon is started and stopped (see Services Shepherd).

account-service-type
     This extension for this service is computed by GUIX-ACCOUNTS, which returns a list of user-group and user-account objects representing the build user accounts (see Invoquer guix-daemon).

activation-service-type
     Here GUIX-ACTIVATION is a procedure that returns a gexp, which is a code snippet to run at ``activation time''---e.g., when the service is booted.

A service of this type is instantiated like this:

     (service guix-service-type
              (guix-configuration
                (build-accounts 5)
                (use-substitutes? #f)))

The second argument to the service form is a value representing the parameters of this specific service instance. See guix-configuration, for information about the guix-configuration data type.  When the value is omitted, the default value specified by guix-service-type is used:

     (service guix-service-type)

GUIX-SERVICE-TYPE is quite simple because it extends other services but is not extensible itself.

The service type for an extensible service looks like this:

     (define udev-service-type
       (service-type (name 'udev)
                     (extensions
                      (list (service-extension shepherd-root-service-type
                                               udev-shepherd-service)))

                     (compose concatenate)       ;concatenate the list of rules
                     (extend (lambda (config rules)
                               (match config
                                 (($ <udev-configuration> udev initial-rules)
                                  (udev-configuration
                                   (udev udev)   ;the udev package to use
                                   (rules (append initial-rules rules)))))))))

This is the service type for the eudev device management daemon (https://wiki.gentoo.org/wiki/Project:Eudev).  Compared to the previous example, in addition to an extension of SHEPHERD-ROOT-SERVICE-TYPE, we see two new fields:

compose
     This is the procedure to compose the list of extensions to services of this type.

     Services can extend the udev service by passing it lists of rules; we compose those extensions simply by concatenating them.

extend
     This procedure defines how the value of the service is extended with the composition of the extensions.

     Udev extensions are composed into a list of rules, but the udev service value is itself a <udev-configuration> record.  So here, we extend that record by appending the list of rules it contains to the list of contributed rules.

description
     This is a string giving an overview of the service type.  The string can contain Texinfo markup (see Overview (GNU Texinfo)).  The guix system search command searches these strings and displays them (see Invoquer guix system).

There can be only one instance of an extensible service type such as UDEV-SERVICE-TYPE.  If there were more, the service-extension specifications would be ambiguous.

Still here? The next section provides a reference of the programming interface for services.

Référence de service
....................

We have seen an overview of service types (see Types service et services).  This section provides a reference on how to manipulate services and service types.  This interface is provided by the (gnu services) module.

 -- Scheme Procedure: service TYPE [VALUE]
     Return a new service of TYPE, a <service-type> object (see below.)  VALUE can be any object; it represents the parameters of this particular service instance.

     When VALUE is omitted, the default value specified by TYPE is used; if TYPE does not specify a default value, an error is raised.

     For instance, this:

          (service openssh-service-type)

     is equivalent to this:

          (service openssh-service-type
                   (openssh-configuration))

     In both cases the result is an instance of openssh-service-type with the default configuration.

 -- Scheme Procedure: service? OBJ
     Return true if OBJ is a service.

 -- Scheme Procedure: service-kind SERVICE
     Return the type of SERVICE---i.e., a <service-type> object.

 -- Scheme Procedure: service-value SERVICE
     Return the value associated with SERVICE.  It represents its parameters.

Here is an example of how a service is created and manipulated:

     (define s
       (service nginx-service-type
                (nginx-configuration
                 (nginx nginx)
                 (log-directory log-directory)
                 (run-directory run-directory)
                 (file config-file))))

     (service? s)
     => #t

     (eq? (service-kind s) nginx-service-type)
     => #t

The modify-services form provides a handy way to change the parameters of some of the services of a list such as %BASE-SERVICES (see %base-services).  It evaluates to a list of services.  Of course, you could always use standard list combinators such as map and fold to do that (see List Library (GNU Guile Reference Manual)); modify-services simply provides a more concise form for this common pattern.

 -- Scheme Syntax: modify-services SERVICES
     (TYPE VARIABLE => BODY) ...

     Modify the services listed in SERVICES according to the given clauses.  Each clause has the form:

          (TYPE VARIABLE => BODY)

     where TYPE is a service type---e.g., guix-service-type---and VARIABLE is an identifier that is bound within the BODY to the service parameters---e.g., a guix-configuration instance---of the original service of that TYPE.

     The BODY should evaluate to the new service parameters, which will be used to configure the new service.  This new service will replace the original in the resulting list.  Because a service's service parameters are created using define-record-type*, you can write a succinct BODY that evaluates to the new service parameters by using the inherit feature that define-record-type* provides.

     See Utiliser le système de configuration, for example usage.

Next comes the programming interface for service types.  This is something you want to know when writing new service definitions, but not necessarily when simply looking for ways to customize your operating-system declaration.

 -- Data Type: service-type
     This is the representation of a service type (see Types service et services).

     name
          This is a symbol, used only to simplify inspection and debugging.

     extensions
          A non-empty list of <service-extension> objects (see below).

     compose (default: #f)
          If this is #f, then the service type denotes services that cannot be extended---i.e., services that do not receive ``values'' from other services.

          Otherwise, it must be a one-argument procedure.  The procedure is called by fold-services and is passed a list of values collected from extensions.  It may return any single value.

     extend (default: #f)
          If this is #f, services of this type cannot be extended.

          Otherwise, it must be a two-argument procedure: fold-services calls it, passing it the initial value of the service as the first argument and the result of applying compose to the extension values as the second argument.  It must return a value that is a valid parameter value for the service instance.

     See Types service et services, for examples.

 -- Scheme Procedure: service-extension TARGET-TYPE
     COMPUTE Return a new extension for services of type
     TARGET-TYPE.  COMPUTE must be a one-argument procedure: fold-services calls it, passing it the value associated with the service that provides the extension; it must return a valid value for the target service.

 -- Scheme Procedure: service-extension? OBJ
     Return true if OBJ is a service extension.

Occasionally, you might want to simply extend an existing service.  This involves creating a new service type and specifying the extension of interest, which can be verbose; the simple-service procedure provides a shorthand for this.

 -- Scheme Procedure: simple-service NAME TARGET VALUE
     Return a service that extends TARGET with VALUE.  This works by creating a singleton service type NAME, of which the returned service is an instance.

     For example, this extends mcron (see Exécution de tâches planifiées) with an additional job:

          (simple-service 'my-mcron-job mcron-service-type
                          #~(job '(next-hour (3)) "guix gc -F 2G"))

At the core of the service abstraction lies the fold-services procedure, which is responsible for ``compiling'' a list of services down to a single directory that contains everything needed to boot and run the system---the directory shown by the guix system build command (see Invoquer guix system).  In essence, it propagates service extensions down the service graph, updating each node parameters on the way, until it reaches the root node.

 -- Scheme Procedure: fold-services SERVICES
     [#:target-type SYSTEM-SERVICE-TYPE] Fold SERVICES by propagating
     their extensions down to the root of type TARGET-TYPE; return the root service adjusted accordingly.

Lastly, the (gnu services) module also defines several essential service types, some of which are listed below.

 -- Scheme Variable: system-service-type
     This is the root of the service graph.  It produces the system directory as returned by the guix system build command.

 -- Scheme Variable: boot-service-type
     The type of the ``boot service'', which produces the boot script.  The boot script is what the initial RAM disk runs when booting.

 -- Scheme Variable: etc-service-type
     The type of the /etc service.  This service is used to create files under /etc and can be extended by passing it name/file tuples such as:

          (list `("issue" ,(plain-file "issue" "Welcome!\n")))

     In this example, the effect would be to add an /etc/issue file pointing to the given file.

 -- Scheme Variable: setuid-program-service-type
     Type for the ``setuid-program service''.  This service collects lists of executable file names, passed as gexps, and adds them to the set of setuid-root programs on the system (see Programmes setuid).

 -- Scheme Variable: profile-service-type
     Type of the service that populates the system profile---i.e., the programs under /run/current-system/profile.  Other services can extend it by passing it lists of packages to add to the system profile.

Services Shepherd
.................

The (gnu services shepherd) module provides a way to define services managed by the GNU Shepherd, which is the GuixSD initialization system---the first process that is started when the system boots, also known as PID 1 (see Introduction (The GNU Shepherd Manual)).

Services in the Shepherd can depend on each other.  For instance, the SSH daemon may need to be started after the syslog daemon has been started, which in turn can only happen once all the file systems have been mounted. The simple operating system defined earlier (see Utiliser le système de configuration) results in a service graph like this:

Typical shepherd service graph.

You can actually generate such a graph for any operating system definition using the guix system shepherd-graph command (see guix system shepherd-graph).

The %SHEPHERD-ROOT-SERVICE is a service object representing PID 1, of type SHEPHERD-ROOT-SERVICE-TYPE; it can be extended by passing it lists of <shepherd-service> objects.

 -- Data Type: shepherd-service
     The data type representing a service managed by the Shepherd.

     provision
          This is a list of symbols denoting what the service provides.

          These are the names that may be passed to herd start, herd status, and similar commands (see Invoking herd (The GNU Shepherd Manual)).  See the provides slot (The GNU Shepherd Manual), for details.

     requirements (default: '())
          List of symbols denoting the Shepherd services this one depends on.

     respawn? (default: #t)
          Whether to restart the service when it stops, for instance when the underlying process dies.

     start
     stop (default: #~(const #f))
          The start and stop fields refer to the Shepherd's facilities to start and stop processes (see Service De- and Constructors (The GNU Shepherd Manual)).  They are given as G-expressions that get expanded in the Shepherd configuration file (see G-Expressions).

     actions (default: '())
          This is a list of shepherd-action objects (see below) defining actions supported by the service, in addition to the standard start and stop actions.  Actions listed here become available as herd sub-commands:

               herd ACTION SERVICE [ARGUMENTS...]

     documentation
          A documentation string, as shown when running:

               herd doc SERVICE-NAME

          where SERVICE-NAME is one of the symbols in PROVISION (see Invoking herd (The GNU Shepherd Manual)).

     modules (default: %DEFAULT-MODULES)
          This is the list of modules that must be in scope when start and stop are evaluated.

 -- Data Type: shepherd-action
     This is the data type that defines additional actions implemented by a Shepherd service (see above).

     name
          Symbol naming the action.

     documentation
          This is a documentation string for the action.  It can be viewed by running:

               herd doc SERVICE action ACTION

     procedure
          This should be a gexp that evaluates to a procedure of at least one argument, which is the ``running value'' of the service (see Slots of services (The GNU Shepherd Manual)).

     The following example defines an action called say-hello that kindly greets the user:

          (shepherd-action
            (name 'say-hello)
            (documentation "Say hi!")
            (procedure #~(lambda (running . args)
                           (format #t "Hello, friend! arguments: ~s\n"
                                   args)
                           #t)))

     Assuming this action is added to the example service, then you can do:

          # herd say-hello example
          Hello, friend! arguments: ()
          # herd say-hello example a b c
          Hello, friend! arguments: ("a" "b" "c")

     This, as you can see, is a fairly sophisticated way to say hello. See Service Convenience (The GNU Shepherd Manual), for more info on actions.

 -- Scheme Variable: shepherd-root-service-type
     The service type for the Shepherd ``root service''---i.e., PID 1.

     This is the service type that extensions target when they want to create shepherd services (see Types service et services, for an example). Each extension must pass a list of <shepherd-service>.

 -- Scheme Variable: %shepherd-root-service
     This service represents PID 1.

Documentation
=============

In most cases packages installed with Guix come with documentation.  There are two main documentation formats: ``Info'', a browseable hypertext format used for GNU software, and ``manual pages'' (or ``man pages''), the linear documentation format traditionally found on Unix.  Info manuals are accessed with the info command or with Emacs, and man pages are accessed using man.

You can look for documentation of software installed on your system by keyword.  For example, the following command searches for information about ``TLS'' in Info manuals:

     $ info -k TLS
     "(emacs)Network Security" -- STARTTLS
     "(emacs)Network Security" -- TLS
     "(gnutls)Core TLS API" -- gnutls_certificate_set_verify_flags
     "(gnutls)Core TLS API" -- gnutls_certificate_set_verify_function
     ...

The command below searches for the same keyword in man pages:

     $ man -k TLS
     SSL (7)              - OpenSSL SSL/TLS library
     certtool (1)         - GnuTLS certificate tool
     ...{}

These searches are purely local to your computer so you have the guarantee that documentation you find corresponds to what you have actually installed, you can access it off-line, and your privacy is respected.

Once you have these results, you can view the relevant documentation by running, say:

     $ info "(gnutls)Core TLS API"

or:

     $ man certtool

Info manuals contain sections and indices as well as hyperlinks like those found in Web pages.  The info reader (see Info reader (Stand-alone GNU Info)) and its Emacs counterpart (see Misc Help (The GNU Emacs Manual)) provide intuitive key bindings to navigate manuals.  See Getting Started (Info: An Introduction), for an introduction to Info navigation.

Installer les fichiers de débogage
==================================

Program binaries, as produced by the GCC compilers for instance, are typically written in the ELF format, with a section containing debugging information.  Debugging information is what allows the debugger, GDB, to map binary code to source code; it is required to debug a compiled program in good conditions.

Le problème avec les informations de débogage est qu'elles prennent pas mal de place sur le disque. Par exemple, les informations de débogage de la bibliothèque C de GNU prend plus de 60 Mo. Ainsi, en tant qu'utilisateur, garder toutes les informations de débogage de tous les programmes installés n'est souvent pas une possibilité. Cependant, l'économie d'espace ne devrait pas empêcher le débogage — en particulier, dans le système GNU, qui devrait faciliter pour ses utilisateurs l'exercice de leurs libertés (see Distribution GNU).

Thankfully, the GNU Binary Utilities (Binutils) and GDB provide a mechanism that allows users to get the best of both worlds: debugging information can be stripped from the binaries and stored in separate files.  GDB is then able to load debugging information from those files, when they are available (see Separate Debug Files (Debugging with GDB)).

The GNU distribution takes advantage of this by storing debugging information in the lib/debug sub-directory of a separate package output unimaginatively called debug (see Des paquets avec plusieurs résultats).  Users can choose to install the debug output of a package when they need it.  For instance, the following command installs the debugging information for the GNU C Library and for GNU Guile:

     guix package -i glibc:debug guile:debug

GDB must then be told to look for debug files in the user's profile, by setting the debug-file-directory variable (consider setting it from the ~/.gdbinit file, see Startup (Debugging with GDB)):

     (gdb) set debug-file-directory ~/.guix-profile/lib/debug

From there on, GDB will pick up debugging information from the .debug files under ~/.guix-profile/lib/debug.

In addition, you will most likely want GDB to be able to show the source code being debugged.  To do that, you will have to unpack the source code of the package of interest (obtained with guix build --source, see Invoquer guix build), and to point GDB to that source directory using the directory command (see directory (Debugging with GDB)).

The debug output mechanism in Guix is implemented by the gnu-build-system (see Systèmes de construction).  Currently, it is opt-in---debugging information is available only for the packages with definitions explicitly declaring a debug output.  This may be changed to opt-out in the future if our build farm servers can handle the load.  To check whether a package has a debug output, use guix package --list-available (see Invoquer guix package).

Mises à jour de sécurité
========================

Occasionally, important security vulnerabilities are discovered in software packages and must be patched.  Guix developers try hard to keep track of known vulnerabilities and to apply fixes as soon as possible in the master branch of Guix (we do not yet provide a ``stable'' branch containing only security updates.)  The guix lint tool helps developers find out about vulnerable versions of software packages in the distribution:

     $ guix lint -c cve
     gnu/packages/base.scm:652:2: glibc@2.21: probably vulnerable to CVE-2015-1781, CVE-2015-7547
     gnu/packages/gcc.scm:334:2: gcc@4.9.3: probably vulnerable to CVE-2015-5276
     gnu/packages/image.scm:312:2: openjpeg@2.1.0: probably vulnerable to CVE-2016-1923, CVE-2016-1924
     ...

See Invoquer guix lint, for more information.

     As of version VERSION, the feature described below is considered ``beta''.

Guix suit une discipline de gestion de paquets fonctionnelle (see Introduction), ce qui implique que lorsqu'un paquet change, tous les paquets qui en dépendent doivent être reconstruits. Cela peut grandement ralentir le déploiement de corrections dans les paquets du cœur comme libc ou bash comme presque toute la distribution aurait besoin d'être reconstruite. Cela aide d'utiliser des binaires pré-construits (see Substituts), mais le déploiement peut toujours prendre plus de temps de souhaité.

To address this, Guix implements grafts, a mechanism that allows for fast deployment of critical updates without the costs associated with a whole-distribution rebuild.  The idea is to rebuild only the package that needs to be patched, and then to ``graft'' it onto packages explicitly installed by the user and that were previously referring to the original package.  The cost of grafting is typically very low, and order of magnitudes lower than a full rebuild of the dependency chain.

For instance, suppose a security update needs to be applied to Bash.  Guix developers will provide a package definition for the ``fixed'' Bash, say BASH-FIXED, in the usual way (see Définition des paquets).  Then, the original package definition is augmented with a replacement field pointing to the package containing the bug fix:

     (define bash
       (package
         (name "bash")
         ;; ...
         (replacement bash-fixed)))

From there on, any package depending directly or indirectly on Bash---as reported by guix gc --requisites (see Invoquer guix gc)---that is installed is automatically ``rewritten'' to refer to BASH-FIXED instead of BASH.  This grafting process takes time proportional to the size of the package, usually less than a minute for an ``average'' package on a recent machine.  Grafting is recursive: when an indirect dependency requires grafting, then grafting ``propagates'' up to the package that the user is installing.

Currently, the length of the name and version of the graft and that of the package it replaces (BASH-FIXED and BASH in the example above) must be equal.  This restriction mostly comes from the fact that grafting works by patching files, including binary files, directly.  Other restrictions may apply: for instance, when adding a graft to a package providing a shared library, the original shared library and its replacement must have the same SONAME and be binary-compatible.

The --no-grafts command-line option allows you to forcefully avoid grafting (see --no-grafts).  Thus, the command:

     guix build bash --no-grafts

returns the store file name of the original Bash, whereas:

     guix build bash

returns the store file name of the ``fixed'', replacement Bash.  This allows you to distinguish between the two variants of Bash.

To verify which Bash your whole profile refers to, you can run (see Invoquer guix gc):

     guix gc -R `readlink -f ~/.guix-profile` | grep bash

... and compare the store file names that you get with those above. Likewise for a complete GuixSD system generation:

     guix gc -R `guix system build my-config.scm` | grep bash

Lastly, to check which Bash running processes are using, you can use the lsof command:

     lsof | grep /gnu/store/.*bash

Modules de paquets
==================

From a programming viewpoint, the package definitions of the GNU distribution are provided by Guile modules in the (gnu packages ...) name space (Note that packages under the (gnu packages ...) module name space are not necessarily ``GNU packages''. This module naming scheme follows the usual Guile module naming convention: gnu means that these modules are distributed as part of the GNU system, and packages identifies modules that define packages.) (see Guile modules (GNU Guile Reference Manual)).  For instance, the (gnu packages emacs) module exports a variable named emacs, which is bound to a <package> object (see Définition des paquets).

The (gnu packages ...) module name space is automatically scanned for packages by the command-line tools.  For instance, when running guix package -i emacs, all the (gnu packages ...) modules are scanned until one that exports a package object whose name is emacs is found.  This package search facility is implemented in the (gnu packages) module.

Users can store package definitions in modules with different names---e.g., (my-packages emacs) (Note that the file name and module name must match.  For instance, the (my-packages emacs) module must be stored in a my-packages/emacs.scm file relative to the load path specified with --load-path or GUIX_PACKAGE_PATH. See Modules and the File System (GNU Guile Reference Manual), for details.).  These package definitions will not be visible by default.  Users can invoke commands such as guix package and guix build with the -e option so that they know where to find the package. Better yet, they can use the -L option of these commands to make those modules visible (see --load-path), or define the GUIX_PACKAGE_PATH environment variable.  This environment variable makes it easy to extend or customize the distribution and is honored by all the user interfaces.

 -- Environment Variable: GUIX_PACKAGE_PATH
     This is a colon-separated list of directories to search for additional package modules.  Directories listed in this variable take precedence over the own modules of the distribution.

The distribution is fully bootstrapped and self-contained: each package is built based solely on other packages in the distribution.  The root of this dependency graph is a small set of bootstrap binaries, provided by the (gnu packages bootstrap) module.  For more information on bootstrapping, see Bootstrapping.

Consignes d'empaquetage
=======================

The GNU distribution is nascent and may well lack some of your favorite packages.  This section describes how you can help make the distribution grow.  See Contribuer, for additional information on how you can help.

Free software packages are usually distributed in the form of source code tarballs---typically tar.gz files that contain all the source files.  Adding a package to the distribution means essentially two things: adding a recipe that describes how to build the package, including a list of other packages required to build it, and adding package metadata along with that recipe, such as a description and licensing information.

In Guix all this information is embodied in package definitions. Package definitions provide a high-level view of the package.  They are written using the syntax of the Scheme programming language; in fact, for each package we define a variable bound to the package definition, and export that variable from a module (see Modules de paquets).  However, in-depth Scheme knowledge is not a prerequisite for creating packages.  For more information on package definitions, see Définition des paquets.

Once a package definition is in place, stored in a file in the Guix source tree, it can be tested using the guix build command (see Invoquer guix build).  For example, assuming the new package is called gnew, you may run this command from the Guix build tree (see Lancer Guix avant qu'il ne soit installé):

     ./pre-inst-env guix build gnew --keep-failed

Using --keep-failed makes it easier to debug build failures since it provides access to the failed build tree.  Another useful command-line option when debugging is --log-file, to access the build log.

If the package is unknown to the guix command, it may be that the source file contains a syntax error, or lacks a define-public clause to export the package variable.  To figure it out, you may load the module from Guile to get more information about the actual error:

     ./pre-inst-env guile -c '(use-modules (gnu packages gnew))'

Once your package builds correctly, please send us a patch (see Contribuer).  Well, if you need help, we will be happy to help you too.  Once the patch is committed in the Guix repository, the new package automatically gets built on the supported platforms by our continuous integration system (http://hydra.gnu.org/jobset/gnu/master).

On peut obtenir la nouvelle définition du paquet simplement en lançant guix pull (see Invoquer guix pull). Lorsque hydra.gnu.org a fini de construire le paquet, l'installation du paquet y télécharge automatiquement les binaires (see Substituts). La seule intervention humaine requise est pendant la revue et l'application du correctif.

Liberté logiciel
----------------

The GNU operating system has been developed so that users can have freedom in their computing.  GNU is free software, meaning that users have the four essential freedoms (http://www.gnu.org/philosophy/free-sw.html): to run the program, to study and change the program in source code form, to redistribute exact copies, and to distribute modified versions.  Packages found in the GNU distribution provide only software that conveys these four freedoms.

In addition, the GNU distribution follow the free software distribution guidelines (http://www.gnu.org/distros/free-system-distribution-guidelines.html).  Among other things, these guidelines reject non-free firmware, recommendations of non-free software, and discuss ways to deal with trademarks and patents.

Some otherwise free upstream package sources contain a small and optional subset that violates the above guidelines, for instance because this subset is itself non-free code.  When that happens, the offending items are removed with appropriate patches or code snippets in the origin form of the package (see Définition des paquets).  This way, guix build --source returns the ``freed'' source rather than the unmodified upstream source.

Conventions de nommage
----------------------

A package has actually two names associated with it: First, there is the name of the Scheme variable, the one following define-public. By this name, the package can be made known in the Scheme code, for instance as input to another package.  Second, there is the string in the name field of a package definition.  This name is used by package management commands such as guix package and guix build.

Both are usually the same and correspond to the lowercase conversion of the project name chosen upstream, with underscores replaced with hyphens.  For instance, GNUnet is available as gnunet, and SDL_net as sdl-net.

We do not add lib prefixes for library packages, unless these are already part of the official project name.  But see Modules python and Modules perl for special rules concerning modules for the Python and Perl languages.

Font package names are handled differently, see Polices de caractères.

Numéros de version
------------------

We usually package only the latest version of a given free software project.  But sometimes, for instance for incompatible library versions, two (or more) versions of the same package are needed.  These require different Scheme variable names.  We use the name as defined in Conventions de nommage for the most recent version; previous versions use the same name, suffixed by - and the smallest prefix of the version number that may distinguish the two versions.

The name inside the package definition is the same for all versions of a package and does not contain any version number.

For instance, the versions 2.24.20 and 3.9.12 of GTK+ may be packaged as follows:

     (define-public gtk+
       (package
         (name "gtk+")
         (version "3.9.12")
         ...))
     (define-public gtk+-2
       (package
         (name "gtk+")
         (version "2.24.20")
         ...))

If we also wanted GTK+ 3.8.2, this would be packaged as

     (define-public gtk+-3.8
       (package
         (name "gtk+")
         (version "3.8.2")
         ...))

Occasionally, we package snapshots of upstream's version control system (VCS) instead of formal releases.  This should remain exceptional, because it is up to upstream developers to clarify what the stable release is.  Yet, it is sometimes necessary.  So, what should we put in the version field?

Clearly, we need to make the commit identifier of the VCS snapshot visible in the version string, but we also need to make sure that the version string is monotonically increasing so that guix package --upgrade can determine which version is newer.  Since commit identifiers, notably with Git, are not monotonically increasing, we add a revision number that we increase each time we upgrade to a newer snapshot.  The resulting version string looks like this:

     2.0.11-3.cabba9e
       ^    ^    ^
       |    |    `-- upstream commit ID
       |    |
       |    `--- Guix package revision
       |
     latest upstream version

It is a good idea to strip commit identifiers in the version field to, say, 7 digits.  It avoids an aesthetic annoyance (assuming aesthetics have a role to play here) as well as problems related to OS limits such as the maximum shebang length (127 bytes for the Linux kernel.)  It is best to use the full commit identifiers in origins, though, to avoid ambiguities.  A typical package definition may look like this:

     (define my-package
       (let ((commit "c3f29bc928d5900971f65965feaae59e1272a3f7")
             (revision "1"))          ;révision du paquet Guix
         (package
           (version (git-version "0.9" revision commit))
           (source (origin
                     (method git-fetch)
                     (uri (git-reference
                           (url "git://example.org/my-package.git")
                           (commit commit)))
                     (sha256 (base32 "1mbikn..."))
                     (file-name (git-file-name name version))))
           ;; ...
           )))

Synopsis et descriptions
------------------------

As we have seen before, each package in GNU Guix includes a synopsis and a description (see Définition des paquets).  Synopses and descriptions are important: They are what guix package --search searches, and a crucial piece of information to help users determine whether a given package suits their needs.  Consequently, packagers should pay attention to what goes into them.

Synopses must start with a capital letter and must not end with a period. They must not start with ``a'' or ``the'', which usually does not bring anything; for instance, prefer ``File-frobbing tool'' over ``A tool that frobs files''.  The synopsis should say what the package is---e.g., ``Core GNU utilities (file, text, shell)''---or what it is used for---e.g., the synopsis for GNU grep is ``Print lines matching a pattern''.

Keep in mind that the synopsis must be meaningful for a very wide audience. For example, ``Manipulate alignments in the SAM format'' might make sense for a seasoned bioinformatics researcher, but might be fairly unhelpful or even misleading to a non-specialized audience.  It is a good idea to come up with a synopsis that gives an idea of the application domain of the package.  In this example, this might give something like ``Manipulate nucleotide sequence alignments'', which hopefully gives the user a better idea of whether this is what they are looking for.

Descriptions should take between five and ten lines.  Use full sentences, and avoid using acronyms without first introducing them.  Please avoid marketing phrases such as ``world-leading'', ``industrial-strength'', and ``next-generation'', and avoid superlatives like ``the most advanced''---they are not helpful to users looking for a package and may even sound suspicious.  Instead, try to be factual, mentioning use cases and features.

Descriptions can include Texinfo markup, which is useful to introduce ornaments such as @code or @dfn, bullet lists, or hyperlinks (see Overview (GNU Texinfo)).  However you should be careful when using some characters for example @ and curly braces which are the basic special characters in Texinfo (see Special Characters (GNU Texinfo)).  User interfaces such as guix package --show take care of rendering it appropriately.

Synopses and descriptions are translated by volunteers at the Translation Project (http://translationproject.org/domain/guix-packages.html) so that as many users as possible can read them in their native language.  User interfaces search them and display them in the language specified by the current locale.

To allow xgettext to extract them as translatable strings, synopses and descriptions must be literal strings.  This means that you cannot use string-append or format to construct these strings:

     (package
       ;; ...
       (synopsis "This is translatable")
       (description (string-append "This is " "*not*" " translatable.")))

Translation is a lot of work so, as a packager, please pay even more attention to your synopses and descriptions as every change may entail additional work for translators.  In order to help them, it is possible to make recommendations or instructions visible to them by inserting special comments like this (see xgettext Invocation (GNU Gettext)):

     ;; TRANSLATORS: "X11 resize-and-rotate" should not be translated.
     (description "ARandR is designed to provide a simple visual front end
     for the X11 resize-and-rotate (RandR) extension. ...")

Modules python
--------------

We currently package Python 2 and Python 3, under the Scheme variable names python-2 and python as explained in Numéros de version.  To avoid confusion and naming clashes with other programming languages, it seems desirable that the name of a package for a Python module contains the word python.

Some modules are compatible with only one version of Python, others with both.  If the package Foo compiles only with Python 3, we name it python-foo; if it compiles only with Python 2, we name it python2-foo. If it is compatible with both versions, we create two packages with the corresponding names.

If a project already contains the word python, we drop this; for instance, the module python-dateutil is packaged under the names python-dateutil and python2-dateutil.  If the project name starts with py (e.g. pytz), we keep it and prefix it as described above.

Specifying Dependencies
.......................

Dependency information for Python packages is usually available in the package source tree, with varying degrees of accuracy: in the setup.py file, in requirements.txt, or in tox.ini.

Your mission, when writing a recipe for a Python package, is to map these dependencies to the appropriate type of ``input'' (see inputs).  Although the pypi importer normally does a good job (see Invoquer guix import), you may want to check the following check list to determine which dependency goes where.

  * We currently package Python 2 with setuptools and pip installed like Python 3.4 has per default.  Thus you don't need to specify either of these as an input.  guix lint will warn you if you do.

  * Python dependencies required at run time go into propagated-inputs. They are typically defined with the install_requires keyword in setup.py, or in the requirements.txt file.

  * Python packages required only at build time---e.g., those listed with the setup_requires keyword in setup.py---or only for testing---e.g., those in tests_require---go into native-inputs.  The rationale is that (1) they do not need to be propagated because they are not needed at run time, and (2) in a cross-compilation context, it's the ``native'' input that we'd want.

     Examples are the pytest, mock, and nose test frameworks.  Of course if any of these packages is also required at run-time, it needs to go to propagated-inputs.

  * Anything that does not fall in the previous categories goes to inputs, for example programs or C libraries required for building Python packages containing C extensions.

  * If a Python package has optional dependencies (extras_require), it is up to you to decide whether to add them or not, based on their usefulness/overhead ratio (see guix size).

Modules perl
------------

Perl programs standing for themselves are named as any other package, using the lowercase upstream name.  For Perl packages containing a single class, we use the lowercase class name, replace all occurrences of :: by dashes and prepend the prefix perl-.  So the class XML::Parser becomes perl-xml-parser.  Modules containing several classes keep their lowercase upstream name and are also prepended by perl-.  Such modules tend to have the word perl somewhere in their name, which gets dropped in favor of the prefix.  For instance, libwww-perl becomes perl-libwww.

Paquets java
------------

Java programs standing for themselves are named as any other package, using the lowercase upstream name.

To avoid confusion and naming clashes with other programming languages, it is desirable that the name of a package for a Java package is prefixed with java-.  If a project already contains the word java, we drop this; for instance, the package ngsjava is packaged under the name java-ngs.

For Java packages containing a single class or a small class hierarchy, we use the lowercase class name, replace all occurrences of . by dashes and prepend the prefix java-.  So the class apache.commons.cli becomes package java-apache-commons-cli.

Polices de caractères
---------------------

For fonts that are in general not installed by a user for typesetting purposes, or that are distributed as part of a larger software package, we rely on the general packaging rules for software; for instance, this applies to the fonts delivered as part of the X.Org system or fonts that are part of TeX Live.

To make it easier for a user to search for fonts, names for other packages containing only fonts are constructed as follows, independently of the upstream package name.

The name of a package containing only one font family starts with font-; it is followed by the foundry name and a dash - if the foundry is known, and the font family name, in which spaces are replaced by dashes (and as usual, all upper case letters are transformed to lower case).  For example, the Gentium font family by SIL is packaged under the name font-sil-gentium.

For a package containing several font families, the name of the collection is used in the place of the font family name.  For instance, the Liberation fonts consist of three families, Liberation Sans, Liberation Serif and Liberation Mono.  These could be packaged separately under the names font-liberation-sans and so on; but as they are distributed together under a common name, we prefer to package them together as font-liberation.

In the case where several formats of the same font family or font collection are packaged separately, a short form of the format, prepended by a dash, is added to the package name.  We use -ttf for TrueType fonts, -otf for OpenType fonts and -type1 for PostScript Type 1 fonts.

Bootstrapping
=============

Bootstrapping in our context refers to how the distribution gets built ``from nothing''.  Remember that the build environment of a derivation contains nothing but its declared inputs (see Introduction).  So there's an obvious chicken-and-egg problem: how does the first package get built? How does the first compiler get compiled? Note that this is a question of interest only to the curious hacker, not to the regular user, so you can shamelessly skip this section if you consider yourself a ``regular user''.

The GNU system is primarily made of C code, with libc at its core.  The GNU build system itself assumes the availability of a Bourne shell and command-line tools provided by GNU Coreutils, Awk, Findutils, `sed', and `grep'.  Furthermore, build programs---programs that run ./configure, make, etc.---are written in Guile Scheme (see Dérivations). Consequently, to be able to build anything at all, from scratch, Guix relies on pre-built binaries of Guile, GCC, Binutils, libc, and the other packages mentioned above---the bootstrap binaries.

These bootstrap binaries are ``taken for granted'', though we can also re-create them if needed (more on that later).

Preparing to Use the Bootstrap Binaries
---------------------------------------

Dependency graph of the early bootstrap derivations

The figure above shows the very beginning of the dependency graph of the distribution, corresponding to the package definitions of the (gnu packages bootstrap) module.  A similar figure can be generated with guix graph (see Invoquer guix graph), along the lines of:

     guix graph -t derivation \
       -e '(@@ (gnu packages bootstrap) %bootstrap-gcc)' \
       | dot -Tps > t.ps

At this level of detail, things are slightly complex.  First, Guile itself consists of an ELF executable, along with many source and compiled Scheme files that are dynamically loaded when it runs.  This gets stored in the guile-2.0.7.tar.xz tarball shown in this graph.  This tarball is part of Guix's ``source'' distribution, and gets inserted into the store with add-to-store (see Le dépôt).

But how do we write a derivation that unpacks this tarball and adds it to the store? To solve this problem, the guile-bootstrap-2.0.drv derivation---the first one that gets built---uses bash as its builder, which runs build-bootstrap-guile.sh, which in turn calls tar to unpack the tarball.  Thus, bash, tar, xz, and mkdir are statically-linked binaries, also part of the Guix source distribution, whose sole purpose is to allow the Guile tarball to be unpacked.

Once guile-bootstrap-2.0.drv is built, we have a functioning Guile that can be used to run subsequent build programs.  Its first task is to download tarballs containing the other pre-built binaries---this is what the .tar.xz.drv derivations do.  Guix modules such as ftp-client.scm are used for this purpose.  The module-import.drv derivations import those modules in a directory in the store, using the original layout.  The module-import-compiled.drv derivations compile those modules, and write them in an output directory with the right layout.  This corresponds to the #:modules argument of build-expression->derivation (see Dérivations).

Finally, the various tarballs are unpacked by the derivations gcc-bootstrap-0.drv, glibc-bootstrap-0.drv, etc., at which point we have a working C tool chain.

Building the Build Tools
------------------------

Bootstrapping is complete when we have a full tool chain that does not depend on the pre-built bootstrap tools discussed above.  This no-dependency requirement is verified by checking whether the files of the final tool chain contain references to the /gnu/store directories of the bootstrap inputs.  The process that leads to this ``final'' tool chain is described by the package definitions found in the (gnu packages commencement) module.

The guix graph command allows us to ``zoom out'' compared to the graph above, by looking at the level of package objects instead of individual derivations---remember that a package may translate to several derivations, typically one derivation to download its source, one to build the Guile modules it needs, and one to actually build the package from source.  The command:

     guix graph -t bag \
       -e '(@@ (gnu packages commencement)
               glibc-final-with-bootstrap-bash)' | dot -Tps > t.ps

produces the dependency graph leading to the ``final'' C library (You may notice the glibc-intermediate label, suggesting that it is not quite final, but as a good approximation, we will consider it final.), depicted below.

Dependency graph of the early packages

The first tool that gets built with the bootstrap binaries is GNU Make---noted make-boot0 above---which is a prerequisite for all the following packages.  From there Findutils and Diffutils get built.

Then come the first-stage Binutils and GCC, built as pseudo cross tools---i.e., with --target equal to --host.  They are used to build libc.  Thanks to this cross-build trick, this libc is guaranteed not to hold any reference to the initial tool chain.

From there the final Binutils and GCC (not shown above) are built.  GCC uses ld from the final Binutils, and links programs against the just-built libc.  This tool chain is used to build the other packages used by Guix and by the GNU Build System: Guile, Bash, Coreutils, etc.

And voilà! At this point we have the complete set of build tools that the GNU Build System expects.  These are in the %final-inputs variable of the (gnu packages commencement) module, and are implicitly used by any package that uses gnu-build-system (see gnu-build-system).

Building the Bootstrap Binaries
-------------------------------

Because the final tool chain does not depend on the bootstrap binaries, those rarely need to be updated.  Nevertheless, it is useful to have an automated way to produce them, should an update occur, and this is what the (gnu packages make-bootstrap) module provides.

The following command builds the tarballs containing the bootstrap binaries (Guile, Binutils, GCC, libc, and a tarball containing a mixture of Coreutils and other basic command-line tools):

     guix build bootstrap-tarballs

The generated tarballs are those that should be referred to in the (gnu packages bootstrap) module mentioned at the beginning of this section.

Still here? Then perhaps by now you've started to wonder: when do we reach a fixed point? That is an interesting question! The answer is unknown, but if you would like to investigate further (and have significant computational and storage resources to do so), then let us know.

Reducing the Set of Bootstrap Binaries
--------------------------------------

Our bootstrap binaries currently include GCC, Guile, etc.  That's a lot of binary code! Why is that a problem? It's a problem because these big chunks of binary code are practically non-auditable, which makes it hard to establish what source code produced them.  Every unauditable binary also leaves us vulnerable to compiler backdoors as described by Ken Thompson in the 1984 paper Reflections on Trusting Trust.

This is mitigated by the fact that our bootstrap binaries were generated from an earlier Guix revision.  Nevertheless it lacks the level of transparency that we get in the rest of the package dependency graph, where Guix always gives us a source-to-binary mapping.  Thus, our goal is to reduce the set of bootstrap binaries to the bare minimum.

The Bootstrappable.org web site (http://bootstrappable.org) lists on-going projects to do that.  One of these is about replacing the bootstrap GCC with a sequence of assemblers, interpreters, and compilers of increasing complexity, which could be built from source starting from a simple and auditable assembler.  Your help is welcome!

Porting to a New Platform
=========================

As discussed above, the GNU distribution is self-contained, and self-containment is achieved by relying on pre-built ``bootstrap binaries'' (see Bootstrapping).  These binaries are specific to an operating system kernel, CPU architecture, and application binary interface (ABI).  Thus, to port the distribution to a platform that is not yet supported, one must build those bootstrap binaries, and update the (gnu packages bootstrap) module to use them on that platform.

Fortunately, Guix can cross compile those bootstrap binaries.  When everything goes well, and assuming the GNU tool chain supports the target platform, this can be as simple as running a command like this one:

     guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs

For this to work, the glibc-dynamic-linker procedure in (gnu packages bootstrap) must be augmented to return the right file name for libc's dynamic linker on that platform; likewise, system->linux-architecture in (gnu packages linux) must be taught about the new platform.

Once these are built, the (gnu packages bootstrap) module needs to be updated to refer to these binaries on the target platform.  That is, the hashes and URLs of the bootstrap tarballs for the new platform must be added alongside those of the currently supported platforms.  The bootstrap Guile tarball is treated specially: it is expected to be available locally, and gnu/local.mk has rules do download it for the supported architectures; a rule for the new platform must be added as well.

In practice, there may be some complications.  First, it may be that the extended GNU triplet that specifies an ABI (like the eabi suffix above) is not recognized by all the GNU tools.  Typically, glibc recognizes some of these, whereas GCC uses an extra --with-abi configure flag (see gcc.scm for examples of how to handle this).  Second, some of the required packages could fail to build for that platform.  Lastly, the generated binaries could be broken for some reason.

     [file contributing.fr.texi not included]

Remerciements
*************

Guix se base sur le gestionnaire de paquets Nix (http://nixos.org/nix/) conçu et implémenté par Eelco Dolstra, avec des constributions d'autres personnes (voir le fichier nix/AUTHORS dans Guix).  Nix a inventé la gestion de paquet fonctionnelle et promu des fonctionnalités sans précédents comme les mises à jour de paquets transactionnelles et les retours en arrière, les profils par utilisateurs et les processus de constructions transparents pour les références.  Sans ce travail, Guix n'existerait pas.

Les distributions logicielles basées sur Nix, Nixpkgs et NixOS, ont aussi été une inspiration pour Guix.

GNU Guix lui-même est un travail collectif avec des contributions d'un grand nombre de personnes.  Voyez le fichier AUTHORS dans Guix pour plus d'information sur ces personnes de qualité.  Le fichier THANKS liste les personnes qui ont aidé en rapportant des bogues, en prenant soin de l'infrastructure, en fournissant des images et des thèmes, en faisant des suggestions et bien plus. Merci !

La licence GNU Free Documentation
*********************************

     [file fdl-1.3.texi not included]