     [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 STORE PACKAGE [SYSTEM]
     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 STORE
     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 REPLACEMENTS
     [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ées: 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ées: 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 SERVER
     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.

 -- Procédure Scheme: 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.

la distribution fournit les paquets cœur de GNU comme la GNU libc, GCC et Binutils, ainsi que de nombreuses applications GNU et non-GNU.  La liste complète des paquets disponibles se trouve en ligne (http://www.gnu.org/software/guix/packages) ou en lançant guix package  (see Invoquer guix package) :

     guix package --list-available

Notre but est de fournir une distribution logicielle entièrement libre de GNU/Linux et d'autres variantes de GNU, en se concentrant sur la promotion et l'intégration étroite des composants GNU en insistant sur les programmes et les outils qui aident l'utilisateur à exercer ses libertés.

Les paquets sont actuellement disponibles pour les plateformes suivantes :

x86_64-linux
     l'architecture Intel et AMD x86_64 avec le noyau Linux-libre ;

i686-linux
     l'architecture Intel 32-bits (IA32) avec le noyau Linux-libre ;

armhf-linux
     l'architecture ARMv7-A avec gestion des flottants matérielle, Thumb-2 et NEON, avec l'interface binaire applicative (ABI) EABI hard-float et le noyau Linux-libre ;

aarch64-linux
     les processeurs ARMv8-A 64-bits en little-endian avec le noyau Linux-libre. Le support est actuellement expérimental et limité.  See Contribuer, pour savoir comment aider !

mips64el-linux
     les processeurs MIPS 64-bits little-endian, spécifiquement la série Loongson, ABI n32, avec le noyau Linux-libre.

GuixSD lui-même est actuellement disponible sur i686 et x86_64.

Pour des informations sur comment porter vers d'autres architectures et d'autres noyau, see Porter.

La construction de cette distribution est un effort collaboratif et nous vous invitons à nous rejoindre ! See Contribuer, pour des informations sur la manière de nous aider.

Installation du système
=======================

Cette section explique comment installer la distribution système Guix (GuixSD) sur votre machine.  Le gestionnaire de paquets Guix peut aussi être installé sur un système GNU/Linux déjà installé, see Installation.

     Vous lisez cette documentation avec un lecteur Info.  Pour des détails sur son utilisation, appuyez sur la touche ENTRÉE (« Entrée » ou « à la ligne ») sur le lien suivant : see Info reader (Stand-alone GNU Info).  Appuyez ensuite sur l pour revenir ici.

     Autrement, lancez info info dans un autre tty pour garder ce manuel ouvert.

Limitations
-----------

À la version VERSION, la distribution système Guix (GuixSD) n'est pas prête pour la production.  Elle peut contenir des bogues et ne pas avoir certaines fonctionnalités importantes.  Ainsi, si vous cherche un système de production stable qui respecte votre liberté en tant qu'utilisateur, une bonne solution consiste à utiliser une des distributions GNU/Linux mieux établie (http://www.gnu.org/distros/free-distros.html).  Nous espérons que vous pourrez bientôt passer à GuixSD sans peur, bien sûr.  Pendant ce temps, vous pouvez aussi utiliser votre distribution actuelle et essayer le gestionnaire de paquet par dessus celle-ci (see Installation).

Avant de procéder à l'installation, soyez conscient de ces limitations les plus importantes qui s'appliquent à la version VERSION :

  * Le procédé d'installation n'a pas d'interface utilisateur graphique et requiert une certaine familiarité avec GNU/Linux (voir les sous-sections suivantes pour avoir un aperçu de ce que cela signifie).

  * LVM (gestionnaire de volumes logiques) n'est pas supporté.

  * De plus en plus de services systèmes sont fournis (see Services) mais certains manquent toujours cruellement.

  * More than 7,500 packages are available, but you might occasionally find that a useful package is missing.

  * GNOME, Xfce, LXDE et Enlightenment sont disponibles (see Services de bureaux), ainsi qu'un certain nombre de gestionnaires de fenêtres X11. cependant, certaines applications graphiques peuvent manquer, ainsi que KDE.

Vous êtes avertis ! Mais plus qu'un avertissement, c'est une invitation à rapporter les problèmes (et vos succès !) et à nous rejoindre pour améliorer la distribution.  See Contribuer, pour plus d'info.

Considérations matérielles
--------------------------

GNU GuixSD se concentre sur le respect des libertés de ses utilisateurs.  Il est construit autour du noyau Linux-libre, ce qui signifie que seuls les matériels pour lesquels des pilotes logiciels et des microgiciels libres sont disponibles sont supportés.  De nos jours, une grande gamme de matériel qu'on peut acheter est supporté par GNU/Linux-libre — des claviers aux cartes graphiques en passant par les scanners et les contrôleurs Ethernet.  Malheureusement, il reste des produit dont les fabriquants refusent de laisser le contrôle aux utilisateurs sur leur propre utilisation de l'ordinateur, et ces matériels ne sont pas supportés par GuixSD.

L'un des types de matériels où les pilotes ou les microgiciels sont le moins disponibles sont les appareils WiFi.  Les appareils WiFi connus pour fonctionner sont ceux qui utilisent des puces Atheros (AR9271 et AR7010) qui correspondent au pilote ath9k de Linux-libre, et ceux qui utilisent des puces Broadcom/AirForce (BCM43xx avec la révision Wireless-Core 5), qui correspondent au pilote b43-open de Linux-libre.  Des microgiciels libres existent pour les deux et sont disponibles directement sur GuixSD, dans %BASE-FIRMWARE (see firmware).

La Free Software Foundation (https://www.fsf.org/) a un programme de certification nommé Respects Your Freedom (https://www.fsf.org/ryf) (RYF), pour les produits matériels qui respectent votre liberté et votre vie privée en s'assurant que vous avez le contrôle sur l'appareil. Nous vous encourageons à vérifier la liste des appareils certifiés par RYF.

Une autre ressource utile est le site web H-Node (https://www.h-node.org/).  Il contient un catalogue d'appareils avec des informations sur leur support dans 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
     pour un système GNU/Linux sur un CPU compatible Intel/AMD 64-bits ;

i686-linux
     pour un système GNU/Linux sur un CPU compatible Intel 32-bits ;

Assurez-vous de télécharger les fichiers .sig associés et de vérifier l'authenticité de l'image avec, de cette manière :

     $ 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.

Cette image contient les outils nécessaires à l'installation.  Elle est faite pour être copiée telle quelle sur une clef USB assez grosse ou un DVD.

Copie sur une clef USB
......................

Pour copier l'image sur une clef USB, suivez ces étapes :

 1. Décompressez l'image avec la commande xz :

          xz -d guixsd-install-VERSION.SYSTÈME.iso.xz

 2. Insérez la clef USB de 1 Gio ou plus dans votre machine et déterminez son nom d'appareil.  En supposant que la clef usb est connue sous le nom de /dev/sdX, copiez l'image avec :

          dd if=guixsd-install-VERSION.x86_64-linux.iso of=/dev/sdX
          sync

     Accéder à /dev/sdX requiert généralement les privilèges super-utilisateur.

Graver sur un DVD
.................

Pour copier l'image sur un DVD, suivez ces étapes :

 1. Décompressez l'image avec la commande xz :

          xz -d guixsd-install-VERSION.SYSTÈME.iso.xz

 2. Insérez un DVD vierge dans votre machine et déterminez son nom d'appareil. En supposant que le DVD soit connu sont le nom de /dev/srX, copiez l'image avec :

          growisofs -dvd-compat -Z /dev/srX=guixsd-install-VERSION.x86_64.iso

     Accéder à /dev/srX requiert généralement les privilèges super-utilisateur.

Démarrage
.........

Une fois que c'est fait, vous devriez pouvoir redémarrer le système et démarrer depuis la clef USB ou le DVD.  Pour cela, vous devrez généralement entrer dans le menu de démarrage BIOS ou UEFI, où vous pourrez choisir de démarrer sur la clef USB.

See Installer GuixSD dans une VM, si, à la place, vous souhaitez installer GuixSD dans une machine virtuelle (VM).

Préparer l'installation
-----------------------

Une fois que vous avez démarré votre ordinateur sur le média d'installation, vous devriez vous retrouver sur un prompt en root.  Plusieurs TTY sont configurées et peuvent être utilisés pour lancer des commandes en root.  Le TTY2 affiche cette documentation, dans la quelle vous pouvez naviguer avec les commandes du lecteur Info (see Stand-alone GNU Info).  Le démon de souris GPM tourne sur le système d'installation, ce qui vous permet de sélectionner du texte avec le bouton gauche de la souris et de le coller en appuyant sur la molette.

     L'installation nécessite un accès au réseau pour que les dépendances manquantes de votre configuration système puissent être téléchargées.  Voyez la section « réseau » plus bas.

Le système d'installation inclus plusieurs outils usuels pour requis pour cette tâche.  Mais c'est aussi un système GuixSD complet, ce qui signifie que vous pouvez installer des paquets supplémentaires si vous en avez besoin, avec guix package (see Invoquer guix package).

Disposition du clavier
......................

L'image d'installation utilise la disposition clavier qwerty (US).  Si vous voulez la changer, vous pouvez utiliser la commande loadkeys.  Par exemple, la commande suivante sélectionne la disposition Dvorak :

     loadkeys dvorak

Consultez les fichiers dans /run/current-system/profile/share/keymaps pour trouver une liste des dispositions disponibles.  Lancez man loadkey pour plus d'informations.

Réseau
......

Run the following command to see what your network interfaces are called:

     ifconfig -a

... ou, avec la commande spécifique à GNU/Linux ip :

     ip a

Les interfaces filaires ont un nom qui commence par e ; par exemple, l'interface qui correspond au premier contrôleur Ethernet sur la carte mère est appelé eno1.  Les interfaces sans-fil ont un nom qui commence par w, comme w1p2s0.

Connexion filaire
     Pour configure une connexion filaire, lancez la commande suivante, en remplaçant INTERFACE par le nom de l'interface filaire que vous voulez utiliser.

          ifconfig INTERFACE up

Connexion sans-fil
     Pour configurer le réseau sans-fil, vous pouvez créer un fichier de configuration pour l'outil de configuration wpa_supplicant (son emplacement importe peu) avec l'un des éditeurs de texte disponibles comme nano :

          nano wpa_supplicant.conf

     Par exemple, la déclaration qui suit peut aller dans ce fichier et fonctionnera pour plusieurs réseaux sans-fil, si vous donnez le vrai SSID et la phrase de passe pour le réseau auquel vous vous connectez :

          network={
            ssid="MON-SSID"
            key_mgmt=WPA-PSK
            psk="la phrase de passe secrète du réseau"
          }

     Démarrez le service sans-file et lancez-le en tache de fond avec la commande suivante (en remplaçant INTERFACE par le nom de l'interface réseau que vous voulez utiliser) :

          wpa_supplicant -c wpa_supplicant.conf -i INTERFACE -B

     Lancez man wpa_supplicant pour plus d'informations.

À partir de ce moment, vous avez besoin d'une adresse IP.  Sur les réseaux où les IP sont automatiquement attribuée par DHCP, vous pouvez lancer :

     dhclient -v INTERFACE

Essayez de pinger un serveur pour voir si le réseau fonctionne :

     ping -c 3 gnu.org

Mettre en place un accès réseau est presque toujours une nécessité parce que l'image ne contient pas tous les logiciels et les outils dont vous pourriez avoir besoin.

Si vous le souhaitez, vous pouvez continuer l'installation à distance en démarrant un serveur SSH :

     herd start ssh-daemon

Assurez-vous soit de définir un mot de passe avec passwd, soit de configurer l'authentification par clef OpenSSH avant de vous connecter.

Partitionnement
...............

À moins que vous ne l'ayez déjà fait, l'étape suivante consiste à partitionner le disque puis à formater les partitions cibles.

L'image d'installation inclus plusieurs outils de partitionnement, dont Parted (see Overview (GNU Parted User Manual)), fdisk, et cfdisk.  Lancez-en un et paramétrez votre disque avec le partitionnement qui vous convient :

     cfdisk

Si votre disque utilise le format des tables de partitions GUID (GPT) et que vous souhaitez installer un GRUB pour système BIOS (c'est le cas par défaut), assurez-vous de créer qu'une partition de démarrage BIOS soit bien disponible (see BIOS installation (GNU GRUB manual)).

Si vous souhaitez à la place utilise GRUB pour système EFI, vous devrez avoir une partition système EFI (ESP) en FAT32.  Cette partition devrait être montée dans /boot/efi et doit avoir le drapeau esp.  P. ex. pour 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

Une fois cela effectué, montez le système de fichier cible dans /mnt avec une commande comme (de nouveau, en supposant que my-root est l'étiquette du système de fichiers racine) :

     mount LABEL=my-root /mnt

Montez aussi tous les systèmes de fichiers que vous voudriez utiliser sur le système cible relativement à ce chemin.  Si vous avez un /boot sur une partition séparé par exemple, montez-le sur /mnt/boot maintenant pour qu'il puisse être trouvé par guix system init ensuite.

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

Autrement, vous pouvez utiliser un fichier de swap.  Par exemple, en supposant que dans le nouveau système vous voulez utiliser le fichier /swapfile comme fichier de swap, vous lanceriez (Cet exemple fonctionnera sur plusieurs types de systèmes de fichiers (p. ex. ext4). Cependant, pour les systèmes de fichiers qui utilisent la copie sur écriture (COW) comme btrfs, les étapes requises peuvent varier.  Pour plus de détails, regardez les pages de manuel de mkswap et swapon.) :

     # Cela représente 10 Gio d'espace d'échange. Ajustez « count » pour changer la taille.
     dd if=/dev/zero of=/mnt/swapfile bs=1MiB count=10240
     # Par sécurité, laissez le fichier en lecture et en écriture uniquement pour root.
     chmod 600 /mnt/swapfile
     mkswap /mnt/swapfile
     swapon /mnt/swapfile

Remarquez que si vous avez chiffré la partition racine et créé un fichier d'échange dans son système de fichier comme décrit ci-dessus, alors le chiffrement protégera aussi le fichier d'échange, comme n'importe quel fichier de ce système de fichiers.

Effectuer l'installation
------------------------

Lorsque la partition cible est prête et que les autres partitions sont montées, on est prêt à commencer l'installation.  Commencez par :

     herd start cow-store /mnt

Cela rend /gnu/store capable de faire de la copie sur écriture, de sorte que les paquets ajoutés pendant l'installation sont écrits sur le disque cible sur /mnt plutôt que gardés en mémoire.  Cela est nécessaire parce que la première phase de la commande guix system init (voir plus bas) implique de télécharger ou de construire des éléments de /gnu/store qui est initialement un système de fichiers en mémoire.

Ensuite, vous devrez modifier un fichier et fournir la déclaration du système à installer.  Pour cela, le système d'installation propose trois éditeurs de texte.  Nous recommandons GNU nano (see GNU nano Manual), qui supporte la coloration syntaxique la correspondance de parenthèses ; les autres éditeurs sont GNU Zile (un clone d'Emacs) et nvi (un clone de l'éditeur vi original de BSD).  Nous recommandons vivement de stocker ce fichier sur le système de fichier racine cible, disons en tant que /mnt/etc/config.scm.  Sinon, vous perdrez votre fichier de configuration une fois que vous aurez redémarré sur votre nouveau système.

See Utiliser le système de configuration, pour un aperçu de comment créer votre fichier de configuration.  Les exemples de configuration dont on parle dans cette section sont disponibles dans /etc/configuration sur l'image d'installation.  Ainsi, pour commencer avec une configuration du système qui fournit un serveur d'affichage graphique (un système de « bureau »), vous pouvez lancer ce qui suit :

     # mkdir /mnt/etc
     # cp /etc/configuration/desktop.scm /mnt/etc/config.scm
     # nano /mnt/etc/config.scm

Vous devriez faire attention à ce que contient votre fichier de configuration, en particulier :

  * Assurez-vous que la forme bootloader-configuration se réfère à la cible où vous voulez installer GRUB.  Elle devrait aussi mentionner grub-bootloader si vous installer GRUB en mode BIOS (ou « legacy ») ou grub-efi-bootloader pour les système UEFI plus récents.  Pour les anciens systèmes, le champs target contient un périphérique comme /dev/sda ; pour les systèmes UEFI il contient un chemin vers une partition EFI montée, comme /boot/efi, et assurez-vous que ce chemin est bien monté.

  * 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 uses the file-system-label procedure in its device field.

  * Si vous avez des partitions RAID ou chiffrées, assurez-vous d'ajouter un champ mapped-device pour les décrire (see Périphériques mappés).

Une fois que vous avez fini les préparatifs sur le fichier de configuration, le nouveau système peut être initialisé (rappelez-vous que le système de fichiers racine cible est dans /mnt) :

     guix system init /mnt/etc/config.scm /mnt

Cela copie tous les fichiers nécessaires et installe GRUB sur /dev/sdX à moins que vous ne passiez l'option --no-bootloader.  Pour plus d'informations, see Invoquer guix system.  Cette commande peut engendrer des téléchargements ou des constructions pour les paquets manquants, ce qui peut prendre du temps.

Une fois que cette commande a terminée — et on l'espère réussi ! — vous pouvez lancer reboot et démarrer sur votre nouveau système.  Le mot de passe root est d'abord vide ; les mots de passe des autres utilisateurs doivent être initialisés avec la commande passwd en tant que root, à mois que votre configuration ne spécifie autre chose (see mot de passe des comptes utilisateurs).

À partir de maintenant, vous pouvez mettre à jour GuixSD lorsque vous le souhaitez en lançant guix pull en tant que root (see Invoquer guix pull), puis en lançant guix system reconfigure pour construire une nouvelle génération du système avec les derniers paquets et les derniers services (see Invoquer guix system). Nous vous recommandons de le faire régulièrement pour que votre système inclus les dernières mises à jour de sécurité (see Mises à jour de sécurité).

Rejoignez-nous sur #guix sur le réseau IRC Freenode ou sur guix-devel@gnu.org pour partager votre expérience — bonne ou mauvaise.

Installer GuixSD sur une machine virtuelle
------------------------------------------

Si vous souhaitez installer GuixSD sur une machine virtuelle (VM) ou un serveur privé virtuel (VPS) plutôt que sur votre machine chérie, cette section est faite pour vous.

Pour démarrer une VM QEMU (http://qemu.org/) pour installer GuixSD sur une image disque, suivez ces étapes :

 1. Tout d'abord récupérez et décompressez l'image d'installation de GuixSD comme décrit précédemment (see Installation depuis une clef USB ou un DVD).

 2. Créez une image disque qui contiendra le système installé.  Pour créer une image qcow2, utilise la commande qemu-img :

          qemu-img create -f qcow2 guixsd.img 50G

     Le fichier qui en résulte sera bien plus petit que les 50 Go (habituellement moins de 1 Mo) mais il grossira au fur et à mesure que le stockage virtuel grossira.

 3. Démarrez l'image d'installation USB dans une 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

     L'ordre des périphérique est important

     Dans la console de la VM, appuyez rapidement sur F12 pour entrer dans le menu de démarrage.  Ensuite appuyez sur 2 et la touche Entrée pour valider votre choix.

 4. Vous êtes maintenant root dans la VM, continuez en suivant la procédure d'installation.  See Préparer l'installation, et suivez les instructions.

Une fois l'installation terminée, vous pouvez démarrer le système dans votre image guixsd.img.  See Lancer GuixSD dans une VM, pour une manière de faire.

Construire l'image d'installation
---------------------------------

L'image d'installation décrite plus haut a été construite avec la commande guix system, plus précisément :

     guix system disk-image gnu/system/install.scm

Regardez le fichier gnu/system/install.scm dans l'arborescence des sources et regardez aussi Invoquer guix system pour plus d'informations sur l'image d'installation.

Construire l'image d'installation pour les cartes ARM
-----------------------------------------------------

De nombreuses cartes ARM requièrent une variante spécifique du chargeur d'amorçage U-Boot (http://www.denx.de/wiki/U-Boot/).

Si vous construisez une image disque et que le chargeur d'amorçage n'est pas disponible autrement (sur un autre périphérique d'amorçage etc), il est recommandé de construire une image qui inclus le chargeur d'amorçage, plus précisément :

     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 est le nom de la carte.  Si vous spécifiez une carte invalide, une liste de cartes possibles sera affichée.

Configuration système
=====================

La distribution système Guix utilise un mécanisme de configuration du système cohérent.  On veut dire par là que tous les aspects de la configuration globale du système — comme la disponibilité des services système, des fuseaux horaires, des paramètres linguistiques, des comptes utilisateurs — sont déclarés à un seul endroit.  Une telle configuration système peut être instanciée, c'est-à-dire entrer en vigueur.

L'un des avantages de placer toute la configuration du système sous le contrôle de Guix est de permettre les mises à jour transactionnelles du système ce qui rend possible le fait de revenir en arrière à une instanciation précédent du système, si quelque chose se passait mal avec le nouveau (see Fonctionnalités).  Un autre avantage est de rendre facile la réplication de la même configuration sur plusieurs machines différentes ou à différents moments dans le temps, sans avoir à recourir à des outils d'administrations supplémentaires au-dessus des outils du système.

Cette section décrit ce mécanisme.  Tout d'abord nous nous concentrons sur le point de vue de l'administrateur système en expliquant comment le système est configuré et instancié.  Ensuite nous montrons comment ce mécanisme peut être étendu, par exemple pour supporter de nouveaux services systèmes.

Utiliser le système de configuration
------------------------------------

Le système d'exploitation est configuré en fournissant une déclaration operating-system dans un fichier qui peut être passé à la command guix system (see Invoquer guix system).  Une configuration simple, avec les services systèmes par défaut, le noyau Linux-Libre par défaut, un disque de RAM initial et un chargeur d'amorçage ressemble à ceci :

          [file os-config-bare-bones.texi not included]

Cet exemple devrait se comprendre de lui-même.  Certains champs définis ci-dessus, comme host-name et bootloader sont obligatoires. D'autres comme packages et services peuvent être omis auquel cas ils ont une valeur par défaut.

Ci-dessous nous discutons des effets de certains des champs les plus importants (see Référence de système d'exploitation, pour des détails sur tous les champs disponibles) et comment instancier le système d'exploitation avec 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.

Paquets visibles sur tout le système
....................................

Le champ packages liste les paquets qui seront visibles sur tout le système, pour tous les comptes utilisateurs — c.-à-d. dans la variable d'environnement PATH de tous les utilisateurs — en plus des paquets par profil (see Invoquer guix package).  La variable %BASE-PACKAGES fournit tous les outils qu'on pourrait attendre pour les taches de base de l'administrateur et de l'utilisateur — dont les GNU Core Utilities, les GNU Networking Utilities, l'éditeur de texte léger GNU Zile, find, grep, etc.  L'exemple au-dessus ajout GNU Screen et OpenSSH à ces paquets, récupérés depuis les modules (gnu packages screen) et (gnu packages ssh) (see Modules de paquets).  La syntaxe (list paquet sortie) peut être utilisée pour ajouter une sortie spécifique d'un paquet :

     (use-modules (gnu packages))
     (use-modules (gnu packages dns))

     (operating-system
       ;; ...
       (packages (cons (list bind "utils")
                       %base-packages)))

Se référer aux paquets par le nom de leur variable, comme bind ci-dessus, a l'avantage d'être sans ambiguïté ; cela permet aussi de se rendre rapidement compte de coquilles quand on a des « variables non liées ».  L'inconvénient est qu'on a besoin de savoir dans quel module est défini le paquet, et de modifier la ligne use-package-modules en conséquence.  Pour éviter cela, on peut utiliser la procédure specification->package du module (gnu packages), qui renvoie le meilleur paquet pour un nom donné ou un nom et une version :

     (use-modules (gnu packages))

     (operating-system
       ;; ...
       (packages (append (map specification->package
                              '("tcpdump" "htop" "gnupg@2.0"))
                         %base-packages)))

Services systèmes
.................

Le champ services liste les services système à rendre disponible lorsque le système démarre (see Services).  La déclaration operating-system au-dessus spécifie que, en plus des services de base, on veut que le démon ssh lshd écoute sur le port 2222 (see lsh-service).  Sous le capot, lsh-service s'arrange pour que lshd soit lancé avec les bonnes options de la ligne de commande, éventuellement en générant des fichiers de configuration (see Définir des services).

Parfois, plutôt que d'utiliser les services de base tels-quels, on peut vouloir les personnaliser.  Pour cela, utilisez  modify-services (see modify-services) pour modifier la liste.

Par exemple, supposons que vous souhaitiez modifier guix-daemon et Mingetty (l'écran de connexion en console) dans la liste %BASE-SERVICES (see %base-services).  Pour cela, vous pouvez écrire ce qui suit dans votre déclaration de système d'exploitation :

     (define %my-services
       ;; Ma propre liste de 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))

Cela modifie la configuration — c.-à-d. les paramètres du service — de l'instance de guix-service-type, et de toutes les instances de mingetty-service-type dans la liste %BASE-SERVICES.  Remarquez comment on fait cela : d'abord, on s'arrange pour que la configuration de départ soit liée à l'identifiant config dans BODY puis on écrit BODY pour qu'il s'évalue en la configuration désirée.  En particulier, remarquez comment on utilise inherit pour créer une nouvelle configuration qui a les même valeurs que l'ancienne configuration, avec seulement quelques modifications.

La configuration pour une utilisation de « bureau » typique, avec une partition racine chiffrée, le serveur d'affichage X11, GNOME et Xfce (les utilisateurs peuvent choisir l'environnement de bureau sur l'écran de connexion en appuyant sur F1), la gestion du réseau, la gestion de l'énergie, et bien plus, ressemblerait à ceci :

          [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]

Cet exemple se réfère au système de fichier /boot/efi par son UUID, 1234-ABCD.  Remplacez cet UUID par le bon UUID de votre système, renvoyé par la commande blkid.

See Services de bureaux, pour la liste exacte des services fournis par %DESKTOP-SERVICES.  See Certificats X.509, pour des informations sur le paquet nss-certs utilisé ici.

Encore une fois, %DESKTOP-SERVICES n'est qu'une liste d'objets service.  Si vous voulez en supprimer des services, vous pouvez le faire avec des procédures pour les listes (see SRFI-1 Filtering and Partitioning (GNU Guile Reference Manual)).  Par exemple, l'expression suivante renvoie une liste qui contient tous les services dans %DESKTOP-SERVICES sauf le service Avahi :

     (remove (lambda (service)
               (eq? (service-kind service) avahi-service-type))
             %desktop-services)

Instancier le système
.....................

En supposant que la déclaration operating-system est stockée dans le fichier my-system-config.scm, la commande guix system reconfigure my-system-config.scm instancie cette configuration et en fait l'entrée par défaut dans GRUB (see Invoquer guix system).

Pour changer la configuration du système, on met normalement à jour ce fichier et on relance guix system reconfigure.  On ne devrait jamais avoir à modifier de fichiers dans /etc ou à lancer des commandes qui modifient l'état du système comme useradd ou grub-install.  En fait, vous devez les éviter parce que non seulement ça annulerait vos garanties, mais ça empêcherait aussi de revenir à des versions précédents du système, si vous en avez besoin.

En parlant de revenir en arrière, à chaque fois que vous lancez guix system reconfigure, une nouvelle génération du système est crée — sans modifier ou supprimer les générations précédentes.  Les anciennes générations du système ont une entrée dans le menu du chargeur d'amorçage, ce qui vous permet de démarrer dessus au cas où quelque chose se serait mal passé avec la dernière génération.  C'est rassurant, non ?  La commande guix system list-generations liste les générations du système disponibles sur le disque.  Il est possible de revenir à une ancienne génération via les commandes guix system roll-back et guix system switch-generation.

Although the guix system reconfigure command will not modify previous generations, you 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).

L'interface de programmation
............................

Au niveau Scheme, la grosse déclaration operating-system est instanciée avec la procédure monadique suivante (see La monad du dépôt) :

 -- Procédure Monadique: operating-system-derivation os
     Renvoie une dérivation qui construit OS, un objet operating-system (see Dérivations).

     La sortie de la dérivation est un répertoire qui se réfère à tous les paquets et d'autres fichiers supports requis pour instancier OS.

Cette procédure est fournie par le module (gnu system).  Avec (gnu srevices) (see Services), ce module contient les entrailles de GuixSD.  Ouvrez-le un jour !

Référence de operating-system
-----------------------------

Cette section résume toutes les options disponibles dans les déclarations operating-system (see Utiliser le système de configuration).

 -- Type de données: operating-system
     C'est le type de données représentant une configuration d'un système d'exploitation.  On veut dire par là toute la configuration globale du système, mais pas la configuration par utilisateur (see Utiliser le système de configuration).

     kernel (par défaut : LINUX-LIBRE)
          L'objet paquet d'un noyau de système d'exploitation à utiliser (Actuellement seul le noyau Linux-libre est supporté.  Dans le futur, il sera possible d'utiliser GNU Hurd.).

     kernel-arguments (par défaut : '())
          Liste de chaînes ou de gexps représentant des arguments supplémentaires à passer sur la ligne de commande du noyau — p. ex. ("console=ttyS0").

     bootloader
          L'objet de configuration du chargeur d'amorçage.  See Configuration du chargeur d'amorçage.

     initrd-modules (par défaut : %base-initrd-modules)
          La liste des modules du noyau linux requis dans l'image disque de RAM initiale.  See Disque de RAM initial.

     initrd (par défaut : base-initrd)
          Une procédure monadique qui renvoie un disque de RAM initial pour le noyau Linux.  Ce champ est fournit pour pouvoir personnaliser son système à bas-niveau et n'est que rarement utile dans le cas général.  See Disque de RAM initial.

     firmware (par défaut : %BASE-FIRMWARE)
          Liste les paquets de microgiciels chargeables pour le noyau de système d'exploitation.

          La valeur par défaut contient les microgiciels requis pour les périphériques WiFi Atheros et Broadcom (modules ath9k et b43-open de Linux-libre, respectivement).  See Considérations matérielles, pour plus d'info sur les périphériques supportés.

     host-name
          Le nom d'hôte.

     hosts-file
          Un objet simili-fichier (see file-like objects) à utiliser comme /etc/hosts (see Host Names (The GNU C Library Reference Manual)).  La valeur par défaut est un fichier avec des entrées pour localhost et HOST-NAME.

     mapped-devices (par défaut : '())
          Une liste de périphériques mappés.  See Périphériques mappés.

     file-systems
          Une liste de systèmes de fichiers.  See Systèmes de fichiers.

     swap-devices (par défaut : '())
          Une liste de chaînes identifiant les périphériques ou les fichiers utilisé pour « l'espace d'échange » (see Memory Concepts (The GNU C Library Reference Manual)).  Par exemple, '("/dev/sda3") ou '("/swapfile").  Il est possible de spécifier un fichier d'échange sur un périphérique mappé, tant que le périphérique nécessaire et le système de fichiers sont aussi spécifiés.  See Périphériques mappés et Systèmes de fichiers.

     users (par défaut : %base-user-accounts)
     groups (par défaut : %BASE-GROUPS)
          Liste les comptes utilisateurs et les groupes.  See Comptes utilisateurs.

          Si la liste users n'a pas de compte lié à l'UID 0, un compte « root » avec l'UID 0 est automatiquement ajouté.

     skeletons (par défaut : (default-skeletons))
          Une liste de couples composés d'un nom de fichier cible et d'un objet simili-fichier (see file-like objects).  Ce sont les fichiers squelettes qui seront ajoutés au répertoire personnel des comptes utilisateurs nouvellement créés.

          Par exemple, un valeur valide ressemblerait à cela :

               `((".bashrc" ,(plain-file "bashrc" "echo Hello\n"))
                 (".guile" ,(plain-file "guile"
                                        "(use-modules (ice-9 readline))
                                         (activate-readline)")))

     issue (par défaut : %DEFAULT-ISSUE)
          Une chaîne qui dénote le contenu du fichier /etc/issue qui est affiché lorsqu'un utilisateur se connecte sur la console.

     packages (par défaut : %BASE-PACKAGES)
          L'ensemble des paquets installés dans le profil global, qui est accessible à partir de /run/current-system/profile.

          L'ensemble par défaut contient les utilitaires de base et c'est une bonne pratique d'installer les utilitaires non essentiels dans les profils utilisateurs (see Invoquer guix package).

     timezone
          Une chaîne identifiant un fuseau horaire — p. ex. "Europe/Paris".

          Vous pouvez lancer la commande tzselect pour trouver le fuseau horaire correspondant à votre région.  Si vous choisissez un nom de fuseau horaire invalide, guix system échouera.

     locale (par défaut : "en_US.utf8")
          Le nom du paramètre régional par défaut (see Locale Names (The GNU C Library Reference Manual)).  See Régionalisation, pour plus d'informations.

     locale-definitions (par défaut : %DEFAULT-LOCALE-DEFINITIONS)
          La liste des définitions de locales à compiler et qui devraient être utilisées à l'exécution.  See Régionalisation.

     locale-libcs (par défaut : (list GLIBC))
          La liste des paquets GNU libc dont les données des paramètres linguistiques sont utilisées pour construire les définitions des paramètres linguistiques.  See Régionalisation, pour des considérations sur la compatibilité qui justifient cette option.

     name-service-switch (par défaut : %DEFAULT-NSS)
          La configuration de NSS de la libc (name service switch) — un objet <name-service-switch>.  See Name Service Switch, pour des détails.

     services (par défaut : %BASE-SERVICES)
          Une liste d'objets services qui dénotent les services du système. See Services.

     pam-services (par défaut : (base-pam-services))
          Services PAM (pluggable authentication module) Linux.

     setuid-programs (par défaut : %SETUID-PROGRAMS)
          Liste de G-expressions qui s'évaluent en chaînes de caractères qui dénotent les programmes setuid.  See Programmes setuid.

     sudoers-file (par défaut : %SUDOERS-SPECIFICATION)
          Le contenu du fichier /etc/sudoers comme un objet simili-fichier (see local-file et plain-file).

          Ce fichier spécifier quels utilisateurs peuvent utiliser la commande sudo, ce qu'ils ont le droit de faire, et quels privilèges ils peuvent gagner.  La valeur par défaut est que seul root et les membres du groupe wheel peuvent utiliser sudo.

Systèmes de fichiers
--------------------

La liste des systèmes de fichiers à monter est spécifiée dans le champ file-systems de la déclaration de système d'exploitation (see Utiliser le système de configuration).  Chaque système de fichier est déclaré avec la forme file-system, comme ceci :

     (file-system
       (mount-point "/home")
       (device "/dev/sda3")
       (type "ext4"))

Comme d'habitude, certains de ces champs sont obligatoire — comme le montre l'exemple au-dessus — alors que d'autres peuvent être omis.  Ils sont décrits plus bas.

 -- Type de données: file-system
     Les objets de ce type représentent des systèmes de fichiers à monter.  Ils contiennent les membres suivants :

     type
          C'est une chaîne de caractères spécifiant le type du système de fichier — p. ex. "ext4".

     mount-point
          Désigne l'emplacement où le système de fichier sera monté.

     device
          Ce champ nomme le système de fichier « source ».  il peut être l'une de ces trois choses : une étiquette de système de fichiers, un UUID de système de fichier ou le nom d'un nœud dans /dev.  Les étiquettes et les UUID offrent une manière de se référer à des systèmes de fichiers sans avoir à coder en dur le nom de périphérique (Remarquez que, s'il est tentant d'utiliser /dev/disk/by-uuid et autres chemins similaires pour obtenir le même résultat, ce n'est pas recommandé : ces nœuds de périphériques spéciaux sont créés par le démon udev et peuvent ne pas être disponibles au moment de monter le périphérique.).

          Les étiquettes de systèmes de fichiers sont crées avec la procédure file-system-label, les UUID avec uuid et les nœuds de /dev sont de simples chaînes de caractères.  Voici un exemple d'un système de fichiers référencé par son étiquette, donnée par la commande e2label :

               (file-system
                 (mount-point "/home")
                 (type "ext4")
                 (device (file-system-label "my-home")))

          Les UUID sont convertis à partir de leur représentation en chaîne de caractères (montrée par la command tune2fs -l) en utilisant la forme uuid (La forme uuid s'attend à des UUID sur 16 octets définis dans la RFC 4122 (https://tools.ietf.org/html/rfc4122).  C'est la forme des UUID utilisées par la famille de systèmes de fichiers ext2 et d'autres, mais ce n'est pas le même type d'UUID que ceux qui se trouvent sur les systèmes de fichiers FAT par exemple), comme ceci :

               (file-system
                 (mount-point "/home")
                 (type "ext4")
                 (device (uuid "4dab5feb-d176-45de-b287-9b0a6e4c01cb")))

          Lorsque la source d'un système de fichiers est un périphérique mappé (see Périphériques mappés), sont champ device doit se référer au nom du périphérique mappé — p. ex. "/dev/mapper/root-partition". Cela est requis pour que le système sache que monter ce système de fichier dépend de la présence du périphérique mappé correspondant.

     flags (par défaut : '())
          C'est une liste de symboles qui dénotent des drapeaux de montage.  Les drapeaux reconnus sont read-only, bind-mount, no-dev (interdit l'accès aux fichiers spéciaux), no-suid (ignore les bits setuid et setgid) et no-exec (interdit l'exécution de programmes).

     options (par défaut : #f)
          C'est soit #f soit une chaîne de caractères dénotant des options de montage.

     mount? (par défaut : #t)
          Cette valeur indique s'il faut monter automatiquement le système de fichier au démarrage du système.  Lorsque la valeur est #f, le système de fichier reçoit une entrée dans /etc/fstab (lue par la commande mount) mais n'est pas monté automatiquement.

     needed-for-boot? (par défaut : #f)
          Cette valeur booléenne indique si le système de fichier est nécessaire au démarrage.  Si c'est vrai alors le système de fichier est monté au chargement du disque de RAM initial.  C'est toujours le cas par exemple du système de fichiers racine.

     check? (par défaut : #t)
          Cette valeur booléenne indique si le système de fichier doit être vérifié avant de le monter.

     create-mount-point? (par défaut : #f)
          Lorsque cette valeur est vraie, le point de montage est créé s'il n'existe pas déjà.

     dependencies (par défaut : '())
          C'est une liste d'objets <file-system> ou <mapped-device> qui représentent les systèmes de fichiers qui doivent être montés ou les périphériques mappés qui doivent être ouverts avant (et monté ou fermés après) celui-ci.

          Par exemple, considérons une hiérarchie de montage : /sys/fs/cgroup est une dépendance de /sys/fs/cgroup/cpu et /sys/fs/cgroup/memory.

          Un autre exemple est un système de fichier qui dépend d'un périphérique mappé, par exemple pour une partition chiffrée (see Périphériques mappés).

Le module (gnu system file-systems) exporte les variables utiles suivantes.

 -- Variable Scheme: %base-file-systems
     Ce sont les systèmes de fichiers essentiels qui sont requis sur les systèmes normaux, comme %PSEUDO-TERMINAL-FILE-SYSTEM et %IMMUTABLE-STORE (voir plus bas).  Les déclarations de systèmes d'exploitation devraient au moins les contenir.

 -- Variable Scheme: %pseudo-terminal-file-system
     C'est le système de fichier monté sur /dev/pts.  Il supporte les pseudo-terminaux créés via openpty et les fonctions similaires (see Pseudo-Terminals (The GNU C Library Reference Manual)).  Les pseudo-terminaux sont utilisés par les émulateurs de terminaux comme xterm.

 -- Variable Scheme: %shared-memory-file-system
     Ce système de fichier est monté dans /dev/shm et est utilisé pour le partage de mémoire entre processus (see shm_open (The GNU C Library Reference Manual)).

 -- Variable Scheme: %immutable-store
     Ce système de fichiers effectue un « montage lié » en lecture-seule de /gnu/store, ce qui en fait un répertoire en lecture-seule pour tous les utilisateurs dont root.  Cela évite que des logiciels qui tournent en root ou des administrateurs systèmes ne modifient accidentellement le dépôt.

     Le démon lui-même est toujours capable d'écrire dans le dépôt : il est remonté en lecture-écriture dans son propre « espace de nom ».

 -- Variable Scheme: %binary-format-file-system
     Le système de fichiers binfmt_misc, qui permet de gérer n'importe quel type de fichiers exécutables à déléguer en espace utilisateur.  Cela demande que le module du noyau binfmt.ko soit chargé.

 -- Variable Scheme: %fuse-control-file-system
     Le système de fichiers fusectl, qui permet à des utilisateurs non privilégiés de monter et de démonter des systèmes de fichiers FUSE en espace utilisateur.  Cela requiert que le module du noyau fuse.ko soit chargé.

Périphériques mappés
--------------------

Le noyau Linux a une notion de mappage de périphériques : un périphérique bloc, comme une partition sur un disque dur, peut être mappé sur un autre périphérique, typiquement dans /dev/mapper, avec des calculs supplémentaires sur les données qui naviguent entre les deux (Remarquez que le Hurd ne fait pas de différence entre le concept de « périphérique mappé » et celle d'un système de fichiers : les deux correspondent à la traduction des opérations d'entrée-sortie faites sur un fichier en des opérations sur ce qui le contient.  Ainsi, le Hurd implémente les périphériques mappés, comme les systèmes de fichiers, avec le mécanisme des traducteurs générique (see Translators (The GNU Hurd Reference Manual)).).  Un exemple typique est le mappage de périphériques chiffrés : toutes les écritures sont sur le périphérique mappé sont chiffrées, toutes les lectures déchiffrées, de manière transparente.  Guix étend cette notion en considérant que tout périphérique ou ensemble de périphériques qui sont transformés d'une certaine manière créent un nouveau périphérique ; par exemple, les périphériques RAID sont obtenus en assemblant plusieurs autres périphériques, comme des disque ou des partitions, en un nouveau périphérique en tant qu'unique partition.  Un autre exemple, qui n'est pas encore disponible, sont les volumes logiques LVM.

Les périphériques mappés sont déclarés avec la forme mapped-device, définie comme suit ; par exemple, voir ci-dessous.

 -- Type de données: mapped-device
     Les objets de ce type représentent des mappages de périphériques qui seront effectués au démarrage du système.

     source
          C'est soit une chaîne qui spécifie le nom d'un périphérique bloc à mapper, comme "/dev/sda3", soit une liste de plusieurs périphériques à assembler pour en créer un nouveau.

     target
          Cette chaîne spécifie le nom du périphérique mappé qui en résulte.  Pour les mappeurs noyaux comme les périphériques chiffrés de type luks-device-mapping, spécifier "ma-partition" crée le périphérique "/dev/mapper/ma-partition".  Pour les périphériques RAID de type raid-device-mapping, il faut donner le nom complet comme "/dev/md0".

     type
          Ce doit être un objets mapped-device-kind, qui spécifie comment SOURCE est mappés sur TARGET.

 -- Variable Scheme: luks-device-mapping
     Cela définie les périphériques blocs chiffrés en LUKS avec cryptsetup du paquet du même nom.  Elle s'appuie sur le module du noyau Linux dm-crypt.

 -- Variable Scheme: raid-device-mapping
     Cela définie un périphérique RAID qui est assemblé avec la commande mdadm du paquet du même nom.  Elle nécessite un module noyau Linux approprié pour le niveau RAID chargé, comme raid456 pour RAID-4, RAID-5 et RAID-6 ou raid10 pour RAID-10.

L'exemple suivant spécifie un mappage de /dev/sda3 vers /dev/mapper/home avec LUKS — Linux Unified Key Setup (https://gitlab.com/cryptsetup/cryptsetup), un mécanisme standard pour chiffrer les disques.  Le périphérique /dev/mapper/home peut ensuite être utilisé comme device d'une déclaration file-system (see Systèmes de fichiers).

     (mapped-device
       (source "/dev/sda3")
       (target "home")
       (type luks-device-mapping))

Autrement, pour devenir indépendant du numéro de périphérique, on peut obtenir l'UUID LUKS (l'identifiant unique) du périphérique source avec une commande comme :

     cryptsetup luksUUID /dev/sda3

et l'utiliser ainsi :

     (mapped-device
       (source (uuid "cb67fc72-0d54-4c88-9d4b-b225f30b0f44"))
       (target "home")
       (type luks-device-mapping))

Il est aussi désirable de chiffrer l'espace d'échange, puisque l'espace d'échange peut contenir des données sensibles.  Une manière de faire cela est d'utiliser un fichier d'échange dans un système de fichiers sur un périphérique mappé avec un chiffrement LUKS.  De cette manière, le fichier d'échange est chiffré parce que tout le périphérique est chiffré. See Disk Partitioning, pour un exemple.

Un périphérique RAID formé des partitions /dev/sda1 et /dev/sdb1 peut être déclaré ainsi :

     (mapped-device
       (source (list "/dev/sda1" "/dev/sdb1"))
       (target "/dev/md0")
       (type raid-device-mapping))

Le périphérique /dev/md0 peut ensuite être utilisé comme device d'une déclaration file-system (see Systèmes de fichiers). Remarquez que le niveau de RAID n'a pas besoin d'être donné ; il est choisi pendant la création initiale du périphérique RAID et est ensuite déterminé automatiquement.

Comptes utilisateurs
--------------------

Les comptes utilisateurs et les groupes sont gérés entièrement par la déclaration operating-system.  Ils sont spécifiés avec les formes user-account et user-group :

     (user-account
       (name "alice")
       (group "users")
       (supplementary-groups '("wheel"   ;permet d'utiliser sudo, etc.
                               "audio"   ;carte son
                               "video"   ;périphériques réseaux comme les webcams
                               "cdrom")) ;le bon vieux CD-ROM
       (comment "Bob's sister")
       (home-directory "/home/alice"))

Lors du démarrage ou à la fin de guix system reconfigure, le système s'assure que seuls les comptes utilisateurs et les groupes spécifiés dans la déclaration operating-system existent, et avec les propriétés spécifiées.  Ainsi, les modifications ou les créations de comptes ou de groupes effectuées directement en invoquant des commandes comme useradd sont perdue à la reconfiguration ou au redémarrage.  Cela permet de s'assurer que le système reste exactement tel que déclaré.

 -- Type de données: user-account
     Les objets de se type représentent les comptes utilisateurs.  Les membres suivants peuvent être spécifiés :

     name
          Le nom du compte utilisateur.

     group
          C'est le nom (une chaîne) ou un identifiant (un nombre) du groupe utilisateur auquel ce compte appartient.

     supplementary-groups (par défaut : '())
          Éventuellement, cela peut être définie comme une liste de noms de groupes auxquels ce compte appartient.

     uid (par défaut : #f)
          C'est l'ID utilisateur de ce compte (un nombre) ou #f.  Dans ce dernier cas, le nombre est choisi automatiquement par le système à la création du compte.

     comment (par défaut : "")
          Un commentaire à propos du compte, comme le nom complet de l'utilisateur.

     home-directory
          C'est le nom du répertoire personnel du compte.

     create-home-directory? (par défaut : #t)
          Indique si le répertoire personnel du compte devrait être créé s'il n'existe pas déjà.

     shell (par défaut : Bash)
          C'est une G-expression qui dénote un nom de fichier d'un programme utilisé comme shell (see G-Expressions).

     system? (par défaut : #f)
          C'est une valeur booléenne qui indique si le compte est un compte « système ».  Les comptes systèmes sont parfois traités à part ; par exemple, les gestionnaires de connexion graphiques ne les liste pas.

     password (par défaut : #f)
          Vous laisseriez normalement ce champ à #f et initialiseriez les mots de passe utilisateurs en tant que root avec la commande passwd, puis laisseriez l'utilisateur le changer avec passwd.  Les mots de passes définis avec passwd sont bien sûr préservés après redémarrage et reconfiguration.

          Si vous voulez vraiment définir un mot de passe pour un compte, alors ce champ doit contenir le mot de passe chiffré, comme une chaîne de caractère.  See crypt (The GNU C Library Reference Manual), pour plus d'information sur le chiffrement des mots de passe et Encryption (GNU Guile Reference Manual), pour des informations sur la procédure crypt de Guile.

Les déclarations de groupes sont encore plus simple :

     (user-group (name "students"))

 -- Type de données: user-group
     C'est le type pour, hé bien, les comptes utilisateurs.  Il n'y a que quelques champs :

     name
          Le nom du groupe.

     id (par défaut : #f)
          L'identifiant du groupe (un nombre).  S'il est #f, un nouveau nombre est alloué automatiquement lorsque le groupe est créé.

     system? (par défaut : #f)
          Cette valeur booléenne indique si le groupe est un groupe « système ».  les groupes systèmes ont un numéro d'ID bas.

     password (par défaut : #f)
          Quoi, les groupes utilisateurs peuvent avoir des mots de passe ?  On dirait bien.  À moins que la valeur ne soit #f, ce champ spécifie le mot de passe du groupe.

Par simplicité, une variable liste les groupes utilisateurs de base auxquels on pourrait s'attendre :

 -- Variable Scheme: %base-groups
     C'est la liste des groupes utilisateur de base que les utilisateurs et les paquets s'attendent à trouver sur le système.  Cela comprend des groupes comme « root », « wheel » et « users », ainsi que des groupes utilisés pour contrôler l'accès à certains périphériques, comme « audio », « disk » et « cdrom ».

 -- Variable Scheme: %base-user-accounts
     C'est la liste des compte du système de base que les programmes peuvent s'attendre à trouver sur un système GNU/Linux, comme le compte « nobody ».

     Remarquez que le compte « root » n'est pas défini ici.  C'est un cas particulier et il est automatiquement ajouté qu'il soit spécifié ou non.

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

Un paramètre linguistique définie les conventions culturelles d'une langue et d'une région particulières (see Régionalisation (The GNU C Library Reference Manual)).  Chaque paramètre linguistique a un nom de la forme LANGUE_TERRITOIRE.JEUDECARACTÈRES — p. ex. fr_LU.utf8 désigne le paramètre linguistique pour le français, avec les conventions culturelles du Luxembourg, en utilisant l'encodage UTF-8.

Normalement, vous voudrez spécifier les paramètres linguistiques par défaut pour la machine en utilisant le champ locale de la déclaration operating-system (see locale).

Les paramètres régionaux choisis sont automatiquement ajoutés aux définitions des paramètres régionaux connues par le système au besoin, avec le jeu de caractères inféré à partir de son nom, p. ex. bo_CN.utf8 supposera qu'il faut utiliser le jeu de caractères UTF-8.  Des définitions supplémentaires peuvent être spécifiées dans le champ locale-definitions de operating-system — c'est utile par exemple si le jeu de caractères n'a pas été inféré à partir du nom. L'ensemble par défaut de définitions comprend certains paramètres linguistiques parmi les plus utilisés, mais pas toutes les variantes disponibles, pour gagner de la place.

Par exemple, pour ajouter les paramètres pour le frison septentrional en Allemagne, la valeur de ce champ serait :

     (cons (locale-definition
             (name "fy_DE.utf8") (source "fy_DE"))
           %default-locale-definitions)

De me, pour gagner de la place, on peut vouloir lister dans locale-definitions seulement les paramètres qui sont vraiment utilisés, comme dans :

     (list (locale-definition
             (name "ja_JP.eucjp") (source "ja_JP")
             (charset "EUC-JP")))

Les définitions des paramètres linguistiques compilées sont disponibles dans /run/current-system/locale/X.Y, où X.Y est la version de la libc, ce qui est l'emplacement par défaut où la GNU libc fournie par Guix cherche les données de régionalisation.  Cet emplacement peut être modifié avec la variable d'environnement LOCPATH (see LOCPATH and locale packages).

La forme locale-definition est fournie par le module (gnu system locale).  Des détails sont disponibles plus bas.

 -- Type de données: locale-definition
     C'est le type de données d'une définition de paramètres linguistiques.

     name
          Le nom du paramètre linguistique.   See Locale Names (The GNU C Library Reference Manual), pour en savoir plus sur les noms de paramètres linguistiques.

     source
          Le nom de la source pour ce paramètre linguistique.  C'est typiquement la partie LANGUE_TERRITOIRE du nom du paramètre.

     charset (par défaut : "UTF-8")
          Le « jeu de caractères » d'un paramètre linguistique, défini par l'IANA (http://www.iana.org/assignments/character-sets).

 -- Variable Scheme: %default-locale-definitions
     Une liste des paramètres linguistiques UTF-8 couramment utilisés, utilisée comme valeur par défaut pour le champ locale-definitions des déclarations operating-system.

     Ces définitions de paramètres linguistiques utilisent le jeu de caractère normalisé pour la partie qui suit le point dans le nom (see normalized codeset (The GNU C Library Reference Manual)).  Donc par exemple il y a uk_UA.utf8 mais pas, disons, uk_UA.UTF-8.

Considérations sur la compatibilité des données linguistiques
.............................................................

Les déclaration operating-system fournissent un champ locale-libcs pour spécifier les paquets GNU libc à utiliser pour compiler les déclarations de paramètres linguistiques (see Référence de système d'exploitation).  « Pourquoi je devrais m'en soucier ? », vous demandez-vous sûrement.  Hé bien il se trouve que le format binaire des données linguistique est parfois incompatible d'une version de la libc à une autre.

Par exemple, un programme lié à la libc version 2.21 est incapable de lire les données linguistiques produites par la libc 2.22 ; pire, ce programme plante plutôt que d'ignorer les données linguistiques incompatibles (Les version 2.23 et supérieures de la GNU libc sauteront simplement les données linguistiques incompatibles, ce qui est déjà mieux.).  De même, un programme lié à la libc 2.22 peut lire la plupart mais pas toutes les données linguistiques de la libc 2.21 (spécifiquement les données LC_COLLATE sont incompatibles) ; donc les appels à setlocale peuvent échouer, mais les programmes ne plantent pas.

Le « problème » avec GuixSD c'est que les utilisateurs ont beaucoup de liberté : ils peuvent choisir s'ils veulent et quand ils veulent mettre à jour les logiciels de leur profil, et peuvent utiliser une version différente de la libc de celle que l'administrateur système utilise pour construire les données linguistiques du système global.

Heureusement, les utilisateurs non privilégiés peuvent aussi installer leur propres données linguistiques et définir GUIX_LOCPATH comme il le faut (see GUIX_LOCPATH and locale packages).

Cependant, c'est encore mieux si les données linguistiques du système dans /run/current-system/locale étaient construites avec les versions de la libc utilisées sur le système, pour que tous les programmes puissent y accéder — c'est surtout crucial sur un système multi-utilisateurs.  Pour cela, l'administrateur peut spécifier plusieurs paquets de la libc dans le champ locale-libcs de operating-system :

     (use-package-modules base)

     (operating-system
       ;; ...
       (locale-libcs (list glibc-2.21 (canonical-package glibc))))

cet exemple créera un système contenant les définitions des paramètres linguistiques pour la libc 2.21 et pour la version actuelle de la libc dans /run/current-system/locale.

Services
--------

Une part importante de la préparation d'une déclaration operating-system est la liste des services systèmes et de leur configuration (see Utiliser le système de configuration).  Les services systèmes sont typiquement des démons lancés au démarrage ou d'autres actions requises à ce moment-là — p. ex. configurer les accès réseaux.

GuixSD a une définition large de « service » (see Composition de services), mais beaucoup de services sont gérés par le GNU Shepherd (see Services Shepherd).  Sur un système lancé, la commande herd vous permet de lister les services disponibles, montrer leur statut, les démarrer et les arrêter, ou faire d'autres opérations spécifiques (see Jump Start (The GNU Shepherd Manual)).  Par exemple :

     # herd status

La commande ci-dessus, lancée en root, liste les services actuellement définis.  La commande herd doc montre un synopsis du service donné :

     # herd doc nscd
     Run libc's name service cache daemon (nscd).

Les sous-commandes start, stop et restart ont l'effet auquel on s'attend.  Par exemple, les commande suivantes stoppent le service nscd et redémarrent le serveur d'affichage Xorg :

     # herd stop nscd
     Service nscd has been stopped.
     # herd restart xorg-server
     Service xorg-server has been stopped.
     Service xorg-server has been started.

Les sections suivantes documentent les services disponibles, en commençant par les services de base qui peuvent être utilisés avec une déclaration operating-system.

Services de base
................

Le module (gnu services base) fournit des définitions de services poru les services de base qu'on peut attendre du système.  Les services exportés par ce module sort listés ci-dessous.

 -- Variable Scheme: %base-services
     Cette variable contient une liste de services de base (see Types service et services, pour plus d'informations sur les objets service) qu'on peut attendre du système : un service de connexion (mingetty) sur chaque tty, syslogd, le démon de cache de noms de la libc (nscd), le gestionnaire de périphériques udev, et plus.

     C'est la valeur par défaut du champ services des déclarations operating-system.  Habituellement, lors de la personnalisation d'un système, vous voudrez ajouter des services à ceux de %BASE-SERVICES, comme ceci :

          (cons* (avahi-service) (lsh-service) %base-services)

 -- Variable Scheme: special-files-service-type
     C'est le service qui met en place des « fichiers spéciaux » comme /bin/sh ; une instance de ce service fait partie de %base-services.

     La valeur associée avec les services special-files-service-type doit être une liste de couples dont le premier élément est le « fichier spécial » et le deuxième sa cible.  Par défaut il s'agit de :

          `(("/bin/sh" ,(file-append BASH "/bin/sh")))

     Si vous voulez ajouter, disons, /usr/bin/env à votre système, vous pouvez changer cela en :

          `(("/bin/sh" ,(file-append BASH "/bin/sh"))
            ("/usr/bin/env" ,(file-append COREUTILS "/bin/env")))

     Comme il fait parti de %base-services, vous pouvez utiliser modify-services pour personnaliser l'ensemble des fichiers spéciaux (see modify-services).  Mais une manière plus simple d'ajouter un fichier spécial est d'utiliser la procédure extra-special-file (voir plus bas).

 -- Procédure Scheme: extra-special-file FILE TARGET
     Utilise TARGET comme « fichier spécial » FILE.

     Par exemple, ajouter l'une des lignes suivantes au champ services de votre déclaration de système d'exploitation crée un lien symbolique /usr/bin/env :

          (extra-special-file "/usr/bin/env"
                              (file-append coreutils "/bin/env"))

 -- Procédure Scheme: host-name-service NAME
     Renvoie un service qui paramètre le nom d'hôte à NAME.

 -- Procédure Scheme: login-service CONFIG
     Renvoie un service pour lancer login en suivant CONFIG, un objet <login-configuration> qui spécifie le message du jour, entre autres choses.

 -- Type de données: login-configuration
     Le type de données qui représente la configuration de login.

     motd
          Un objet simili-fichier contenant le « message du jour ».

     allow-empty-passwords? (par défaut : #t)
          Permet les mots de passes vides par défaut pour que les utilisateurs puissent se connecter au compte « root » la première fois après sa création.

 -- Procédure Scheme: mingetty-service CONFIG
     Renvoie un service qui lance mingetty en suivant CONFIG, un objet <mingetty-configuration>, qui spécifie le tty à lancer entre autres choses.

 -- Type de données: mingetty-configuration
     C'est le type de données représentant la configuration de Mingetty, qui fournit l'implémentation par défaut de l'écran de connexion des consoles virtuelles.

     tty
          Le nom de la console sur laquelle tourne ce Mingetty, p. ex. "tty1".

     auto-login (par défaut : #f)
          Lorsque la valeur est vraie, ce champ doit être une chaîne de caractère dénotant le nom d'utilisateur pour lequel le système se connecte automatiquement.  Lorsque la valeur est #f, il faut entrer un nom d'utilisateur et un mot de passe pour se connecter.

     login-program (par défaut : #f)
          Ce doit être soit #f, auquel cas le programme de connexion par défaut est utilisé (login de la suite d'outils Shadow), soit une gexp dénotant le nom d'un programme de connexion.

     login-pause? (par défaut : #f)
          Lorsque la valeur est #t en plus de AUTO-LOGIN, l'utilisateur devrai appuyer sur une touche avant que le shell de connexion ne soit lancé.

     mingetty (par défaut : MINGETTY)
          Le paquet Mingetty à utiliser.

 -- Procédure Scheme: agetty-service CONFIG
     Renvoie un service pour lancer agetty en suivant CONFIG, un objet <agetty-configuration>, qui spécifie le tty à lancer, entre autres choses.

 -- Type de données: agetty-configuration
     Ce type de données représente la configuration de agetty, qui implémente l'écran de connexion des consoles virtuelles et series.  Voir la page de manuel de agetty(8) pour plus d'informations.

     tty
          Le nom de la console sur laquelle agetty est lancé p. ex. "ttyS0".  Cet argument est facultatif, il aura par défaut une valeur raisonnable d'un port série utilisé par le noyau Linux.

          Pour cela, s'il y a une valeur pour une option agetty.tty sur la ligne de commande du noyau, agetty extraira le nom du périphérique du port série à partir de cette option.

          Sinon et s'il y a une valeur pour une option console avec un tty sur la ligne de commande du noyau Linux, agetty extraira le nom du périphérique du port série et l'utilisera.

          Dans les deux cas, agetty laissera les autres paramètres du périphérique série (baud, etc) sans y toucher — dans l'espoir que Linux leur a assigné les bonnes valeurs.

     baud-rate (par défaut : #f)
          Une chaîne qui contient une liste d'un ou plusieurs taux de baud séparés par des virgules, en ordre décroissant.

     term (par défaut : #f)
          Une chaîne contenant la valeur utilisée pour la variable d'environnement TERM.

     eight-bits? (par défaut : #f)
          Lorsque la valeur est #t, le tty est supposé être propre pour les caractères 8-bit et la détection de parité est désactivée.

     auto-login (par défaut : #f)
          Lorsqu'un nom de connexion est passé comme une chaîne de caractères, l'utilisateur spécifié sera automatiquement connecté sans demande du nom d'utilisateur ni du mot de passe.

     no-reset? (par défaut : #f)
          Lorsque la valeur est #t, ne vide pas les cflags du terminal (modes de contrôle).

     host (par défaut : #f)
          Cette option accepte une chaîne contenant le « login_host », qui sera écrit dans le fichier /var/run/utmpx.

     remote? (par défaut : #f)
          Lorsque la valeur est #t en plus de HOST, cette option ajoutera une option fakehost -r à la ligne de commande du programme de connexion spécifié dans LOGIN-PROGRAM.

     flow-control? (par défaut : #f)
          Lorsque la valeur est #t, active le contrôle de flux matériel (RTS/CTS).

     no-issue? (par défaut : #f)
          Lorsque la valeur est #t, le contenu du fichier /etc/issue ne sera pas affiché avant de présenter l'écran de connexion.

     init-string (par défaut : #f)
          Cette option accepte une chaîne de caractères qui sera envoyée au tty ou au modem avant toute autre chose.  Elle peut être utilisée pour initialiser un modem.

     no-clear? (par défaut : #f)
          Lorsque la valeur est #t, agetty ne nettoiera pas l'écran avant de montrer l'écran de connexion.

     login-program (par défaut : (file-append shadow "/bin/login"))
          Cette option doit être soit une gexp dénotant le nom d'un programme de connexion, soit non définie, auquel cas la valeur par défaut est la commande login de la suite d'outils Shadow.

     local-line (par défaut : #f)
          Contrôle le drapeau CLOCAL.  Cette option accepte l'un des trois symboles comme argument, 'auto, 'always ou 'never.  Si la valeur est #f, la valeur par défaut choisie par agetty est 'auto…

     extract-baud? (par défaut : #f)
          Lorsque la valeur est #t, dit à agetty d'essayer d'extraire la taux de baud depuis les messages de statut produits par certains modems.

     skip-login? (par défaut : #f)
          Lorsque la valeur est #t, ne demande par de nom d'utilisateur.  Elle peut être utilisée avec le champ LOGIN-PROGRAM pour utiliser des systèmes de connexion non standards.

     no-newline? (par défaut : #f)
          Lorsque la valeur est #t, n'affiche pas de retour à la ligne avant d'afficher le fichier /etc/issue.

     login-options (par défaut : #f)
          Cette option accepte une chaîne de caractères contenant des options passées au programme login.  Lorsqu'utilisé avec LOGIN-PROGRAM, soyez conscient qu'un utilisateur malicieux pourrait essayer de rentrer un nom d'utilisateur contenant des options incluses qui pourraient être analysées par le programme de connexion.

     login-pause (par défaut : #f)
          Lorsque la valeur est #t, attend qu'une touche soit appuyée avant de montrer l'écran de connexion.  Cela peut être utilisé avec AUTO-LOGIN pour sauvegarder de la mémoire en lançant les shells de manière fainéante.

     chroot (par défaut : #f)
          Change de racine dans le répertoire donné.  Cette option accepte un chemin en tant que chaîne de caractères.

     hangup? (par défaut : #f)
          Utilise l'appel système Linux vhangup pour raccrocher virtuellement le terminal spécifié.

     keep-baud? (par défaut : #f)
          Lorsque la valeur est #t, essaye de garder le taux de baud existant. Les taux de baud de BAUD-RATE sont utilisés lorsque agetty reçoit un caractères BREAK.

     timeout (par défaut : #f)
          Lorsque la valeur est un nombre entier, termine la session si aucun nom d'utilisateur n'a pu être lu après TIMEOUT secondes.

     detect-case? (par défaut : #f)
          Lorsque la valeur est #t, active le support pour la détection des terminaux en majuscule uniquement.  Ce paramètre détectera qu'un nom d'utilisateur qui ne contient que des majuscules indique un terminal en majuscule et effectuera des conversion de majuscule en minuscule.  Remarquez que cela ne fonctionne pas avec les caractères unicode.

     wait-cr? (par défaut : #f)
          Lorsque la valeur est #t, attend que l'utilisateur ou le modem envoie un retour chariot ou un saut de ligne avant d'afficher /etc/issue ou l'écran de connexion.  Cela est typiquement utilisé avec l'option INIT-STRING.

     no-hints? (par défaut : #f)
          Lorsque la valeur est #t, n'affiche par les astuces à propos des verrouillages numériques, majuscule et défilement.

     no-hostname? (par défaut : #f)
          Par défaut, le nom d'hôte est affiché.  Lorsque la valeur est #t, aucun nom d'hôte ne sera affiché.

     long-hostname? (par défaut : #f)
          Par défaut, le nom d'hôte n'est affiché qu'après le premier point.  Lorsque la valeur est #t, le nom d'hôte pleinement qualifié renvoyé par gethostname ou getaddrinfo sera affiché.

     erase-characters (par défaut : #f)
          Cette option accepte une chaîne de caractères de caractères supplémentaires qui devraient être interprétés comme des effacements lorsque l'utilisateur les tape dans leur nom d'utilisateur.

     kill-characters (par défaut : #f)
          Cette option accepte une chaîne de caractères qui devrait être interprété comme signifiant « ignore tous les caractères précédent » (aussi appelé un caractère « kill ») lorsque l'utilisateur tape son nom d'utilisateur.

     chdir (par défaut : #f)
          Cette option accepte, en tant que chaîne de caractères, un chemin vers un répertoire dans lequel se trouvera la commande avant la connexion.

     delay (par défaut : #f)
          Cette option accepte, en tant qu'entier, le nombre de secondes à attendre avant d'ouvrir le tty et afficher l'écran de connexion.

     nice (par défaut : #f)
          Cette option accepte, en tant qu'entier, la valeur « nice » avec laquelle le programme login tourne.

     extra-options (par défaut : '())
          Cette option fournie un « mécanisme de secours » pour que l'utilisateur puisse ajouter des arguments de la ligne de commande arbitraires à agetty comme une liste de chaînes de caractères.

 -- Procédure Scheme: kmscon-service-type CONFIG
     Renvoie un service qui lance kmscon (https://www.freedesktop.org/wiki/Software/kmscon) d'après CONFIG, un objet <kmscon-configuration>, qui spécifie le tty sur lequel tourner, entre autres choses.

 -- Type de données: kmscon-configuration
     C'est le type de données représentant la configuration de Kscon, qui implémente l'écran de chargement de la console virtuelle.

     virtual-terminal
          Le nom de la console sur laquelle Kmscon tourne, p. ex. "tty1".

     login-program (par défaut : #~(string-append #$shadow "/bin/login"))
          Une gexp qui dénote le nom d'un programme de connexion.  le programme de connexion par défaut est login de la suite d'outils Shadow.

     login-arguments (par défaut : '("-p"))
          Une liste d'arguments à passer à login.

     hardware-acceleration? (par défaut : #f)
          S'il faut utiliser l'accélération matérielle.

     kmscon (par défaut : KMSCON)
          Le paquet Kmscon à utiliser.

 -- Procédure Scheme: nscd-service [CONFIG] [#:glibc glibc]
     [#:name-services '()]
     Renvoie un service qui lance le démon de cache de services de noms de la libc (nscd) avec la CONFIG donnée — un objet <nscd-configuration>.  See Name Service Switch, pour un exemple.

 -- Variable Scheme: %nscd-default-configuration
     C'est la valeur par défaut de <nscd-configuration> (voir plus bas) utilisée par nscd-service.  Elle utilise les caches définis par %NSCD-DEFAULT-CACHES ; voir plus bas.

 -- Type de données: nscd-configuration
     C'est le type de données qui représente la configuration du démon de cache de services de noms (nscd).

     name-services (par défaut : '())
          Liste des paquets dénotant des services de noms qui doivent être visible pour nscd, p. ex. (list NSS-MDNS).

     glibc (par défaut : GLIBC)
          Objet de paquet qui dénote la Biblothèque C de GNU qui fournit la commande nscd.

     log-file (par défaut : "/var/log/nscd.log")
          Nom du fichier journal de nscd.  C'est là que les sorties de débogage sont envoyée lorsque debug-level est strictement positif.

     debug-level (par défaut : 0)
          Entier qui dénote le niveau de débogage.  Les entiers les plus grands signifient plus de sortie de débogage.

     caches (par défaut : %NSCD-DEFAULT-CACHES)
          Liste d'objets <nscd-cache> qui dénotent des choses à mettre en cache ; voir plus bas.

 -- Type de données: nscd-cache
     Type de données représentant une base de données de cache de nscd et ses paramètres.

     database
          C'est un symbole qui représente le nom de la base de donnée à mettre en cache.  Les valeurs valide sont passwd, group, hosts et services qui désignent les bases de données NSS correspondantes (see NSS Basics (The GNU C Library Reference Manual)).

     positive-time-to-live
     negative-time-to-live (par défaut : 20)
          Un entier qui représente le nombre de secondes pendant lesquelles un résultat positif ou négatif reste en cache.

     check-files? (par défaut : #t)
          Indique s'il faut vérifier des mises à jours dans les fichiers correspondant à DATABASE.

          Par exemple, lorsque DATABASE est hosts, ce drapeau indique à nscd de vérifier s'il y a des mises à jour de /etc/hosts et de les prendre en compte.

     persistent? (par défaut : #t)
          Indique si le cache devrait être stocké de manière persistante sur le disque.

     shared? (par défaut : #t)
          Indique si le cache devrait être partagé entre les utilisateurs.

     max-database-size (par défaut : 32 MiB)
          Taille maximale en octets de la base de données en cache.

 -- Variable Scheme: %nscd-default-caches
     Liste d'objets <nscd-cache> utilisés par défaut par nscd-configuration (voir plus haut).

     Elle active la mise en cache persistante et agressive des recherches de services et de noms d'hôtes.  Ces derniers fournissent une recherche de noms d'hôtes plus performante, résiliente face à des serveurs de noms peu fiables et une protection de votre vie privée plus efficace — souvent le résultat des recherches de noms d'hôtes sont dans le cache local, donc les serveurs de nom externes n'ont même pas besoin d'être questionnés.

 -- Type de données: syslog-configuration
     Ce type de données représente la configuration du démon syslog.

     syslogd (par défaut : #~(string-append #$inetutils "/libexec/syslogd"))
          Le démon syslog à utiliser.

     config-file (par défaut : %default-syslog.conf)
          Le fichier de configuration de syslog à utiliser.

 -- Procédure Scheme: syslog-service CONFIG
     Renvoie un service qui lance un démon syslog en suivant CONFIG.

     See syslogd invocation (GNU Inetutils), pour plus d'informations sur la syntaxe du fichier de configuration.

 -- Type de données: guix-configuration
     Ce type de données représente la configuration du démon de construction de Guix.  See Invoquer guix-daemon pour plus d'informations.

     guix (par défaut : GUIX)
          Le paquet Guix à utiliser.

     build-group (par défaut : "guixbuild")
          Nom du groupe des comptes utilisateurs de construction.

     build-accounts (par défaut : 10)
          Nombre de comptes utilisateurs de construction à créer.

     authorize-key? (par défaut : #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 (par défaut : %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? (par défaut : #t)
          S'il faut utiliser les substituts.

     substitute-urls (par défaut : %DEFAULT-SUBSTITUTE-URLS)
          La liste des URL où trouver des substituts par défaut.

     max-silent-time (par défaut : 0)
     timeout (par défaut : 0)
          Le nombre de secondes de silence et le nombre de secondes d'inactivité, respectivement, après lesquelles un processus de construction son délai d'attente.  Une valeur de zéro désactive le délai d'attente.

     log-compression (par défaut : 'bzip2)
          Le type de compression utilisé par les journaux de construction — parmi gzip, bzip2 et none.

     extra-options (par défaut : '())
          Liste d'options supplémentaires de la ligne de commande pour guix-daemon.

     log-file (par défaut : "/var/log/guix-daemon.log")
          Le fichier où les sorties standard et d'erreur de guix-daemon sont écrites.

     http-proxy (par défaut : #f)
          Le serveur mandataire HTTP à utiliser pour télécharger les dérivations à sortie fixe et les substituts.

     tmpdir (par défaut : #f)
          Un répertoire où guix-daemon effectuera ses constructions.

 -- Procédure Scheme: guix-service CONFIG
     Renvoie un service qui fait tourner le démon de construction de Guix en suivant CONFIG.

 -- Procédure Scheme: udev-service [#:udev EUDEV #:rules '()]
     Lance UDEV, qui rempli le répertoire /dev dynamiquement.  Les règles udev peuvent être fournies comme une liste de fichier via la variable RULES.  Les procédures UDEV-RULE et FILE->UDEV-RULE de (gnu services base) simplifient la création de ces fichiers de règle.

      -- Procédure Scheme: udev-rule [FILE-NAME CONTENTS]
          Renvoie un fichier de règle udev nommé FILE-NAME contenant les règles définie par le litéral CONTENTS.

          Dans l'exemple suivant, on définie une règle pour un périphérique USB qui sera stockée dans le fichier 90-usb-thing.rules.  La règle lance un script à la détection du périphérique USB avec l'identifiant de produit donné.

               (define %example-udev-rule
                 (udev-rule
                   "90-usb-thing.rules"
                   (string-append "ACTION==\"add\", SUBSYSTEM==\"usb\", "
                                  "ATTR{product}==\"Example\", "
                                  "RUN+=\"/path/to/script\"")))

     Ici on montre comment le service UDEV-SERVICE par défaut peut être étendu avec cette règle.

          (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))))))))

      -- Procédure Scheme: file->udev-rule [FILE-NAME FILE]
          Renvoie un fichier udev nommé FILE-NAME contenant les règles définies dans FILE, un objet simili-fichier.

          L'exemple suivant montre comment utiliser un fichier de règles existant.

               (use-modules (guix download)     ;pour url-fetch
                            (guix packages)     ;pour 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"))))))

     En plus, les définitions des paquets de Guix peuvent être inclus dans RULES pour étendre les règles avec les définitions trouvées dans leur sous-répertoire lib/udev/rules.d.  Au lieu de l'exemple FILE->UDEV-RULE précédent, on aurait pu utiliser le paquet ANDROID-UDEV-RULES qui existe dans le module (gnu packages android).

     L'exemple suivant montre comment utiliser le paquet ANDROID-UDEV-RULES pour que l'outil Android adb puisse détecter les appareils sans privilège root.  Il détaille aussi comment créer le grope adbusers, requis pour le bon fonctionnement des règles définies dans le paquet ANDROID-UDEV-RULES.  Pour créer ce groupe, on doit le définir dans les SUPPLEMENTARY-GROUPS de la déclaration USER-ACCOUNT ainsi que dans le champ GROUPS de l'enregistrement OPERATING-SYSTEM.

          (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))))))))

 -- Variable Scheme: urandom-seed-service-type
     Garde de l'entropie dans %RANDOM-SEED-FILE pour démarrer /dev/urandom au redémarrage.  Ce service essaye aussi de démarrer /dev/urandom à partir de /dev/hwrng au démarrage si /dev/hwrng existe et peut être lu.

 -- Variable Scheme: %random-seed-file
     C'est le nom du fichier où des octets aléatoires sont sauvegardés par URANDOM-SEED-SERVICE pour démarrer /dev/urandom au redémarrage.  Sa valeur par défaut est /var/lib/random-seed.

 -- Procédure Scheme: console-keymap-service FILES ...
     Renvoie un service qui charge les dispositions claviers de FILES avec la commande loadkeys.  Vraisemblablement, vous voudrez charger une disposition par défaut, ce qui se fait ainsi :

          (console-keymap-service "dvorak")

     Ou par exemple pour un clavier suédois, vous pourriez avoir besoin de combiner les dispositions suivantes :

          (console-keymap-service "se-lat6" "se-fi-lat6")

     Vous pouvez aussi spécifier le nom de fichier (ou les noms de fichiers) complets de vos dispositions.  Voir man loadkeys pour des détails.

 -- Variable Scheme: gpm-service-type
     C'est le type du service qui lance GPM, le démon de souris à but général, qui fournit le support de la souris sur la console Linux.  GPM permet aux utilisateurs d'utiliser la souris dans la console, entre autres pour sélectionner, copier et coller du texte.

     La valeur pour les services de ce type doit être un gpm-configuration (voir plus bas).  Ce service ne fait pas partie de %BASE-SERVICES.

 -- Type de données: gpm-configuration
     Type de données représentant la configuration de GPM.

     options (par défaut : %default-gpm-options)
          Les options de la ligne de commande à passer à gpm.  L'ensemble des options par défaut dit à gpm d'écouter les événements de la souris dans /dev/input/mice.  See Command Line (gpm manual), pour plus d'informations.

     gpm (par défaut : gpm)
          Le paquet GPM à utiliser.

 -- Variable Scheme: guix-publish-service-type
     C'est le type de service pour guix publish (see Invoquer guix publish).  Sa valeur doit être un objet guix-configuration décrit plus bas.

     Ce service suppose que /etc/guix contient déjà une paire de clefs créée par guix archive --generate-key (see Invoquer guix archive).  Si ce n'est pas le cas, le service ne démarrera pas.

 -- Type de données: guix-publish-configuration
     Le type de données représentant la configuration du service guix publish.

     guix (par défaut : guix)
          Le paquet Guix à utiliser.

     port (par défaut : 80)
          Le port TCP sur lequel écouter les connexions.

     host (par défaut : "localhost")
          L'hôte (et donc, l'interface réseau) sur lequel écouter.  Utilisez "0.0.0.0" pour écouter sur toutes les interfaces réseaux.

     compression-level (par défaut : 3)
          Le niveau de compression gzip auquel les substituts sont compressés. Utilisez 0 pour désactiver complètement la compression, et 9 pour avoir le meilleur taux de compression contre une plus grande utilisation du CPU.

     nar-path (par défaut : "nar")
          Le chemin d'URL où les « nars » se trouvent.  See --nar-path, pour des détails.

     cache (par défaut : #f)
          Lorsque la valeur est #f, désactive le cache et génère les archives à la demande.  Sinon, cela devrait être le nom d'un répertoire — p. ex. "/var/cache/guix/publish" — où guix publish gère le cache des archives et des métadonnées prêtes à être envoyées.   See --cache, pour plus d'informations sur les compromis impliqués.

     workers (par défaut : #f)
          Lorsque la valeur est un entier, c'est le nombre de threads de travail utilisés pour le cache ; lorsque la valeur est #f, le nombre de processeurs est utilisé.  See --workers, pour plus d'informations.

     ttl (par défaut : #f)
          Lorsque la valeur est un entier, il dénote la durée de vie en secondes des archives publiées.  See --ttl, pour plus d'informations.

 -- Procédure Scheme: rngd-service [#:rng-tools RNG-TOOLS]
     [#:device "/dev/hwrng"]
     Renvoie un service qui lance le programme rngd de RNG-TOOLS pour ajouter DEVICE à la réserve d'entropie du noyau.  Le service échouera si DEVICE n'existe pas.

 -- Procédure Scheme: pam-limits-service [#:limits '()]

     Renvoie un service qui installe un fichier de configuration pour le module pam_limits (http://linux-pam.org/Linux-PAM-html/sag-pam_limits.html).  La procédure prend éventuellement une liste de valeurs pam-limits-entry qui peuvent être utilisées pour spécifier les limites ulimit et les priorités des sessions utilisateurs.

     La définition de limites suivante défini deux limites matérielles et logicielles pour toutes les sessions connectées des utilisateurs du groupe realtime :

          (pam-limits-service
           (list
            (pam-limits-entry "@realtime" 'both 'rtprio 99)
            (pam-limits-entry "@realtime" 'both 'memlock 'unlimited)))

     La première entrée augment la priorité en temps réel maximale des processus non privilégiés ; la deuxième entrée abandonne les restrictions sur l'espace d'adressage maximal qui peut être verrouillé en mémoire.  Ces paramètres sont souvent utilisés sur les systèmes audio temps-réel.

Exécution de tâches planifiées
..............................

Le module (gnu services mcron) fournit une interface pour GNU mcron, un démon qui lance des tâches planifiées (see GNU mcron).  GNU mcron est similaire au démon Unix traditionel cron ; la principale différence est qu'il est implémenté en Guile Scheme, qui fournit beaucoup de flexibilité lors de la spécification de la planification des tâches et de leurs actions.

L'exemple en dessous définit un système d'exploitation qu lance les commandes updatebd (see Invoking updatedb (Finding Files)) et guix gc (see Invoquer guix gc) tous les jours, ainsi que la commande mkid en tant qu'utilisateur non privilégié (see mkid invocation (ID Database Utilities)).  Il utilise des gexps pour introduire des définitions de tâches qui sont passées à mcron (see G-Expressions).

     (use-modules (guix) (gnu) (gnu services mcron))
     (use-package-modules base idutils)

     (define updatedb-job
       ;; Lance « updatedb » à 3h du matin chaque jour.  Ici nous spécifions
       ;; l'action de la tâche comme une procédure Scheme.
       #~(job '(next-hour '(3))
              (lambda ()
                (execl (string-append #$findutils "/bin/updatedb")
                       "updatedb"
                       "--prunepaths=/tmp /var/tmp /gnu/store"))))

     (define garbage-collector-job
       ;; Lance le ramasse-miettes tous les jours à minuit cinq.
       ;; L'action de la tâche est une commande shell.
       #~(job "5 0 * * *"            ;Vixie cron syntax
              "guix gc -F 1G"))

     (define idutils-job
       ;; Met à jour la base de données d'index en tant que « charlie » à 12h15
       ;; et 19h15.  La commande est lancée depuis le répertoire personnel de l'utilisateur.
       #~(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), pour plus d'informations sur les spécifications des tâche de mcron.  Ci-dessous est la référence du service mcron.

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

 -- Procédure Scheme: mcron-service JOBS [#:mcron MCRON]
     Renvoie un service mcron qui lance MCRON qui planifie les tâches JOBS, une liste de gexps qui dénotent des spécifications de tâches de mcron.

     C'est un raccourci pour :

          (service mcron-service-type
                   (mcron-configuration (mcron mcron) (jobs jobs)))

 -- Variable Scheme: mcron-service-type
     C'est le type du service mcron, dont la valeur est un objet mcron-configuration

     Ce type de service peut être la cible d'une extension de service qui lui fournit des spécifications de tâches supplémentaires (see Composition de services).  En d'autres termes, il est possible de définir des services qui fournissent des tâches mcron à lancer.

 -- Type de données: mcron-configuration
     Type données qui représente la configuration de mcron.

     mcron (par défaut : MCRON)
          Le paquet mcron à utiliser.

     jobs
          C'est la liste des gexps (see G-Expressions), où chaque gexp correspond à une spécification de tâche de mcron (see mcron job specifications (GNU mcron)).

Rotation des journaux
.....................

Les fichiers journaux comme ceux qui se trouvent dans /var/log ont tendance à grandir sans fin, donc c'est une bonne idée de le faire tourner de temps à autres — c.-à-d. archiver leur contenu dans des fichiers séparés, potentiellement compressés.  Le module (gnu services admin) fournit une interface pour GNU Rot[t]log, un outil de rotation de journaux (see GNU Rot[t]log Manual).

L'exemple ci-dessous définit un système d'exploitation qui fournit la rotation des journaux avec les paramètres par défaut, pour les journaux les plus courants.

     (use-modules (guix) (gnu))
     (use-service-modules admin mcron)
     (use-package-modules base idutils)

     (operating-system
       ;; ...
       (services (cons (service rottlog-service-type)
                       %base-services)))

 -- Variable Scheme: rottlog-service-type
     C'est le type du service Rotlog, dont la valeur est un objet rottlog-configuration.

     D'autres services peuvent étendre celui-ci avec de nouveaux objets log-rotation (voir plus bas), en augmentant ainsi l'ensemble des fichiers à faire tourner.

     Ce type de service peut définir des taches (see Exécution de tâches planifiées) pour lancer le service rottlog.

 -- Type de données: rottlog-configuration
     Type de données représentant la configuration de rottlog.

     rottlog (par défaut : rottlog)
          Le paquet Rottlog à utiliser.

     rc-file (par défaut : (file-append rottlog "/etc/rc"))
          Le fichier de configuration Rottlog à utiliser (see Mandatory RC Variables (GNU Rot[t]log Manual)).

     rotations (par défaut : %default-rotations)
          Une liste d'objets log-rotation définis plus bas.

     jobs
          C'est une liste de gexps où chaque gexp correspond à une spécification de tache de mcron (see Exécution de tâches planifiées).

 -- Type de données: log-rotation
     Type de données représentant la rotation d'un groupe de fichiers journaux.

     En reprenant un exemple du manuel de Rottlog (see Period Related File Examples (GNU Rot[t]log Manual)), on peut définir la rotation d'un journal de cette manière :

          (log-rotation
            (frequency 'daily)
            (files '("/var/log/apache/*"))
            (options '("storedir apache-archives"
                       "rotate 6"
                       "notifempty"
                       "nocompress")))

     La liste des champs est la suivante :

     frequency (par défaut : 'weekly)
          La fréquence de rotation, un symbole.

     files
          La liste des fichiers ou des motifs de noms de fichiers à faire tourner.

     options (par défaut : '())
          La liste des options de rottlog pour cette rotation (see Configuration parameters (GNU Rot[t]lg Manual)).

     post-rotate (par défaut : #f)
          Soit #f, soit une gexp à exécuter une fois la rotation terminée.

 -- Variable Scheme: %default-rotations
     Spécifie la rotation hebdomadaire de %ROTATED-FILES et de quelques autres fichiers.

 -- Variable Scheme: %rotated-files
     La liste des fichiers contrôlés par syslog à faire tourner.  Par défaut il s'agit de : '("/var/log/messages" "/var/log/secure")

Services réseau
...............

Le module (gnu services networking) fournit des services pour configurer les interfaces réseaux.

 -- Procédure Scheme: dhcp-client-service [#:dhcp ISC-DHCP]
     Renvoie un service qui lance DHCP, un client DHCP (Dynamic Host Configuration Protocol) sur toutes les interfaces réseaux en dehors de la boucle locale.

 -- Procédure Scheme: dhcpd-service-type
     Ce type définie un service qui lance un démon DHCP.  Pour créer un service de ce type, vous devez appliquer un objet <dhcpd-configuration>.  Par exemple :

          (service dhcpd-service-type
                   (dhcpd-configuration
                    (config-file (local-file "my-dhcpd.conf"))
                    (interfaces '("enp0s25"))))

 -- Type de données: dhcpd-configuration

     package (par défaut : isc-dhcp)
          Le paquet qui fournit le démon DHCP.  ce paquet doit fournir le démon sbin/dhcpd relativement à son répertoire de sortie.  Le paquet par défaut est le serveur DHCP d'ISC (http://www.isc.org/products/DHCP)

     config-file (par défaut : #f)
          Le fichier de configuration à utiliser.  Il est requis.  Il sera passé à dhcpd via son option -cf.  La valeur peut être n'importe quel objet « simili-fichier » (see file-like objects).  Voir man dhcpd.conf pour des détails sur la syntaxe du fichier de configuration.

     version (par défaut : "4")
          La version de DHCP à utiliser.  Le serveur DHCP d'ISC supporte les valeur « 4 », « 6 » et « 4o6 ».  Elles correspondent aux options -4, -6 et -4o6 du programme dhcpd.  Voir man dhcpd pour plus de détails.

     run-directory (par défaut : "/run/dhcpd")
          Le répertoire d'exécution à utiliser.  Au moment de l'activation du service, ce répertoire sera créé s'il n'existe pas.

     pid-file (par défaut : "/run/dhcpd/dhcpd.pid")
          Le fichier de PID à utiliser.  Cela correspond à l'option -pf de dhcpd.  Voir man dhcpd pour plus de détails.

     interfaces (par défaut : '())
          Les noms des interfaces réseaux sur lesquelles dhcpd écoute.  Si cette liste n'est pas vide, alors ses éléments (qui doivent être des chaînes de caractères) seront ajoutés à l'invocation de dhcpd lors du démarrage du démon.  Il n'est pas forcément nécessaire de spécifier des interfaces ici ; voir man dhcpd pour plus de détails.

 -- Variable Scheme: static-networking-service-type
     C'est le type des interfaces réseaux configurés statiquement.

 -- Procédure Scheme: 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.

     On peut appeler cette procédure plusieurs fois, une fois par interface réseau qui nous intéresse.  Dans les coulisses, elle étend static-networking-service-type avec les interfaces réseaux supplémentaires à gérer.

 -- Procédure Scheme: wicd-service [#:wicd WICD]
     Renvoie un service qui lance Wicd (https://launchpad.net/wicd), un démon de gestion réseau qui cherche à simplifier la configuration des résaux filaires et sans fil.

     Ce service ajoute le paquet WICD au profil global, pour fournir des commandes pour interagir avec le démon et configurer le réseau : wicd-client, une interface graphique et les interfaces utilisateurs wicd-cli et wicd-curses.

 -- Variable Scheme: modem-manager-service-type
     C'est le type de service pour le service ModemManager (https://wiki.gnome.org/Projects/ModemManager).  La valeur de ce type de service est un enregistrement modem-manager-configuration.

     Ce service fait partie de %desktop-services (see Services de bureaux).

 -- Type de données: modem-manager-configuration
     Type de donnée représentant la configuration de ModemManager.

     modem-manager (par défaut : modem-manager)
          Le paquet ModemManager à utiliser.

 -- Variable Scheme: network-manager-service-type
     C'est le type de service pour le service NetworkManager (https://wiki.gnome.org/Projects/NetworkManager).  La valeur pour ce type de service est un enregistrement network-manager-configuration.

     Ce service fait partie de %desktop-services (see Services de bureaux).

 -- Type de données: network-manager-configuration
     Type de données représentant la configuration de NetworkManager.

     network-manager (par défaut : network-manager)
          Le paquet NetworkManager à utiliser.

     dns (par défaut : "default")
          Mode de gestion pour le DNS, qui affecte la manière dont NetworkManager utilise le fichier de configuration resolv.conf

          default
               NetworkManager mettra à jour resolv.conf pour refléter les serveurs de noms fournis par les connexions actives.

          dnsmasq
               NetworkManager lancera dnsmasq en tant que serveur de cache local, en utilisant une configuration « DNS disjointe » si vous êtes connecté par un VPN puis mettra à jour resolv.conf pour pointer vers le serveur de nom local.

          none
               NetworkManager ne modifiera pas resolv.conf.

     vpn-plugins (par défaut : '())
          C'est la liste des greffons disponibles pour les VPN (réseaux privés virtuels).  Un exemple est le paquet network-manager-openvpn, qui permet à NetworkManager de gérer des VPN via OpenVPN.

 -- Variable Scheme: connman-service-type
     C'est le type de service pour lancer Connman (https://01.org/connman), un gestionnaire de connexions réseaux.

     Sa valeur doit être un enregistrement connman-configuration comme dans cet exemple :

          (service connman-service-type
                   (connman-configuration
                     (disable-vpn? #t)))

     Voir plus bas pour des détails sur connman-configuration.

 -- Type de données: connman-configuration
     Type de données représentant la configuration de connman.

     connman (par défaut : CONNMAN)
          Le paquet connman à utiliser.

     disable-vpn? (par défaut : #f)
          Lorsque la valeur est vraie, active le greffon vpn de connman.

 -- Variable Scheme: wpa-supplicant-service-type
     C'est le type du service qui lance WPA supplicant (https://w1.fi/wpa_supplicant/), un démon d'authentification requis pour s'authentifier sur des WiFi chiffrés ou des réseaux ethernet.  l est configuré pour écouter des requêtes sur D-Bus.

     La valeur de ce service est le paquet wpa-supplicant à utiliser. Ainsi, il peut être instancié de cette manière :

          (use-modules (gnu services networking))

          (service wpa-supplicant-service-type)

 -- Procédure Scheme: ntp-service [#:ntp NTP]
     [#:servers %NTP-SERVERS]
     [#:allow-large-adjustment? #f]
     Renvoie un service qui lance le démon de NTP, le paquet Network Time Protocol (http://www.ntp.org).  Le démon gardera l'horloge système synchronisée avec celle des serveurs SERVERS. ALLOW-LARGE-ADJUSTMENT? détermine si ntpd a le droit de faire des ajustements initiaux de plus de 1 000 secondes.

 -- Variable Scheme: %ntp-servers
     Liste des noms d'hôtes utilisés comme serveurs NTP par défaut.

 -- Procédure Scheme: openntpd-service-type
     Lance le démon NTP ntpd, implémenté par OpenNTPD (http://www.openntpd.org).  Le démon gardera l'horloge système synchronisée avec celle des serveurs donnés.

          (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)))

 -- Type de données: openntpd-configuration

     openntpd (par défaut : (file-append openntpd "/sbin/ntpd"))
          L'exécutable openntpd à utiliser.

     listen-on (par défaut : '("127.0.0.1" "::1"))
          Une liste d'adresses IP locales ou de noms d'hôtes que devrait écouter le démon ntpd.

     query-from (par défaut : '())
          Une liste d'adresses IP que le démon devrait utiliser pour les requêtes sortantes.

     sensor (par défaut : '())
          Spécifie une liste de senseurs de différences de temps que ntpd devrait utiliser.  ntpd écoutera chaque senseur qui existe et ignorera ceux qui n'existent pas.  Voir la documentation en amont (https://man.openbsd.org/ntpd.conf) pour plus d'informations.

     server (par défaut : %NTP-SERVERS)
          Spécifie une liste d'adresses IP ou de noms d'hôtes de serveurs NTP avec lesquels se synchroniser.

     servers (par défaut : '())
          Spécifie une liste d'adresses IP ou de noms d'hôtes de banques de serveurs NTP avec lesquelles se synchroniser.

     constraint-from (par défaut : '())
          ntpd peut être configuré pour demander la « Date » à des serveurs HTTPS de confiance via TLS.  Cette information de temps n'est pas utilisée pour sa précision mais agit comme une contrainte authentifiée, ce qui réduit l'impact d'une attaque par l'homme du milieu sur le protocole NTP non authentifié.  Spécifie une liste d'URL, d'adresses IP ou de noms d'hôtes de serveurs HTTPS qui fournissent cette contrainte.

     constraints-from (par défaut : '())
          Comme pour constraint-from, spécifie une liste d'URL, d'adresses IP ou de noms d'hôtes de serveurs HTTPS qui fournissent une contrainte.  Si les noms d'hôtes sont résolus en plusieurs adresses IP, ntpd calculera la contrainte médiane.

     allow-large-adjustment? (par défaut : #f)
          Détermine si ntpd peut faire un ajustement initial de plus de 180 secondes.

 -- Variable Scheme: inetd-service-type
     Ce service lance le démon inetd (see inetd invocation (GNU Inetutils)).  inetd écoute des connexionssur des sockets internet et démarre le programme spécifié uniquement lorsqu'une connexion arrive sur l'un de ces sockets.

     La valeur de ce service est un objet inetd-configuration.  L'exemple suivant configure le démon inetd pour qu'il fournisse le service echo, ainsi qu'in service smtp qui transfère le trafic smtp par ssh à un serveur smtp-server derrière une passerelle 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")))))

     Voir plus bas pour plus de détails sur inetd-configuration.

 -- Type de données: inetd-configuration
     Type de données représentant la configuration de inetd.

     program (par défaut : (file-append inetutils "/libexec/inetd"))
          L'exécutable inetd à utiliser.

     entries (par défaut : '())
          Une liste d'entrées de services inetd.  Chaque entrée devrait être crée avec le constructeur inetd-entry.

 -- Type de données: inetd-entry
     Type de données représentant une entrée dans la configuration d'inetd.  Chaque entrée correspond à un socket sur lequel inetd écoutera les requêtes.

     node (par défaut : #f)
          Chaîne de caractères facultative, un liste d'adresses locales séparées par des virgules que inetd devrait utiliser pour écouter ce service. See Configuration file (GNU Inetutils) pour une description complète de toutes les options.

     name
          Une chaîne de caractères dont le nom doit correspondre à une entrée de /etc/services.

     socket-type
          Un symbole parmi 'stream, 'dgram, 'raw, 'rdm ou 'seqpacket.

     protocol
          Une chaîne de caractères qui doit correspondre à une entrée dans /etc/protocols.

     wait? (par défaut : #t)
          Indique si inetd devrait attendre que le serveur ait quitté avant d'écouter de nouvelles demandes de service.

     user
          Une chaîne de caractères contenant le nom d'utilisateur (et éventuellement de groupe) de l'utilisateur en tant que lequel le serveur devrait tourner. Le nom du groupe peut être spécifié comme un suffixe, séparé par un deux-points ou un point, c.-à-d. "utilisateur", "utilisateur:groupe" ou "utilisateur.groupe".

     program (par défaut : "internal")
          Le programme du serveur qui servira les requêtes, ou "internal" si inetd devrait utiliser un service inclus.

     arguments (par défaut : '())
          Une liste de chaînes de caractères ou d'objets simili-fichiers qui sont les arguments du programme du serveur, en commençant par le zéroième argument, c.-à-d. le nom du programme lui-même.  Pour les services internes à inetd, cette entrée doit être '() ou '("internal").

     See Configuration file (GNU Inetutils) pour trouver une discussion plus détaillée de chaque champ de configuration.

 -- Procédure Scheme: tor-service [CONFIG-FILE] [#:tor TOR]
     Renvoie un service qui lance le démon de réseau anonyme Tor (https://torproject.org).

     Le démon est lancé avec l'identité de l'utilisateur non privilégié tor.  Il lit CONFIG-FILE, un objet simili-fichier, avec une ligne User tor supplémentaire et des lignes pour les services cachés ajoutées par des tor-hidden-service.  Lncez man tor pour obtenir des informations sur le fichier de configuration.

 -- Procédure Scheme: tor-hidden-service NAME MAPPING
     Définie un service caché pour Tor nommé NAME qui implémente MAPPING.  MAPPING est une liste de paires de port et d'hôte, comme dans :

           '((22 "127.0.0.1:22")
             (80 "127.0.0.1:8080"))

     Dans cet exemple, le port 22 du service caché est relié au port local 22 et le port 80 est relié au port local 8080.

     Cela crée un répertoire /var/lib/tor/hidden-services/NAME où le fichier hostname contient le nom d'hôte .onion pour le service caché.

     Voir the Tor project's documentation (https://www.torproject.org/docs/tor-hidden-service.html.en) pour trouver plus d'information.

Le module (gnu services rsync) fournit les services suivant :

Vous pourriez vouloir un démon rsync si vous voulez que des fichiers soient disponibles pour que n'importe qui (ou juste vous) puisse télécharger des fichiers existants ou en téléverser des nouveaux.

 -- Variable Scheme: rsync-service-type
     C'est le type pour le démon rsync (https://rsync.samba.org), qui prend un enregistrement rsync-configuration comme dans cet exemple :

          (service rsync-service-type)

     Voir plus pas pour trouver des détails à propos de rsync-configuration.

 -- Type de données: rsync-configuration
     Type de données représentant la configuration de rsync-service.

     package (par défaut : RSYNC)
          Le paquet rsync à utiliser.

     port-number (par défaut : 873)
          Le port TCP sur lequel rsync écoute les connexions entrantes.  Si le port est inférieur à 1024, rsync doit être démarré en tant qu'utilisateur et groupe root.

     pid-file (par défaut : "/var/run/rsyncd/rsyncd.pid")
          Nom du fichier où rsync écrit son PID.

     lock-file (par défaut : "/var/run/rsyncd/rsyncd.lock")
          Nom du fichier où rsync écrit son fichier de verrouillage.

     log-file (par défaut : "/var/log/rsyncd.log")
          Nom du fichier où rsync écrit son fichier de journal.

     use-chroot? (par défaut : #T)
          S'il faut utiliser un chroot pour le répertoire partagé de rsync.

     share-path (par défaut : /srv/rsync)
          Emplacement du répertoire partagé de rsync.

     share-comment (par défaut : "Rsync share")
          Commentaire du répertoire partagé de rsync.

     read-only? (par défaut : #F)
          Permission en écriture sur le répertoire partagé.

     timeout (par défaut : 300)
          Délai d'attente d'entrée-sortie en secondes.

     user (par défaut : "ROOT")
          Propriétaire du processus rsync.

     group (par défaut : "ROOT")
          Groupe du processus rsync.

     uid (par défaut : "RSYNCD")
          Nom d'utilisateur ou ID utilisateur en tant que lequel les transferts de fichiers ont lieu si le démon a été lancé en root.

     gid (par défaut : "RSYNCD")
          Nom du groupe ou ID du groupe qui sera utilisé lors de l'accès au module.

En plus, (gnu services ssh) fournit les services suivant.

 -- Procédure Scheme: 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]
     Lance le programme lshd de LSH pour écouter sur le port PORT-NUMBER.  HOST-KEY doit désigner un fichier contenant la clef d'hôte et ne doit être lisible que par root.

     Lorsque DAEMONIC? est vrai, lshd se détachera du terminal qui le contrôle et enregistrera ses journaux avec syslogd, à moins que SYSLOG-OUTPUT? ne soit faux.  Évidemment, cela rend aussi lsh-service dépendant de l'existence d'un service syslogd.  Lorsque PID-FILE? est vrai, lshd écrit son PID dans le fichier PID-FILE.

     Lorsque INITIALIZE? est vrai, la graine et la clef d'hôte seront créés lors de l'activation du service s'ils n'existent pas encore.  Cela peut prendre du temps et demande une interaction.

     Lorsque INITIALIZE? est faux, c'est à l'utilisateur d'initialiser le générateur d'aléatoire (see lsh-make-seed (LSH Manual)) et de crée une paire de clefs dont la clef privée sera stockée dans le fichier HOST-KEY (see lshd basics (LSH Manual)).

     Lorsque INTERFACES est vide, lshd écoute les connexions sur toutes les interfaces réseau ; autrement, INTERFACES doit être une liste de noms d'hôtes et d'adresses.

     ALLOW-EMPTY-PASSWORDS? spécifie si les connexions avec des mots de passes vides sont acceptés et ROOT-LOGIN? spécifie si la connexion en root est acceptée.

     Les autres options devraient être évidentes.

 -- Variable Scheme: openssh-service-type
     C'est le type pour le démon ssh OpenSSH (http://www.openssh.org), sshd.  Sa valeur doit être un enregistrement openssh-configuration comme dans cet exemple :

          (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"))))))

     Voir plus bas pour trouver des détails sur openssh-configuration.

     Ce service peut être étendu avec des clefs autorisées supplémentaires, comme dans cet exemple :

          (service-extension openssh-service-type
                             (const `(("charlie"
                                       ,(local-file "charlie.pub")))))

 -- Type de données: openssh-configuration
     C'est l'enregistrement de la configuration de la commande sshd d'OpenSSH.

     pid-file (par défaut : "/var/run/sshd.pid")
          Nom du fichier où sshd écrit son PID.

     port-number (par défaut : 22)
          Port TCP sur lequel sshd écoute les connexions entrantes.

     permit-root-login (par défaut : #f)
          Ce champ détermine si et quand autoriser les connexions en root.  Si la valeur est #f, les connexions en root sont désactivées ; si la valeur est #t, elles sont autorisées.  S'il s'agit du symbole 'without-password, alors les connexions root sont autorisées mais pas par une authentification par mot de passe.

     allow-empty-passwords? (par défaut : #f)
          Lorsque la valeur est vraie, les utilisateurs avec un mot de passe vide peuvent se connecter.  Sinon, ils ne peuvent pas.

     password-authentication? (par défaut : #t)
          Lorsque la valeur est vraie, les utilisateurs peuvent se connecter avec leur mot de passe.  Sinon, ils doivent utiliser une autre méthode d'authentification.

     public-key-authentication? (par défaut : #t)
          Lorsque la valeur est vraie, les utilisateurs peuvent se connecter avec leur clef publique.  Sinon, les utilisateurs doivent utiliser une autre méthode d'authentification.

          Les clefs publiques autorisées sont stockées dans ~/.ssh/authorized_keys.  Ce n'est utilisé que par le protocole version 2.

     x11-forwarding? (par défaut : #f)
          Lorsque la valeur est vraie, le transfert de connexion du client graphique X11 est activé — en d'autre termes, les options -X et -Y de ssh fonctionneront.

     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? (par défaut : #f)
          Spécifie si l'authentification par défi est autorisée (p. ex. via PAM).

     use-pam? (par défaut : #t)
          Active l'interface avec le module d'authentification greffable, PAM.  Si la valeur est #t, cela activera l'authentification PAM avec challenge-response-authentication? et password-authentication?, en plus des modules de compte et de session de PAM pour tous les types d'authentification.

          Comme l'authentification par défi de PAM sert généralement un rôle équivalent à l'authentification par mot de passe, vous devriez désactiver soit challenge-response-authentication?, soit password-authentication?.

     print-last-log? (par défaut : #t)
          Spécifie si sshd devrait afficher la date et l'heure de dernière connexion des utilisateurs lorsqu'un utilisateur se connecte de manière interactive.

     subsystems (par défaut : '(("sftp" "internal-sftp")))
          Configure les sous-systèmes externes (p. ex. le démon de transfert de fichiers).

          C'est une liste de paires, composées chacune du nom du sous-système et d'une commande (avec éventuellement des arguments) à exécuter à la demande du sous-système.

          La commande internal-sftp implémente un serveur SFTP dans le processus.  Autrement, on peut spécifier la commande sftp-server :

               (service openssh-service-type
                        (openssh-configuration
                         (subsystems
                          `(("sftp" ,(file-append openssh "/libexec/sftp-server"))))))

     accepted-environment (par défaut : '())
          Liste de chaînes de caractères qui décrivent les variables d'environnement qui peuvent être exportées.

          Chaque chaîne a sa propre ligne.  Voir l'option AcceptEnv dans man sshd_config.

          Cet exemple permet aux clients ssh d'exporter la variable COLORTERM. Elle est initialisée par les émulateurs de terminaux qui supportent les couleurs.  Vous pouvez l'utiliser dans votre fichier de ressource de votre shell pour activer les couleurs sur la ligne de commande si cette variable est initialisée.

               (service openssh-service-type
                        (openssh-configuration
                          (accepted-environment '("COLORTERM"))))

     authorized-keys (par défaut : '())
          C'est la liste des clefs autorisées.  Chaque élément de la liste est un nom d'utilisateur suivit d'un ou plusieurs objets simili-fichiers qui représentent les clefs publiques SSH.  Par exemple :

               (openssh-configuration
                 (authorized-keys
                   `(("rekado" ,(local-file "rekado.pub"))
                     ("chris" ,(local-file "chris.pub"))
                     ("root" ,(local-file "rekado.pub") ,(local-file "chris.pub")))))

          enregistre les clefs publiques spécifiées pour les comptes rekado, chris et root.

          Des clefs autorisées supplémentaires peuvent être spécifiées via service-extension.

          Remarquez que cela n'interfère pas avec l'utilisation de ~/.ssh/authorized_keys.

 -- Procédure Scheme: dropbear-service [CONFIG]
     Lance le démon SSH Dropbear (https://matt.ucc.asn.au/dropbear/dropbear.html) avec la configuration CONFIG donnée, un objet <dropbear-configuration>.

     Par exemple, pour spécifier un service Dropbear qui écoute sur le port 1234, ajoutez cet appel au champ services d evotre système d'exploitation :

          (dropbear-service (dropbear-configuration
                              (port-number 1234)))

 -- Type de données: dropbear-configuration
     Ce type de données représente la configuration d'un démon SSH Dropbear.

     dropbear (par défaut : DROPBEAR)
          Le paquet Dropbear à utiliser.

     port-number (par défaut : 22)
          Le port TCP sur lequel le démon attend des connexions entrantes.

     syslog-output? (par défaut : #t)
          Indique s'il faut activer la sortie vers syslog.

     pid-file (par défaut : "/var/run/dropbear.pid")
          Nom du fichier de PID du démon.

     root-login? (par défaut : #f)
          Indique s'il faut autoriser les connexions en root.

     allow-empty-passwords? (par défaut : #f)
          Indique s'il faut autoriser les mots de passes vides.

     password-authentication? (par défaut : #t)
          Indique s'il faut autoriser l'authentification par mot de passe.

 -- Variable Scheme: %facebook-host-aliases
     Cette variable contient une chaîne de caractères à utiliser dans /etc/hosts (see Host Names (The GNU C Library Reference Manual)).  Chaque ligne contient une entrée qui fait correspondre les noms des serveurs connus du service en ligne Facebook — p. ex. www.facebook.com — à l'hôte local — 127.0.0.1 ou son équivalent en IPv6, ::1.

     Cette variable est typiquement utilisée dans le champ hosts-file d'une déclaration operating-system (see /etc/hosts) :

          (use-modules (gnu) (guix))

          (operating-system
            (host-name "mamachine")
            ;; ...
            (hosts-file
              ;; Crée un fichier /etc/hosts avec des alias pour « localhost »
              ;; et « mamachine », ainsi que pour les serveurs de Facebook.
              (plain-file "hosts"
                          (string-append (local-host-aliases host-name)
                                         %facebook-host-aliases))))

     Ce mécanisme peut éviter que des programmes qui tournent localement, comme des navigateurs Web, ne se connectent à Facebook.

Le module (gnu services avahi) fourni la définition suivante.

 -- Procédure Scheme: avahi-service [#:avahi AVAHI]
     [#:host-name #f] [#:publish? #t] [#:ipv4? #t]
     [#:ipv6? #t] [#:wide-area? #f]
     [#:domains-to-browse '()] [#:debug? #f]
     Renvoie un service qui lance avahi-daemon, un serveur qui répond aux requêtes mDNS/DNS-SD qui permet de découvrir des services et de chercher des noms d'hôtes « sans configuration » (voir http://avahi.org/) et qui étend le démon de cache de services de noms (nscd) pour qu'il puisse résoudre des noms en .local avec nss-mdns (http://0pointer.de/lennart/projects/nss-mdns/).  En plus, ajoute le paquet AVAHI au profil du système pour que les commandes comme avahi-browse soient directement utilisables.

     Si HOST-NAME n'est pas #f, utilise cette valeur comme nom d'hôte à publier pour la machine ; sinon, utilise le vrai nom d'hôte de la machine.

     Lorsque la valeur de PUBLISH? est vraie, la publication des noms d'hôtes et des domaines sont autorisés ; en particulier, avahi-daemon publiera le nom d'hôte et l'adresse IP de la machine via mDNS sur le réseau local.

     Lorsque la valeur de WIDE-AREA? est vraie, DNS-SD sur DNS unicast est activé.

     Les valeurs booléennes IPV4? et IPV6? déterminent s'il faut utiliser un socket IPv4 ou IPv6 respectivement.

 -- Variable Scheme: openvswitch-service-type
     C'est le type du service Open vSwitch (http://www.openvswitch.org), dont la valeur devrait être un objet openvswitch-configuration.

 -- Type de données: openvswitch-configuration
     Type de données représentant la configuration de Open vSwitch, un commutateur virtuel multiniveaux conçu pour rendre possible l'automatisation massive des réseaux avec des extensions programmables.

     package (par défaut : OPENVSWITCH)
          Objet de paquet de Open vSwitch.

Système de fenêtrage X
......................

Le support pour le système d'affichage graphique X Window — en particulier Xorg — est fournit par le module (gnu services xorg).  Remarquez qu'il n'y a pas de procédure xorg-service.  À la place, le serveur X est démarré par le gestionnaire de connexion, par défaut SLiM.

Pour utiliser X11, vous devez installer au moins un gestionnaire de fenêtre — par exemple les paquets windowmaker ou openbox — de préférence en l'ajoutant au champ packages de votre définition de système d'exploitation (see system-wide packages).

 -- Variable Scheme: slim-service-type
     C'est de type pour le gestionnaire de connexion graphique SLiM pour X11.

     SLiM cherche des types de sessions définies par les fichiers .desktop dans /run/current-system/profile/share/xsessions et permet aux utilisateurs de choisir une session depuis l'écran de connexion avec F1.  Les paquets comme xfce, sawfish et ratpoison fournissent des fichiers .desktop ; les ajouter à l'ensemble des paquets du système les rendra automatiquement disponibles sur l'écran de connexion.

     En plus, les fichiers ~/.xsession sont honorées.  Lorsqu'il est disponible, ~/.xsession doit être un fichier exécutable qui démarre un gestionnaire de fenêtre au un autre client X.

 -- Type de données: slim-configuration
     Type de données représentant la configuration de slim-service-type.

     allow-empty-passwords? (par défaut : #t)
          S'il faut autoriser les connexions avec un mot de passe vide.

     auto-login? (par défaut : #f)
     default-user (par défaut : "")
          Lorsque auto-login? est faux, SLiM présent un écran de connexion.

          Lorsque auto-login? est vrai, SLiM se connecte directement en tant que default-user.

     theme (par défaut : %default-slim-theme)
     theme-name (par défaut : %default-slim-theme-name)
          Le thème graphique à utiliser et son nom.

     auto-login-session (par défaut : #f)
          Si la valeur est vraie, elle doit être le nom d'un exécutable à démarrer comme session par défaut — p. ex. (file-append windowmaker "/bin/windowmaker").

          Si la valeur est fausse, une session décrite par l'un des fichiers .desktop disponibles dans /run/current-system/profile et ~/.guix-profile sera utilisée.

               Vous devez installer au moins un gestionnaire de fenêtres dans le profil du système ou dans votre profil utilisateur.  Sinon, si auto-login-session est faux, vous ne serez jamais capable de vous connecter.

     startx (par défaut : (xorg-start-command))
          La commande utilisée pour démarrer le serveur graphique X11.

     xauth (par défaut : xauth)
          Le paquet XAuth à utiliser.

     shepherd (par défaut : shepherd)
          Le paquet Shepherd à utiliser pour invoquer halt et reboot.

     sessreg (par défaut : sessreg)
          Le paquet sessreg à utiliser pour enregistrer la session.

     slim (par défaut : slim)
          Le paquet SLiM à utiliser.

 -- Variable Scheme: %default-theme
 -- Variable Scheme: %default-theme-name
     Le thème SLiM par défaut et son nom.

 -- Type de données: sddm-configuration
     C'est le type de données représentant la configuration du service sddm.

     display-server (par défaut : "x11")
          Choisit le serveur d'affichage à utiliser pour l'écran d'accueil.  Les valeurs valides sont « x11 » et « wayland ».

     numlock (par défaut : "on")
          Les valeurs valides sont « on », « off » ou « none ».

     halt-command (par défaut : #~(string-apppend #$shepherd "/sbin/halt"))
          La commande à lancer à l'arrêt du système.

     reboot-command (par défaut : #~(string-append #$shepherd "/sbin/reboot"))
          La commande à lancer lors du redémarrage du système.

     theme (par défaut : "maldives")
          Le thème à utiliser.  Les thèmes par défaut fournis par SDDM sont « elarun » et « maldives ».

     themes-directory (par défaut : "/run/current-system/profile/share/sddm/themes")
          Le répertoire où se trouvent les thèmes.

     faces-directory (par défaut : "/run/current-system/profile/share/sddm/faces")
          Répertoire où se trouvent les avatars.

     default-path (par défaut : "/run/current-system/profile/bin")
          Le PATH par défaut à utiliser.

     minimum-uid (par défaut : 1000)
          UID minimum pour être affiché dans SDDM.

     maximum-uid (par défaut : 2000)
          UID maximum pour être affiché dans SDDM.

     remember-last-user? (par défaut : #t)
          S'il faut se rappeler le dernier utilisateur connecté.

     remember-last-session? (par défaut : #t)
          S'il faut se rappeler la dernière session.

     hide-users (par défaut : "")
          Les noms d'utilisateurs à cacher sur l'écran d'accueil de SDDM.

     hide-shells (par défaut : #~(string-append #$shadow "/sbin/nologin"))
          Les utilisateurs avec les shells listés seront cachés sur l'écran d'accueil de SDDM.

     session-command (par défaut : #~(string-append #$sddm "/share/sddm/scripts/wayland-session"))
          Le script à lancer avant de démarrer une session wayland.

     sessions-directory (par défaut : "/run/current-system/profile/share/wayland-sessions")
          Le répertoire où trouver les fichiers .desktop qui démarrent des sessions wayland.

     xorg-server-path (par défaut : xorg-start-command)
          Chemin vers xorg-server.

     xauth-path (par défaut : #~(string-append #$xauth "/bin/xauth"))
          Chemin vers xauth.

     xephyr-path (par défaut : #~(string-append #$xorg-server "/bin/Xephyr"))
          Chemin vers Xephyr.

     xdisplay-start (par défaut : #~(string-append #$sddm "/share/sddm/scripts/Xsetup"))
          Le script à lancer après avoir démarré xorg-server.

     xdisplay-stop (par défaut : #~(string-append #$sddm "/share/sddm/scripts/Xstop"))
          Le script à lancer avant d'arrêter xorg-server.

     xsession-command (par défaut : xinitrc)
          Le script à lancer avant de démarrer une session X.

     xsessions-directory (par défaut : "/run/current-system/profile/share/xsessions")
          Répertoire où trouver les fichiers .desktop pour les sessions X.

     minimum-vt (par défaut : 7)
          VT minimal à utiliser.

     xserver-arguments (par défaut : "-nolisten tcp")
          Arguments à passer à xorg-server.

     auto-login-user (par défaut : "")
          Utilisateur à utiliser pour la connexion automatique.

     auto-login-session (par défaut : "")
          Le fichier desktop à utiliser pour la connexion automatique.

     relogin? (par défaut : #f)
          S'il faut se reconnecter après la déconnexion.

 -- Procédure Scheme: sddm-service config
     Renvoie un service qui démarre le gestionnaire de connexion graphique SDDM avec une configuration de type <sddm-configuration>.

            (sddm-service (sddm-configuration
                           (auto-login-user "Alice")
                           (auto-login-session "xfce.desktop")))

 -- Procédure Scheme: xorg-start-command [#:guile]
     [#:modules %default-xorg-modules]
     [#:fonts %default-xorg-fonts]
     [#:configuration-file (xorg-configuration-file ...)]
     [#:xorg-server XORG-SERVER]
     Renvoie un script startx dans lequel MODULES, une liste de paquets de modules X et FONTS, une liste de répertoires de polices X, sont disponibles.  Voir xorg-wrapper pour plus de détails sur les arguments.  Le résultat devrait être utilisé à la place de startx.

     Habituellement le serveur X est démarré par un gestionnaire de connexion.

 -- Procédure Scheme: xorg-configuration-file
     [#:modules %default-xorg-modules]
     [#:fonts %default-xorg-fonts]
     [#:drivers '()] [#:resolutions '()] [#:extra-config '()]
     Renvoie un fichier de configuration pour le serveur Xorg qui contient des chemins de recherche pour tous les pilotes communs.

     MODULES doit être une liste de paquets de modules chargés par le serveur Xorg — p. ex. xf86-video-vesa, xf86-input-keyboard etc.  FONTS doit être une liste de répertoires de polices à ajouter au chemin de polices du serveur.

     DRIVERS doit être soit la liste vide, auquel cas Xorg choisis un pilote graphique automatiquement, soit une liste de noms de pilotes qui seront essayés dans cet ordre — p. ex. ("modesetting" "vesa").

     De même, lorsque RESOLUTIONS est la liste vide, Xorg choisis une résolution d'écran appropriée ; autrement, ce doit être une liste de résolutions — p. ex. ((1024 768) (640 480)).

     Enfin, EXTRA-CONFIG est une liste de chaînes de caractères ou d'objets ajoutés au fichier de configuration.  Elle est utilisée pour passer du texte supplémentaire à être ajouté directement au fichier de configuration.

     Cette procédure est particulièrement utile pour configurer une disposition de clavier différente de la disposition US par défaut.  Par exemple, pour utiliser la disposition « bépo » par défaut sur le gestionnaire d'affichage :

          (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)))))))))

     La ligne MatchIsKeyboard spécifie que nous n'appliquons la configuration qu'aux claviers.  Sans cette ligne, d'autres périphériques comme les pavés tactiles ne fonctionneront pas correctement parce qu'ils seront associés au mauvais pilote.  Dans cet exemple, l'utilisateur utiliserait typiquement setxkbmap fr bepo pour utiliser sa disposition de clavier préférée une fois connecté.  Le premier argument correspond à la disposition, tandis que le second argument correspond à la variante.  La ligne xkb_variant peut être omise pour choisir la variante par défaut.

 -- Procédure Scheme: screen-locker-service PACKAGE [PROGRAM]
     Ajoute PACKAGE, un paquet pour un verrouiller l'écran ou un économiseur d'écran dont la commande est PROGRAM, à l'ensemble des programmes setuid et lui ajoute une entrée PAM.  Par exemple :

          (screen-locker-service xlockmore "xlock")

     rend utilisable le bon vieux XlockMore.

Services d'impression
.....................

Le module (gnu services cups) fournit une définition de service Guix pour le service d'impression CUPS.  Pour ajouter le support d'une imprimante à un système GuixSD, ajoutez un cups-service à la définition du système d'exploitation :

 -- Variable Scheme: cups-service-type
     Le type de service pour un serveur d'impression CUPS.  Sa valeur devrait être une configuration CUPS valide (voir plus bas).  Pour utiliser les paramètres par défaut, écrivez simplement :

          (service cups-service-type)

La configuration de CUPS contrôle les paramètres de base de votre installation CUPS : sur quelles interfaces il doit écouter, que faire si un travail échoue, combien de journalisation il faut faire, etc.  Pour ajouter une imprimante, vous devrez visiter l'URL http://localhost:631 ou utiliser un outil comme les services de configuration d'imprimante de GNOME.  Par défaut, la configuration du service CUPS générera un certificat auto-signé si besoin, pour les connexions sécurisée avec le serveur d'impression.

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.

Les paramètres de configuration disponibles sont les suivants.  Chaque définition des paramètres est précédé par son type ; par exemple, string-list foo indique que le paramètre foo devrait être spécifié comme une liste de chaînes de caractères.  Il y a aussi une manière de spécifier la configuration comme une chaîne de caractères, si vous avez un vieux fichier cupsd.conf que vous voulez porter depuis un autre système ; voir la fin pour plus de détails.

Les champs de cups-configuration disponibles sont :

 -- paramètre de cups-configuration: package cups
     Le paquet CUPS.

 -- paramètre de cups-configuration: package-list extensions
     Pilotes et autres extensions du paquet CUPS.

 -- paramètre de cups-configuration: files-configuration files-configuration
     Configuration de l'emplacement où écrire les journaux, quels répertoires utiliser pour les travaux d'impression et les paramètres de configuration privilégiés liés.

     Les champs files-configuration disponibles sont :

      -- paramètre de files-configuration: log-location access-log
          Définit le fichier de journal d'accès.  Spécifier un nom de fichier vide désactive la génération de journaux d'accès.  La valeur stderr fait que les entrées du journal seront envoyés sur l'erreur standard lorsque l'ordonnanceur est lancé au premier plan ou vers le démon de journal système lorsqu'il tourne en tache de fond.  La valeur syslog fait que les entrées du journal sont envoyées au démon de journalisation du système.  Le nom du serveur peut être inclus dans les noms de fichiers avec la chaîne %s, comme dans /var/log/cups/%s-access_log.

          La valeur par défaut est "/var/log/cups/access_log".

      -- paramètre de files-configuration: file-name cache-dir
          L'emplacement où CUPS devrait mettre les données en cache.

          La valeur par défaut est "/var/cache/cups".

      -- paramètre de files-configuration: string config-file-perm
          Spécifie les permissions pour tous les fichiers de configuration que l'ordonnanceur écrit.

          Remarquez que les permissions pour le fichier printers.conf sont actuellement masqués pour ne permettre que l'accès par l'utilisateur de l'ordonnanceur (typiquement root).  La raison est que les URI des imprimantes contiennent des informations d'authentification sensibles qui ne devraient pas être connues sur le système.  Il n'est pas possible de désactiver cette fonctionnalité de sécurité.

          La valeur par défaut est "0640".

      -- paramètre de files-configuration: log-location error-log
          Définit le fichier de journal d'erreur.  Spécifier un nom de fichier vide désactive la génération de journaux d'erreur.  La valeur stderr fait que les entrées du journal seront envoyés sur l'erreur standard lorsque l'ordonnanceur est lancé au premier plan ou vers le démon de journal système lorsqu'il tourne en tache de fond.  La valeur syslog fait que les entrées du journal sont envoyées au démon de journalisation du système.  Le nom du serveur peut être inclus dans les noms de fichiers avec la chaîne %s, comme dans /var/log/cups/%s-error_log.

          La valeur par défaut est "/var/log/cups/error_log".

      -- paramètre de files-configuration: string fatal-errors
          Spécifie quelles erreurs sont fatales, qui font terminer l'ordonnanceur. Les types de chaînes sont :

          none
               Aucune erreur n'est fatale.

          all
               Toutes les erreurs ci-dessous sont fatales.

          browse
               Les erreurs d'initialisation de la navigation sont fatales, par exemple les connexion échouées au démon DNS-SD.

          config
               Les erreurs de syntaxe du fichier de configuration sont fatale.

          listen
               Les erreurs d'écoute ou de port sont fatales, sauf pour les erreurs d'IPv6 sur la boucle locale ou les adresses any.

          log
               Les erreurs de création ou d'écriture des fichiers de journal sont fatales.

          permissions
               Les mauvaises permissions des fichiers de démarrage sont fatales, par exemple un certificat TLS et des fichiers de clefs avec des permissions permettant la lecture à tout le monde.

          La valeur par défaut est "all -browse".

      -- paramètre de files-configuration: boolean file-device?
          Spécifie si le fichier de pseudo-périphérique peut être utilisé pour de nouvelles queues d'impression.  L'URI file:///dev/null est toujours permise.

          La valeur par défaut est #f.

      -- paramètre de files-configuration: string group
          Spécifie le nom ou l'ID du groupe qui sera utilisé lors de l'exécution de programmes externes.

          La valeur par défaut est "lp".

      -- paramètre de files-configuration: string log-file-perm
          Spécifie les permissions pour tous les fichiers de journal que l'ordonnanceur écrit.

          La valeur par défaut est "0644".

      -- paramètre de files-configuration: log-location page-log
          Définit le fichier de journal de page.  Spécifier un nom de fichier vide désactive la génération de journaux de pages.  La valeur stderr fait que les entrées du journal seront envoyés sur l'erreur standard lorsque l'ordonnanceur est lancé au premier plan ou vers le démon de journal système lorsqu'il tourne en tache de fond.  La valeur syslog fait que les entrées du journal sont envoyées au démon de journalisation du système.  Le nom du serveur peut être inclus dans les noms de fichiers avec la chaîne %s, comme dans /var/log/cups/%s-page_log.

          La valeur par défaut est "/var/log/cups/page_log".

      -- paramètre de files-configuration: string remote-root
          Spécifie le nom d'utilisateur associé aux accès non authentifiés par des clients qui se disent être l'utilisateur root.  La valeur par défaut est remroot.

          La valeur par défaut est "remroot".

      -- paramètre de files-configuration: file-name request-root
          Spécifie le répertoire qui contient les travaux d'impression et d'autres données des requêtes HTTP.

          La valeur par défaut est "/var/spool/cups".

      -- paramètre de files-configuration: sandboxing sandboxing
          Spécifie le niveau d'isolation de sécurité appliqué aux filtres d'impression, aux moteurs et aux autres processus fils de l'ordonnanceur ; soit relaxed soit strict.  Cette directive n'est actuellement utilisée et supportée que sur macOS.

          La valeur par défaut est strict.

      -- paramètre de files-configuration: file-name server-keychain
          Spécifie l'emplacement des certifications TLS et des clefs privées.  CUPS cherchera les clefs publiques et privées dans ce répertoire : un fichier .crt pour un certificat encodé en PEM et le fichier .key correspondant pour la clef privée encodée en PEM.

          La valeur par défaut est "/etc/cups/ssl".

      -- paramètre de files-configuration: file-name server-root
          Spécifie le répertoire contenant les fichiers de configuration du serveur.

          La valeur par défaut est "/etc/cups".

      -- paramètre de files-configuration: boolean sync-on-close?
          Spécifie si l'ordonnanceur appelle fsync(2) après avoir écrit la configuration ou les fichiers d'état.

          La valeur par défaut est #f.

      -- paramètre de files-configuration: space-separated-string-list system-group
          Spécifie le groupe ou les groupes à utiliser pour l'authentification du groupe @SYSTEM.

      -- paramètre de files-configuration: file-name temp-dir
          Spécifie le répertoire où les fichiers temporaires sont stockés.

          La valeur par défaut est "/var/spool/cups/tmp".

      -- paramètre de files-configuration: string user
          Spécifie le nom d'utilisateur ou l'ID utilisé pour lancer des programmes externes.

          La valeur par défaut est "lp".

 -- paramètre de cups-configuration: access-log-level access-log-level
     Spécifie le niveau de journalisation pour le fichier AccessLog.  Le niveau config enregistre les ajouts, suppressions et modifications d'imprimantes et de classes et lorsque les fichiers de configuration sont accédés ou mis à jour.  Le niveau actions enregistre la soumission, la suspension, la libération, la modification et l'annulation des travaux et toutes les conditions de config.  Le niveau all enregistre toutes les requêtes.

     La valeur par défaut est actions.

 -- paramètre de cups-configuration: boolean auto-purge-jobs?
     Spécifie s'il faut vider l'historique des travaux automatiquement lorsqu'il n'est plus nécessaire pour les quotas.

     La valeur par défaut est #f.

 -- paramètre de cups-configuration: browse-local-protocols browse-local-protocols
     Spécifie les protocoles à utiliser pour partager les imprimantes sur le réseau local.

     La valeur par défaut est dnssd.

 -- paramètre de cups-configuration: boolean browse-web-if?
     Spécifie si l'interface web de CUPS est publiée.

     La valeur par défaut est #f.

 -- paramètre de cups-configuration: boolean browsing?
     Spécifie si les imprimantes partagées sont publiées.

     La valeur par défaut est #f.

 -- paramètre de cups-configuration: string classification
     Spécifie la classification de sécurité du serveur.  N'importe quel nom de bannière peut être utilisé, comme « classifié », « confidentiel », « secret », « top secret » et « déclassifié » ou la bannière peut être omise pour désactiver les fonctions d'impression sécurisées.

     La valeur par défaut est "".

 -- paramètre de cups-configuration: boolean classify-override?
     Spécifie si les utilisateurs peuvent remplacer la classification (page de couverture) des travaux d'impression individuels avec l'option job-sheets.

     La valeur par défaut est #f.

 -- paramètre de cups-configuration: default-auth-type default-auth-type
     Spécifie le type d'authentification par défaut à utiliser.

     La valeur par défaut est Basic.

 -- paramètre de cups-configuration: default-encryption default-encryption
     Spécifie si le chiffrement sera utilisé pour les requêtes authentifiées.

     La valeur par défaut est Required.

 -- paramètre de cups-configuration: string default-language
     Spécifie la langue par défaut à utiliser pour le contenu textuel et web.

     La valeur par défaut est "en".

 -- paramètre de cups-configuration: string default-paper-size
     Spécifie la taille de papier par défaut pour les nouvelles queues d'impression.  "Auto" utilise la valeur par défaut du paramètre de régionalisation, tandis que "None" spécifie qu'il n'y a pas de taille par défaut.  Des noms de tailles spécifique sont par exemple "Letter" et "A4".

     La valeur par défaut est "Auto".

 -- paramètre de cups-configuration: string default-policy
     Spécifie la politique d'accès par défaut à utiliser.

     La valeur par défaut est "default".

 -- paramètre de cups-configuration: boolean default-shared?
     Spécifie si les imprimantes locales sont partagées par défaut.

     La valeur par défaut est #t.

 -- paramètre de cups-configuration: non-negative-integer dirty-clean-interval
     Spécifie le délai pour mettre à jour les fichiers de configuration et d'état.  Une valeur de 0 fait que la mise à jour arrive aussi vite que possible, typiquement en quelques millisecondes.

     La valeur par défaut est 30.

 -- paramètre de cups-configuration: error-policy error-policy
     Spécifie ce qu'il faut faire si une erreur a lieu.  Les valeurs possibles sont abort-job, qui supprimera les travaux d'impression en échec ; retry-job, qui tentera de nouveau l'impression plus tard ; retry-this-job, qui retentera l'impression immédiatement ; et stop-printer qui arrête l'imprimante.

     La valeur par défaut est stop-printer.

 -- paramètre de cups-configuration: non-negative-integer filter-limit
     Spécifie le coût maximum des filtres qui sont lancés en même temps, pour minimiser les problèmes de ressources de disque, de mémoire et de CPU.  Une limite de 0 désactive la limite de filtrage.  Une impression standard vers une imprimante non-PostScript requirt une limite de filtre d'environ 200. Une imprimante PostScript requiert environ la moitié (100).  Mettre en place la limite en dessous de ces valeurs limitera l'ordonnanceur à un seul travail d'impression à la fois.

     La valeur par défaut est 0.

 -- paramètre de cups-configuration: non-negative-integer filter-nice
     Spécifie la priorité des filtres de l'ordonnanceur qui sont lancés pour imprimer un travail.  La valeur va de 0, la plus grande priorité, à 19, la plus basse priorité.

     La valeur par défaut est 0.

 -- paramètre de cups-configuration: host-name-lookups host-name-lookups
     Spécifie s'il faut faire des résolutions inverses sur les clients qui se connectent.  Le paramètre double fait que cupsd vérifie que le nom d'hôte résolu depuis l'adresse correspond à l'une des adresses renvoyées par ce nom d'hôte.  Les résolutions doubles évitent aussi que des clients avec des adresses non enregistrées ne s'adressent à votre serveur. N'initialisez cette valeur qu'à #t ou double que si c'est absolument nécessaire.

     La valeur par défaut est #f.

 -- paramètre de cups-configuration: non-negative-integer job-kill-delay
     Spécifie le nombre de secondes à attendre avant de tuer les filtres et les moteurs associés avec un travail annulé ou suspendu.

     La valeur par défaut est 30.

 -- paramètre de cups-configuration: non-negative-integer job-retry-interval
     Spécifie l'intervalle des nouvelles tentatives en secondes.  C'est typiquement utilisé pour les queues de fax mais peut aussi être utilisé avec des queues d'impressions normales dont la politique d'erreur est retry-job ou retry-current-job.

     La valeur par défaut est 30.

 -- paramètre de cups-configuration: non-negative-integer job-retry-limit
     Spécifie le nombre de nouvelles tentatives pour les travaux.  C'est typiquement utilisé pour les queues de fax mais peut aussi être utilisé pour les queues d'impressions dont la politique d'erreur est retry-job ou retry-current-job.

     La valeur par défaut est 5.

 -- paramètre de cups-configuration: boolean keep-alive?
     Spécifie s'il faut supporter les connexion HTTP keep-alive.

     La valeur par défaut est #t.

 -- paramètre de cups-configuration: non-negative-integer keep-alive-timeout
     Spécifie combien de temps les connexions inactives avec les clients restent ouvertes, en secondes.

     La valeur par défaut est 30.

 -- paramètre de cups-configuration: non-negative-integer limit-request-body
     Spécifie la taille maximale des fichiers à imprimer, des requêtes IPP et des données de formulaires HTML.  Une limite de 0 désactive la vérification de la limite.

     La valeur par défaut est 0.

 -- paramètre de cups-configuration: multiline-string-list listen
     Écoute sur les interfaces spécifiées.  Les valeurs valides sont de la forme ADRESSE:PORT, où ADRESSE est sotit une daresse IPv6 dans des crochets, soit une adresse IPv4, soit * pour indiquer toutes les adresses.  Les valeurs peuvent aussi être des noms de fichiers de socket UNIX domain.  La directive Listen est similaire à la directive Port mais vous permet de restreindre l'accès à des interfaces ou des réseaux spécifiques.

 -- paramètre de cups-configuration: non-negative-integer listen-back-log
     Spécifie le nombre de connexions en attente qui seront permises.  Ça n'affecte normalement que les serveurs très actifs qui ont atteint la limite MaxClients, mais peut aussi être déclenché par un grand nombre de connexions simultanées.  Lorsque la limite est atteinte, le système d'exploitation refusera les connexions supplémentaires jusqu'à ce que l'ordonnanceur accepte les connexions en attente.

     La valeur par défaut est 128.

 -- paramètre de cups-configuration: location-access-control-list location-access-controls
     Spécifie un ensemble de contrôles d'accès supplémentaires.

     Les champs de location-access-controls disponibles sont :

      -- paramètre de location-access-controls: file-name path
          Spécifie le chemin d'URI auquel les contrôles d'accès s'appliquent.

      -- paramètre de location-access-controls: access-control-list access-controls
          Les contrôles d'accès pour tous les accès à ce chemin, dans le même format que le champ access-controls de operation-access-control.

          La valeur par défaut est ().

      -- paramètre de location-access-controls: method-access-control-list method-access-controls
          Contrôles d'accès pour les accès spécifiques à la méthode à ce chemin.

          La valeur par défaut est ().

          Les champs de method-access-controls disponibles sont :

           -- paramètre de method-access-controls: boolean reverse?
               Si la valeur est #t, applique les contrôles d'accès à toutes les méthodes sauf les méthodes listées.  Sinon, applique le contrôle uniquement aux méthodes listées.

               La valeur par défaut est #f.

           -- paramètre de method-access-controls: method-list methods
               Les méthodes auxquelles ce contrôle d'accès s'applique.

               La valeur par défaut est ().

           -- paramètre de method-access-controls: access-control-list access-controls
               Directives de contrôle d'accès, comme une liste de chaînes de caractères. Chaque chaîne devrait être une directive, comme « Order allow, deny ».

               La valeur par défaut est ().

 -- paramètre de cups-configuration: non-negative-integer log-debug-history
     Spécifie le nombre de messages de débogage qui sont retenu pour la journalisation si une erreur arrive dans un travail d'impression.  Les messages de débogage sont journalisés indépendamment du paramètre LogLevel.

     La valeur par défaut est 100.

 -- paramètre de cups-configuration: log-level log-level
     Spécifie le niveau de journalisation du fichier ErrorLog.  La valeur none arrête toute journalisation alors que que debug2 enregistre tout.

     La valeur par défaut est info.

 -- paramètre de cups-configuration: log-time-format log-time-format
     Spécifie le format de la date et de l'heure dans les fichiers de journaux. La valeur standard enregistre les secondes entières alors que usecs enregistre les microsecondes.

     La valeur par défaut est standard.

 -- paramètre de cups-configuration: non-negative-integer max-clients
     Spécifie le nombre maximum de clients simultanés qui sont autorisés par l'ordonnanceur.

     La valeur par défaut est 100.

 -- paramètre de cups-configuration: non-negative-integer max-clients-per-host
     Spécifie le nombre maximum de clients simultanés permis depuis une même adresse.

     La valeur par défaut est 100.

 -- paramètre de cups-configuration: non-negative-integer max-copies
     Spécifie le nombre maximum de copies qu'un utilisateur peut imprimer pour chaque travail.

     La valeur par défaut est 9999.

 -- paramètre de cups-configuration: non-negative-integer max-hold-time
     Spécifie la durée maximum qu'un travail peut rester dans l'état de suspension indefinite avant qu'il ne soit annulé.  La valeur 0 désactive l'annulation des travaux suspendus.

     La valeur par défaut est 0.

 -- paramètre de cups-configuration: non-negative-integer max-jobs
     Spécifie le nombre maximum de travaux simultanés autorisés.  La valeur 0 permet un nombre illimité de travaux.

     La valeur par défaut est 500.

 -- paramètre de cups-configuration: non-negative-integer max-jobs-per-printer
     Spécifie le nombre maximum de travaux simultanés autorisés par imprimante. La valeur 0 permet au plus MaxJobs travaux par imprimante.

     La valeur par défaut est 0.

 -- paramètre de cups-configuration: non-negative-integer max-jobs-per-user
     Spécifie le nombre maximum de travaux simultanés permis par utilisateur.  La valeur 0 permet au plus MaxJobs travaux par utilisateur.

     La valeur par défaut est 0.

 -- paramètre de cups-configuration: non-negative-integer max-job-time
     Spécifie la durée maximum qu'un travail peut prendre avant qu'il ne soit annulé, en secondes.  Indiquez 0 pour désactiver l'annulation des travaux « coincés ».

     La valeur par défaut est 10800.

 -- paramètre de cups-configuration: non-negative-integer max-log-size
     Spécifie la taille maximale des fichiers de journaux avant qu'on ne les fasse tourner, en octets.  La valeur 0 désactive la rotation.

     La valeur par défaut est 1048576.

 -- paramètre de cups-configuration: non-negative-integer multiple-operation-timeout
     Spécifie la durée maximale à permettre entre les fichiers d'un travail en contenant plusieurs, en secondes.

     La valeur par défaut est 300.

 -- paramètre de cups-configuration: string page-log-format
     Spécifie le format des lignes PageLog.  Les séquences qui commencent par un pourcent (%) sont remplacées par l'information correspondante, tandis que les autres caractères sont copiés littéralement.  Les séquences pourcent suivantes sont reconnues :

     %%
          insère un seul caractères pourcent

     %{name}
          insère la valeur de l'attribut IPP spécifié

     %C
          insère le nombre de copies pour la page actuelle

     %P
          insère le numéro de page actuelle

     %T
          insère la date et l'heure actuelle dans un format de journal commun

     %j
          insère l'ID du travail

     %p
          insère le nom de l'imprimante

     %u
          insère le nom d'utilisateur

     Si la valeur est la chaîne vide, le PageLog est désactivée.  La chaîne %p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides} crée un PageLog avec les entrées standards.

     La valeur par défaut est "".

 -- paramètre de cups-configuration: environment-variables environment-variables
     Passe les variables d'environnement spécifiées aux processus fils ; une liste de chaînes de caractères.

     La valeur par défaut est ().

 -- paramètre de cups-configuration: policy-configuration-list policies
     Spécifie des politiques de contrôle d'accès nommées.

     Les champs de policy-configuration disponibles sont :

      -- paramètre de policy-configuration: string name
          Nom de la politique.

      -- paramètre de policy-configuration: string job-private-access
          Spécifie une liste d'accès pour les valeurs privées du travail. @ACL correspond aux valeurs requesting-user-name-allowed ou requesting-user-name-denied de l'imprimante.  @OWNER correspond au propriétaire du travail.  @SYSTEM correspond aux groupes listés dans le champ system-group de la configuration files-config, qui est réifié dans le fichier cups-files.conf(5).  Les autres éléments possibles de la liste d'accès sont des noms d'utilisateurs spécifiques et @GROUP pour indiquer les membres d'un groupe spécifique.  La liste d'accès peut aussi être simplement all ou default.

          La valeur par défaut est "@OWNER @SYSTEM".

      -- paramètre de policy-configuration: string job-private-values
          Spécifie la liste des valeurs de travaux à rendre privée, ou all, default, ou none.

          La valeur par défaut est "job-name job-originating-host-name job-originating-user-name phone".

      -- paramètre de policy-configuration: string subscription-private-access
          Spécifie un liste d'accès pour les valeurs privées de la souscription. @ACL correspond aux valeurs requesting-user-name-allowed ou requesting-user-name-denied de l'imprimante.  @OWNER correspond au propriétaire du travail.  @SYSTEM correspond aux groupes listés dans le champ system-group de la configuration files-config, qui est réifié dans le fichier cups-files.conf(5).  Les autres éléments possibles de la liste d'accès sont des noms d'utilisateurs spécifiques et @GROUP pour indiquer les membres d'un groupe spécifique.  La liste d'accès peut aussi être simplement all ou default.

          La valeur par défaut est "@OWNER @SYSTEM".

      -- paramètre de policy-configuration: string subscription-private-values
          Spécifie la liste des valeurs de travaux à rendre privée, ou all, default, ou none.

          La valeur par défaut est "notify-events notify-pull-method notify-recipient-uri notify-subscriber-user-name notify-user-data".

      -- paramètre de policy-configuration: operation-access-control-list access-controls
          Contrôle d'accès par les actions IPP.

          La valeur par défaut est ().

 -- paramètre de cups-configuration: boolean-or-non-negative-integer preserve-job-files
     Spécifie si les fichiers de travaux (les documents) sont préservés après qu'un travail est imprimé.  Si une valeur numérique est spécifiée, les fichiers de travaux sont préservés pour le nombre de secondes indiquées après l'impression.  Sinon, une valeur booléenne s'applique indéfiniment.

     La valeur par défaut est 86400.

 -- paramètre de cups-configuration: boolean-or-non-negative-integer preserve-job-history
     Spécifie si l'historique des travaux est préservé après qu'un travail est imprimé.  Si une valeur numérique est spécifiée, l'historique des travaux est préservé pour le nombre de secondes indiquées après l'impression.  Si la valeur est #t, l'historique des travaux est préservé jusqu'à atteindre la limite MaxJobs.

     La valeur par défaut est #t.

 -- paramètre de cups-configuration: non-negative-integer reload-timeout
     Spécifie la durée d'attente pour la fin des travaux avant de redémarrer l'ordonnanceur.

     La valeur par défaut est 30.

 -- paramètre de cups-configuration: string rip-cache
     Spécifie la quantité de mémoire maximale à utiliser pour convertir des documents en bitmaps pour l'imprimante.

     La valeur par défaut est "128m".

 -- paramètre de cups-configuration: string server-admin
     Spécifie l'adresse de courriel de l'administrateur système.

     La valeur par défaut est "root@localhost.localdomain".

 -- paramètre de cups-configuration: host-name-list-or-* server-alias
     La directive ServerAlias est utilisée pour la validation des en-tête HTTP Host lorsque les clients se connectent à l'ordonnanceur depuis des interfaces externes.  Utiliser le nom spécial * peut exposer votre système à des attaques connues de recombinaison DNS dans le navigateur, même lorsque vous accédez au site à travers un pare-feu.  Si la découverte automatique des autres noms ne fonctionne pas, nous vous recommandons de lister chaque nom alternatif avec une directive SeverAlias plutôt que d'utiliser *.

     La valeur par défaut est *.

 -- paramètre de cups-configuration: string server-name
     Spécifie le nom d'hôte pleinement qualifié du serveur.

     La valeur par défaut est "localhost".

 -- paramètre de cups-configuration: server-tokens server-tokens
     Spécifie les informations incluses dans les en-têtes Server des réponses HTTP.  None désactive l'en-tête Server.  ProductOnly rapporte CUPS.  Major rapporte CUPS 2.  Minor rapporte CUPS 2.0.  Minimal rapporte CUPS 2.0.0.  OS rapporte CUPS 2.0.0 (UNAME) où UNAME est la sortie de la commande uname.  Full rapporte CUPS 2.0.0 (UNAME) IPP/2.0.

     La valeur par défaut est Minimal.

 -- paramètre de cups-configuration: string set-env
     Indique que la variable d'environnement spécifiée doit être passée aux processus fils.

     La valeur par défaut est "variable value".

 -- paramètre de cups-configuration: multiline-string-list ssl-listen
     Écoute des connexions chiffrées sur les interfaces spécifiées.  Les valeurs valides sont de la forme ADRESSE:PORT, où ADRESSE est soit une adresse IPv6 dans des crochets, soit une adresse IPv4, soit * pour indiquer toutes les interfaces.

     La valeur par défaut est ().

 -- paramètre de cups-configuration: ssl-options ssl-options
     Indique les options de chiffrement.  Par défaut, CUPS ne supporte que le chiffrement avec TLS 1.0 ou plus avec des suites de chiffrement connues pour être sures.  L'option AllowRC4 active les suites de chiffrement 128-bits RC4, qui sont requises pour certains vieux clients qui n'implémentent pas les nouvelles.  L'option AllowSSL3 active SSL v3.0, qui est requis par certains vieux clients qui ne supportent pas TLS v1.0.

     La valeur par défaut est ().

 -- paramètre de cups-configuration: boolean strict-conformance?
     Spécifie si l'ordonnanceur demande aux clients d'adhérer aux spécifications IPP.

     La valeur par défaut est #f.

 -- paramètre de cups-configuration: non-negative-integer timeout
     Spécifie le délai d'attente des requêtes HTTP, en secondes.

     La valeur par défaut est 300.

 -- paramètre de cups-configuration: boolean web-interface?
     Spécifie si l'interface web est activée.

     La valeur par défaut est #f.

Maintenant, vous vous dîtes peut-être « oh la la, cher manuel de Guix, je t'aime bien mais arrête maintenant avec ces options de configuration » (NdT : je vous rassure, c'est aussi mon sentiment au moment de traduire ces lignes.  Et pour moi, c'est encore loin d'être fini.).  En effet.  cependant, encore un point supplémentaire : vous pouvez avoir un fichier cupsd.conf existant que vous pourriez vouloir utiliser.  Dans ce cas, vous pouvez passer un opaque-cups-configuration en configuration d'un cups-service-type.

Les champs de opaque-cups-configuration disponibles sont :

 -- paramètre de opaque-cups-configuration: package cups
     Le paquet CUPS.

 -- paramètre de opaque-cups-configuration: string cupsd.conf
     Le contenu de cupsd.conf, en tant que chaîne de caractères.

 -- paramètre de opaque-cups-configuration: string cups-files.conf
     Le contenu du fichier cups-files.conf, en tant que chaîne de caractères.

Par exemple, si vos fichiers cupsd.conf et cups-files.conf sont dans des chaînes du même nom, pouvez instancier un service CUPS de cette manière :

     (service cups-service-type
              (opaque-cups-configuration
                (cupsd.conf cupsd.conf)
                (cups-files.conf cups-files.conf)))

Services de bureaux
...................

Le module (gnu services desktop) fournit des services qui sont habituellement utiles dans le contexte d'une installation « de bureau » — c'est-à-dire sur une machine qui fait tourner un service d'affichage graphique, éventuellement avec des interfaces utilisateurs graphiques, etc. Il définit aussi des services qui fournissent des environnements de bureau spécifiques comme GNOME, XFCE et MATE.

Pour simplifier les choses, le module définit une variable contenant l'ensemble des services que les utilisateurs s'attendent en général à avoir sur une machine avec un environnement graphique et le réseau :

 -- Variable Scheme: %desktop-services
     C'est la liste des services qui étend %BASE-SERVICES en ajoutant ou en ajustant des services pour une configuration « de bureau » typique.

     En particulier, il ajoute un gestionnaire de connexion graphique (see slim-service), des verrouilleurs d'écran, un outil de gestion réseau (see network-manager-service-type), des services de gestion de l'énergie et des couleurs, le gestionnaire de connexion et de session elogind, le service de privilèges Polkit, le service de géolocalisation GeoClue, le démon Accounts Service qui permet aux utilisateurs autorisés de changer leur mot de passe, un client NTP (see Services réseau), le démon Avahi, et le service name service switch est configuré pour pouvoir utiliser nss-mdns (see mDNS).

La variable %DESKTOP-SERVICES peut être utilisée comme champ services d'une déclaration operating-system (see services).

En plus, les procédures gnome-desktop-service, xfce-desktop-service, mate-desktop-service et enlightenment-desktop-service-type peuvent ajouter GNOME, XFCE, MATE ou Enlightenment à un système.  « Ajouter GNOME » signifie que les services du système comme les utilitaires d'ajustement de la luminosité et de gestion de l'énergie sont ajoutés au système, en étendant polkit et dbus de la bonne manière, ce qui permet à GNOME d'opérer avec des privilèges plus élevés sur un nombre limité d'interfaces systèmes spécialisées.  En plus, ajouter un service construit par gnome-desktop-service ajoute le métapaquet GNOME au profil du système.  de même, ajouter le service XFCE ajoute le métapaquet xfce au profil système, mais il permet aussi au gestionnaire de fichiers Thunar d'ouvrir une fenêtre de gestion des fichier « en mode root », si l'utilisateur s'authentifie avec le mot de passe administrateur via l'interface graphique polkit standard.  « Ajouter MATE » signifie que polkit et dbus sont étendue de la bonne manière, ce qui permet à MATE d'opérer avec des privilèges plus élevés sur un nombre limité d'interface systèmes spécialisées.  « Ajouter ENLIGHTENMENT » signifie que dbus est étendu comme il faut et que plusieurs binaires d'Enlightenment récupèrent le bit setuid, ce qui permet au verrouilleur d'écran d'Enlightenment et à d'autres fonctionnalités de fonctionner correctement.

Les environnement de bureau dans Guix utilisent le service d'affichage Xorg par défaut.  Si vous voulez utiliser le protocol de serveur d'affichage plus récent Wayland, vous devez utiliser sddm-service à la place de slim-service comme gestionnaire de connexion graphique.  Vous devriez ensuite sélectionner la session « GNOME (Wayland) » dans SDDM.  Autrement, vous pouvez essayer de démarrer GNOME sur Wayland manuellement depuis un TTY avec la commande XDG_SESSION_TYPE=wayland exec dbus-run-session gnome-session.  Actuellement seul GNOME support Wayland.

 -- Procédure Scheme: gnome-desktop-service
     Renvoie un service qui ajoute le paquet gnome au profil système et étend polkit avec des actions de gnome-settings-daemon.

 -- Procédure Scheme: xfce-desktop-service
     Renvoie un service qui ajoute le paquet xfce au profil du système et étend polkit avec la capacité pour thunar de manipuler le système de fichier en tant que root depuis une session utilisateur, après que l'utilisateur s'est authentifié avec le mot de passe administrateur.

 -- Procédure Scheme: mate-desktop-service
     Renvoie un service qui ajoute le paquet mate au profil du système et étend polkit avec les actions de mate-settings-daemon.

 -- Procédure Scheme: enlightenment-desktop-service-type
     Renvoie un service qui ajoute le paquet enlightenment et étend dbus avec les actions de efl

 -- Type de données: enlightenment-desktop-service-configuration

     enlightenment (par défaut : enlightenment)
          Le paquet enlightenment à utiliser.

Comme les services de bureau GNOME, XFCE et MATE récupèrent tant de paquet, la variable %desktop-services par défaut n'inclut aucun d'entre eux. Pour ajouter GNOME, XFCE ou MATE, utilisez cons pour les ajouter à %desktop-services dans le champ services de votre operating-system.

     (use-modules (gnu))
     (use-service-modules desktop)
     (operating-system
       ...
       ;; cons* ajoute les élément à la liste donnée en dernier argument
       (services (cons* (gnome-desktop-service)
                        (xfce-desktop-service)
                        %desktop-services))
       ...)

Ces environnements de bureau seront alors disponibles comme une option dans la fenêtre de connexion graphique.

Les définitions de service qui sont vraiment incluses dans %desktop-services et fournies par (gnu services dbus) et (gnu services desktop) sont décrites plus bas.

 -- Procédure Scheme: dbus-service [#:dbus DBUS] [#:services '()]
     Renvoie un service qui lance le « bus système », DBUS, avec le support de SERVICES.

     D-Bus (http://dbus.freedesktop.org/) est un utilitaire de communication inter-processus.  Son bus système est utilisé pour permettre à des services systèmes de communiquer et d'être notifiés d'événements systèmes.

     SERVICES doit être une liste de paquets qui fournissent un répertoire etc/dbus-1/system.d contenant de la configuration D-Bus supplémentaire et des fichiers de politiques.  Par exemple, pour permettre à avahi-daemon d'utiliser le bus système, SERVICES doit être égal à (list avahi).

 -- Procédure Scheme: elogind-service [#:config CONFIG]
     Renvoie un service qui lance le démon de gestion de connexion et de session elogind.  Elogind (https://github.com/elogind/elogind) expose une interface D-Bus qui peut être utilisée pour connaître quels utilisateurs sont connectés, le type de session qu'ils sont ouverte, suspendre le système, désactiver la veille système, redémarrer le système et d'autre taches.

     Elogind gère la plupart des événements liés à l'énergie du système, par exemple mettre en veille le système quand l'écran est rabattu ou en l'éteignant quand le bouton de démarrage est appuyé.

     L'argument CONFIG spécifie la configuration d'elogind et devrait être le résultat d'une invocation de (elogind-configuration (PARAMETER VALUE)...).  Les paramètres disponibles et leur valeur par défaut sont :

     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")

 -- Procédure Scheme: accountsservice-service
     [#:accountsservice ACCOUNTSSERVICE]
     Renvoie un service qui lance AccountsService, un service système qui peut lister les comptes disponibles, changer leur mot de passe, etc. AccountsService s'intègre à Polkit pour permettre aux utilisateurs non privilégiés de pouvoir modifier la configuration de leur système. le site de accountsservice (https://www.freedesktop.org/wiki/Software/AccountsService/) pour trouver plus d'informations.

     L'argument ACCOUNTSSERVICE est le paquet accountsservice à exposer comme un service.

 -- Procédure Scheme: polkit-service
     [#:polkit POLKIT]
     Renvoie un service qui lance le service de gestion des privilèges Polkit (http://www.freedesktop.org/wiki/Software/polkit/), qui permet aux administrateurs systèmes de permettre l'accès à des opération privilégiées d'une manière structurée.  En demandant au service Polkit, un composant système privilégié peut savoir lorsqu'il peut donner des privilèges supplémentaires à des utilisateurs normaux.  Par exemple, un utilisateur normal peut obtenir le droit de mettre le système en veille si l'utilisateur est connecté localement.

 -- Procédure Scheme: 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]
     Renvoie un service qui lance upowerd (http://upower.freedesktop.org/), un moniteur système pour la consommation électrique et le niveau de batterie, avec les paramètres de configuration données.  Il implémente l'interface D-Bus org.freedesktop.UPower et est notamment utilisé par GNOME.

 -- Procédure Scheme: udisks-service [#:udisks UDISKS]
     Renvoie un service pour UDisks (http://udisks.freedesktop.org/docs/latest/), un démon de gestion de disques qui fournit des notifications et la capacité de monter et démonter des disques à des interfaces utilisateurs.  Les programmes qui parlent à UDisks sont par exemple la commande udisksctl, qui fait partie de UDisks et GNOME Disks.

 -- Procédure Scheme: colord-service [#:colord COLORD]
     Renvoie un service qui lance colord, un service système avec une interface D-Bus pour gérer les profils de couleur des périphériques d'entrées et de sorties comme les écrans et les scanners.  Il est notamment utilisé par l'outil graphique GNOME Color Manager.  Voir le site web de colord (http://www.freedesktop.org/software/colord/) pour plus d'informations.

 -- Procédure Scheme: geoclue-application name [#:allowed? #t] [#:system? #f] [#:users '()]
     Renvoie une configuration qui permet d'accéder aux données de localisation de GeoClue.  NAME est l'ID Desktop de l'application, sans la partie en .desktop.  Si ALLOWED? est vraie, l'application aura droit d'accéder aux informations de localisation par défaut.  Le booléen SYSTEM? indique si une application est un composant système ou non. Enfin USERS est la liste des UID des utilisateurs pour lesquels cette application a le droit d'accéder aux informations de géolocalisation.  Une liste d'utilisateurs vide indique que tous les utilisateurs sont autorisés.

 -- Variable Scheme: %standard-geoclue-applications
     la liste standard de configuration des application GeoClue connues, qui permet à l'utilitaire date-and-time de GNOME de demander l'emplacement actuel pour initialiser le fuseau horaire et aux navigateurs web IceCat et Epiphany de demander les informations de localisation.  IceCat et Epiphany demandent tous deux à l'utilisateur avant de permettre à une page web de connaître l'emplacement de l'utilisateur.

 -- Procédure Scheme: 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] Renvoie un service qui lance le service de géolocalisation GeoClue.  Ce service fournit une interface D-Bus pour permettre aux applications de demande l'accès à la position de l'utilisateur et éventuellement d'ajouter des informations à des bases de données de géolocalisation en ligne.  Voir le site web de GeoClue (https://wiki.freedesktop.org/www/Software/GeoClue/) pour plus d'informations.

 -- Procédure Scheme: bluetooth-service [#:bluez BLUEZ]
     [#:auto-enable? #f]
     Renvoie un service qui lance le démon bluetoothd qui gère tous les appareils Bluetooth et fournit un certain nombre d'interfaces D-Bus. Lorsque AUTO-ENABLE? est vraie, le contrôler bluetooth est automatiquement alimenté au démarrage, ce qui peut être utile lorsque vous utilisez un clavier ou une souris bluetooth.

     Les utilisateurs doivent être dans le groupe lp pour accéder au service D-Bus.

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)

     Voir plus bas pour des détails sur alsa-configuration.

 -- Type de données: alsa-configuration
     Type de données représentant la configuration pour alsa-service.

     alsa-plugins (default: ALSA-PLUGINS)
          alsa-plugins package to use.

     pulseaudio? (par défaut : #T)
          Indique si les applications ALSA devraient utiliser le serveur de son PulseAudio (http://www.pulseaudio.org/) de manière transparente pour elles.

          Utiliser PulseAudio vous permet dans lancer plusieurs applications qui produisent du son en même temps et de les contrôler individuellement via pavucontrol entre autres choses.

     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
............................

Le module (gnu services databases) fournit les services suivants.

 -- Procédure Scheme: postgresql-service [#:postgresql postgresql]
     [#:config-file] [#:data-directory ``/var/lib/postgresql/data'']
     [#:port 5432] [#:locale ``en_US.utf8'']
     Renvoie un service qui lance POSTGRESQL, le service de bases de données PostgreSQL.

     Le démon PostgreSQL charge sa configuration à l'exécution depuis CONFIG-FILE, crée une grappe de bases de données avec LOCALE comme paramètre de régionalisation par défaut, stockée dans DATA-DIRECTORY.  Il écoute ensuite sur PORT.

 -- Procédure Scheme: mysql-service [#:config (mysql-configuration)]
     Renvoie un service qui lance mysqld, le service de bases de données MySQL ou MariaDB.

     L'argument CONFIG facultatif spécifie la configuration de mysqld, qui devrait être un objet <mysql-configuration>.

 -- Type de données: mysql-configuration
     Type de données représentant la configuration de MYSQL-SERVICE.

     mysql (par défaut : MARIADB)
          Objet paquet du serveur de base de données MySQL, qui peut être soit MARIADB, soit MYSQL.

          Pour MySQL, un mot de passe root temporaire sera affiché à l'activation. Pour MariaDB, le mot de passe root est vide.

     port (par défaut : 3306)
          Port TCP sur lequel le serveur de base de données écoute les connexions entrantes.

 -- Variable Scheme: memcached-service-type
     C'est le type de service pour le service Memcached (https://memcached.org/) qui fournit un cache en mémoire distribué.  La valeur pour le type de service est un objet memcached-configuration.

     (service memcached-service-type)

 -- Type de données: memcached-configuration
     Type de données représentant la configuration de memcached.

     memcached (par défaut : memcached)
          Le paquet Memcached à utiliser.

     interfaces (par défaut : '("0.0.0.0"))
          Les interfaces réseaux sur lesquelles écouter.

     tcp-port (par défaut : 11211)
          Port sur lequel accepter les connexions.

     udp-port (par défaut : 11211)
          Port sur lequel accepter les connexions UDP, une valeur de 0 désactive l'écoute en UDP.

     additional-options (par défaut : '())
          Options de la ligne de commande supplémentaires à passer à memcached.

 -- Variable Scheme: mongodb-service-type
     C'est le type de service pour MongoDB (https://www.mongodb.com/).  La valeur de ce service est un objet mongodb-configuration.

     (service mongodb-service-type)

 -- Type de données: mongodb-configuration
     Type de données représentant la configuration de mongodb.

     mongodb (par défaut : mongodb)
          Le paquet MongoDB à utiliser.

     config-file (par défaut : %default-mongodb-configuration-file)
          Le fichier de configuration pour MongoDB.

     data-directory (par défaut : "/var/lib/mongodb")
          Cette valeur est utilisée pour créer le répertoire, pour qu'il existe et appartienne à l'utilisateur mongodb.  Il devrait correspondre au data-directory que MongoDB est configuré pour utiliser dans son fichier de configuration.

 -- Variable Scheme: redis-service-type
     C'est le type de service pour la base clef-valeur Redis (https://redis.io/) dont la valeur est un objet redis-configuration.

 -- Type de données: redis-configuration
     Type de données représentant la configuration de redis.

     redis (par défaut : redis)
          Le paquet Redis à utiliser.

     bind (par défaut : "127.0.0.1")
          Interface réseau sur laquelle écouter.

     port (par défaut : 6379)
          Port sur lequel accepter les connexions, une valeur de 0 désactive l'écoute sur un socket TCP.

     working-directory (par défaut : "/var/lib/redis")
          Répertoire dans lequel stocker la base de données et les fichiers liés.

Services de courriels
.....................

Le module (gnu services mail) fournit des définitions de services Guix pour les services de courriel : des serveurs IMAP, POP3 et LMTP ainsi que des MTA (Mail Transport Agent).  Que d'acronymes !  Ces services sont détaillés dans les sous-sections ci-dessous.

Service Dovecot
...............

 -- Procédure Scheme: dovecot-service [#:config (dovecot-configuration)]
     Renvoie un service qui lance le serveur de courriel IMAP/POP3/LMTP Dovecot.

Par défaut, Dovecot n'a pas besoin de beaucoup de configuration ; l'objet de configuration par défaut créé par (dovecot-configuration) suffira si votre courriel est livré dans ~/Maildir.  Un certificat auto-signé sera généré pour les connexions TLS, bien que Dovecot écoutera aussi sur les ports non chiffrés par défaut.  Il y a quelques options cependant, que les administrateurs peuvent avoir besoin de changer et comme c'est le cas avec d'autres services, Guix permet aux administrateurs systèmes de spécifier ces paramètres via une interface Scheme unifiée.

Par exemple, pour spécifier que les courriels se trouvent dans maildir~/.mail, on peut instancier Dovecot de cette manière :

     (dovecot-service #:config
                      (dovecot-configuration
                       (mail-location "maildir:~/.mail")))

Les paramètres de configuration disponibles sont les suivants.  Chaque définition des paramètres est précédé par son type ; par exemple, string-list foo indique que le paramètre foo devrait être spécifié comme une liste de chaînes de caractères.  Il y a aussi une manière de spécifier la configuration comme une chaîne de caractères, si vous avez un vieux fichier dovecot.conf que vous voulez porter depuis un autre système ; voir la fin pour plus de détails.

Les champs de dovecot-configuration disponibles sont :

 -- paramètre de dovecot-configuration: package dovecot
     Le paquet dovecot

 -- paramètre de dovecot-configuration: comma-separated-string-list listen
     Une liste d'IP ou d'hôtes à écouter pour les connexions.  * écoute sur toutes les interfaces IPv4, :: écoute sur toutes les interfaces IPv6.  Si vous voulez spécifier des ports différents de la valeur par défaut ou quelque chose de plus complexe, complétez les champs d'adresse et de port de inet-listener des services spécifiques qui vous intéressent.

 -- paramètre de dovecot-configuration: protocol-configuration-list protocols
     Liste des protocoles que vous voulez servir.  Les protocoles disponibles comprennent imap, pop3 et lmtp.

     Les champs protocol-configuration disponibles sont :

      -- paramètre de protocol-configuration: string name
          Le nom du protocole.

      -- paramètre de protocol-configuration: string auth-socket-path
          Le chemin d'un socket UNIX vers le serveur d'authentification maître pour trouver les utilisateurs.  C'est utilisé par imap (pour les utilisateurs partagés) et lda.  Sa valeur par défaut est "/var/run/dovecot/auth-userdb".

      -- paramètre de protocol-configuration: space-separated-string-list mail-plugins
          Liste de greffons à charger séparés par des espaces.

      -- paramètre de protocol-configuration: non-negative-integer mail-max-userip-connections
          Nombre maximum de connexions IMAP permises pour un utilisateur depuis chaque adresse IP.  Remarque : la comparaison du nom d'utilisateur est sensible à la casse.  Par défaut 10.

 -- paramètre de dovecot-configuration: service-configuration-list services
     Liste des services à activer.  Les services disponibles comprennent imap, imap-login, pop3, pop3-login, auth et lmtp.

     Les champs de service-configuration disponibles sont :

      -- paramètre de service-configuration: string kind
          Le type de service.  Les valeurs valides comprennent director, imap-login, pop3-login, lmtp, imap, pop3, auth, auth-worker, dict, tcpwrap, quota-warning ou n'importe quoi d'autre.

      -- paramètre de service-configuration: listener-configuration-list listeners
          Les auditeurs du service.  Un auditeur est soit un unix-listener-configuration, soit un fifo-listener-configuration, soit un inet-listener-configuration.  La valeur par défaut est ().

          Les champs de unix-listener-configuration disponibles sont :

           -- paramètre de unix-listener-configuration: string path
               Chemin vers le fichier, relativement au champ base-dir.  C'est aussi utilisé comme nom de section.

           -- paramètre de unix-listener-configuration: string mode
               Le mode d'accès pour le socket.  La valeur par défaut est "0600".

           -- paramètre de unix-listener-configuration: string user
               L'utilisateur à qui appartient le socket.  La valeur par défaut est ""

           -- paramètre de unix-listener-configuration: string group
               Le groupe auquel appartient le socket.  La valeur par défaut est "".

          Les champs de fifo-listener-configuration disponibles sont :

           -- paramètre de fifo-listener-configuration: string path
               Chemin vers le fichier, relativement au champ base-dir.  C'est aussi utilisé comme nom de section.

           -- paramètre de fifo-listener-configuration: string mode
               Le mode d'accès pour le socket.  La valeur par défaut est "0600".

           -- paramètre de fifo-listener-configuration: string user
               L'utilisateur à qui appartient le socket.  La valeur par défaut est ""

           -- paramètre de fifo-listener-configuration: string group
               Le groupe auquel appartient le socket.  La valeur par défaut est "".

          Les champs de inet-listener-configuration disponibles sont :

           -- paramètre de inet-listener-configuration: string protocol
               Le protocole à écouter.

           -- paramètre de inet-listener-configuration: string address
               L'adresse sur laquelle écouter, ou la chaîne vide pour toutes les adresses. La valeur par défaut est "".

           -- paramètre de inet-listener-configuration: non-negative-integer port
               Le port sur lequel écouter.

           -- paramètre de inet-listener-configuration: boolean ssl?
               S'il faut utiliser SSL pour ce service ; yes, no ou required.  La valeur par défaut est #t.

      -- paramètre de service-configuration: non-negative-integer service-count
          Nombre de connexions à gérer avant de démarrer un nouveau processus. Typiquement les valeurs utiles sont 0 (sans limite) ou 1.  1 est plus sûr, mais 0 est plus rapide.  <doc/wiki/LoginProcess.txt>.  La valeur par défaut est 1.

      -- paramètre de service-configuration: non-negative-integer process-min-avail
          Nombre de processus à toujours garder en attente de connexions.  La valeur par défaut est 0.

      -- paramètre de service-configuration: non-negative-integer vsz-limit
          Si vous mettez service-count 0, vous avez sans doute besoin d'augmenter ce paramètre.  La valeur par défaut est 256000000.

 -- paramètre de dovecot-configuration: dict-configuration dict
     Configuration du dictionnaire, créé par le constructeur dict-configuration.

     Les champs de dict-configuration disponibles sont :

      -- paramètre de dict-configuration: free-form-fields entries
          Une liste de paires de clefs-valeurs que ce dictionnaire contient.  La valeur par défaut est ().

 -- paramètre de dovecot-configuration: passdb-configuration-list passdbs
     Une liste de configurations passdb, chacune créée par le constructeur passdb-configuration.

     Les champs de passdb-configuration disponibles sont :

      -- paramètre de passdb-configuration: string driver
          Le pilote à utiliser par passdb.  Les valeur valides comprennent pam, passwd, shadow, bsdauth et static.  La valeur par défaut est "pam".

      -- paramètre de passdb-configuration: space-separated-string-list args
          Liste d'arguments pour le pilote passdb séparés par des espaces.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: userdb-configuration-list userdbs
     Liste des configurations userdb, chacune créée par le constructeur userdb-configuration.

     Les champs de userdb-configuration disponibles sont :

      -- paramètre de userdb-configuration: string driver
          Le pilote que userdb devrait utiliser.  Les valeurs valides comprennent passwd et static.  La valeur par défaut est "passwd".

      -- paramètre de userdb-configuration: space-separated-string-list args
          Liste des arguments du pilote userdb séparés par des espaces.  La valeur par défaut est "".

      -- paramètre de userdb-configuration: free-form-args override-fields
          Remplace des champs de passwd.  La valeur par défaut est ().

 -- paramètre de dovecot-configuration: plugin-configuration plugin-configuration
     Configuration du greffon, créé par le constructeur plugin-configuration.

 -- paramètre de dovecot-configuration: list-of-namespace-configuration namespaces
     Liste d'espaces de noms.  Chaque élément de la liste est créé par le constructeur namespace-configuration.

     Les champs de namespace-configuration disponibles sont :

      -- paramètre de namespace-configuration: string name
          Nom de cet espace de nom.

      -- paramètre de namespace-configuration: string type
          Type d'espace de nom : private, shared ou public.  La valeur par défaut est "private".

      -- paramètre de namespace-configuration: string separator
          Séparateur de hiérarchie à utiliser.  Vous devriez utiliser le même séparateur pour tous les espaces de noms ou certains clients seront confus. / est généralement une bonne valeur.  La valeur par défaut dépend cependant du format de stockage sous-jacent.  La valeur par défaut est "".

      -- paramètre de namespace-configuration: string prefix
          Préfixe requis pour accéder à cet espace de nom.  Ce paramètres doit être différent pour tous les espaces de noms.  Par exemple Public/.  La valeur par défaut est "".

      -- paramètre de namespace-configuration: string location
          Emplacement physique de la boîte aux lettres.  C'est le même format que mail_location, qui est aussi la valeur par défaut.  La valeur par défaut est "".

      -- paramètre de namespace-configuration: boolean inbox?
          Il ne peut y avoir qu'un INBOX, et ce paramètre définit l'espace de nom qui le possède.  La valeur par défaut est #f.

      -- paramètre de namespace-configuration: boolean hidden?
          Si l'espace de nom est caché, il n'est pas publié auprès des clients par l'extension NAMESPACE.  Vous voudrez aussi sans doute indiquer list? #f.  C'est surtout utile lors de la conversion depuis un autre serveur avec des espaces de noms différents que vous voulez rendre obsolètes sans les casser.  Par exemple vous pouvez cacher les espaces de noms avec les préfixes ~/mail/, ~%u/mail/ et mail/.  La valeur par défaut est #f.

      -- paramètre de namespace-configuration: boolean list?
          Montre les boîtes aux lettres sons cet espace de nom avec la commande LIST. Cela rend l'espace de nom visible pour les clients qui ne supportent pas l'extension NAMESPACE.  La valeur spéciale children liste les boîtes aux lettres filles mais cache le préfixe de l'espace de nom.  La valeur par défaut est #t.

      -- paramètre de namespace-configuration: boolean subscriptions?
          Les espaces de noms gèrent leur propre souscription.  Si la valeur est #f, l'espace de nom parent s'en charge.  Le préfixe vide devrait toujours avoir cette valeur à #t.  La valeur par défaut est #t.

      -- paramètre de namespace-configuration: mailbox-configuration-list mailboxes
          Liste des boîtes aux lettres prédéfinies dans cet espace de nom.  La valeur par défaut est ().

          Les champs de mailbox-configuration disponibles sont :

           -- paramètre de mailbox-configuration: string name
               Nom de cette boîte aux lettres.

           -- paramètre de mailbox-configuration: string auto
               create créera automatiquement cette boîte aux lettres. subscribe créera et souscrira à la boîte aux lettres.  La valeur par défaut est "no".

           -- paramètre de mailbox-configuration: space-separated-string-list special-use
               Liste des attributs SPECIAL-USE IMAP spécifiés par la RFC 6154.  Les valeurs valides sont \All, \Archive, \Drafts, \Flagged, \Junk, \Sent et \Trash.  La valeur par défaut est ().

 -- paramètre de dovecot-configuration: file-name base-dir
     Répertoire de base où stocker les données d'exécution.  La valeur par défaut est "/var/run/dovecot/".

 -- paramètre de dovecot-configuration: string login-greeting
     Message d'accueil pour les clients.  La valeur par défaut est "Dovecot ready.".

 -- paramètre de dovecot-configuration: space-separated-string-list login-trusted-networks
     Liste des groupes d'adresses de confiance.  Les connexions depuis ces IP sont autorisées à modifier leurs adresses IP et leurs ports (pour la connexion et la vérification d'authentification). disable-plaintext-auth est aussi ignoré pour ces réseaux. Typiquement vous voudrez spécifier votre mandataire IMAP ici.  La valeur par défaut est ().

 -- paramètre de dovecot-configuration: space-separated-string-list login-access-sockets
     Liste des sockets de vérification d'accès de connexion (p. ex. tcpwrap).  La valeur par défaut est ().

 -- paramètre de dovecot-configuration: boolean verbose-proctitle?
     Montre des titres de processus plus verbeux (dans ps).  Actuellement, montre le nom d'utilisateur et l'adresse IP.  Utile pour voir qui utilise les processus IMAP (p. ex. des boîtes aux lettres partagées ou si le même uid est utilisé pour plusieurs comptes).  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: boolean shutdown-clients?
     Indique si les processus devraient toujours être tués lorsque le processus maître de Dovecot est éteint.  La valeur #f signifie que Dovecot peut être mis à jour sans forcer les connexions clientes existantes à se fermer (bien que cela puisse être un problème si la mise à jour est un correctif de sécurité par exemple).  La valeur par défaut est #t.

 -- paramètre de dovecot-configuration: non-negative-integer doveadm-worker-count
     Si la valeur n'est pas zéro, lance les commandes de courriel via ce nombre de connexions au serveur doveadm au lieu de les lancer dans le même processus.  La valeur par défaut est 0.

 -- paramètre de dovecot-configuration: string doveadm-socket-path
     Socket UNIX ou hôte:port utilisé pour se connecter au serveur doveadm.  La valeur par défaut est "doveadm-server".

 -- paramètre de dovecot-configuration: space-separated-string-list import-environment
     Liste des variables d'environnement qui sont préservées au démarrage de Dovecot et passées à tous ses processus fils.  Vous pouvez aussi donner des paires clef=valeur pour toujours spécifier ce paramètre.

 -- paramètre de dovecot-configuration: boolean disable-plaintext-auth?
     Désactive la commande LOGIN et toutes les autres authentifications en texte clair à moins que SSL/TLS ne soit utilisé (capacité LOGINDISABLED). Remarquez que si l'IP distante correspond à l'IP locale (c.-à-d. que vous vous connectez depuis le même ordinateur), la connexion est considérée comme sécurisée et l'authentification en texte clair est permise.  Voir aussi le paramètre ssl=required.  La valeur par défaut est #t.

 -- paramètre de dovecot-configuration: non-negative-integer auth-cache-size
     Taille du cache d'authentification (p. ex. #e10e6).  0 signifie qu'il est désactivé.  Remarquez que bsdauth, PAM et vpopmail ont besoin que cache-key soit indiqué pour que le cache soit utilisé.  La valeur par défaut est 0.

 -- paramètre de dovecot-configuration: string auth-cache-ttl
     Durée de vie des données en cache.  Après l'expiration du TTL l'enregistrement en cache n'est plus utilisé *sauf* si la requête à la base de données principale revoie une erreur interne.  Nous essayons aussi de gérer les changements de mot de passe automatiquement : si l'authentification précédente de l'utilisateur était réussie mais pas celle-ci, le cache n'est pas utilisé.  Pour l'instant cela fonctionne avec l'authentification en texte clair uniquement.  La valeur par défaut est "1 hour".

 -- paramètre de dovecot-configuration: string auth-cache-negative-ttl
     TTL pour les résultats négatifs (l'utilisateur n'est pas trouvé ou le mot de passe ne correspond pas).  0 désactive la mise en cache complètement.  La valeur par défaut est "1 hour".

 -- paramètre de dovecot-configuration: space-separated-string-list auth-realms
     Liste des domaines pour les mécanismes d'authentification SASL qui en ont besoin.  Vous pouvez laisser ce paramètre vide si vous ne voulez pas utiliser plusieurs domaines.  Beaucoup de clients utilisent le premier domaine listé ici, donc gardez celui par défaut en premier.  La valeur par défaut est ()

 -- paramètre de dovecot-configuration: string auth-default-realm
     Domaine par défaut à utiliser si aucun n'est spécifié.  C'est utilisé pour les domaines SASL et pour ajouter @domaine au nom d'utilisateur dans les authentification en texte clair.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: string auth-username-chars
     Liste des caractères autorisés dans les noms d'utilisateur.  Si le nom d'utilisateur donné par l'utilisateur contient un caractère qui n'est pas listé ici, la connexion échoue automatiquement.  C'est juste une vérification supplémentaire pour s'assure que l'utilisateur ne puisse pas exploiter des vulnérabilités potentielles d'échappement de guillemets avec les bases de données SQL/LDAP.  Si vous voulez autoriser tous les caractères, indiquez la liste vide.

 -- paramètre de dovecot-configuration: string auth-username-translation
     Traduction de caractères dans les noms d'utilisateur avant qu'ils ne soient cherchés en base.  La valeur contient une série de caractère de -> à.  Par exemple #@/@ signifie que # et / sont traduits en @.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: string auth-username-format
     Format des noms d'utilisateur avant qu'ils ne soient cherchés en base.  Vous pouvez utiliser les variables standard ici, p. ex. %Lu est le nom d'utilisateur en minuscule, %n enlève le domaine s'il est donné ou %n-AT-%d changerait le @ en -AT-.  Cette traduction est faite après les changements de auth-username-translation.  La valeur par défaut est "%Lu".

 -- paramètre de dovecot-configuration: string auth-master-user-separator
     Si vous voulez permettre aux utilisateurs maîtres de se connecter en spécifiant le nom d'utilisateur maître dans la chaîne de nom d'utilisateur normal (c.-à-d. sans utiliser le support du mécanisme SASL pour cela), vous pouvez spécifier le caractère de séparation ici.  Le format est ensuite <nom d'utilisateur><séparateur><nom d'utilisateur maître>.  UW-IMAP utilise * comme séparateur, donc ça pourrait être un bon choix.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: string auth-anonymous-username
     Nom d'utilisateur à utiliser pour les utilisateurs qui se connectent avec le mécanisme SASL ANONYMOUS.  La valeur par défaut est "anonymous".

 -- paramètre de dovecot-configuration: non-negative-integer auth-worker-max-count
     Nombre maximum de processus de travail dovecot-auth.  Ils sont utilisés pour exécuter des requêtes passdb et userdb bloquantes (p. ex. MySQL et PAM).  Ils sont créés automatiquement et détruits au besoin.  La valeur par défaut est 30.

 -- paramètre de dovecot-configuration: string auth-gssapi-hostname
     Nom d'hôte à utiliser dans les noms GSSAPI principaux.  La valeur par défaut est d'utiliser le nom renvoyé par gethostname().  Utilisez $ALL (avec des guillemets) pour permettre toutes les entrées keytab.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: string auth-krb5-keytab
     Keytab Kerberos à utiliser pour le mécanisme GSSAPI.  Utilisera la valeur par défaut du système (typiquement /etc/krb5.keytab) s'il n'est pas spécifié.  Vous pourriez avoir besoin de faire en sorte que le service d'authentification tourne en root pour pouvoir lire ce fichier.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: boolean auth-use-winbind?
     Effectue l'authentification NTLM et GSS-SPNEGO avec le démon winbind de Samba et l'utilitaire ntlm-auth. <doc/wiki/Authentication/Mechanisms/Winbind.txt>.  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: file-name auth-winbind-helper-path
     Chemin du binaire ntlm-auth de samba.  La valeur par défaut est "/usr/bin/ntlm_auth".

 -- paramètre de dovecot-configuration: string auth-failure-delay
     Durée d'attente avant de répondre à des authentifications échouées.  La valeur par défaut est "2 secs".

 -- paramètre de dovecot-configuration: boolean auth-ssl-require-client-cert?
     Requiert un certification client SSL valide ou l'authentification échoue. La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: boolean auth-ssl-username-from-cert?
     Prend le nom d'utilisateur du certificat SSL client, avec X509_NAME_get_text_by_NID() qui renvoie le CommonName du DN du sujet.  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: space-separated-string-list auth-mechanisms
     Liste des mécanismes d'authentification souhaités.  Les mécanismes supportés sont : plain, login, digest-md5, cram-md5, ntlm, rpa, apop, anonymous, gssapi, otp, skey et gss-spnego.  Remarquez : Voir aussi le paramètre disable-plaintext-auth.

 -- paramètre de dovecot-configuration: space-separated-string-list director-servers
     Liste des IP ou des noms d'hôtes des serveurs directeurs, dont soi-même. Les ports peuvent être spécifiés avec ip:port.  Le port par défaut est le même que le inet-listener du service directeur.  La valeur par défaut est ().

 -- paramètre de dovecot-configuration: space-separated-string-list director-mail-servers
     Liste des IP ou des noms d'hôtes de tous les serveurs de courriel de la grappe.  Les intervalles sont aussi permis, comme 10.0.0.10-10.0.0.30.  La valeur par défaut est ().

 -- paramètre de dovecot-configuration: string director-user-expire
     Combien de temps avant de rediriger les utilisateurs à un serveur spécifique après qu'il n'y a plus de connexion.  La valeur par défaut est "15 min".

 -- paramètre de dovecot-configuration: string director-username-hash
     La manière de traduire le nom d'utilisateur avant de le hasher.  Les valeurs utiles comprennent %Ln si l'utilisateur peut se connecter avec ou sans @domain, %Ld si les boîtes aux lettres sont partagées dans le domaine.  La valeur par défaut est "%Lu".

 -- paramètre de dovecot-configuration: string log-path
     Fichier de journal à utiliser pour les messages d'erreur.  syslog journalise vers syslog, /dev/stderr vers la sortie d'erreur.  La valeur par défaut est "syslog".

 -- paramètre de dovecot-configuration: string info-log-path
     Fichier de journal à utiliser pour les messages d'information.  La valeur par défaut est log-path.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: string debug-log-path
     Fichier de journal à utiliser pour les messages de débogage.  La valeur par défaut est info-log-path.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: string syslog-facility
     Dispositif syslog à utiliser si vous journalisez avec syslog.  Normalement si vous ne voulez pas utiliser mail, vous voudrez utiliser local0..local7.  D'autres dispositifs standard sont supportés.  La valeur par défaut est "mail".

 -- paramètre de dovecot-configuration: boolean auth-verbose?
     Log unsuccessful authentication attempts and the reasons why they failed. Defaults to #f.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: boolean auth-debug?
     Even more verbose logging for debugging purposes.  Shows for example SQL queries.  Defaults to #f.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: boolean mail-debug?
     Enable mail process debugging.  This can help you figure out why Dovecot isn't finding your mails.  Defaults to #f.

 -- paramètre de dovecot-configuration: boolean verbose-ssl?
     Show protocol level SSL errors.  Defaults to #f.

 -- paramètre de dovecot-configuration: string log-timestamp
     Prefix for each line written to log file.  % codes are in strftime(3) format.  Defaults to "\"%b %d %H:%M:%S \"".

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: string login-log-format
     Login log format.  %s contains login-log-format-elements string, %$ contains the data we want to log.  Defaults to "%$: %s".

 -- paramètre de dovecot-configuration: 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}>: \"".

 -- paramètre de dovecot-configuration: 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.

     La valeur par défaut est "msgid=%m: %$".

 -- paramètre de dovecot-configuration: 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/%

     La valeur par défaut est "".

 -- paramètre de dovecot-configuration: 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 "".

 -- paramètre de dovecot-configuration: string mail-gid

     La valeur par défaut est "".

 -- paramètre de dovecot-configuration: 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 "".

 -- paramètre de dovecot-configuration: 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 "".

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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).

     La valeur par défaut est "optimized".

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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".

 -- paramètre de dovecot-configuration: file-name mail-temp-dir
     Directory in which LDA/LMTP temporarily stores incoming mails >128 kB. Defaults to "/tmp".

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: non-negative-integer last-valid-uid

     La valeur par défaut est 0.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: non-negative-integer last-valid-gid

     La valeur par défaut est 0.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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 ().

 -- paramètre de dovecot-configuration: 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 "".

 -- paramètre de dovecot-configuration: 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".

 -- paramètre de dovecot-configuration: file-name mail-plugin-dir
     Directory where to look up mail plugins.  Defaults to "/usr/lib/dovecot".

 -- paramètre de dovecot-configuration: 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 ().

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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".

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: space-separated-string-list mbox-write-locks

 -- paramètre de dovecot-configuration: string mbox-lock-timeout
     Maximum time to wait for lock (all of them) before aborting.  Defaults to "5 mins".

 -- paramètre de dovecot-configuration: 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".

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: non-negative-integer mdbox-rotate-size
     Maximum dbox file size until it's rotated.  Defaults to 10000000.

 -- paramètre de dovecot-configuration: 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".

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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 "".

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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.

     La valeur par défaut est "sis posix".

 -- paramètre de dovecot-configuration: 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}".

 -- paramètre de dovecot-configuration: non-negative-integer default-process-limit

     La valeur par défaut est 100.

 -- paramètre de dovecot-configuration: non-negative-integer default-client-limit

     La valeur par défaut est 1000.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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".

 -- paramètre de dovecot-configuration: 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".

 -- paramètre de dovecot-configuration: string ssl?
     SSL/TLS support: yes, no, required.  <doc/wiki/SSL.txt>.  Defaults to "required".

 -- paramètre de dovecot-configuration: string ssl-cert
     PEM encoded X.509 SSL/TLS certificate (public key).  Defaults to "</etc/dovecot/default.pem".

 -- paramètre de dovecot-configuration: 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".

 -- paramètre de dovecot-configuration: 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 "".

 -- paramètre de dovecot-configuration: 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 "".

 -- paramètre de dovecot-configuration: boolean ssl-require-crl?
     Require that CRL check succeeds for client certificates.  Defaults to #t.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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".

 -- paramètre de dovecot-configuration: string ssl-min-protocol
     Minimum SSL protocol version to accept.  Defaults to "TLSv1".

 -- paramètre de dovecot-configuration: 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".

 -- paramètre de dovecot-configuration: string ssl-crypto-device
     SSL crypto device to use, for valid values run "openssl engine".  Defaults to "".

 -- paramètre de dovecot-configuration: string postmaster-address
     Address to use when sending rejection mails.  %d expands to recipient domain.  Defaults to "postmaster@%d".

 -- paramètre de dovecot-configuration: 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 "".

 -- paramètre de dovecot-configuration: boolean quota-full-tempfail?
     If user is over quota, return with temporary failure instead of bouncing the mail.  Defaults to #f.

 -- paramètre de dovecot-configuration: file-name sendmail-path
     Binary to use for sending mails.  Defaults to "/usr/sbin/sendmail".

 -- paramètre de dovecot-configuration: string submission-host
     If non-empty, send mails via this SMTP host[:port] instead of sendmail. Defaults to "".

 -- paramètre de dovecot-configuration: 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".

 -- paramètre de dovecot-configuration: string rejection-reason
     Human readable error message for rejection mails.  You can use variables:

     %n
          CRLF

     %r
          reason

     %s
          original subject

     %t
          recipient

     La valeur par défaut est "Your message to <%t> was automatically rejected:%n%r".

 -- paramètre de dovecot-configuration: string recipient-delimiter
     Delimiter character between local-part and detail in email address. Defaults to "+".

 -- paramètre de dovecot-configuration: 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 "".

 -- paramètre de dovecot-configuration: boolean lda-mailbox-autocreate?
     Should saving a mail to a nonexistent mailbox automatically create it?. Defaults to #f.

 -- paramètre de dovecot-configuration: boolean lda-mailbox-autosubscribe?
     Should automatically created mailboxes be also automatically subscribed?. Defaults to #f.

 -- paramètre de dovecot-configuration: 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.

 -- paramètre de dovecot-configuration: 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}".

 -- paramètre de dovecot-configuration: 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 "".

 -- paramètre de dovecot-configuration: string imap-idle-notify-interval
     How long to wait between "OK Still here" notifications when client is IDLEing.  Defaults to "2 mins".

 -- paramètre de dovecot-configuration: 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 "".

 -- paramètre de dovecot-configuration: string imap-id-log
     ID fields sent by client to log.  * means everything.  Defaults to "".

 -- paramètre de dovecot-configuration: 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.

     La valeur par défaut est ().

 -- paramètre de dovecot-configuration: 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.

Les champs de opaque-dovecot-configuration disponibles sont :

 -- paramètre de opaque-dovecot-configuration: package dovecot
     Le paquet dovecot

 -- paramètre de opaque-dovecot-configuration: 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
.................

 -- Variable Scheme: 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"))))

 -- Type de données: opensmtpd-configuration
     Data type representing the configuration of opensmtpd.

     package (par défaut : OPENSMTPD)
          Package object of the OpenSMTPD SMTP server.

     config-file (par défaut : %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
............

 -- Variable Scheme: 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).

 -- Type de données: exim-configuration
     Data type representing the configuration of exim.

     package (par défaut : EXIM)
          Package object of the Exim server.

     config-file (par défaut : #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
....................

 -- Variable Scheme: 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
...............

 -- Variable Scheme: 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

Les paramètres de configuration disponibles sont les suivants.  Chaque définition des paramètres est précédé par son type ; par exemple, string-list foo indique que le paramètre foo devrait être spécifié comme une liste de chaînes de caractères.  Les types précédés de maybe- signifient que le paramètre n'apparaîtra pas dans prosody.cfg.lua lorsque sa valeur est '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.

Les champs de prosody-configuration disponibles sont :

 -- paramètre de prosody-configuration: package prosody
     The Prosody package.

 -- paramètre de prosody-configuration: file-name data-path
     Location of the Prosody data storage directory.  See https://prosody.im/doc/configure.  Defaults to "/var/lib/prosody".

 -- paramètre de prosody-configuration: 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 ().

 -- paramètre de prosody-configuration: 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".

 -- paramètre de prosody-configuration: 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 ().

 -- paramètre de prosody-configuration: boolean use-libevent?
     Enable use of libevent for better performance under high load.  See https://prosody.im/doc/libevent.  Defaults to #f.

 -- paramètre de prosody-configuration: 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").

 -- paramètre de prosody-configuration: 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 ().

 -- paramètre de prosody-configuration: 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".

 -- paramètre de prosody-configuration: boolean allow-registration?
     Disable account creation by default, for security.  See https://prosody.im/doc/creating_accounts.  Defaults to #f.

 -- paramètre de prosody-configuration: 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.

     Les champs de ssl-configuration disponibles sont :

      -- paramètre de ssl-configuration: maybe-string protocol
          This determines what handshake to use.

      -- paramètre de ssl-configuration: maybe-file-name key
          Path to your private key file.

      -- paramètre de ssl-configuration: maybe-file-name certificate
          Path to your certificate file.

      -- paramètre de ssl-configuration: 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".

      -- paramètre de ssl-configuration: 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.

      -- paramètre de ssl-configuration: maybe-string-list verify
          A list of verification options (these mostly map to OpenSSL's set_verify() flags).

      -- paramètre de ssl-configuration: 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.

      -- paramètre de ssl-configuration: maybe-non-negative-integer depth
          How long a chain of certificate authorities to check when looking for a trusted root certificate.

      -- paramètre de ssl-configuration: maybe-string ciphers
          An OpenSSL cipher string.  This selects what ciphers Prosody will offer to clients, and in what order.

      -- paramètre de ssl-configuration: 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

      -- paramètre de ssl-configuration: maybe-string curve
          Curve for Elliptic curve Diffie-Hellman. Prosody's default is "secp384r1".

      -- paramètre de ssl-configuration: maybe-string-list verifyext
          A list of "extra" verification options.

      -- paramètre de ssl-configuration: maybe-string password
          Password for encrypted private keys.

 -- paramètre de prosody-configuration: 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.

 -- paramètre de prosody-configuration: 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").

 -- paramètre de prosody-configuration: 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.

 -- paramètre de prosody-configuration: 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.

 -- paramètre de prosody-configuration: 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 ().

 -- paramètre de prosody-configuration: 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 ().

 -- paramètre de prosody-configuration: 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".

 -- paramètre de prosody-configuration: 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".

 -- paramètre de prosody-configuration: file-name pidfile
     File to write pid in.  See https://prosody.im/doc/modules/mod_posix. Defaults to "/var/run/prosody/prosody.pid".

 -- paramètre de prosody-configuration: maybe-non-negative-integer http-max-content-size
     Maximum allowed size of the HTTP body (in bytes).

 -- paramètre de prosody-configuration: 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.

 -- paramètre de prosody-configuration: 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.

     Les champs de virtualhost-configuration disponibles sont :

     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:
      -- paramètre de virtualhost-configuration: string domain
          Domain you wish Prosody to serve.

 -- paramètre de prosody-configuration: 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 ().

     Les champs de int-component-configuration disponibles sont :

     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:
      -- paramètre de int-component-configuration: string hostname
          Hostname of the component.

      -- paramètre de int-component-configuration: string plugin
          Plugin you wish to use for the component.

      -- paramètre de int-component-configuration: 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.

          Les champs de mod-muc-configuration disponibles sont :

           -- paramètre de mod-muc-configuration: string name
               The name to return in service discovery responses.  Defaults to "Prosody Chatrooms".

           -- paramètre de mod-muc-configuration: 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.

           -- paramètre de mod-muc-configuration: 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.

 -- paramètre de prosody-configuration: 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 ().

     Les champs de ext-component-configuration disponibles sont :

     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:
      -- paramètre de ext-component-configuration: string component-secret
          Password which the component will use to log in.

      -- paramètre de ext-component-configuration: string hostname
          Hostname of the component.

 -- paramètre de prosody-configuration: non-negative-integer-list component-ports
     Port(s) Prosody listens on for component connections.  Defaults to (5347).

 -- paramètre de prosody-configuration: string component-interface
     Interface Prosody listens on for component connections.  Defaults to "127.0.0.1".

 -- paramètre de prosody-configuration: 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:

 -- paramètre de opaque-prosody-configuration: package prosody
     The prosody package.

 -- paramètre de opaque-prosody-configuration: 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.

 -- Variable Scheme: 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)

 -- Type de données: bitlbee-configuration
     This is the configuration for BitlBee, with the following fields:

     interface (par défaut : "127.0.0.1")
     port (par défaut : 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 (par défaut : bitlbee)
          Le paquet BitlBee à utiliser.

     plugins (par défaut : '())
          List of plugin packages to use---e.g., bitlbee-discord.

     extra-settings (par défaut : "")
          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.

 -- Type de données: 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.

     Les champs de murmur-configuration disponibles sont :

     package (par défaut : mumble)
          Package that contains bin/murmurd.

     user (par défaut : "murmur")
          User who will run the Murmur server.

     group (par défaut : "murmur")
          Group of the user who will run the murmur server.

     port (par défaut : 64738)
          Port on which the server will listen.

     welcome-text (par défaut : "")
          Welcome text sent to clients when they connect.

     server-password (par défaut : "")
          Password the clients have to enter in order to connect.

     max-users (par défaut : 100)
          Maximum of users that can be connected to the server at once.

     max-user-bandwidth (par défaut : #f)
          Maximum voice traffic a user can send per second.

     database-file (par défaut : "/var/lib/murmur/db.sqlite")
          File name of the sqlite database.  The service's user will become the owner of the directory.

     log-file (par défaut : "/var/log/murmur/murmur.log")
          File name of the log file.  The service's user will become the owner of the directory.

     autoban-attempts (par défaut : 10)
          Maximum number of logins a user can make in autoban-timeframe without getting auto banned for autoban-time.

     autoban-timeframe (par défaut : 120)
          Timeframe for autoban in seconds.

     autoban-time (par défaut : 300)
          Amount of time in seconds for which a client gets banned when violating the autoban limits.

     opus-threshold (par défaut : 100)
          Percentage of clients that need to support opus before switching over to opus audio codec.

     channel-nesting-limit (par défaut : 10)
          How deep channels can be nested at maximum.

     channelname-regex (par défaut : #f)
          A string in from of a Qt regular expression that channel names must conform to.

     username-regex (par défaut : #f)
          A string in from of a Qt regular expression that user names must conform to.

     text-message-length (par défaut : 5000)
          Maximum size in bytes that a user can send in one text chat message.

     image-message-length (par défaut : (* 128 1024))
          Maximum size in bytes that a user can send in one image message.

     cert-required? (par défaut : #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? (par défaut : #f)
          Should html be allowed in text messages, user comments, and channel descriptions.

     allow-ping? (par défaut : #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? (par défaut : #f)
          Should the server advertise itself in the local network through the bonjour protocol.

     send-version? (par défaut : #f)
          Should the murmur server version be exposed in ping requests.

     log-days (par défaut : 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? (par défaut : #t)
          Should logged ips be obfuscated to protect the privacy of users.

     ssl-cert (par défaut : #f)
          File name of the SSL/TLS certificate used for encrypted connections.

               (ssl-cert "/etc/letsencrypt/live/example.com/fullchain.pem")

     ssl-key (par défaut : #f)
          Filepath to the ssl private key used for encrypted connections.

               (ssl-key "/etc/letsencrypt/live/example.com/privkey.pem")

     ssl-dh-params (par défaut : #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 (par défaut : #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 (par défaut : #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 (par défaut : #f)
          Optional alternative override for this configuration.

 -- Type de données: 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 (par défaut : #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"))))))

 -- Type de données: tailon-configuration
     Data type representing the configuration of Tailon.  This type has the following parameters:

     config-file (par défaut : (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 (par défaut : tailon)
          Le paquet tailon à utiliser.

 -- Type de données: tailon-configuration-file
     Data type representing the configuration options for Tailon.  This type has the following parameters:

     files (par défaut : (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 (par défaut : "localhost:8080")
          Address and port to which Tailon should bind on.

     relative-root (par défaut : #f)
          URL path to use for Tailon, set to #f to not use a path.

     allow-transfers? (par défaut : #t)
          Allow downloading the log files in the web interface.

     follow-names? (par défaut : #t)
          Allow tailing of not-yet existent files.

     tail-lines (par défaut : 200)
          Number of lines to read initially from each file.

     allowed-commands (par défaut : (list "tail" "grep" "awk"))
          Commands to allow running. By default, sed is disabled.

     debug? (par défaut : #f)
          Set debug? to #t to show debug messages.

     wrap-lines (par défaut : #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 (par défaut : #f)
          HTTP authentication type to use. Set to #f to disable authentication (the default). Supported values are "digest" or "basic".

     users (par défaut : #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: Variable Scheme 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")))

 -- Type de données: darkstat-configuration
     Data type representing the configuration of darkstat.

     package (par défaut : darkstat)
          Le paquet darkstat à utiliser.

     interface
          Capture traffic on the specified network interface.

     port (par défaut : "667")
          Bind the web interface to the specified port.

     bind-address (par défaut : "127.0.0.1")
          Bind the web interface to the specified address.

     base (par défaut : "/")
          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.

 -- Variable Scheme: 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.

 -- Type de données: 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.

 -- Type de données: krb5-configuration

     allow-weak-crypto? (par défaut : #f)
          If this flag is #t then services which only offer encryption algorithms known to be weak will be accepted.

     default-realm (par défaut : #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.

 -- Variable Scheme: pam-krb5-service-type
     A service type for the Kerberos 5 PAM module.

 -- Type de données: pam-krb5-configuration
     Data type representing the configuration of the Kerberos 5 PAM module This type has the following parameters:

     pam-krb5 (par défaut : pam-krb5)
          Le paquet pam-krb5 à utiliser.

     minimum-uid (par défaut : 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
..................

 -- Variable Scheme: 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.

 -- Type de données: httpd-configuration
     This data type represents the configuration for the httpd service.

     package (par défaut : httpd)
          Le paquet httpd à utiliser.

     pid-file (par défaut : "/var/run/httpd")
          The pid file used by the shepherd-service.

     config (par défaut : (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.

 -- Type de données: 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").

 -- Type de données: httpd-config-file
     This data type represents a configuration file for the httpd service.

     modules (par défaut : %default-httpd-modules)
          The modules to load. Additional modules can be added here, or loaded by additional configuration.

     server-root (par défaut : 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 (par défaut : #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 (par défaut : "/srv/http")
          The DocumentRoot from which files will be served.

     listen (par défaut : '("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 (par défaut : "/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 (par défaut : "/var/log/httpd/error_log")
          The ErrorLog to which the server will log errors.

     user (par défaut : "httpd")
          The User which the server will answer requests as.

     group (par défaut : "httpd")
          The Group which the server will answer requests as.

     extra-config (par défaut : (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.

 -- Type de données: 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
.....

 -- Variable Scheme: 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.

 -- Type de données: 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 (par défaut : nginx)
          Le paquet nginx à utiliser.

     log-directory (par défaut : "/var/log/nginx")
          The directory to which NGinx will write log files.

     run-directory (par défaut : "/var/run/nginx")
          The directory in which NGinx will create a pid file, and write temporary files.

     server-blocks (par défaut : '())
          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 (par défaut : '())
          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 (par défaut : #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 (par défaut : #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 (par défaut : #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.

 -- Type de données: nginx-server-configuration
     Data type representing the configuration of an nginx server block.  This type has the following parameters:

     listen (par défaut : '("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 (par défaut : (list 'default))
          A list of server names this server represents. 'default represents the default server for connections matching no other server.

     root (par défaut : "/srv/http")
          Root of the website nginx will serve.

     locations (par défaut : '())
          A list of nginx-location-configuration or nginx-named-location-configuration records to use within this server block.

     index (par défaut : (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 (par défaut : '())
          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 (par défaut : #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 (par défaut : #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? (par défaut : #f)
          Whether the server should add its configuration to response.

     raw-content (par défaut : '())
          A list of raw lines added to the server block.

 -- Type de données: 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.

 -- Type de données: 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;").

 -- Type de données: 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.

 -- Variable Scheme: fcgiwrap-service-type
     A service type for the fcgiwrap FastCGI proxy.

 -- Type de données: fcgiwrap-configuration
     Data type representing the configuration of the fcgiwrap serice. This type has the following parameters:

     package (par défaut : fcgiwrap)
          Le paquet fcgiwrap à utiliser.

     socket (par défaut : 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 (par défaut : fcgiwrap)
     group (par défaut : 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.

 -- Variable Scheme: php-fpm-service-type
     A Service type for php-fpm.

 -- Type de données: php-fpm-configuration
     Data Type for php-fpm service configuration.

     php (par défaut : php)
          Le paquet php à utiliser.

     socket (par défaut : (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 (par défaut : php-fpm)
          User who will own the php worker processes.

     group (par défaut : php-fpm)
          Group of the worker processes.

     socket-user (par défaut : php-fpm)
          User who can speak to the php-fpm socket.

     socket-group (par défaut : php-fpm)
          Group that can speak to the php-fpm socket.

     pid-file (par défaut : (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 (par défaut : (string-append "/var/log/php" (version-major (package-version php)) "-fpm.log"))
          Log for the php-fpm master process.

     process-manager (par défaut : (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 (par défaut : #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 (par défaut : (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 (par défaut : #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 (par défaut : 5)
          Maximum of worker processes.

     start-servers (par défaut : 2)
          How many worker processes should be started on start-up.

     min-spare-servers (par défaut : 1)
          How many spare worker processes should be kept around at minimum.

     max-spare-servers (par défaut : 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 (par défaut : 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 (par défaut : 5)
          Maximum of worker processes.

     process-idle-timeout (par défaut : 10)
          The time in seconds after which a process with no requests is killed.

 -- Procédure Scheme: 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.

 -- Procédure Scheme: 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ées: 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-proc (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).

     package (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.

 -- Variable Scheme: 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.

 -- Type de données: certbot-configuration
     Data type representing the configuration of the certbot service. This type has the following parameters:

     package (par défaut : certbot)
          Le paquet certbot à utiliser.

     webroot (par défaut : /var/www)
          The directory from which to serve the Let's Encrypt challenge/response files.

     certificates (par défaut : ())
          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 (par défaut : 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.

 -- Type de données: 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 (par défaut : ())
          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 (par défaut : #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)))

 -- Variable Scheme: 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:

 -- Type de données: knot-key-configuration
     Data type representing a key.  This type has the following parameters:

     id (par défaut : "")
          An identifier for other configuration fields to refer to this key. IDs must be unique and must not be empty.

     algorithm (par défaut : #f)
          The algorithm to use.  Choose between #f, 'hmac-md5, 'hmac-sha1, 'hmac-sha224, 'hmac-sha256, 'hmac-sha384 and 'hmac-sha512.

     secret (par défaut : "")
          The secret key itself.

 -- Type de données: knot-acl-configuration
     Data type representing an Access Control List (ACL) configuration.  This type has the following parameters:

     id (par défaut : "")
          An identifier for ether configuration fields to refer to this key. IDs must be unique and must not be empty.

     address (par défaut : '())
          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 (par défaut : '())
          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 (par défaut : '())
          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? (par défaut : #f)
          When true, the ACL defines restrictions.  Listed actions are forbidden. When false, listed actions are allowed.

 -- Type de données: zone-entry
     Data type represnting a record entry in a zone file.  This type has the following parameters:

     name (par défaut : "@")
          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 (par défaut : "")
          The Time-To-Live (TTL) of this record.  If not set, the default TTL is used.

     class (par défaut : "IN")
          The class of the record.  Knot currently supports only "IN" and partially "CH".

     type (par défaut : "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 (par défaut : "")
          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.

 -- Type de données: zone-file
     Data type representing the content of a zone file.  This type has the following parameters:

     entries (par défaut : '())
          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 (par défaut : "")
          The name of your zone.  This parameter cannot be empty.

     ns (par défaut : "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 (par défaut : "hostmaster")
          An email address people can contact you at, as the owner of the zone.  This is translated as <mail>@<origin>.

     serial (par défaut : 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 (par défaut : (* 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 (par défaut : (* 15 60))
          The period after which a slave will retry to contact its master when it fails to do so a first time.

     expiry (par défaut : (* 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 (par défaut : 3600)
          Default TTL of inexistant records.  This delay is usually short because you want your new domains to reach everyone quickly.

 -- Type de données: knot-remote-configuration
     Data type representing a remote configuration.  This type has the following parameters:

     id (par défaut : "")
          An identifier for other configuration fields to refer to this remote. IDs must be unique and must not be empty.

     address (par défaut : '())
          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 (par défaut : '())
          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 (par défaut : #f)
          A reference to a key, that is a string containing the identifier of a key defined in a knot-key-configuration field.

 -- Type de données: knot-keystore-configuration
     Data type representing a keystore to hold dnssec keys.  This type has the following parameters:

     id (par défaut : "")
          The id of the keystore.  It must not be empty.

     backend (par défaut : 'pem)
          The backend to store the keys in.  Can be 'pem or 'pkcs11.

     config (par défaut : "/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.

 -- Type de données: 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 (par défaut : "")
          The id of the policy.  It must not be empty.

     keystore (par défaut : "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? (par défaut : #f)
          Whether the key management is manual or automatic.

     single-type-signing? (par défaut : #f)
          When #t, use the Single-Type Signing Scheme.

     algorithm (par défaut : "ecdsap256sha256")
          An algorithm of signing keys and issued signatures.

     ksk-size (par défaut : 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 (par défaut : 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 (par défaut : 'default)
          The TTL value for DNSKEY records added into zone apex.  The special 'default value means same as the zone SOA TTL.

     zsk-lifetime (par défaut : (* 30 24 3600))
          The period between ZSK publication and the next rollover initiation.

     propagation-delay (par défaut : (* 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 (par défaut : (* 14 24 3600))
          A validity period of newly issued signatures.

     rrsig-refresh (par défaut : (* 7 24 3600))
          A period how long before a signature expiration the signature will be refreshed.

     nsec3? (par défaut : #f)
          When #t, NSEC3 will be used instead of NSEC.

     nsec3-iterations (par défaut : 5)
          The number of additional times the hashing is performed.

     nsec3-salt-length (par défaut : 8)
          The length of a salt field in octets, which is appended to the original owner name before hashing.

     nsec3-salt-lifetime (par défaut : (* 30 24 3600))
          The validity period of newly issued salt field.

 -- Type de données: knot-zone-configuration
     Data type representing a zone served by Knot.  This type has the following parameters:

     domain (par défaut : "")
          The domain served by this configuration.  It must not be empty.

     file (par défaut : "")
          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 (par défaut : (zone-file))
          The content of the zone file.  This parameter is ignored by slave zones.  It must contain a zone-file record.

     master (par défaut : '())
          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 (par défaut : #f)
          The main master.  When empty, it defaults to the first master in the list of masters.

     notify (par défaut : '())
          A list of slave remote identifiers.

     acl (par défaut : '())
          A list of acl identifiers.

     semantic-checks? (par défaut : #f)
          When set, this adds more semantic checks to the zone.

     disable-any? (par défaut : #f)
          When set, this forbids queries of the ANY type.

     zonefile-sync (par défaut : 0)
          The delay between a modification in memory and on disk.  0 means immediate synchronization.

     serial-policy (par défaut : 'increment)
          A policy between 'increment and 'unixtime.

 -- Type de données: knot-configuration
     Data type representing the Knot configuration.  This type has the following parameters:

     knot (par défaut : knot)
          The Knot package.

     run-directory (par défaut : "/var/run/knot")
          The run directory.  This directory will be used for pid file and sockets.

     listen-v4 (par défaut : "0.0.0.0")
          An ip address on which to listen.

     listen-v6 (par défaut : "::")
          An ip address on which to listen.

     listen-port (par défaut : 53)
          A port on which to listen.

     keys (par défaut : '())
          The list of knot-key-configuration used by this configuration.

     acls (par défaut : '())
          The list of knot-acl-configuration used by this configuration.

     remotes (par défaut : '())
          The list of knot-remote-configuration used by this configuration.

     zones (par défaut : '())
          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ées: 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 (par défaut : '())
          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/).

 -- Procédure Scheme: openvpn-client-service
     [#:config (openvpn-client-configuration)]

     Return a service that runs openvpn, a VPN daemon, as a client.

 -- Procédure Scheme: openvpn-server-service
     [#:config (openvpn-server-configuration)]

     Return a service that runs openvpn, a VPN daemon, as a server.

     Both can be run simultaneously.

Les champs de openvpn-client-configuration disponibles sont :

 -- paramètre de openvpn-client-configuration: package openvpn
     The OpenVPN package.

 -- paramètre de openvpn-client-configuration: string pid-file
     The OpenVPN pid file.

     La valeur par défaut est "/var/run/openvpn/openvpn.pid".

 -- paramètre de openvpn-client-configuration: proto proto
     The protocol (UDP or TCP) used to open a channel between clients and servers.

     La valeur par défaut est udp.

 -- paramètre de openvpn-client-configuration: dev dev
     The device type used to represent the VPN connection.

     La valeur par défaut est tun.

 -- paramètre de openvpn-client-configuration: string ca
     The certificate authority to check connections against.

     La valeur par défaut est "/etc/openvpn/ca.crt".

 -- paramètre de openvpn-client-configuration: string cert
     The certificate of the machine the daemon is running on.  It should be signed by the authority given in ca.

     La valeur par défaut est "/etc/openvpn/client.crt".

 -- paramètre de openvpn-client-configuration: string key
     The key of the machine the daemon is running on.  It must be the key whose certificate is cert.

     La valeur par défaut est "/etc/openvpn/client.key".

 -- paramètre de openvpn-client-configuration: boolean comp-lzo?
     Whether to use the lzo compression algorithm.

     La valeur par défaut est #t.

 -- paramètre de openvpn-client-configuration: boolean persist-key?
     Don't re-read key files across SIGUSR1 or --ping-restart.

     La valeur par défaut est #t.

 -- paramètre de openvpn-client-configuration: boolean persist-tun?
     Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 or --ping-restart restarts.

     La valeur par défaut est #t.

 -- paramètre de openvpn-client-configuration: number verbosity
     Verbosity level.

     La valeur par défaut est 3.

 -- paramètre de openvpn-client-configuration: tls-auth-client tls-auth
     Add an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.

     La valeur par défaut est #f.

 -- paramètre de openvpn-client-configuration: key-usage verify-key-usage?
     Whether to check the server certificate has server usage extension.

     La valeur par défaut est #t.

 -- paramètre de openvpn-client-configuration: bind bind?
     Bind to a specific local port number.

     La valeur par défaut est #f.

 -- paramètre de openvpn-client-configuration: resolv-retry resolv-retry?
     Retry resolving server address.

     La valeur par défaut est #t.

 -- paramètre de openvpn-client-configuration: openvpn-remote-list remote
     A list of remote servers to connect to.

     La valeur par défaut est ().

     Les champs de openvpn-remote-configuration disponibles sont :

      -- paramètre de openvpn-remote-configuration: string name
          Server name.

          La valeur par défaut est "my-server".

      -- paramètre de openvpn-remote-configuration: number port
          Port number the server listens to.

          La valeur par défaut est 1194.

Les champs de openvpn-server-configuration disponibles sont :

 -- paramètre de openvpn-server-configuration: package openvpn
     The OpenVPN package.

 -- paramètre de openvpn-server-configuration: string pid-file
     The OpenVPN pid file.

     La valeur par défaut est "/var/run/openvpn/openvpn.pid".

 -- paramètre de openvpn-server-configuration: proto proto
     The protocol (UDP or TCP) used to open a channel between clients and servers.

     La valeur par défaut est udp.

 -- paramètre de openvpn-server-configuration: dev dev
     The device type used to represent the VPN connection.

     La valeur par défaut est tun.

 -- paramètre de openvpn-server-configuration: string ca
     The certificate authority to check connections against.

     La valeur par défaut est "/etc/openvpn/ca.crt".

 -- paramètre de openvpn-server-configuration: string cert
     The certificate of the machine the daemon is running on.  It should be signed by the authority given in ca.

     La valeur par défaut est "/etc/openvpn/client.crt".

 -- paramètre de openvpn-server-configuration: string key
     The key of the machine the daemon is running on.  It must be the key whose certificate is cert.

     La valeur par défaut est "/etc/openvpn/client.key".

 -- paramètre de openvpn-server-configuration: boolean comp-lzo?
     Whether to use the lzo compression algorithm.

     La valeur par défaut est #t.

 -- paramètre de openvpn-server-configuration: boolean persist-key?
     Don't re-read key files across SIGUSR1 or --ping-restart.

     La valeur par défaut est #t.

 -- paramètre de openvpn-server-configuration: boolean persist-tun?
     Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 or --ping-restart restarts.

     La valeur par défaut est #t.

 -- paramètre de openvpn-server-configuration: number verbosity
     Verbosity level.

     La valeur par défaut est 3.

 -- paramètre de openvpn-server-configuration: tls-auth-server tls-auth
     Add an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks.

     La valeur par défaut est #f.

 -- paramètre de openvpn-server-configuration: number port
     Specifies the port number on which the server listens.

     La valeur par défaut est 1194.

 -- paramètre de openvpn-server-configuration: ip-mask server
     An ip and mask specifying the subnet inside the virtual network.

     La valeur par défaut est "10.8.0.0 255.255.255.0".

 -- paramètre de openvpn-server-configuration: cidr6 server-ipv6
     A CIDR notation specifying the IPv6 subnet inside the virtual network.

     La valeur par défaut est #f.

 -- paramètre de openvpn-server-configuration: string dh
     The Diffie-Hellman parameters file.

     La valeur par défaut est "/etc/openvpn/dh2048.pem".

 -- paramètre de openvpn-server-configuration: string ifconfig-pool-persist
     The file that records client IPs.

     La valeur par défaut est "/etc/openvpn/ipp.txt".

 -- paramètre de openvpn-server-configuration: gateway redirect-gateway?
     When true, the server will act as a gateway for its clients.

     La valeur par défaut est #f.

 -- paramètre de openvpn-server-configuration: boolean client-to-client?
     When true, clients are allowed to talk to each other inside the VPN.

     La valeur par défaut est #f.

 -- paramètre de openvpn-server-configuration: 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.

 -- paramètre de openvpn-server-configuration: number max-clients
     The maximum number of clients.

     La valeur par défaut est 100.

 -- paramètre de openvpn-server-configuration: string status
     The status file.  This file shows a small report on current connection.  It is truncated and rewritten every minute.

     La valeur par défaut est "/var/run/openvpn/status".

 -- paramètre de openvpn-server-configuration: openvpn-ccd-list client-config-dir
     The list of configuration for some clients.

     La valeur par défaut est ().

     Les champs de openvpn-ccd-configuration disponibles sont :

      -- paramètre de openvpn-ccd-configuration: string name
          Client name.

          La valeur par défaut est "client".

      -- paramètre de openvpn-ccd-configuration: ip-mask iroute
          Client own network

          La valeur par défaut est #f.

      -- paramètre de openvpn-ccd-configuration: ip-mask ifconfig-push
          Client VPN IP.

          La valeur par défaut est #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.

 -- Variable Scheme: rpcbind-service-type
     A service type for the RPC portmapper daemon.

 -- Type de données: rpcbind-configuration
     Data type representing the configuration of the RPC Bind Service.  This type has the following parameters:

     rpcbind (par défaut : rpcbind)
          Le paquet rpcbind à utiliser.

     warm-start? (par défaut : #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.

 -- Variable Scheme: pipefs-service-type
     A service type for the pipefs pseudo file system.

 -- Type de données: pipefs-configuration
     Data type representing the configuration of the pipefs pseudo file system service.  This type has the following parameters:

     mount-point (par défaut : "/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).

 -- Variable Scheme: gss-service-type
     A service type for the Global Security System (GSS) daemon.

 -- Type de données: gss-configuration
     Data type representing the configuration of the GSS daemon service.  This type has the following parameters:

     nfs-utils (par défaut : nfs-utils)
          The package in which the rpc.gssd command is to be found.

     pipefs-directory (par défaut : "/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.

 -- Variable Scheme: idmap-service-type
     A service type for the Identity Mapper (IDMAP) daemon.

 -- Type de données: idmap-configuration
     Data type representing the configuration of the IDMAP daemon service.  This type has the following parameters:

     nfs-utils (par défaut : nfs-utils)
          The package in which the rpc.idmapd command is to be found.

     pipefs-directory (par défaut : "/var/lib/nfs/rpc_pipefs")
          The directory where the pipefs file system is mounted.

     domain (par défaut : #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.

 -- Procédure Scheme: 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.

 -- Type de données: cuirass-configuration
     Data type representing the configuration of Cuirass.

     log-file (par défaut : "/var/log/cuirass.log")
          Location of the log file.

     cache-directory (par défaut : "/var/cache/cuirass")
          Location of the repository cache.

     user (par défaut : "cuirass")
          Owner of the cuirass process.

     group (par défaut : "cuirass")
          Owner's group of the cuirass process.

     interval (par défaut : 60)
          Number of seconds between the poll of the repositories followed by the Cuirass jobs.

     database (par défaut : "/var/run/cuirass/cuirass.db")
          Location of sqlite database which contains the build results and previously added specifications.

     port (par défaut : 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 (par défaut : #~'())
          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? (par défaut : #f)
          This allows using substitutes to avoid building every dependencies of a job from source.

     one-shot? (par défaut : #f)
          Only evaluate specifications and build derivations once.

     fallback? (par défaut : #f)
          When substituting a pre-built binary fails, fall back to building packages locally.

     cuirass (par défaut : cuirass)
          Le paquet Cuirass à utiliser.

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).

 -- Variable Scheme: 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.

Les champs de tlp-configuration disponibles sont :

 -- paramètre de tlp-configuration: package tlp
     The TLP package.

 -- paramètre de tlp-configuration: boolean tlp-enable?
     Set to true if you wish to enable TLP.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: string tlp-default-mode
     Default mode when no power supply can be detected.  Alternatives are AC and BAT.

     La valeur par défaut est "AC".

 -- paramètre de tlp-configuration: 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.

     La valeur par défaut est 0.

 -- paramètre de tlp-configuration: non-negative-integer disk-idle-secs-on-bat
     Same as disk-idle-ac but on BAT mode.

     La valeur par défaut est 2.

 -- paramètre de tlp-configuration: non-negative-integer max-lost-work-secs-on-ac
     Dirty pages flushing periodicity, expressed in seconds.

     La valeur par défaut est 15.

 -- paramètre de tlp-configuration: non-negative-integer max-lost-work-secs-on-bat
     Same as max-lost-work-secs-on-ac but on BAT mode.

     La valeur par défaut est 60.

 -- paramètre de tlp-configuration: 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.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-space-separated-string-list cpu-scaling-governor-on-bat
     Same as cpu-scaling-governor-on-ac but on BAT mode.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-scaling-min-freq-on-ac
     Set the min available frequency for the scaling governor on AC.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-scaling-max-freq-on-ac
     Set the max available frequency for the scaling governor on AC.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-scaling-min-freq-on-bat
     Set the min available frequency for the scaling governor on BAT.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-scaling-max-freq-on-bat
     Set the max available frequency for the scaling governor on BAT.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: 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.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: 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.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-min-perf-on-bat
     Same as cpu-min-perf-on-ac on BAT mode.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-max-perf-on-bat
     Same as cpu-max-perf-on-ac on BAT mode.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-boolean cpu-boost-on-ac?
     Enable CPU turbo boost feature on AC mode.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-boolean cpu-boost-on-bat?
     Same as cpu-boost-on-ac? on BAT mode.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: boolean sched-powersave-on-ac?
     Allow Linux kernel to minimize the number of CPU cores/hyper-threads used under light load conditions.

     La valeur par défaut est #f.

 -- paramètre de tlp-configuration: boolean sched-powersave-on-bat?
     Same as sched-powersave-on-ac? but on BAT mode.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: boolean nmi-watchdog?
     Enable Linux kernel NMI watchdog.

     La valeur par défaut est #f.

 -- paramètre de tlp-configuration: 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".

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: string energy-perf-policy-on-ac
     Set CPU performance versus energy saving policy on AC.  Alternatives are performance, normal, powersave.

     La valeur par défaut est "performance".

 -- paramètre de tlp-configuration: string energy-perf-policy-on-bat
     Same as energy-perf-policy-ac but on BAT mode.

     La valeur par défaut est "powersave".

 -- paramètre de tlp-configuration: space-separated-string-list disks-devices
     Hard disk devices.

 -- paramètre de tlp-configuration: space-separated-string-list disk-apm-level-on-ac
     Hard disk advanced power management level.

 -- paramètre de tlp-configuration: space-separated-string-list disk-apm-level-on-bat
     Same as disk-apm-bat but on BAT mode.

 -- paramètre de tlp-configuration: 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.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-space-separated-string-list disk-spindown-timeout-on-bat
     Same as disk-spindown-timeout-on-ac but on BAT mode.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: 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.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: string sata-linkpwr-on-ac
     SATA aggressive link power management (ALPM) level.  Alternatives are min_power, medium_power, max_performance.

     La valeur par défaut est "max_performance".

 -- paramètre de tlp-configuration: string sata-linkpwr-on-bat
     Same as sata-linkpwr-ac but on BAT mode.

     La valeur par défaut est "min_power".

 -- paramètre de tlp-configuration: maybe-string sata-linkpwr-blacklist
     Exclude specified SATA host devices for link power management.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-on-off-boolean ahci-runtime-pm-on-ac?
     Enable Runtime Power Management for AHCI controller and disks on AC mode.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-on-off-boolean ahci-runtime-pm-on-bat?
     Same as ahci-runtime-pm-on-ac on BAT mode.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: non-negative-integer ahci-runtime-pm-timeout
     Seconds of inactivity before disk is suspended.

     La valeur par défaut est 15.

 -- paramètre de tlp-configuration: string pcie-aspm-on-ac
     PCI Express Active State Power Management level.  Alternatives are default, performance, powersave.

     La valeur par défaut est "performance".

 -- paramètre de tlp-configuration: string pcie-aspm-on-bat
     Same as pcie-aspm-ac but on BAT mode.

     La valeur par défaut est "powersave".

 -- paramètre de tlp-configuration: string radeon-power-profile-on-ac
     Radeon graphics clock speed level.  Alternatives are low, mid, high, auto, default.

     La valeur par défaut est "high".

 -- paramètre de tlp-configuration: string radeon-power-profile-on-bat
     Same as radeon-power-ac but on BAT mode.

     La valeur par défaut est "low".

 -- paramètre de tlp-configuration: string radeon-dpm-state-on-ac
     Radeon dynamic power management method (DPM).  Alternatives are battery, performance.

     La valeur par défaut est "performance".

 -- paramètre de tlp-configuration: string radeon-dpm-state-on-bat
     Same as radeon-dpm-state-ac but on BAT mode.

     La valeur par défaut est "battery".

 -- paramètre de tlp-configuration: string radeon-dpm-perf-level-on-ac
     Radeon DPM performance level.  Alternatives are auto, low, high.

     La valeur par défaut est "auto".

 -- paramètre de tlp-configuration: string radeon-dpm-perf-level-on-bat
     Same as radeon-dpm-perf-ac but on BAT mode.

     La valeur par défaut est "auto".

 -- paramètre de tlp-configuration: on-off-boolean wifi-pwr-on-ac?
     Wifi power saving mode.

     La valeur par défaut est #f.

 -- paramètre de tlp-configuration: on-off-boolean wifi-pwr-on-bat?
     Same as wifi-power-ac? but on BAT mode.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: y-n-boolean wol-disable?
     Disable wake on LAN.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: 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.

     La valeur par défaut est 0.

 -- paramètre de tlp-configuration: non-negative-integer sound-power-save-on-bat
     Same as sound-powersave-ac but on BAT mode.

     La valeur par défaut est 1.

 -- paramètre de tlp-configuration: y-n-boolean sound-power-save-controller?
     Disable controller in powersaving mode on Intel HDA devices.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: 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.

     La valeur par défaut est #f.

 -- paramètre de tlp-configuration: string bay-device
     Name of the optical drive device to power off.

     La valeur par défaut est "sr0".

 -- paramètre de tlp-configuration: string runtime-pm-on-ac
     Runtime Power Management for PCI(e) bus devices.  Alternatives are on and auto.

     La valeur par défaut est "on".

 -- paramètre de tlp-configuration: string runtime-pm-on-bat
     Same as runtime-pm-ac but on BAT mode.

     La valeur par défaut est "auto".

 -- paramètre de tlp-configuration: boolean runtime-pm-all?
     Runtime Power Management for all PCI(e) bus devices, except blacklisted ones.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: maybe-space-separated-string-list runtime-pm-blacklist
     Exclude specified PCI(e) device addresses from Runtime Power Management.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: space-separated-string-list runtime-pm-driver-blacklist
     Exclude PCI(e) devices assigned to the specified drivers from Runtime Power Management.

 -- paramètre de tlp-configuration: boolean usb-autosuspend?
     Enable USB autosuspend feature.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: maybe-string usb-blacklist
     Exclude specified devices from USB autosuspend.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: boolean usb-blacklist-wwan?
     Exclude WWAN devices from USB autosuspend.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: maybe-string usb-whitelist
     Include specified devices into USB autosuspend, even if they are already excluded by the driver or via usb-blacklist-wwan?.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-boolean usb-autosuspend-disable-on-shutdown?
     Enable USB autosuspend before shutdown.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: boolean restore-device-state-on-startup?
     Restore radio device state (bluetooth, wifi, wwan) from previous shutdown on system startup.

     La valeur par défaut est #f.

Thermald daemon
...............

The (gnu services pm) module provides an interface to thermald, a CPU frequency scaling service which helps prevent overheating.

 -- Variable Scheme: 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.

 -- Type de données: thermald-configuration
     Data type representing the configuration of thermald-service-type.

     ignore-cpuid-check? (par défaut : #f)
          Ignore cpuid check for supported CPU models.

     thermald (par défaut : 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")))

 -- Variable Scheme: mpd-service-type
     The service type for mpd

 -- Type de données: mpd-configuration
     Data type representing the configuration of mpd.

     user (par défaut : "mpd")
          The user to run mpd as.

     music-dir (par défaut : "~/Music")
          The directory to scan for music files.

     playlist-dir (par défaut : "~/.mpd/playlists")
          The directory to store playlists.

     port (par défaut : "6600")
          The port to run mpd on.

     address (par défaut : "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.

 -- Variable Scheme: 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")))

Les champs de libvirt-configuration disponibles sont :

 -- paramètre de libvirt-configuration: package libvirt
     Libvirt package.

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est #t.

 -- paramètre de libvirt-configuration: 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)

     La valeur par défaut est #f.

 -- paramètre de libvirt-configuration: string tls-port
     Port for accepting secure TLS connections This can be a port number, or service name

     La valeur par défaut est "16514".

 -- paramètre de libvirt-configuration: string tcp-port
     Port for accepting insecure TCP connections This can be a port number, or service name

     La valeur par défaut est "16509".

 -- paramètre de libvirt-configuration: string listen-addr
     IP address or hostname used for client connections.

     La valeur par défaut est "0.0.0.0".

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est #f.

 -- paramètre de libvirt-configuration: string mdns-name
     Default mDNS advertisement name.  This must be unique on the immediate broadcast network.

     La valeur par défaut est "Virtualization Host <hostname>".

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est "root".

 -- paramètre de libvirt-configuration: string unix-sock-ro-perms
     UNIX socket permissions for the R/O socket.  This is used for monitoring VM status only.

     La valeur par défaut est "0777".

 -- paramètre de libvirt-configuration: 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)

     La valeur par défaut est "0770".

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est "0777".

 -- paramètre de libvirt-configuration: string unix-sock-dir
     The directory in which sockets will be found/created.

     La valeur par défaut est "/var/run/libvirt".

 -- paramètre de libvirt-configuration: string auth-unix-ro
     Authentication scheme for UNIX read-only sockets.  By default socket permissions allow anyone to connect

     La valeur par défaut est "polkit".

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est "polkit".

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est "sasl".

 -- paramètre de libvirt-configuration: 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

     La valeur par défaut est "none".

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est ().

 -- paramètre de libvirt-configuration: string key-file
     Server key file path.  If set to an empty string, then no private key is loaded.

     La valeur par défaut est "".

 -- paramètre de libvirt-configuration: string cert-file
     Server key file path.  If set to an empty string, then no certificate is loaded.

     La valeur par défaut est "".

 -- paramètre de libvirt-configuration: string ca-file
     Server key file path.  If set to an empty string, then no CA certificate is loaded.

     La valeur par défaut est "".

 -- paramètre de libvirt-configuration: string crl-file
     Certificate revocation list path.  If set to an empty string, then no CRL is loaded.

     La valeur par défaut est "".

 -- paramètre de libvirt-configuration: boolean tls-no-sanity-cert
     Disable verification of our own server certificates.

     When libvirtd starts it performs some sanity checks against its own certificates.

     La valeur par défaut est #f.

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est #f.

 -- paramètre de libvirt-configuration: optional-list tls-allowed-dn-list
     Whitelist of allowed x509 Distinguished Name.

     La valeur par défaut est ().

 -- paramètre de libvirt-configuration: optional-list sasl-allowed-usernames
     Whitelist of allowed SASL usernames.  The format for username depends on the SASL authentication mechanism.

     La valeur par défaut est ().

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est "NORMAL".

 -- paramètre de libvirt-configuration: integer max-clients
     Maximum number of concurrent client connections to allow over all sockets combined.

     La valeur par défaut est 5000.

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est 1000.

 -- paramètre de libvirt-configuration: integer max-anonymous-clients
     Maximum length of queue of accepted but not yet authenticated clients.  Set this to zero to turn this feature off

     La valeur par défaut est 20.

 -- paramètre de libvirt-configuration: integer min-workers
     Number of workers to start up initially.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est 20.

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer max-requests
     Total global limit on concurrent RPC calls.

     La valeur par défaut est 20.

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer admin-min-workers
     Same as min-workers but for the admin interface.

     La valeur par défaut est 1.

 -- paramètre de libvirt-configuration: integer admin-max-workers
     Same as max-workers but for the admin interface.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer admin-max-clients
     Same as max-clients but for the admin interface.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer admin-max-queued-clients
     Same as max-queued-clients but for the admin interface.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer admin-max-client-requests
     Same as max-client-requests but for the admin interface.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer log-level
     Logging level.  4 errors, 3 warnings, 2 information, 1 debug.

     La valeur par défaut est 3.

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est "3:remote 4:event".

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est "3:stderr".

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est 1.

 -- paramètre de libvirt-configuration: boolean audit-logging
     Send audit messages via libvirt logging infrastructure.

     La valeur par défaut est #f.

 -- paramètre de libvirt-configuration: optional-string host-uuid
     Host UUID.  UUID must not have all digits be the same.

     La valeur par défaut est "".

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est "smbios".

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer admin-keepalive-interval
     Same as above but for admin interface.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer admin-keepalive-count
     Same as above but for admin interface.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: 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.

     La valeur par défaut est 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.

 -- Variable Scheme: 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)))

 -- paramètre de virtlog-configuration: integer log-level
     Logging level.  4 errors, 3 warnings, 2 information, 1 debug.

     La valeur par défaut est 3.

 -- paramètre de virtlog-configuration: 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.

     La valeur par défaut est "3:remote 4:event".

 -- paramètre de virtlog-configuration: 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.

     La valeur par défaut est "3:stderr".

 -- paramètre de virtlog-configuration: integer max-clients
     Maximum number of concurrent client connections to allow over all sockets combined.

     La valeur par défaut est 1024.

 -- paramètre de virtlog-configuration: integer max-size
     Maximum file size before rolling over.

     Defaults to 2MB

 -- paramètre de virtlog-configuration: 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.

 -- Variable Scheme: 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)).

 -- Type de données: qemu-binfmt-configuration
     This is the configuration for the qemu-binfmt service.

     platforms (par défaut : '())
          The list of emulated QEMU platforms.  Each item must be a platform object as returned by lookup-qemu-platforms (see below).

     guix-support? (par défaut : #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 (par défaut : qemu)
          Le paquet QEMU à utiliser.

 -- Procédure Scheme: 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.

 -- Procédure Scheme: qemu-platform? OBJ
     Return true if OBJ is a platform object.

 -- Procédure Scheme: 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.

 -- Procédure Scheme: 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.

 -- Type de données: git-daemon-configuration
     Data type representing the configuration for git-daemon-service.

     package (par défaut : GIT)
          Package object of the Git distributed version control system.

     export-all? (par défaut : #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 (par défaut : #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 (par défaut : '())
          Whether to listen on specific IP addresses or hostnames, defaults to all.

     port (par défaut : #F)
          Whether to listen on an alternative port, which defaults to 9418.

     whitelist (par défaut : '())
          If not empty, only allow access to this list of directories.

     extra-options (par défaut : '())
          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.

 -- Type de données: git-http-configuration
     Data type representing the configuration for git-http-service.

     package (par défaut : 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? (par défaut : #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 (par défaut : 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.

 -- Procédure Scheme: 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.

Les champs de cgit-configuration disponibles sont :

 -- paramètre de cgit-configuration: package package
     The CGIT package.

 -- paramètre de cgit-configuration: nginx-server-configuration-list nginx
     NGINX configuration.

 -- paramètre de cgit-configuration: 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).

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: file-object auth-filter
     Specifies a command that will be invoked for authenticating repository access.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est "name".

 -- paramètre de cgit-configuration: string cache-root
     Path used to store the cgit cache entries.

     La valeur par défaut est "/var/cache/cgit".

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est -1.

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est 5.

 -- paramètre de cgit-configuration: integer cache-repo-ttl
     Number which specifies the time-to-live, in minutes, for the cached version of the repository summary page.

     La valeur par défaut est 5.

 -- paramètre de cgit-configuration: integer cache-root-ttl
     Number which specifies the time-to-live, in minutes, for the cached version of the repository index page.

     La valeur par défaut est 5.

 -- paramètre de cgit-configuration: integer cache-scanrc-ttl
     Number which specifies the time-to-live, in minutes, for the result of scanning a path for Git repositories.

     La valeur par défaut est 15.

 -- paramètre de cgit-configuration: integer cache-about-ttl
     Number which specifies the time-to-live, in minutes, for the cached version of the repository about page.

     La valeur par défaut est 15.

 -- paramètre de cgit-configuration: integer cache-snapshot-ttl
     Number which specifies the time-to-live, in minutes, for the cached version of snapshots.

     La valeur par défaut est 5.

 -- paramètre de cgit-configuration: integer cache-size
     The maximum number of entries in the cgit cache.  When set to 0, caching is disabled.

     La valeur par défaut est 0.

 -- paramètre de cgit-configuration: boolean case-sensitive-sort?
     Sort items in the repo list case sensitively.

     La valeur par défaut est #t.

 -- paramètre de cgit-configuration: list clone-prefix
     List of common prefixes which, when combined with a repository URL, generates valid clone URLs for the repository.

     La valeur par défaut est ().

 -- paramètre de cgit-configuration: list clone-url
     List of clone-url templates.

     La valeur par défaut est ().

 -- paramètre de cgit-configuration: file-object commit-filter
     Command which will be invoked to format commit messages.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est "git log".

 -- paramètre de cgit-configuration: file-object css
     URL which specifies the css document to include in all cgit pages.

     La valeur par défaut est "/share/cgit/cgit.css".

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: boolean embedded?
     Flag which, when set to #t, will make cgit generate a HTML fragment suitable for embedding in other HTML pages.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-filter-overrides?
     Flag which, when set to #t, allows all filter settings to be overridden in repository-specific cgitrc files.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-follow-links?
     Flag which, when set to #t, allows users to follow a file in the log view.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-http-clone?
     If set to #t, cgit will act as an dumb HTTP endpoint for Git clones.

     La valeur par défaut est #t.

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-index-owner?
     Flag which, when set to #t, will make cgit display the owner of each repo in the repository index.

     La valeur par défaut est #t.

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-remote-branches?
     Flag which, when set to #t, will make cgit display remote branches in the summary and refs views.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-tree-linenumbers?
     Flag which, when set to #t, will make cgit generate linenumber links for plaintext blobs printed in the tree view.

     La valeur par défaut est #t.

 -- paramètre de cgit-configuration: boolean enable-git-config?
     Flag which, when set to #f, will allow cgit to use Git config to set any repo specific settings.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: file-object favicon
     URL used as link to a shortcut icon for cgit.

     La valeur par défaut est "/favicon.ico".

 -- paramètre de cgit-configuration: 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).

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string head-include
     The content of the file specified with this option will be included verbatim in the HTML HEAD section on all pages.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string header
     The content of the file specified with this option will be included verbatim at the top of all pages.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: file-object include
     Name of a configfile to include before the rest of the current config- file is parsed.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string index-header
     The content of the file specified with this option will be included verbatim above the repository index.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string index-info
     The content of the file specified with this option will be included verbatim below the heading on the repository index page.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: boolean local-time?
     Flag which, if set to #t, makes cgit print commit and tag times in the servers timezone.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: file-object logo
     URL which specifies the source of an image which will be used as a logo on all cgit pages.

     La valeur par défaut est "/share/cgit/cgit.png".

 -- paramètre de cgit-configuration: string logo-link
     URL loaded when clicking on the cgit logo image.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: file-object owner-filter
     Command which will be invoked to format the Owner column of the main page.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: integer max-atom-items
     Number of items to display in atom feeds view.

     La valeur par défaut est 10.

 -- paramètre de cgit-configuration: integer max-commit-count
     Number of entries to list per page in "log" view.

     La valeur par défaut est 50.

 -- paramètre de cgit-configuration: integer max-message-length
     Number of commit message characters to display in "log" view.

     La valeur par défaut est 80.

 -- paramètre de cgit-configuration: integer max-repo-count
     Specifies the number of entries to list per page on the repository index page.

     La valeur par défaut est 50.

 -- paramètre de cgit-configuration: integer max-repodesc-length
     Specifies the maximum number of repo description characters to display on the repository index page.

     La valeur par défaut est 80.

 -- paramètre de cgit-configuration: integer max-blob-size
     Specifies the maximum size of a blob to display HTML for in KBytes.

     La valeur par défaut est 0.

 -- paramètre de cgit-configuration: string max-stats
     Maximum statistics period.  Valid values are week,month, quarter and year.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: mimetype-alist mimetype
     Mimetype for the specified filename extension.

     La valeur par défaut est ((gif "image/gif") (html "text/html") (jpg "image/jpeg") (jpeg "image/jpeg") (pdf "application/pdf") (png "image/png") (svg "image/svg+xml")).

 -- paramètre de cgit-configuration: file-object mimetype-file
     Specifies the file to use for automatic mimetype lookup.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string module-link
     Text which will be used as the formatstring for a hyperlink when a submodule is printed in a directory listing.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: boolean nocache?
     If set to the value #t caching will be disabled.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean noplainemail?
     If set to #t showing full author email addresses will be disabled.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean noheader?
     Flag which, when set to #t, will make cgit omit the standard header on all pages.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est ().

 -- paramètre de cgit-configuration: file-object readme
     Text which will be used as default value for cgit-repo-readme.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: integer renamelimit
     Maximum number of files to consider when detecting renames.

     La valeur par défaut est -1.

 -- paramètre de cgit-configuration: string repository-sort
     The way in which repositories in each section are sorted.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: robots-list robots
     Text used as content for the robots meta-tag.

     La valeur par défaut est ("noindex" "nofollow").

 -- paramètre de cgit-configuration: string root-desc
     Text printed below the heading on the repository index page.

     La valeur par défaut est "a fast webinterface for the git dscm".

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string root-title
     Text printed as heading on the repository index page.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: list snapshots
     Text which specifies the default set of snapshot formats that cgit generates links for.

     La valeur par défaut est ().

 -- paramètre de cgit-configuration: repository-directory repository-directory
     Name of the directory to scan for repositories (represents scan-path).

     La valeur par défaut est "/srv/git".

 -- paramètre de cgit-configuration: string section
     The name of the current repository section - all repositories defined after this option will inherit the current section name.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string section-sort
     Flag which, when set to 1, will sort the sections on the repository listing by name.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: 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.

     La valeur par défaut est 0.

 -- paramètre de cgit-configuration: boolean side-by-side-diffs?
     If set to #t shows side-by-side diffs instead of unidiffs per default.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: file-object source-filter
     Specifies a command which will be invoked to format plaintext blobs in the tree view.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: integer summary-branches
     Specifies the number of branches to display in the repository "summary" view.

     La valeur par défaut est 10.

 -- paramètre de cgit-configuration: integer summary-log
     Specifies the number of log entries to display in the repository "summary" view.

     La valeur par défaut est 10.

 -- paramètre de cgit-configuration: integer summary-tags
     Specifies the number of tags to display in the repository "summary" view.

     La valeur par défaut est 10.

 -- paramètre de cgit-configuration: string strict-export
     Filename which, if specified, needs to be present within the repository for cgit to allow access to that repository.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string virtual-root
     URL which, if specified, will be used as root for all cgit links.

     La valeur par défaut est "/".

 -- paramètre de cgit-configuration: repository-cgit-configuration-list repositories
     A list of cgit-repo records to use with config.

     La valeur par défaut est ().

     Les champs de repository-cgit-configuration disponibles sont :

      -- paramètre de repository-cgit-configuration: repo-list snapshots
          A mask of snapshot formats for this repo that cgit generates links for, restricted by the global snapshots setting.

          La valeur par défaut est ().

      -- paramètre de repository-cgit-configuration: repo-file-object source-filter
          Override the default source-filter.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string url
          The relative URL used to access the repository.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-file-object about-filter
          Override the default about-filter.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: 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.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-list clone-url
          A list of URLs which can be used to clone repo.

          La valeur par défaut est ().

      -- paramètre de repository-cgit-configuration: repo-file-object commit-filter
          Override the default commit-filter.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: 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.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: 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.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string desc
          The value to show as repository description.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string homepage
          The value to show as repository homepage.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-file-object email-filter
          Override the default email-filter.

          La valeur par défaut est "".

      -- repository-cgit-configuration parameter: maybe-repo-boolean enable-commit-graph?
          A flag which can be used to disable the global setting enable-commit-graph?.

          La valeur par défaut est 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?.

          La valeur par défaut est 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?.

          La valeur par défaut est 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.

          La valeur par défaut est 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?.

          La valeur par défaut est 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?.

          La valeur par défaut est disabled.

      -- paramètre de repository-cgit-configuration: repo-boolean hide?
          Flag which, when set to #t, hides the repository from the repository index.

          La valeur par défaut est #f.

      -- paramètre de repository-cgit-configuration: repo-boolean ignore?
          Flag which, when set to #t, ignores the repository.

          La valeur par défaut est #f.

      -- paramètre de repository-cgit-configuration: repo-file-object logo
          URL which specifies the source of an image which will be used as a logo on this repo’s pages.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string logo-link
          URL loaded when clicking on the cgit logo image.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-file-object owner-filter
          Override the default owner-filter.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: 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.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: 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.

          La valeur par défaut est ().

      -- paramètre de repository-cgit-configuration: repo-string max-stats
          Override the default maximum statistics period.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string name
          The value to show as repository name.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string owner
          A value used to identify the owner of the repository.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string path
          An absolute path to the repository directory.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string readme
          A path (relative to repo) which specifies a file to include verbatim as the "About" page for this repo.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string section
          The name of the current repository section - all repositories defined after this option will inherit the current section name.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-list extra-options
          Extra options will be appended to cgitrc file.

          La valeur par défaut est ().

 -- paramètre de cgit-configuration: list extra-options
     Extra options will be appended to cgitrc file.

     La valeur par défaut est ().

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.

Les champs de opaque-cgit-configuration disponibles sont :

 -- paramètre de opaque-cgit-configuration: package cgit
     The cgit package.

 -- paramètre de opaque-cgit-configuration: 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: Variable Scheme 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)

 -- Type de données: wesnothd-configuration
     Data type representing the configuration of wesnothd.

     package (par défaut : wesnoth-server)
          The wesnoth server package to use.

     port (par défaut : 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.

 -- Variable Scheme: 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")))))

 -- Type de données: sysctl-configuration
     The data type representing the configuration of sysctl.

     sysctl (par défaut : (file-append procps "/sbin/sysctl")
          The sysctl executable to use.

     settings (par défaut : '())
          An association list specifies kernel parameters and their values.

PC/SC Smart Card Daemon Service
...............................

The (gnu services security-token) module provides the following service to run pcscd, the PC/SC Smart Card Daemon. pcscd is the daemon program for pcsc-lite and the MuscleCard framework. It is a resource manager that coordinates communications with smart card readers, smart cards and cryptographic tokens that are connected to the system.

 -- Scheme Variable: pcscd-service-type
     Service type for the pcscd service.  Its value must be a pcscd-configuration object.  To run pcscd in the default configuration, instantiate it as:

          (service pcscd-service-type)

 -- Data Type: pcscd-configuration
     The data type representing the configuration of pcscd.

     pcsc-lite (default: pcsc-lite)
          The pcsc-lite package that provides pcscd.

     usb-drivers (default: (list ccid))
          List of packages that provide USB drivers to pcscd. Drivers are expected to be under pcsc/drivers in the store directory of the package.

Lirc Service
............

The (gnu services lirc) module provides the following service.

 -- Procédure Scheme: 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.

 -- Procédure Scheme: 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:

 -- Procédure Scheme: 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)).

 -- Type de données: dicod-configuration
     Data type representing the configuration of dicod.

     dico (par défaut : DICO)
          Package object of the GNU Dico dictionary server.

     interfaces (par défaut : '("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 (par défaut : '())
          List of <dicod-handler> objects denoting handlers (module instances).

     databases (par défaut : (LIST %DICOD-DATABASE:GCIDE))
          List of <dicod-database> objects denoting dictionaries to be served.

 -- Type de données: dicod-handler
     Data type representing a dictionary handler (module instance).

     name
          Name of the handler (module instance).

     module (par défaut : #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

 -- Type de données: 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? (par défaut : #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)).

 -- Variable Scheme: %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.

 -- Variable Scheme: %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.

 -- Variable Scheme: %default-nss
     This is the default name service switch configuration, a name-service-switch object.

 -- Variable Scheme: %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.

 -- Type de données: 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).

 -- Type de données: 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)))

 -- Variable Scheme: %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.

 -- Type de données: 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 (par défaut : ())
          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 (par défaut : 0)
          The index of the default boot menu entry.  Index 0 is for the entry of the current system.

     timeout (par défaut : 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 (par défaut : #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 (par défaut : '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 (par défaut : '())
          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 (par défaut : #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 (par défaut : #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.

 -- Type de données: 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 (par défaut : ())
          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 (par défaut : #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.

 -- Variable Scheme: %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.

Invoquer 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.

 -- Procédure Scheme: 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.

 -- Procédure Scheme: service? OBJ
     Return true if OBJ is a service.

 -- Procédure Scheme: service-kind SERVICE
     Return the type of SERVICE---i.e., a <service-type> object.

 -- Procédure Scheme: 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.

 -- Type de données: 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 (par défaut : #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 (par défaut : #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.

 -- Procédure Scheme: 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.

 -- Procédure Scheme: 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.

 -- Procédure Scheme: 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.

 -- Procédure Scheme: 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.

 -- Variable Scheme: system-service-type
     This is the root of the service graph.  It produces the system directory as returned by the guix system build command.

 -- Variable Scheme: 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.

 -- Variable Scheme: 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.

 -- Variable Scheme: 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).

 -- Variable Scheme: 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.

 -- Type de données: 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 (par défaut : '())
          List of symbols denoting the Shepherd services this one depends on.

     respawn? (par défaut : #t)
          Whether to restart the service when it stops, for instance when the underlying process dies.

     start
     stop (par défaut : #~(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 (par défaut : %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.

 -- Variable Scheme: 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>.

 -- Variable Scheme: %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.

Graphe de dépendance des premiers paquets

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!

Porter vers une nouvelle plateforme
===================================

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]