     [file version-fr.texi not included]

Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 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, 2019 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 ng0
 Copyright © 2016, 2017, 2018, 2019 Jan Nieuwenhuizen
 Copyright © 2016 Julien Lepiller

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

Copyright © 2017 Federico Beffa
 Copyright © 2017, 2018 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
 Copyright © 2018 Florian Pelz
 Copyright © 2018 Laura Lazzati
 Copyright © 2018 Alex Vong

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.

Ce manuel est aussi disponible en anglais (see GNU Guix Reference Manual) et en allemand (see Referenzhandbuch zu GNU Guix).  Si vous souhaitez nous aider à traduire ce manuel en français, vous pouvez nous rejoindre sur le projet de traduction (https://translationproject.org/domain/guix-manual.html) et sur la liste de diffusion traduc@traduc.org (https://listes.traduc.org/mailman/listinfo/traduc/).

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

GNU Guix (``Guix'' is pronounced like ``geeks'', or ``ɡiːks'' using the international phonetic alphabet (IPA).) is a package management tool for and distribution of the GNU system.  Guix makes it easy for unprivileged users to install, upgrade, or remove software packages, to roll back to a previous package set, to build packages from source, and generally assists with the creation and maintenance of software environments.

You can install GNU Guix on top of an existing GNU/Linux system where it complements the available tools without interference (see Installation), or you can use it as a standalone operating system distribution, Guix System (We used to refer to Guix System as ``Guix System Distribution'' or ``GuixSD''.  We now consider it makes more sense to group everything under the ``Guix'' banner since, after all, Guix System is readily available through the guix system command, even if you're using a different distro underneath!).  See Distribution GNU.

Managing Software the Guix Way
==============================

Guix provides a command-line package management interface (see Gestion de paquets), tools to help with software development (see Development), command-line utilities for more advanced usage, (see Utilitaires), as well as Scheme programming interfaces (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).

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

Distribution GNU
================

Guix comes with a distribution of the GNU system consisting entirely of free software (The term ``free'' here refers to the freedom provided to users of that software (http://www.gnu.org/philosophy/free-sw.html).).  The distribution can be installed on its own (see Installation du système), but it is also possible to install Guix as a package manager on top of an installed GNU/Linux system (see Installation).  When we need to distinguish between the two, we refer to the standalone distribution as Guix System.

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.

With Guix System, you declare all aspects of the operating system configuration and Guix takes care of instantiating the configuration in a transactional, reproducible, and stateless fashion (see Configuration système).  Guix System uses the Linux-libre kernel, the Shepherd initialization system (see Introduction (The GNU Shepherd Manual)), the well-known GNU utilities and tool chain, as well as the graphical environment or system services of your choice.

Guix System is available on all the above platforms except mips64el-linux.

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
************

     We recommend the use of this shell installer script (https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh) to install Guix on top of a running GNU/Linux system, thereafter called a foreign distro. (This section is concerned with the installation of the package manager, which can be done on top of a running GNU/Linux system.  If, instead, you want to install the complete GNU operating system, see Installation du système.) The script automates the download, installation, and initial configuration of Guix.  It should be run as the root user.

When installed on a foreign distro, GNU Guix complements the available tools without interference.  Its data lives exclusively in two directories, usually /gnu/store and /var/guix; other files on your system, such as /etc, are left untouched.

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

If you prefer to perform the installation steps manually or want to tweak them, you may find the following subsections useful.  They describe the software requirements of Guix, as well as how to install it manually and get ready to use it.

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

Cette section décrit comment installer 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.

L'installation se comme ceci :

 1. Téléchargez l'archive binaire depuis https://alpha.gnu.org/gnu/guix/guix-binary-VERSION.SYSTÈME.tar.xz, où SYSTÈME est x86_64-linux pour une machine x86_64 sur laquelle tourne déjà le noyau Linux, etc.

     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.SYSTÈME.tar.xz.sig
          $ gpg --verify guix-binary-VERSION.SYSTÈME.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 pool.sks-keyservers.net \
                --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 prêt à ê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 disponible sous ~root/.config/guix/current, qui est l'emplacement où guix pull installera les mises à jour (see Invoquer guix pull) :

          # mkdir -p ~root/.config/guix
          # ln -sf /var/guix/profiles/per-user/root/current-guix \
                   ~root/.config/guix/current

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

          # GUIX_PROFILE="`echo ~root`/.config/guix/current" ; \
            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/.config/guix/current/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/.config/guix/current/lib/upstart/system/guix-daemon.conf \
               /etc/init/
          # start guix-daemon

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

          # ~root/.config/guix/current/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/current-guix/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/current-guix/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. To use substitutes from ci.guix.fr.info or one of its mirrors (see Substituts), authorize them:

          # guix archive --authorize < \
               ~root/.config/guix/current/share/guix/ci.guix.fr.info.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çant la commande suivante dans l'arborescence des sources de Guix :

     make guix-binary.SYSTEM.tar.xz

... which, in turn, runs:

     guix pack -s SYSTEM --localstatedir \
       --profile-name=current-guix 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 is available for download from its website at https://www.gnu.org/software/guix/.

GNU Guix dépend des paquets suivants :

  * GNU Guile (http://gnu.org/software/guile/), version 2.2.x;

  * Guile-Gcrypt (https://notabug.org/cwebber/guile-gcrypt), version 0.1.0 ou supérieure,

  * 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/guile-sqlite3/guile-sqlite3), version 0.1.0 ou supérieure,

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

  * Guile-JSON (https://savannah.nongnu.org/projects/guile-json/);

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

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

Les dépendances suivantes sont facultatives :

  * 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 ulté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 :

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

  * 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éfinir 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 also comes with a whole-system test suite that tests complete Guix System instances.  It can only run on systems where Guix is already installed, using:

     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)
          Le fichier de clef privée SSH à utiliser lors de la connexion à la machine, au format OpenSSH.  Cette clef ne doit pas être protégée par phrase de passe.

          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.

The guix command must be in the search path on the build machines.  You can check whether this is the case by running:

     ssh build-machine guix repl --version

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 includes an SELinux policy file at etc/guix-daemon.cil that can be installed on a system where SELinux is enabled, in order to label Guix files and to specify the expected behavior of the daemon.  Since Guix System does not provide an SELinux base policy, the daemon policy cannot be used on Guix System.

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'est 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, bien que dans le conteneur, l'arborescence de construction est toujours appelée /tmp/guix-build-NAME.drv-0.

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

Le démon écoute les connexions et démarre un sous-processus pour chaque session démarrée par un client (l'une des sous-commandes de guix).  La commande guix processes vous permet d'obtenir un aperçu de l'activité sur votre système en affichant chaque session et client actif.  See Invoquer guix processes pour plus d'informations.

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
     Consider URLS the default whitespace-separated list of substitute source URLs.  When this option is omitted, https://ci.guix.fr.info is used.

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

     Lorsqu'elle est à « yes », le GC gardera les sorties de toutes les dérivations — les fichiers .drv — accessibles dans le dépôt.  La valeur par défaut est « no », ce qui signifie que les sorties des dérivations ne sont gardées que si elles sont accessibles à partir d'une racine du GC.  See Invoquer guix gc pour plus d'informations sur les racines du GC.

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

     De cette manière, avec --gc-keep-derivations à « yes », l'accessibilité des sorties s'étend des sorties aux dérivations et avec --gc-keep-outputs à « yes », elle s'étend des dérivations aux sorties.  Quand les deux options sont à « yes », le GC gardera tous les prérequis de construction (les sources, le compilateur, les bibliothèques, et les autres outils de construction) des objets accessibles dans le dépôt, indépendamment du fait qu'ils soient ou non accessibles depuis une racine du GC.  Cela est pratique pour les développeurs car ça leur fait gagner du temps de reconstruction et de téléchargement.

--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
====================

When using Guix on top of GNU/Linux distribution other than Guix System---a so-called foreign distro---a few additional steps are needed to get everything in place.  Here are some of them.

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 effectuent la résolution eux-mêmes, 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 utilisant 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çant 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.

The wrapper's purpose is to inspect the -L and -l switches passed to the linker, add corresponding -rpath arguments, and invoke the actual linker with this new set of arguments.  You can instruct the wrapper to refuse to link against libraries not in the store by setting the GUIX_LD_WRAPPER_ALLOW_IMPURITIES environment variable to no.

Installation du système
***********************

This section explains how to install Guix System on a machine.  Guix, as a package manager, can also be installed on top of a running GNU/Linux system, 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
===========

As of version VERSION, Guix System is not production-ready.  It may contain bugs and lack important features.  Thus, if you are looking for a stable production system that respects your freedom as a computer user, a good solution at this point is to consider one of the more established GNU/Linux distributions (http://www.gnu.org/distros/free-distros.html).  We hope you can soon switch to the Guix System without fear, of course.  In the meantime, you can also keep using your distribution and try out the package manager on top of it (see Installation).

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 8,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 Guix focuses on respecting the user's computing freedom.  It builds around the kernel Linux-libre, which means that only hardware for which free software drivers and firmware exist is supported.  Nowadays, a wide range of off-the-shelf hardware is supported on GNU/Linux-libre---from keyboards to graphics cards to scanners and Ethernet controllers.  Unfortunately, there are still areas where hardware vendors deny users control over their own computing, and such hardware is not supported on Guix System.

One of the main areas where free drivers or firmware are lacking is WiFi devices.  WiFi devices known to work include those using Atheros chips (AR9271 and AR7010), which corresponds to the ath9k Linux-libre driver, and those using Broadcom/AirForce chips (BCM43xx with Wireless-Core Revision 5), which corresponds to the b43-open Linux-libre driver. Free firmware exists for both and is available out-of-the-box on Guix System, as part of %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
==========================================

Une image d'installation ISO-9660 téléchargeable depuis https://alpha.gnu.org/gnu/guix/guixsd-install-VERSION.SYSTÈME.iso.xz peut être écrite sur une clef USB ou gravée sur un DVD, où SYSTÈME est l'une de ces valeurs :

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 pool.sks-keyservers.net \
           --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.SYSTEM.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.SYSTEM.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 Installing Guix in a VM, if, instead, you would like to install Guix System in a virtual machine (VM).

Préparer l'installation
=======================

Once you have successfully booted your computer using the installation medium, you should end up with the welcome page of the graphical installer. The graphical installer is a text-based user interface built upon the newt library.  It shall guide you through all the different steps needed to install GNU Guix System.  However, as the graphical installer is still under heavy development, you might want to fallback to the original, shell based install process, by switching to TTYs 3 to 6 with the shortcuts CTRL-ALT-F[3-6]. The following sections describe the installation procedure assuming you're using one of those TTYs. They are configured and can be used to run commands as root.

TTY2 shows this documentation, browsable using the Info reader commands (see Stand-alone GNU Info).  The installation system runs the GPM mouse daemon, which allows you to select text with the left mouse button and to paste it with the middle button.

     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.

The installation system includes many common tools needed for this task. But it is also a full-blown Guix System, which means that you can install additional packages, should you need it, using 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
------

Lancez la commande suivante pour voir comment vos interfaces réseau sont appelées :

     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-fil 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)).

If you instead wish to use EFI-based GRUB, a FAT32 EFI System Partition (ESP) is required.  This partition can be mounted at /boot/efi for instance and must have the esp flag set.  E.g., for parted:

     parted /dev/sda set 1 esp on

     Vous n'êtes pas sûr de savoir si vous devez utiliser un GRUB EFI ou BIOS ? Si le répertoire /sys/firmware/efi existe sur l'image d'installation, vous devriez probablement effectuer une installation EFI, avec grub-efi-bootloader.  Sinon, vous devriez utiliser le GRUB en BIOS, grub-bootloader.  See Configuration du chargeur d'amorçage pour plus d'information sur le chargeur d'amorçage.

Once you are done partitioning the target hard disk drive, you have to create a file system on the relevant partition(s) (Currently Guix System 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

Préférez assigner une étiquette au système de fichier pour que vous puissiez vous y référer de manière fiable dans la déclaration file-system (see Systèmes de fichiers).  On le fait habituellement avec l'option -L de mkfs.ext4 et des commandes liées.  Donc, en supposant que la partition racine soit sur /dev/sda2, on peut créer un système de fichier avec pour étiquette my-root avec :

     mkfs.ext4 -L my-root /dev/sda2

Si vous voulez plutôt chiffrer la partition racine, vous pouvez utiliser les utilitaires Cryptsetup et LUKS pour cela (voir man cryptsetup pour plus d'informations).  En supposant que vous voulez stocker la partition racine sur /dev/sda2, la séquence de commandes suivante vous mènerait à ce résultat :

     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

Also mount any other file systems you would like to use on the target system relative to this path.  If you have opted for /boot/efi as an EFI mount point for example, mount it at /mnt/boot/efi now so it is found by guix system init afterwards.

Enfin, si vous souhaitez utiliser une ou plusieurs partitions de swap (see swap space (The GNU C Library Reference Manual)), assurez-vous de les initialiser avec mkswap.  En supposant que vous avez une partition de swap sur /dev/sda3, vous pouvez lancer :

     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 :

  * Make sure the bootloader-configuration form refers to the target you want to install GRUB on.  It should mention grub-bootloader if you are installing GRUB in the legacy way, or grub-efi-bootloader for newer UEFI systems.  For legacy systems, the target field names a device, like /dev/sda; for UEFI systems it names a path to a mounted EFI partition, like /boot/efi; do make sure the path is currently mounted and a file-sytem entry is specified in your configuration.

  * Assurez-vous que les étiquettes de vos systèmes de fichiers correspondent aux valeurs de leur champs device dans votre configuration file-system, en supposant que la configuration file-system utilise la procédure file-system-label dans son champ device.

  * 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).

From then on, you can update the system whenever you want by running, say:

     guix pull
     sudo guix system reconfigure /etc/config.scm

This builds a new system generation with the latest packages and services (see Invoquer guix system).  We recommend doing that regularly so that your system includes the latest security updates (see Mises à jour de sécurité).

     Note that sudo guix runs your user's guix command and not root's, because sudo leaves PATH unchanged.  To explicitly run root's guix, type sudo -i guix ....

Join us on #guix on the Freenode IRC network or on guix-devel@gnu.org to share your experience---good or not so good.

Installing Guix in a Virtual Machine
====================================

If you'd like to install Guix System in a virtual machine (VM) or on a virtual private server (VPS) rather than on your beloved machine, this section is for you.

To boot a QEMU (http://qemu.org/) VM for installing Guix System in a disk image, follow these steps:

 1. First, retrieve and decompress the Guix system installation image as described previously (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.

Once installation is complete, you can boot the system that's on your guixsd.img image.  See Running Guix in a VM, for how to do that.

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 --file-system-type=iso9660 \
       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.

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à installé 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.

In addition, any package transaction may be rolled back.  So, if, for example, an upgrade installs a new version of a package that turns out to have a serious bug, users may roll back to the previous instance of their profile, which was known to work well.  Similarly, the global system configuration on Guix is subject to transactional upgrades and roll-back (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.

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

La totalité de Guix et des définitions de paquets sont placés sous contrôle de version, et guix pull vous permet de « voyager dans le temps » de l'historique de Guix lui-même (see Invoquer guix pull).  Cela est rend possible la réplication d'une instance Guix sur une machine différente ou plus tard, ce qui vous permet de répliquer des environnements logiciels complets, tout en garantissant un suivi de provenance précis des logiciels.

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

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

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

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
     List the available packages whose name, synopsis, or description matches REGEXP (in a case-insensitive fashion), sorted by relevance.  Print all the metadata of matching packages in recutils format (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 intervalles.  --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 intervalle 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 âgé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
------------------------------

The ci.guix.fr.info server is a front-end to an official build farm that builds packages from Guix continuously for some architectures, and makes them available as substitutes.  This is the default source of substitutes; it can be overridden by passing the --substitute-urls option either to guix-daemon (see guix-daemon --substitute-urls)  or to client tools such as 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
----------------------------------

To allow Guix to download substitutes from ci.guix.fr.info or a mirror thereof, you must add its public key to the access control list (ACL) of archive imports, using the guix archive command (see Invoquer guix archive).  Doing so implies that you trust ci.guix.fr.info to not be compromised and to serve genuine substitutes.

The public key for ci.guix.fr.info is installed along with Guix, in PREFIX/share/guix/ci.guix.fr.info.pub, where PREFIX is the installation prefix of Guix.  If you installed Guix from source, make sure you checked the GPG signature of guix-VERSION.tar.gz, which contains this public key file. Then, you can run something like this:

     # guix archive --authorize < PREFIX/share/guix/ci.guix.fr.info.pub

     Similarly, the hydra.gnu.org.pub file contains the public key of an independent build farm also run by the project, reachable at https://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
     ...

This indicates that substitutes from ci.guix.fr.info are usable and will be downloaded, when possible, for future builds.

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 miroir 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êmes, 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
-------------------------------

Today, each individual's control over their own computing is at the mercy of institutions, corporations, and groups with enough power and determination to subvert the computing infrastructure and exploit its weaknesses.  While using ci.guix.fr.info substitutes can be convenient, we encourage users to also build on their own, or even run their own build farm, such that ci.guix.fr.info is less of an interesting target.  One way to help is by publishing the software you build using guix publish so that others have one more choice of server to download substitutes from (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çant 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

It is perfectly safe to run as a non-interactive periodic job (see Exécution de tâches planifiées, for how to set up such a job).  Running guix gc with no arguments will collect as much garbage as it can, but that is often inconvenient: you may find yourself having to rebuild or re-download software that is ``dead'' from the GC viewpoint but that is necessary to build other pieces of software---e.g., the compiler tool chain.

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), par défaut le dépôt officiel de GNU Guix, bien que cela puisse être personnalisé.

À 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

     Génération 2	11 juin 2018 11:02:49
       guix e0cc7f6
         URL du dépôt : https://git.savannah.gnu.org/git/guix.git
         branche : origin/master
         commit : e0cc7f669bec22c37481dd03a7941c7d11a64f1d
       2 nouveaux paquets : keepalived, libnfnetlink
       6 paquets mis à jour : 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

     Génération 3	13 juin 2018 23:31:07	(actuelle)
       guix 844cc1c
         URL du dépôt : https://git.savannah.gnu.org/git/guix.git
         branche : origin/master
         commit : 844cc1c8f394f03b404c5bb3aee086922373490c
       28 nouveaux paquets : emacs-helm-ls-git, emacs-helm-mu, ...
       69 paquets mis à jour : borg@1.1.6, cheese@3.28.0, ...

guix describe pour d'autres manières de décrire le statut actuel de Guix.

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 /var/guix/profiles/per-user/charlie/current-guix-1-link

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

--url=URL
--commit=COMMIT
--branch=BRANCHE
     Télécharger le code depuis l'URL spécifié, au COMMIT donné (un commit Git valide représenté par une chaîne hexadécimale) ou à la branche BRANCH.

     Ces options sont fournies pour votre confort, mais vous pouvez aussi spécifier votre configuration dans le fichier ~/.config/guix/channels.scm ou en utilisant l'option --channels (voir plus bas).

--channels=FILE
-C FILE
     Lit la liste des canaux dans FILE plutôt que dans ~/.config/guix/channels.scm.  FILE doit contenir un code Scheme qui s'évalue en une liste d'objets de canaux.  See Canaux pour plus d'informations.

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

     Invoquer guix describe, pour une manière d'afficher des informations sur la génération actuelle uniquement.

--profile=PROFIL
-p PROFIL
     Utiliser le PROFIL à la place de ~/.config/guix/current.

--dry-run
-n
     Montrer quels commits des canaux seraient utilisés et ce qui serait construit ou substitué mais ne pas le faire vraiment.

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

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

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

Le mécanisme de canaux vous permet de dire à guix pull quels répertoires et branches récupérer, ainsi que les dépôts supplémentaires contenant des modules de paquets qui devraient être déployés.  See Canaux pour plus d'information.

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

Canaux
======

Guix et sa collection de paquets sont mis à jour en lançant guix pull (see Invoquer guix pull).  Par défaut guix pull télécharge et déploie Guix lui-même depuis le dépôt officiel de GNU Guix.  Cela peut être personnalisé en définissant des canaux dans le fichier ~/.config/guix/channels.scm.  Un canal spécifie l'URL et la branche d'un répertoire Git à déployer et on peut demander à guix pull de récupérer un ou plusieurs canaux.  En d'autres termes, les canaux peuvent être utilisés pour personnaliser et pour étendre Guix, comme on le verra plus bas.

Utiliser un canal Guix personnalisé
-----------------------------------

Le canal nommé guix spécifie où Guix lui-même — ses outils en ligne de commande ainsi que sa collection de paquets — sera téléchargé.  Par exemple, supposons que vous voulez effectuer les mises à jour depuis votre propre copie du dépôt Guix sur example.org, et plus particulièrement depuis la branche super-hacks.  Vous pouvez écrire cette spécification dans ~/.config/guix/channels.scm :

     ;; Dit à « guix pull » d'utiliser mon propre dépôt.
     (list (channel
             (name 'guix)
             (url "https://example.org/my-guix.git")
             (branch "super-hacks")))

Maintenant, guix pull récupérera le code depuis la branche super-hacks du dépôt sur example.org.

Spécifier des canaux supplémentaires
------------------------------------

Vous pouvez aussi spécifier des canaux supplémentaires à récupérer. Disons que vous avez un ensemble de paquets personnels ou de variantes personnalisées qu'il ne vaudrait pas le coup de contribuer au projet Guix, mais que vous voudriez pouvoir utiliser de manière transparente sur la ligne de commande.  Vous écririez d'abord des modules contenant ces définitions de paquets (see Modules de paquets), en les maintenant dans un dépôt Git, puis vous ou n'importe qui d'autre pourrait l'utiliser comme un canal supplémentaire où trouver ces paquets.  Sympa, non ?

     Avant que vous, cher utilisateur, ne vous exclamiez « Oh mais c'est super génial ! » et que vous ne publiez vos canaux personnels publiquement, nous voudrions vous donner quelques avertissements :

       * Avant de publier un canal, envisagez de contribuer vos définitions de paquets dans Guix (see Contribuer).  Guix en tant que projet est ouvert à tous les logiciels libres de toutes sortes, et les paquets dans Guix sont déjà disponibles à tous les utilisateurs de Guix et bénéficient des processus d'assurance qualité du projet.

       * Lorsque vous maintenez des définitions de paquets en dehors de Guix, nous, les développeurs de Guix, considérons que la charge de la compatibilité vous incombe.  Rappelez-vous que les modules de paquets et les définitions de paquets ne sont que du code Scheme qui utilise diverses interfaces de programmation (API).  Nous souhaitons rester libres de changer ces API pour continuer à améliorer Guix, éventuellement d'une manière qui casse votre canal.  Nous ne changeons jamais l'API gratuitement, mais nous ne nous engageons pas à geler les API non plus.

       * Corollaire : si vous utilisez un canal externe et que le canal est cassé, merci de rapporter le problème à l'auteur du canal, pas au projet Guix.

     Vous avez été prévenus !  Maintenant, nous pensons que des canaux externes sont une manière pratique d'exercer votre liberté pour augmenter la collection de paquets de Guix et de partager vos améliorations, qui sont les principes de bases du logiciel libre (https://www.gnu.org/philosophy/free-sw.html).  Contactez-nous par courriel sur guix-devel@gnu.org si vous souhaitez discuter à ce propos.

To use a channel, write ~/.config/guix/channels.scm to instruct guix pull to pull from it in addition to the default Guix channel(s):

     ;; Ajouter mes paquets personnels à ceux fournis par Guix.
     (cons (channel
             (name 'my-personal-packages)
             (url "https://example.org/personal-packages.git"))
           %default-channels)

Note that the snippet above is (as always!) Scheme code; we use cons to add a channel the list of channels that the variable %default-channels is bound to (see cons and lists (GNU Guile Reference Manual)).  With this file in place, guix pull builds not only Guix but also the package modules from your own repository.  The result in ~/.config/guix/current is the union of Guix with your own package modules:

     $ guix pull --list-generations
     ...
     Génération 19	Aug 27 2018 16:20:48
       guix d894ab8
         URL du dépôt : https://git.savannah.gnu.org/git/guix.git
         branche : master
         commit : d894ab8e9bfabcefa6c49d9ba2e834dd5a73a300
       my-personal-packages dd3df5e
         URL du dépôt : https://example.org/personal-packages.git
         branche : master
         commit : dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb
       11 nouveaux paquets : my-gimp, my-emacs-with-cool-features, ...
       4 paquets mis à jour : emacs-racket-mode@0.0.2-2.1b78827, ...

La sortie de guix pull ci-dessus montre que la génération 19 contient aussi bien Guix que les paquets du canal my-personal-packages.  Parmi les nouveaux paquets et les paquets mis à jour qui sont listés, certains comme my-gimp et my-emacs-with-cool-features peuvent provenir de my-personal-packages, tandis que d'autres viennent du canal par défaut de Guix.

To create a channel, create a Git repository containing your own package modules and make it available.  The repository can contain anything, but a useful channel will contain Guile modules that export packages.  Once you start using a channel, Guix will behave as if the root directory of that channel's Git repository has been added to the Guile load path (see Load Paths (GNU Guile Reference Manual)).  For example, if your channel contains a file at my-packages/my-tools.scm that defines a Guile module, then the module will be available under the name (my-packages my-tools), and you will be able to use it like any other module (see Modules (GNU Guile Reference Manual)).

Declaring Channel Dependencies
------------------------------

Channel authors may decide to augment a package collection provided by other channels.  They can declare their channel to be dependent on other channels in a meta-data file .guix-channel, which is to be placed in the root of the channel repository.

The meta-data file should contain a simple S-expression like this:

     (channel
      (version 0)
      (dependencies
       (channel
        (name some-collection)
        (url "https://example.org/first-collection.git"))
       (channel
        (name some-other-collection)
        (url "https://example.org/second-collection.git")
        (branch "testing"))))

In the above example this channel is declared to depend on two other channels, which will both be fetched automatically.  The modules provided by the channel will be compiled in an environment where the modules of all these declared channels are available.

For the sake of reliability and maintainability, you should avoid dependencies on channels that you don't control, and you should aim to keep the number of dependencies to a minimum.

Répliquer Guix
--------------

La sortie de guix pull --list-generations ci-dessus montre précisément quels commits ont été utilisés pour construire cette instance de Guix.  Nous pouvons donc la répliquer, disons sur une autre machine, en fournissant une spécification de canal dans ~/.config/guix/channels.scm qui est « épinglé » à ces commits :

     ;; Déployer des commits précis de mes canaux préférés.
     (list (channel
            (name 'guix)
            (url "https://git.savannah.gnu.org/git/guix.git")
            (commit "d894ab8e9bfabcefa6c49d9ba2e834dd5a73a300"))
           (channel
            (name 'my-personal-packages)
            (url "https://example.org/personal-packages.git")
            (branch "dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb")))

La commande guix describe --format=channels peut même générer cette liste de canaux directement (see Invoquer guix describe).

À ce moment les deux machines font tourner exactement le même Guix, avec l'accès exactement aux même paquets.  La sortie de guix build gimp sur une machine sera exactement la même, au bit près, que la sortie de la même commande sur l'autre machine.  Cela signifie aussi que les deux machines ont accès à tous les codes sources de Guix, et transitivement, à tous les codes sources de tous les paquets qu'il définit.

Cela vous donne des super-pouvoirs, ce qui vous permet de suivre la provenance des artefacts binaires avec un grain très fin et de reproduire les environnements logiciels à volonté — une sorte de capacité de « méta-reproductibilité », si vous voulez.  See Inférieurs, pour une autre manière d'utiliser ces super-pouvoirs.

Inférieurs
==========

     La fonctionnalité décrite ici est un « démonstrateur technique » à la version VERSION.  Ainsi, l'interface est sujette à changements.

Parfois vous pourriez avoir à mélanger des paquets de votre révision de Guix avec des paquets disponibles dans une révision différente de Guix.  Les inférieurs de Guix vous permettent d'accomplir cette tâche en composant différentes versions de Guix de manière arbitraire.

Techniquement, un « inférieur » est surtout un processus Guix séparé connecté à votre processus Guix principal à travers un REPL (see Invoquer guix repl).  Le module (guix inferior) vous permet de créer des inférieurs et de communiquer avec eux.  Il fournit aussi une interface de haut-niveau pour naviguer dans les paquets d'un inférieur — des paquets inférieurs — et les manipuler.

Lorsqu'on les combine avec des canaux (see Canaux), les inférieurs fournissent une manière simple d'interagir avec un révision de Guix séparée.  Par exemple, disons que vous souhaitiez installer dans votre profil le paquet guile actuel, avec le guile-json d'une ancienne révision de Guix — peut-être parce que la nouvelle version de guile-json a une API incompatible et que vous voulez lancer du code avec l'ancienne API.  Pour cela, vous pourriez écrire un manifeste à utiliser avec guix package --manifest (see Invoquer guix package) ; dans ce manifeste, vous créeriez un inférieur pour l'ancienne révision de Guix qui vous intéresse et vous chercheriez le paquet guile-json dans l'inférieur :

     (use-modules (guix inferior) (guix channels)
                  (srfi srfi-1))   ;pour « first »

     (define channels
       ;; L'ancienne révision depuis laquelle on veut
       ;; extraire guile-json.
       (list (channel
              (name 'guix)
              (url "https://git.savannah.gnu.org/git/guix.git")
              (commit
               "65956ad3526ba09e1f7a40722c96c6ef7c0936fe"))))

     (define inferior
       ;; Un inférieur représentant la révision ci-dessus.
       (inferior-for-channels channels))

     ;; Maintenant on crée un manifeste avec le paquet « guile » actuel
     ;; et l'ancien paquet « guile-json ».
     (packages->manifest
      (list (first (lookup-inferior-packages inferior "guile-json"))
            (specification->package "guile")))

Durant la première exécution, guix package --manifest pourrait avoir besoin de construire le canal que vous avez spécifié avant de créer l'inférieur ; les exécutions suivantes seront bien plus rapides parce que la révision de Guix sera déjà en cache.

Le module (guix inferior) fournit les procédures suivantes pour ouvrir un inférieur :

 -- Procédure Scheme: inferior-for-channels CHANNELS
     [#:cache-directory] [#:ttl]
     Renvoie un inférieur pour CHANNELS, une liste de canaux.  Elle utilise le cache dans CACHE-DIRECTORY, où les entrées peuvent être glanées après TTL secondes.  Cette procédure ouvre une nouvelle connexion au démon de construction.

     Elle a pour effet de bord de construire ou de substituer des binaires pour CHANNELS, ce qui peut prendre du temps.

 -- Procédure Scheme: open-inferior DIRECTORY
     [#:command "bin/guix"]
     Ouvre le Guix inférieur dans DIRECTORY et lance DIRECTORY/COMMAND repl ou équivalent.  Renvoie #f si l'inférieur n'a pas pu être lancé.

Les procédures listées plus bas vous permettent d'obtenir et de manipuler des paquets inférieurs.

 -- Procédure Scheme: inferior-packages INFERIOR
     Renvoie la liste des paquets connus de l'inférieur INFERIOR.

 -- Procédure Scheme: lookup-inferior-packages INFERIOR NAME
     [VERSION]
     Renvoie la liste triée des paquets inférieurs qui correspondent à NAME dans INFERIOR, avec le plus haut numéro de version en premier.  Si VERSION est vrai, renvoie seulement les paquets avec un numéro de version préfixé par VERSION.

 -- Procédure Scheme: inferior-package? OBJ
     Renvoie vrai si OBJ est un paquet inférieur.

 -- Procédure Scheme: inferior-package-name PACKAGE
 -- Procédure Scheme: inferior-package-version PACKAGE
 -- Procédure Scheme: inferior-package-synopsis PACKAGE
 -- Procédure Scheme: inferior-package-description PACKAGE
 -- Procédure Scheme: inferior-package-home-page PACKAGE
 -- Procédure Scheme: inferior-package-location PACKAGE
 -- Procédure Scheme: inferior-package-inputs PACKAGE
 -- Procédure Scheme: inferior-package-native-inputs PACKAGE
 -- Procédure Scheme: inferior-package-propagated-inputs PACKAGE
 -- Procédure Scheme: inferior-package-transitive-propagated-inputs PACKAGE
 -- Procédure Scheme: inferior-package-native-search-paths PACKAGE
 -- Procédure Scheme: inferior-package-transitive-native-search-paths PACKAGE
 -- Procédure Scheme: inferior-package-search-paths PACKAGE
     Ces procédures sont la contrepartie des accesseurs des enregistrements de paquets (see Référence de paquet).  La plupart fonctionne en effectuant des requêtes à l'inférieur dont provient PACKAGE, donc l'inférieur doit toujours être disponible lorsque vous appelez ces procédures.

Les paquets inférieurs peuvent être utilisés de manière transparente comme tout autre paquet ou objet simili-fichier dans des G-expressions (see G-Expressions).  Ils sont aussi gérés de manière transparente par la procédure packages->manifest, qui est typiquement utilisée dans des manifestes (see l'option --manifest de guix package).  Ainsi, vous pouvez insérer un paquet inférieur à peu près n'importe où vous utiliseriez un paquet normal : dans des manifestes, dans le champ packages de votre déclaration operating-system, etc.

Invoquer guix describe
======================

Souvent vous voudrez répondre à des questions comme « quelle révision de Guix j'utilise ? » ou « quels canaux est-ce que j'utilise ? ».  C'est une information utile dans de nombreuses situations : si vous voulez répliquer un environnement sur une machine différente ou un compte utilisateur, si vous voulez rapporter un bogue ou pour déterminer quel changement dans les canaux que vous utilisez l'a causé ou si vous voulez enregistrer l'état de votre système pour le reproduire.  La commande guix describe répond à ces questions.

Lorsqu'elle est lancée depuis un guix mis à jour avec guix pull, guix describe affiche les canaux qui ont été construits, avec l'URL de leur dépôt et l'ID de leur commit (see Canaux) :

     $ guix describe
     Generation 10	03 sep. 2018 17:32:44	(actuelle)
       guix e0fa68c
         URL du dépôt : https://git.savannah.gnu.org/git/guix.git
         branche : master
         commit : e0fa68c7718fffd33d81af415279d6ddb518f727

Si vous connaissez bien le système de contrôle de version Git, cela ressemble en essence à git describe ; la sortie est aussi similaire à celle de guix pull --list-generations, mais limitée à la génération actuelle (see l'option --list-generations).  Comme l'ID de commit de Git ci-dessus se réfère sans aucune ambiguïté à un instantané de Guix, cette information est tout ce dont vous avez besoin pour décrire la révision de Guix que vous utilisez et pour la répliquer.

Pour rendre plus facile la réplication de Guix, guix describe peut aussi renvoyer une liste de canaux plutôt que la description lisible par un humain au-dessus :

     $ guix describe -f channels
     (list (channel
             (name 'guix)
             (url "https://git.savannah.gnu.org/git/guix.git")
             (commit
               "e0fa68c7718fffd33d81af415279d6ddb518f727")))

Vous pouvez sauvegarder ceci dans un fichier et le donner à guix pull -C sur une autre machine ou plus tard, ce qui instantiera exactement la même révision de Guix (see l'option -C).  À partir de là, comme vous pouvez déployer la même révision de Guix, vous pouvez aussi bien répliquer un environnement logiciel complet.  Nous pensons humblement que c'est génial, et nous espérons que vous aimerez ça aussi !

Voici les détails des options supportées par guix describe :

--format=FORMAT
-f FORMAT
     Produire la sortie dans le FORMAT donné, parmi :

     human
          produire une sortie lisible par un humain,

     canaux
          produire une liste de spécifications de canaux qui peut être passée à guix pull -C ou installée dans ~/.config/guix/channels.scm (see Invoquer guix pull),

     json
          produire une liste de spécifications de canaux dans le format JSON,

     recutils
          produire une liste de spécifications de canaux dans le format Recutils.

--profile=PROFIL
-p PROFIL
     Afficher les informations sur le PROFIL.

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.

     For example, the following command extracts the substitute for Emacs served by ci.guix.fr.info to /tmp/emacs:

          $ wget -O - \
            https://ci.guix.fr.info/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.

Development
***********

If you are a software developer, Guix provides tools that you should find helpful---independently of the language you're developing in.  This is what this chapter is about.

The guix environment command provides a convenient way to set up development environments containing all the dependencies and tools necessary to work on the software package of your choice.  The guix pack command allows you to create application bundles that can be easily distributed to users who do not run Guix.

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

... or to browse the profile:

     $ 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

Sometimes it is desirable to isolate the environment as much as possible, for maximal purity and reproducibility.  In particular, when using Guix on a host distro that is not Guix System, it is desirable to prevent access to /usr/bin and other system-wide resources from the development environment.  For example, the following command spawns a Guile REPL in a ``container'' where only the store and the current working directory are mounted:

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

     starts a shell with all the base system packages available.

     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
     Unset existing environment variables when building the new environment, except those specified with --inherit (see below.)  This has the effect of creating an environment in which search paths only contain package inputs.

--inherit=REGEXP
     When used alongside --pure, inherit all the environment variables matching REGEXP---in other words, put them on a ``white list'' of environment variables that must be preserved.  This option can be repeated several times.

          guix environment --pure --inherit=^SLURM --ad-hoc openmpi ... \
            -- mpirun ...

     This example runs mpirun in a context where the only environment variables defined are PATH, environment variables whose name starts with SLURM, as well as the usual ``precious'' variables (HOME, USER, etc.)

--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/passwd 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/passwd 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 SOURCE 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 also supports all of the common build options that guix build supports (see Options de construction communes) as well as package transformation options (see Options de transformation de paquets).

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 contenant 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

     ... you can copy that pack to a machine that lacks Guix, and from your home directory as a normal user, run:

          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
--profile-name=NOM
     Inclus le « répertoire d'état local », /var/guix, dans le lot qui en résulte, et notamment le profil /var/guix/profiles/per-user/root/NOM — par défaut NOM est guix-profile, ce qui correspond à ~root/.guix-profile.

     /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).

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.

Modules de paquets
==================

D'un point de vue programmatique, les définitions de paquets de la distribution GNU sont fournies par des modules Guile dans l'espace de noms (gnu packages ...) (Remarquez que les paquets sous l'espace de nom (gnu packages ...) ne sont pas nécessairement des « paquets GNU ».  Le nom de ce module suit la convention de nommage usuelle de Guile : gnu signifie que ces modules sont distribués dans le système GNU, et packages identifie les modules qui définissent les paquets.) (see Guile modules (GNU Guile Reference Manual)).  Par exemple, le module (gnu packages emacs) exporte une variable nommée emacs, qui est liée à un objet <package> (see Définition des paquets).

L'espace de nom (gnu packages ...) est automatiquement scanné par les outils en ligne de commande.  Par exemple, lorsque vous lancez guix package -i emacs, tous les modules (gnu packages ...) sont scannés jusqu'à en trouver un qui exporte un objet de paquet dont le nom est emacs.  Cette capacité à chercher des paquets est implémentée dans le module (gnu packages).

Les utilisateurs peuvent stocker des définitions dans des modules avec des noms différents — p. ex. (my-packages emacs) (Remarquez que le nom de fichier et de module doivent être identiques.  Par exemple, le module (my-packages emacs) doit être stocké dans un fichier my-packages/emacs.scm relativement au chemin de chargement spécifié avec --load-path ou GUIX_PACKAGE_PATH.  See Modules and the File System (GNU Guile Reference Manual) pour plus de détails).  Il y a deux manières de rendre ces définitions visibles aux interfaces utilisateurs :

 1. En ajoutant le répertoire contenant vos modules de paquets au chemin de recherche avec le drapeau -L de guix package et des autres commandes (see Options de construction communes) ou en indiquant la variable d'environnement GUIX_PACKAGE_PATH décrite plus bas.

 2. En définissant un canal et en configurant guix pull pour qu'il l'utilise.  Un canal est essentiellement un dépôt Git contenant des modules de paquets.  See Canaux, pour plus d'informations sur comment définir et utiliser des canaux.

GUIX_PACKAGE_PATH fonctionne comme les autres variables de chemins de recherche :

 -- Variable d'environnement: GUIX_PACKAGE_PATH
     C'est une liste séparée par des deux-points de répertoires dans lesquels trouver des modules de paquets supplémentaires.  Les répertoires listés dans cette variable sont prioritaires par rapport aux paquets de la distribution.

La distribution est entièrement bootstrappée et auto-contenue : chaque paquet est construit uniquement à partir d'autres paquets de la distribution.  La racine de ce graphe de dépendance est un petit ensemble de binaires de bootstrap fournis par le module (gnu packages bootstrap).  Pour plus d'informations sur le bootstrap, see Bootstrapping.

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 litté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'informations 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 respecte les conventions de style. Enfin, see Canaux pour des informations sur la manière d'étendre la distribution en ajoutant vos propres définitions de paquets dans un « canal ».

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>
     du 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 junits à 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: clojure-build-system
     Cette variable est exportée par (guix build-system clojure).  Elle implémente une procédure de construction des paquets simple qui utilise le bon vieux compile de Clojure.  La compilation croisée n'est pas encore supportée.

     Elle ajoute clojure, icedtea et zip à l'ensemble des entrées.  Des paquets différents peuvent être spécifiés avec les paramètres #:clojure, #:jdk et #:zip.

     Une liste de répertoires sources, de répertoires de tests et de noms de jar peuvent être spécifiés avec les paramètres #:source-dirs, #:test-dirs et #:jar-names.  Le répertoire de construction est la classe principale peuvent être spécifiés avec les paramètres #:compile-dir et #:main-class.  Les autres paramètres sont documentés plus bas.

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

     build
          Cette phase appelle compile en Clojure pour compiler les fichiers sources et lance jar pour créer les fichiers jar à partir des fichiers sources et des fichiers compilés en suivant la liste d'inclusion et d'exclusion spécifiées dans #:aot-include et #:aot-exclude. La liste d'exclusion a la priorité sur la liste d'inclusion.  Ces listes consistent en des symboles représentant des bibliothèque Clojure ou le mot clef spécial #:all, représentant toutes les bibliothèques Clojure trouvées dans les répertoires des sources.  Le paramètre #:omit-source? décide si les sources devraient être incluses dans les fichiers jar.

     check
          Cette phase lance les tests en suivant les liste d'inclusion et d'exclusion spécifiées dans #:test-include et #:test-exclude.  Leur signification est analogue à celle de #:aot-include et #:aot-exclude, sauf que le mot-clef spécial #:all signifie maintenant toutes les bibliothèques Clojure trouvées dans les répertoires de tests.  Le paramètre #:tests? décide si les tests devraient être lancés.

     install
          Cette phase installe tous les fichiers jar précédemment construits.

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

     install-doc
          Cette phase installe tous les fichiers dans le répertoire de plus haut niveau dont le nom correspond à %DOC-REGEX.  On peut spécifier une regex différente avec le paramètre #:doc-regex.  Tous les fichiers (récursivement) dans les répertoires de documentations spécifiés dans #:doc-dirs sont aussi installés.

 -- 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'outil 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.

 -- Scheme Variable: dune-build-system
     This variable is exported by (guix build-system dune).  It supports builds of packages using Dune (https://dune.build/), a build tool for the OCaml programming language.  It is implemented as an extension of the ocaml-build-system which is described below.  As such, the #:ocaml and #:findlib parameters can be passed to this build system.

     It automatically adds the dune package to the set of inputs.  Which package is used can be specified with the #:dune parameter.

     There is no configure phase because dune packages typically don't need to be configured.  The #:build-flags parameter is taken as a list of flags passed to the dune command during the build.

     The #:jbuild? parameter can be passed to use the jbuild command instead of the more recent dune command while building a package.  Its default value is #f.

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

 -- Variable Scheme: guile-build-system
     Ce système de construction sert aux paquets Guile qui consistent exclusivement en code Scheme et qui sont si simple qu'ils n'ont même pas un makefile, sans parler d'un script configure.  Il compile le code Scheme en utilisant guild compile (see Compilation (GNU Guile Reference Manual)) et installe les fichiers .scm et .go aux bons emplacements.  Il installe aussi la documentation.

     Ce système de construction supporte la compilation croisée en utilisant l'option --target de guild compile.

     Les paquets construits avec guile-build-system doivent fournir un paquet Guile dans leur champ native-inputs.

 -- 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 construction 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 standard 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 standard 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
     This variable is exported by (guix build-system font).  It implements an installation procedure for font packages where upstream provides pre-compiled TrueType, OpenType, etc. font files that merely need to be copied into place.  It copies font files to standard locations in the output directory.

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

     A &store-protocol-error condition is raised if PATH is not prefixed by the store directory (/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 monade 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 monade 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] [#:properties '()]
     Construit une dérivation avec les arguments donnés et renvoie 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.

     PROPERTIES doit être une liste d'association décrivant les « propriétés » de la dérivation.  Elle est gardée telle-quelle, sans être interprétée, dans la dérivation.

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 monade 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 monade très utile pour notre usage, la monade du dépôt.  Les monades 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 monade — 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 monade comme d'un immeuble en flamme, en courant ».  Le jeu de mot est perdu à la traduction : courir et lancer utilisent le même verbe run en anglais.). Donc, pour sortir de la monade 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 monades 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 monade actuelle.  Chaque 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 monade actuelle.  Chaque expression dans la séquence doit être une expression monadique.

Le module (guix monads) fournit la monade 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 monade d'état.  les procédure dans la monade 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 monade 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 monadique: current-state
     Renvoie l'état actuel dans une valeur monadique.

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

 -- Procédure monadique: 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 monadique: 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 monade du dépôt, fournit par le module (guix store), est la suivante.

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

     Les valeurs dans la monade du dépôt encapsulent des accès au dépôt.  Lorsque son effet est requis, une valeur de la monade 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 monade 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.

 -- Procédure monadique: binary-file NAME DATA [REFERENCES]
     Renvoie une valeur monadique correspondant au nom de fichier absolu dans le dépôt du fichier contenant DATA, un vecteur d'octets. REFERENCES est une liste d'éléments du dépôt auxquels le fichier binaire en résultat se réfère ; c'est la liste vide par défaut.

 -- 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 et 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 informations 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 module 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 monade 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]
     [#:properties '()] [#: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
     Renvoie un objet représentant un fichier texte nommé NAME avec pour contenu CONTENT (une chaîne de caractères ou un vecteur d'octets) à ajouter un dépôt.

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

Invoquer guix repl
==================

La commande guix repl démarre un boucle lecture-évaluation-affichage Guile pour la programmation interactive (see Using Guile Interactively (GNU Guile Reference Manual)). Comparé au lancement de la commande guile, guix repl garanti que tous les modules Guix et toutes ses dépendances sont disponibles dans le chemin de recherche.  Vous pouvez l'utiliser de cette manière :

     $ guix repl
     scheme@(guile-user)> ,use (gnu packages base)
     scheme@(guile-user)> coreutils
     $1 = #<package coreutils@8.29 gnu/packages/base.scm:327 3e28300>

En plus, guix repl implémente un protocole REPL simple lisible par une machine à utiliser avec (guix inferior), un dispositif pour interagir avec des inférieurs, des processus séparés qui font tourner une version potentiellement différente de Guix.

Les options disponibles sont les suivante :

--type=TYPE
-t TYPE
     Démarrer un REPL du TYPE donné, qui peut être l'un de ces types :

     guile
          C'est la valeur par défaut.  Elle démarre un REPL Guile standard fonctionnel.

     machine
          Démarre un REPL qui utilise le protocole lisible par machine.  C'est le protocole que parle le module (guix inferior).

--listen=EXTRÉMITÉ
     Par défaut, guix repl lit depuis l'entrée standard et écrit sur la sortie standard.  Lorsque cette option est passée, il écoutera plutôt les connexions sur ENDPOINT.  Voici un exemple d'options valides :

     --listen=tcp:37146
          Accepte les connexions sur localhost, sur le port 31.

     --listen=unix:/tmp/socket
          Accepte les connexions sur le socket Unix-domain /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.

     Cette option n'a pas d'effet lors de la connexion à un démon distant avec l'URI guix:// (see la variable GUIX_DAEMON_SOCKET).

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

-v LEVEL
--verbosity=LEVEL
     Use the given verbosity LEVEL, an integer.  Choosing 0 means that no output is produced, 1 is for quiet output, and 2 shows all the build log output on standard error.

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

--debug=LEVEL
     Produce debugging output coming from the build daemon.  LEVEL must be an integer between 0 and 5; higher means more verbose output.  Setting a level of 4 or more may be helpful when debugging setup issues with the build 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 miroir 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 !

--with-branch=PACKAGE=BRANCH
     Build PACKAGE from the latest commit of BRANCH.  The source field of PACKAGE must be an origin with the git-fetch method (see Référence d'origine) or a git-checkout object; the repository URL is taken from that source.  Git sub-modules of the repository are fetched, recursively.

     For instance, the following command builds guile-sqlite3 from the latest commit of its master branch, and then builds guix (which depends on it) and cuirass (which depends on guix) against this specific guile-sqlite3 build:

          guix build --with-branch=guile-sqlite3=master cuirass

     Obviously, since it uses the latest commit of the given branch, the result of such a command varies over time.  Nevertheless it is a convenient way to rebuild entire software stacks against the latest commit of one or more packages.  This is particularly useful in the context of continuous integration (CI).

     Checkouts are kept in a cache under ~/.cache/guix/checkouts to speed up consecutive accesses to the same repository.  You may want to clean it up once in a while to save disk space.

--with-commit=PACKAGE=COMMIT
     This is similar to --with-branch, except that it builds from COMMIT rather than the tip of a branch.  COMMIT must be a valid Git commit SHA1 identifier.

Options de construction supplémentaires
---------------------------------------

Les options de la ligne de commande ci-dessous sont spécifiques à guix build.

--quiet
-q
     Build quietly, without displaying the build log; this is equivalent to --verbosity=0.  Upon completion, the build log is kept in /var (or similar) and can always be retrieved using the --log-file option.

--file=FICHIER
-f FICHIER
     Construit le paquet, la dérivation ou l'objet simili-fichier en lequel le code dans FILE s'évalue (see file-like objects).

     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 monade 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êmes.

     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
          Build the source derivations of all packages, as well of all transitive inputs to the packages.  This can be used e.g. to prefetch package source for later offline building.

               $ 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 sortie 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://ci.guix.fr.info/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 empaqueteurs 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 celle 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 Modules de 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 : lorsque 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
     Import metadata from the Python Package Index (https://pypi.python.org/).  Information is taken from the JSON-formatted description available at pypi.python.org and usually includes all the relevant information, including package dependencies.  For maximum efficiency, it is recommended to install the unzip utility, so that the importer can unzip Python wheels and gather data from them.

     La commande ci-dessous importe les métadonnées du paquet Python itsdangerous :

          guix import pypi itsdangerous

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

gem
     Import metadata from RubyGems (https://rubygems.org/).  Information is taken from the JSON-formatted description available at rubygems.org and includes most relevant information, including runtime dependencies. There are some caveats, however.  The metadata doesn't distinguish between synopses and descriptions, so the same string is used for both fields. Additionally, the details of non-Ruby dependencies required to build native extensions is unavailable and left as an exercise to the 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
     Import metadata from MetaCPAN (https://www.metacpan.org/). Information is taken from the JSON-formatted metadata provided through MetaCPAN's API (https://fastapi.metacpan.org/) and includes most relevant information, such as module dependencies.  License information should be checked closely.  If Perl is available in the store, then the corelist utility will be used to filter core modules out of the list of dependencies.

     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
     Import package metadata from a local JSON file.  Consider the following example package definition in JSON format:

          {
            "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
     -l VERSION
          VERSION est la version LTS désirée.  Si elle est omise, la dernière version est utilisée.

     --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 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
     Importe les métadonnées du répertoire de paquets OPAM (https://opam.ocaml.org/) utilisé par la communauté OCaml

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 !

--recursive
     Consider the packages specified, and all the packages upon which they depend.

          $ guix refresh --recursive coreutils
          gnu/packages/acl.scm:35:2: warning: no updater for acl
          gnu/packages/m4.scm:30:12: info: 1.4.18 is already the latest version of m4
          gnu/packages/xml.scm:68:2: warning: no updater for expat
          gnu/packages/multiprecision.scm:40:12: info: 6.1.2 is already the latest version of gmp
          ...

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 reste ».  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.

--list-transitive
     List all the packages which one or more packages depend upon.

          $ guix refresh --list-transitive flex
          flex@2.6.4 depends on the following 25 packages: perl@5.28.0 help2man@1.47.6
          bison@3.0.5 indent@2.2.10 tar@1.30 gzip@1.9 bzip2@1.0.6 xz@5.2.4 file@5.33 ...

The command above lists a set of packages which, when changed, would cause flex to be rebuilt.

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.

--keyring=FICHIER
     Utilise FICHIER comme porte-clefs pour les clefs amont.  FICHIER doit être dans le format keybox.  Les fichiers Keybox ont d'habitude un nom qui fini par .kbx et GNU Privacy Guard (GPG) peut manipuler ces fichiers (see kbxutil (Using the Privacy Guard), pour plus d'informations sur un outil pour manipuler des fichiers keybox).

     Lorsque cette option est omise, guix refresh utilise ~/.config/guix/upstream/trustedkeys.kbx comme porte-clefs pour les clefs de signature amont.  Les signatures OpenPGP sont vérifiées avec ces clefs ; les clefs manquantes sont aussi téléchargées dans ce porte-clefs (voir --key-download plus bas).

     Vous pouvez exporter les clefs de votre porte-clefs GPG par défaut dans un fichier keybox avec une commande telle que :

          gpg --export rms@gnu.org | kbxutil --import-openpgp >> mykeyring.kbx

     De même, vous pouvez récupérer des clefs dans un fichier keybox spécifique comme ceci :

          gpg --no-default-keyring --keyring mykeyring.kbx \
            --recv-keys 3CE464558A84FDC69DB40CFB090B11993D9AEBB5

     --keyring (Using the GNU Privacy Guard) pour plus d'informations sur l'option --keyring de GPG.

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

The github updater uses the GitHub API (https://developer.github.com/v3/) to query for new releases.  When used repeatedly e.g. when refreshing all packages, GitHub will eventually refuse to answer any further API requests.  By default 60 API requests per hour are allowed, and a full refresh on all GitHub packages in Guix requires more than this. Authentication with GitHub through the use of an API token alleviates these limits.  To use an API token, set the environment variable GUIX_GITHUB_TOKEN to a token procured from https://github.com/settings/tokens or otherwise.

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
github-url
source-file-name
     Probe home-page and source URLs and report those that are invalid.  Suggest a mirror:// URL when applicable.  If the source URL redirects to a GitHub URL, recommend usage of the GitHub URL.  Check that the source file name is meaningful, e.g. is not just a version number or ``git-checkout'', without a declared file-name (see Référence d'origine).

source-unstable-tarball
     Parse the source URL to determine if a tarball from GitHub is autogenerated or if it is a release tarball.  Unfortunately GitHub's autogenerated tarballs are sometimes regenerated.

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 clôture 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 clôture 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 clôture 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 clôture 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 prend 102.3 Mio en tout, ce qui est bien moins que la somme des clôtures 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 options suivantes :

     self
          la taille de chaque élément (par défaut) ;

     closure
          la taille totale de la clôture de l'élément.

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

     ... yields the graph of packages that depend on 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

     ... yields this bigger graph:

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

--system=SYSTÈME
-s SYSTÈME
     Affiche le graphe pour SYSTÈME — p. ex. i686-linux.

     Le graphe de dépendance des paquets est la plupart du temps indépendant de l'architecture, mais il y a quelques parties qui dépendent de l'architecture que cette option vous permet de visualiser.

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

When guix publish runs, it spawns an HTTP server which allows anyone with network access to obtain substitutes from it.  This means that any machine running Guix can also act as if it were a build farm, since the HTTP interface is compatible with Hydra, the software behind the ci.guix.fr.info build farm.

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 fichier 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 parce 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éponses, 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.

Enabling guix publish on Guix System is a one-liner: just instantiate a guix-publish-service-type service in the services field of the operating-system declaration (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://ci.guix.fr.info https://guix.example.org"
     updating list of substitutes from 'https://ci.guix.fr.info'... 100.0%
     updating list of substitutes from 'https://guix.example.org'... 100.0%
     /gnu/store/...-openssl-1.0.2d contents differ:
       local hash: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q
       https://ci.guix.fr.info/nar/...-openssl-1.0.2d: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q
       https://guix.example.org/nar/...-openssl-1.0.2d: 1zy4fmaaqcnjrzzajkdn3f5gmjk754b43qkq47llbyak9z0qjyim
     /gnu/store/...-git-2.5.0 contents differ:
       local hash: 00p3bmryhjxrhpn2gxs2fy0a15lnip05l97205pgbk5ra395hyha
       https://ci.guix.fr.info/nar/...-git-2.5.0: 069nb85bv4d4a6slrwjdy8v1cn4cwspm3kdbmyb81d6zckj3nq9f
       https://guix.example.org/nar/...-git-2.5.0: 0mdqa9w1p6cmli6976v4wi0sw9r4p5prkj7lzfd1877wk11c9c73
     /gnu/store/...-pius-2.1.1 contents differ:
       local hash: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax
       https://ci.guix.fr.info/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.

As an example, guix.example.org always gets a different answer. Conversely, ci.guix.fr.info agrees with local builds, except in the case of Git.  This might indicate that the build process of Git is non-deterministic, meaning that its output varies as a function of various things that Guix does not fully control, in spite of building packages in isolated environments (see Fonctionnalités).  Most common sources of non-determinism include the addition of timestamps in build results, the inclusion of random numbers, and directory listings sorted by inode number. See https://reproducible-builds.org/docs/, for more information.

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://ci.guix.fr.info/nar/...-git-2.5.0 \
        | guix archive -x /tmp/git
     $ diff -ur --no-dereference /gnu/store/...-git.2.5.0 /tmp/git

This command shows the difference between the files resulting from the local build, and the files resulting from the build on ci.guix.fr.info (see Comparing and Merging Files).  The diff command works great for text files.  When binary files differ, a better option is Diffoscope (https://diffoscope.org/), a tool that helps visualize differences for all kinds of files.

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.

If you are writing packages for Guix, you are encouraged to check whether ci.guix.fr.info and other substitute servers obtain the same build result as you did with:

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

     The following command launches an interactive login shell inside a Guix system container, started by guix system container, and whose process ID is 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

As you can see, it reports the fraction of all the packages for which substitutes are available on the server---regardless of whether substitutes are enabled, and regardless of whether this server's signing key is authorized.  It also reports the size of the compressed archives (``nars'') provided by the server, the size the corresponding store items occupy in the store (assuming deduplication is turned off), and the server's throughput. The second part gives continuous integration (CI) statistics, if the server supports it.  In addition, using the --coverage option, guix weather can list ``important'' package substitutes missing on the server (see below).

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

--coverage[=COUNT]
-c [COUNT]
     Report on substitute coverage for packages: list packages with at least COUNT dependents (zero by default) for which substitutes are unavailable.  Dependent packages themselves are not listed: if B depends on A and A has no substitutes, only A is listed, even though B usually lacks substitutes as well.  The result looks like this:

          $ guix weather --substitute-urls=https://ci.guix.fr.info -c 10
          computing 8,983 package derivations for x86_64-linux...
          looking for 9,343 store items on https://ci.guix.fr.info...
          updating substitutes from 'https://ci.guix.fr.info'... 100.0%
          https://ci.guix.fr.info
            64.7% substitutes available (6,047 out of 9,343)
          ...
          2502 packages are missing from 'https://ci.guix.fr.info' for 'x86_64-linux', among which:
              58  kcoreaddons@5.49.0      /gnu/store/...-kcoreaddons-5.49.0
              46  qgpgme@1.11.1           /gnu/store/...-qgpgme-1.11.1
              37  perl-http-cookiejar@0.008  /gnu/store/...-perl-http-cookiejar-0.008
              ...

     What this example shows is that kcoreaddons and presumably the 58 packages that depend on it have no substitutes at ci.guix.fr.info; likewise for qgpgme and the 46 packages that depend on it.

     If you are a Guix developer, or if you are taking care of this build farm, you'll probably want to have a closer look at these packages: they may simply fail to build.

Invoquer guix processes
=======================

La commande guix processes peut être utile pour les développeurs et les administrateurs systèmes, surtout sur des machines multi-utilisateurs et sur les fermes de construction : elle liste les sessions actuelles (les connexions au démon), ainsi que des informations sur les processus en question (Les sessions distantes, lorsque guix-daemon est démarré avec --listen en spécifiant un point d'entrée TCP, ne sont pas listées.).  Voici un exemple des informations qu'elle renvoie :

     $ sudo guix processes
     SessionPID: 19002
     ClientPID: 19090
     ClientCommand: guix environment --ad-hoc python

     SessionPID: 19402
     ClientPID: 19367
     ClientCommand: guix publish -u guix-publish -p 3000 -C 9 ...

     SessionPID: 19444
     ClientPID: 19419
     ClientCommand: cuirass --cache-directory /var/cache/cuirass ...
     LockHeld: /gnu/store/...-perl-ipc-cmd-0.96.lock
     LockHeld: /gnu/store/...-python-six-bootstrap-1.11.0.lock
     LockHeld: /gnu/store/...-libjpeg-turbo-2.0.0.lock
     ChildProcess: 20495: guix offload x86_64-linux 7200 1 28800
     ChildProcess: 27733: guix offload x86_64-linux 7200 1 28800
     ChildProcess: 27793: guix offload x86_64-linux 7200 1 28800

Dans cet exemple, on voit que guix-daemon a trois clients directs : guix environment, guix publish et l'outil d'intégration continue Cuirass ; leur identifiant de processus (PID) est donné par le champ ClientPID.  Le champ SessionPID fournit le PID du sous-processus guix-daemon de cette session particulière.

Les champs LockHeld montrent quels éléments du dépôt sont actuellement verrouillés par cette session, ce qui correspond aux éléments du dépôt qui sont en train d'être construits ou d'être substitués (le champ LockHeld n'est pas montré si guix processes n'est pas lancé en root).  Enfin, en regardant le champ ChildProcess, on comprend que ces trois constructions sont déchargées (see Réglages du délestage du démon).

La sortie est dans le format Recutils pour qu'on puisse utiliser la commande recsel pour sélectionner les sessions qui nous intéressent (see Selection Expressions (GNU recutils manual)).  Par exemple, la commande montre la ligne de commande et le PID du client qui effectue la construction d'un paquet Perl :

     $ sudo guix processes | \
         recsel -p ClientPID,ClientCommand -e 'LockHeld ~ "perl"'
     ClientPID: 19419
     ClientCommand: cuirass --cache-directory /var/cache/cuirass ...

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

Le champ bootloader décrit la méthode qui sera utilisée pour démarrer votre système.  Les machines basées sur les processeurs Intel peuvent démarrer dans l'ancien mode BIOS, comme dans l'exemple au-dessus. Cependant, les machines plus récentes s'appuient sur l'UEFI (Unified Extensible Firmware Interface) pour démarrer.  Dans ce cas, le champ bootloader devrait contenir quelque chose comme cela :

     (bootloader-configuration
       (bootloader grub-efi-bootloader)
       (target "/boot/efi"))

See Configuration du chargeur d'amorçage, pour plus d'informations sur les options de configuration disponibles.

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 profils utilisateurs (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 ajoute GNU Screen à ces paquets, récupéré depuis le module (gnu packages screen) (see Modules de paquets).  Vous pouvez utiliser la syntaxe (list paquet sortie) 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
-----------------

The services field lists system services to be made available when the system starts (see Services).  The operating-system declaration above specifies that, in addition to the basic services, we want the OpenSSH secure shell daemon listening on port 2222 (see openssh-service-type).  Under the hood, openssh-service-type arranges so that sshd is started with the right command-line options, possibly with supporting configuration files generated as needed (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]

Un système graphique avec un choix de gestionnaires de fenêtres légers plutôt que des environnement de bureaux complets ressemblerait à cela :

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

Bien que la commande guix system reconfigure ne modifiera pas les générations précédentes, vous devez faire attention lorsque votre génération actuelle n'est pas la dernière (p. ex. après avoir invoqué guix system roll-back), puisque l'opération pourrait remplacer une génération suivante (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 monade 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.

This procedure is provided by the (gnu system) module.  Along with (gnu services) (see Services), this module contains the guts of Guix System.  Make sure to visit it!

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

The ``problem'' with Guix is that users have a lot of freedom: They can choose whether and when to upgrade software in their profiles, and might be using a libc version different from the one the system administrator used to build the system-wide locale data.

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.

Guix has a broad definition of ``service'' (see Composition de services), but many services are managed by the GNU Shepherd (see Services Shepherd).  On a running system, the herd command allows you to list the available services, show their status, start and stop them, or do other specific operations (see Jump Start (The GNU Shepherd Manual)).  For example:

     # herd status

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

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

     # herd doc nscd action invalidate
     invalidate: Invalidate the given cache--e.g., 'hosts' for host name lookups.

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 pour 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 :

          (append (list (service avahi-service-type)
                        (service openssh-service-type))
                  %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.

          In both cases, agetty will leave the other serial device settings (baud rate etc.) alone---in the hope that Linux pinned them to the correct values.

     baud-rate (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.

     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.

     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.

     Parce que c'est pratique, le service du Shepherd pour nscd fournit les actions suivantes :

     invalidate
          Cela invalide le cache donné.  Par exemple, en laçant :

               herd invalidate nscd hosts

          on invalide le cache de noms d'hôtes de nscd.

     statistiques
          Lancer herd statistics nscd affiche des informations sur l'utilisation de nscd et des caches.

 -- 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 Bibliothè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.

 -- Variable Scheme: guix-service-type
     C'est le type de service qui lance le démon de construction, guix-daemon (see Invoquer guix-daemon).  Sa valeur doit être un enregistrement guix-configuration décrit plus bas.

 -- 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)
          Whether to authorize the substitute keys listed in authorized-keys---by default that of ci.guix.fr.info (see Substituts).

     authorized-keys (par défaut : %DEFAULT-AUTHORIZED-GUIX-KEYS)
          The list of authorized key files for archive imports, as a list of string-valued gexps (see Invoquer guix archive).  By default, it contains that of ci.guix.fr.info (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: 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 litté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\"")))

     The herd rules udev command, as root, returns the name of the directory containing all the active udev rules.

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 groupe 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 traditionnel 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 qui 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 (service mcron-service-type
                                (mcron-configuration
                                 (jobs (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.

Sur un système lancé, vous pouvez utiliser l'action schedule du service pour visualiser les travaux mcron qui seront exécutés ensuite :

     # herd schedule mcron

Cet exemple ci-dessus montre les cinq tâches qui seront exécutés, mais vous pouvez spécifier le nombre de tâches à afficher :

     # herd schedule mcron 10

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

 -- Variable Scheme: dhcp-client-service-type
     C'est le type de services qui lance DHCP, un client DHC (protocole de configuration d'hôte dynamique) sur toutes les interfaces réseau non-loopback.  Sa valeur est le paquet du client DHCP à utiliser, isc-dhcp par défaut.

 -- 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)]
     Renvoie un service qui démarre INTERFACE avec l'adresse IP.  Si NETMASK est vrai, il sera utilisé comme masque de sous-réseau.  Si GATEWAY est vrai, ce doit être une chaîne de caractères qui spécifie la passerelle par défaut du réseau.  REQUIREMENT peut être utilisé pour déclarer une dépendance sur un autre service avant de configurer l'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.

     Par exemple :

          (static-networking-service "eno1" "192.168.1.82"
                                     #:gateway "192.168.1.2"
                                     #:name-servers '("192.168.1.2"))

 -- 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éseaux 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, désactive le greffon vpn de connman.

 -- Variable Scheme: wpa-supplicant-service-type
     C'est le type du service qui lanceWPA 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.

 -- Type de données: wpa-supplicant-configuration
     Type données qui représente la configuration de WPA Supplicant.

     Il prend les paramètres suivants :

     wpa-supplicant (par défaut : wpa-supplicant)
          Le paquet WPA Supplicant à utiliser.

     dbus? (par défaut : #t)
          Indique s'il faut écouter les requêtes sur D-Bus.

     pid-file (par défaut : "/var/run/wpa_supplicant.pid")
          Où stocker votre fichier de PID.

     interface (par défaut : #f)
          Si une valeur est indiquée, elle doit spécifier le nom d'une interface réseau que WPA supplicant contrôlera.

     config-file (par défaut : #f)
          Fichier de configuration facultatif à utiliser.

     extra-options (par défaut : '())
          Liste d'arguments de la ligne de commande supplémentaires à passer au démon.

 -- Variable Scheme: iptables-service-type
     This is the service type to set up an iptables configuration.  iptables is a packet filtering framework supported by the Linux kernel.  This service supports configuring iptables for both IPv4 and IPv6.  A simple example configuration rejecting all incoming connections except those to the ssh port 22 is shown below.

          (service iptables-service-type
                   (iptables-configuration
                    (ipv4-rules (plain-file "iptables.rules" "*filter
          :INPUT ACCEPT
          :FORWARD ACCEPT
          :OUTPUT ACCEPT
          -A INPUT -p tcp --dport 22 -j ACCEPT
          -A INPUT -j REJECT --reject-with icmp-port-unreachable
          COMMIT
          "))
                    (ipv6-rules (plain-file "ip6tables.rules" "*filter
          :INPUT ACCEPT
          :FORWARD ACCEPT
          :OUTPUT ACCEPT
          -A INPUT -p tcp --dport 22 -j ACCEPT
          -A INPUT -j REJECT --reject-with icmp6-port-unreachable
          COMMIT
          "))))

 -- Type de données: iptables-configuration
     Type de données représentant la configuration d'iptables.

     iptables (par défaut : iptables)
          Le paquet iptables qui fournit iptables-restore et ip6tables-restore.

     ipv4-rules (par défaut : %iptables-accept-all-rules)
          Les règles iptables à utiliser.  Elles seront passées à iptables-restore.  Cela peut être un objet « simili-fichier » (see file-like objects).

     ipv6-rules (par défaut : %iptables-accept-all-rules)
          Les règles iptables à utiliser.  Elles seront passées à ip6tables-restore.  Cela peut être un objet « simili-fichier » (see file-like objects).

 -- Variable Scheme: ntp-service-type
     This is the type of the service running the Network Time Protocol (NTP) (http://www.ntp.org) daemon, ntpd.  The daemon will keep the system clock synchronized with that of the specified NTP servers.

     La valeur de ce service est un objet ntpd-configuration, décrit ci-dessous.

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

     servers (par défaut : %ntp-servers)
          C'est la liste des serveurs (noms d'hôtes) avec lesquels ntpd sera synchronisé.

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

     ntp (par défaut : ntp)
          Le paquet NTP à utiliser.

 -- Variable Scheme: %ntp-servers
     Liste de noms d'hôtes à utiliser comme serveurs NTP par défaut.  Ce sont les serveurs du projet NTP Pool (https://www.ntppool.org/fr/)

 -- 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 connexions sur 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'un 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
          A string containing the user (and, optionally, group) name of the user as whom the server should run.  The group name can be specified in a suffix, separated by a colon or period, i.e. "user", "user:group" or "user.group".

     program (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 : '())
          A list strings or file-like objects, which are the server program's arguments, starting with the zeroth argument, i.e. the name of the program itself.  For inetd's internal services, this entry must be '() or '("internal").

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

 -- Variable Scheme: tor-service-type
     C'est le type pour un service qui lance le démon de navigation anonyme Tor (https://torproject.org).  Le service est configuré avec un enregistrement <tor-configuration>.  Par défaut, le démon Tor est lancé en tant qu'utilisateur non privilégié tor, membre du groupe tor.

 -- Type de données: tor-configuration

     tor (par défaut : tor)
          Le paquet qui fournit le démon Tor.  Ce paquet doit fournir le démon bin/tor relativement à son répertoire de sortie.  Le paquet par défaut est le l'implémentation du projet Tor (https://www.torproject.org).

     config-file (par défaut : (plain-file "empty" ""))
          Le fichier de configuration à utiliser.  Il sera ajouté au fichier de configuration par défaut, et le fichier de configuration final sera passé à tor via son option -f.  Cela peut être n'importe quel objet « simili-fichier » (see file-like objects).  Voir man tor pour plus de détails sur la syntaxe du fichier de configuration.

     hidden-services (par défaut : '())
          La liste des enregistrements <hidden-service> à utiliser.  Pour n'importe quel service cache que vous ajoutez à cette liste, la configuration appropriée pour activer le service caché sera automatiquement ajouté au fichier de configuration par défaut.  Vous pouvez aussi créer des enregistrements <hidden-service> avec la procédure tor-hidden-service décrite plus bas.

     socks-socket-type (par défaut : 'tcp)
          Le type de socket par défaut que Tor devrait utiliser pour les socket SOCKS.  Cela doit être soit 'tcp soit 'unix.  S'il s'agit de 'tcp, alors Tor écoutera pas défaut sur le port TCP 9050 sur l'interface de boucle locale (c.-à-d. localhost).  S'il s'agit de 'unix, Tor écoutera sur le socket UNIX domain /var/run/tor/socks-sock, qui sera inscriptible pour les membres du groupe tor.

          Si vous voulez personnaliser le socket SOCKS plus avant, laissez socks-socket-type à sa valeur par défaut de 'tcp et utilisez config-file pour remplacer les valeurs par défaut avec votre propre option SocksPort.

 -- 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? (par défaut : #t)
          Indique s'il faut autoriser la redirection d'agent.

     allow-tcp-forwarding? (par défaut : #t)
          Indique s'il faut autoriser la redirection TCP.

     gateway-ports? (par défaut : #f)
          Indique s'il faut autoriser les ports de passerelle.

     challenge-response-authentication? (par défaut : #f)
          Specifies whether challenge response authentication is allowed (e.g. 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")))
          Configures external subsystems (e.g. file transfer daemon).

          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.

     log-level (par défaut : 'info)
          C'est le symbole qui spécifie le niveau de journalisation : quiet, fatal, error, info, verbose, debug, etc. Voir la page de manuel de sshd_config pour trouver la liste complète des noms de niveaux.

     extra-content (par défaut : "")
          This field can be used to append arbitrary text to the configuration file. It is especially useful for elaborate configurations that cannot be expressed otherwise.  This configuration, for example, would generally disable root logins, but permit them from one specific IP address:

               (openssh-configuration
                 (extra-content "\
               Match Address 192.168.0.1
                 PermitRootLogin yes"))

 -- 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 de votre 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.

 -- Scheme Variable: avahi-service-type
     This is the service that runs avahi-daemon, a system-wide mDNS/DNS-SD responder that allows for service discovery and ``zero-configuration'' host name lookups (see http://avahi.org/). Its value must be a zero-configuration record---see below.

     This service extends the name service cache daemon (nscd) so that it can resolve .local host names using nss-mdns (http://0pointer.de/lennart/projects/nss-mdns/).  See Name Service Switch, for information on host name resolution.

     Additionally, add the AVAHI package to the system profile so that commands such as avahi-browse are directly usable.

 -- Data Type: avahi-configuration
     Data type representation the configuration for Avahi.

     host-name (default: #f)
          If different from #f, use that as the host name to publish for this machine; otherwise, use the machine's actual host name.

     publish? (default: #t)
          When true, allow host names and services to be published (broadcast) over the network.

     publish-workstation? (default: #t)
          When true, avahi-daemon publishes the machine's host name and IP address via mDNS on the local network.  To view the host names published on your local network, you can run:

               avahi-browse _workstation._tcp

     wide-area? (default: #f)
          When true, DNS-SD over unicast DNS is enabled.

     ipv4? (default: #t)
     ipv6? (default: #t)
          These fields determine whether to use IPv4/IPv6 sockets.

     domains-to-browse (default: '())
          This is a list of domains to browse.

 -- 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] [#:xserver-arguments '("-nolisten" "tcp")] Return a startx script in which MODULES, a list of X module packages, and FONTS, a list of X font directories, are available.  See xorg-wrapper for more details on the arguments.  The result should be used in place of startx.

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

This procedure is useful to override command line options for the X server, such as having it listen to over TCP:

     (operating-system
       ...
       (services
         (modify-services %desktop-services
           (slim-service-type config =>
             (slim-configuration
               (inherit config)
               (startx (xorg-start-command
                        #:xserver-arguments '("-listen" "tcp"))))))))

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

The (gnu services cups) module provides a Guix service definition for the CUPS printing service.  To add printer support to a Guix system, add a cups-service to the operating system definition:

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

Supposons que vous souhaitiez activer l'interface Web de CUPS et ajouter le support pour les imprimantes Epson via le paquet escpr et pour les imprimantes HP via le paquet hplip-minimal.  Vous pouvez le faire directement, comme ceci (vous devez utiliser le module (gnu packages cups)) :

     (service cups-service-type
              (cups-configuration
                (web-interface? #t)
                (extensions
                  (list cups-filters escpr hplip-minimal))))

Remarque : si vous souhaitez utiliser la GUI basée sur Qt5 qui provient du paquet hplip, nous vous suggérons d'installer le paquet hplip, soit dans votre configuration d'OS, soit en tant qu'utilisateur.

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 requiert 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 soit une adresse 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.

 -- Scheme Variable: upower-service-type
     Service that runs upowerd (http://upower.freedesktop.org/), a system-wide monitor for power consumption and battery levels, with the given configuration settings.

     It implements the org.freedesktop.UPower D-Bus interface, and is notably used by GNOME.

 -- Data Type: upower-configuration
     Data type representation the configuration for UPower.

     upower (default: UPOWER)
          Package to use for upower.

     watts-up-pro? (default: #f)
          Enable the Watts Up Pro device.

     poll-batteries? (default: #t)
          Enable polling the kernel for battery level changes.

     ignore-lid? (default: #f)
          Ignore the lid state, this can be useful if it's incorrect on a device.

     use-percentage-for-policy? (default: #f)
          Whether battery percentage based policy should be used.  The default is to use the time left, change to #t to use the percentage.

     percentage-low (default: 10)
          When use-percentage-for-policy? is #t, this sets the percentage at which the battery is considered low.

     percentage-critical (default: 3)
          When use-percentage-for-policy? is #t, this sets the percentage at which the battery is considered critical.

     percentage-action (default: 2)
          When use-percentage-for-policy? is #t, this sets the percentage at which action will be taken.

     time-low (default: 1200)
          When use-time-for-policy? is #f, this sets the time remaining in seconds at which the battery is considered low.

     time-critical (default: 300)
          When use-time-for-policy? is #f, this sets the time remaining in seconds at which the battery is considered critical.

     time-action (default: 120)
          When use-time-for-policy? is #f, this sets the time remaining in seconds at which action will be taken.

     critical-power-action (default: 'hybrid-sleep)
          The action taken when percentage-action or time-action is reached (depending on the configuration of use-percentage-for-policy?).

          Possible values are:

            * 'power-off

            * 'hibernate

            * 'hybrid-sleep.

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

Le module (gnu services sound) fournit un service pour configurer le système ALSA (architecture son linux avancée), qui fait de PulseAudio le pilote de sortie préféré d'ALSA.

 -- Variable Scheme: alsa-service-type
     C'est le type pour le système Advanced Linux Sound Architecture (https://alsa-project.org/) (ALSA), qui génère le fichier de configuration /etc/asound.conf.  La valeur de ce type est un enregistrement alsa-configuration comme dans cet exemple :

          (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 (par défaut : ALSA-PLUGINS)
          Le paquet alsa-plugins à utiliser.

     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 : "")
          Chaîne à ajouter au fichier /etc/asound.conf.

Les utilisateurs individuels qui veulent modifier la configuration système d'ALSA peuvent le faire avec le fichier ~/.asoundrc :

     # Dans guix, il faut spécifier le chemin absolu des greffons.
     pcm_type.jack {
       lib "/home/alice/.guix-profile/lib/alsa-lib/libasound_module_pcm_jack.so"
     }

     # Faire passer ALSA par 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"
       }
     }

Voir https://www.alsa-project.org/main/index.php/Asoundrc pour les détails.

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''] [#:extension-packages '()] Return a service that runs POSTGRESQL, the PostgreSQL database server.

     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.

     Additional extensions are loaded from packages listed in EXTENSION-PACKAGES.  Extensions are available at runtime.  For instance, to create a geographic database using the postgis extension, a user can configure the postgresql-service as in this example:

          (use-package-modules databases geo)

          (operating-system
            ...
            ;; postgresql is required to run `psql' but postgis is not required for
            ;; proper operation.
            (packages (cons* postgresql %base-packages))
            (services
              (cons*
                (postgresql-service #:extension-packages (list postgis))
                %base-services)))

     Then the extension becomes visible and you can initialise an empty geographic database in this way:

          psql -U postgres
          > create database postgistest;
          > \connect postgistest;
          > create extension postgis;
          > create extension postgis_topology;

     There is no need to add this field for contrib extensions such as hstore or dblink as they are already loadable by postgresql.  This field is only required to add extensions provided by other packages.

 -- 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 client-limit
          Connexions de clients simultanées maximum par processus.  Une fois ce nombre de connections atteint, la connexion suivante fera en sorte que Dovecot démarre un autre processus.  Si la valeur est 0, default-client-limit est utilisé à la place.

          La valeur par défaut est 0.

      -- 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-limit
          Nombre de processus maximum qui peut exister pour ce service.  Si la valeur est 0, default-process-limit est utilisé à la place.

          La valeur par défaut est 0.

      -- 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
     List of login access check sockets (e.g. tcpwrap).  Defaults to ().

 -- paramètre de dovecot-configuration: boolean verbose-proctitle?
     Show more verbose process titles (in ps).  Currently shows user name and IP address.  Useful for seeing who is actually using the IMAP processes (e.g. shared mailboxes or if the same uid is used for multiple accounts). Defaults to #f.

 -- paramètre de dovecot-configuration: boolean shutdown-clients?
     Should all processes be killed when Dovecot master process shuts down. Setting this to #f means that Dovecot can be upgraded without forcing existing client connections to close (although that could also be a problem if the upgrade is e.g. due to a security fix).  Defaults to #t.

 -- 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?
     Disable LOGIN command and all other plaintext authentications unless SSL/TLS is used (LOGINDISABLED capability).  Note that if the remote IP matches the local IP (i.e. you're connecting from the same computer), the connection is considered secure and plaintext authentication is allowed.  See also ssl=required setting.  Defaults to #t.

 -- paramètre de dovecot-configuration: non-negative-integer auth-cache-size
     Authentication cache size (e.g. #e10e6).  0 means it's disabled. Note that bsdauth, PAM and vpopmail require cache-key to be set for caching to be used.  Defaults to 0.

 -- 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
     Username formatting before it's looked up from databases.  You can use the standard variables here, e.g. %Lu would lowercase the username, %n would drop away the domain if it was given, or %n-AT-%d would change the @ into -AT-.  This translation is done after auth-username-translation changes.  Defaults to "%Lu".

 -- paramètre de dovecot-configuration: string auth-master-user-separator
     If you want to allow master users to log in by specifying the master username within the normal username string (i.e. not using SASL mechanism's support for it), you can specify the separator character here. The format is then <username><separator><master username>.  UW-IMAP uses * as the separator, so that could be a good choice.  Defaults to "".

 -- 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
     Maximum number of dovecot-auth worker processes.  They're used to execute blocking passdb and userdb queries (e.g. MySQL and PAM).  They're automatically created and destroyed as needed.  Defaults to 30.

 -- 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?
     Indique s'il faut enregistrer les tentatives de connexion échouées et la raison de leur échec.  La valeur par défaut est #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?
     Journaux encore plus verbeux pour le débogage.  Cela montre par exemple les requêtes SQL effectuées.  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: boolean auth-debug-passwords?
     Dans le cas où le mot de passe était incorrect, indique s'il faut enregistrer les mots de passe et les schémas utilisés pour que le problème puisse être débogué.  Activer cette option active aussi auth-debug. La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: boolean mail-debug?
     Indique s'il faut activer le débogage du traitement des courriels.  Cela peut vous aider à comprendre pourquoi Dovecot ne trouve pas vos courriels. La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: boolean verbose-ssl?
     Indique s'il faut montrer les erreurs au niveau SSL.  La valeur par défaut est  #f.

 -- paramètre de dovecot-configuration: string log-timestamp
     Préfixe à utiliser devant chaque ligne écrite dans le fichier journal.  Les codes % sont au format strftime(3).  La valeur par défaut est "\"%b %d %H:%M:%S \"".

 -- paramètre de dovecot-configuration: space-separated-string-list login-log-format-elements
     Liste des éléments qu'il faut enregistrer.  Les éléments qui ont une variable non vide sont agrégés pour former une chaîne de mots séparés par des virgules.

 -- paramètre de dovecot-configuration: string login-log-format
     Format du journal de connexion.  %s contient la chaîne login-log-format-elements, %$ contient la donnée à enregistrer.  La valeur par défaut est "%$: %s".

 -- paramètre de dovecot-configuration: string mail-log-prefix
     Préfixe à utiliser devant chaque ligne du fichier de journal pour les processus traitant les courriels.  Voir doc/wiki/Variables.txt pour trouver la liste des variables que vous pouvez utiliser.  La valeur par défaut est "\"%s(%u)<%{pid}><%{session}>: \"".

 -- paramètre de dovecot-configuration: string deliver-log-format
     Format à utiliser pour enregistrer les livraisons de courriels.  Vous pouvez utiliser ces variables :

     %$
          Delivery status message (e.g. saved to INBOX)

     %m
          Message-ID

     %s
          Objet

     %f
          Adresse « de »

     %p
          Taille physique

     %w
          Taille virtuelle.

     La valeur par défaut est "msgid=%m: %$".

 -- paramètre de dovecot-configuration: string mail-location
     Emplacement des boîtes à lettre des utilisateurs.  La valeur par défaut est vide, ce qui signifie que Dovecot essaiera de trouver les boîte aux lettres automatiquement.  Cela ne fonctionnera pas si l'utilisateur n'a aucun courriel, donc il vaut mieux indiquer explicitement le bon emplacement à Dovecot.

     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.

     Il y a quelques variables spéciales que vous pouvez utiliser :

     %u
          nom d'utilisateur

     %n
          la partie « utilisateur » dans « utilisateur@domaine », comme %u s'il n'y a pas de domaine.

     %d
          la partie « domaine » dans « utilisateur@domaine », vide s'il n'y a pas de domaine

     %h
          répertoire personnel

     Voir doc/wiki/Variables.txt pour la liste complète.  Quelques exemple :

     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
     Utilisateur et groupe système utilisé pour accéder aux courriels.  Si vous utilisez multiple, userdb peut remplacer ces valeurs en renvoyant les champs uid et gid.  Vous pouvez utiliser soit des nombres, soit des noms. <doc/wiki/UserIds.txt>.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: string mail-gid

     La valeur par défaut est "".

 -- paramètre de dovecot-configuration: string mail-privileged-group
     Groupe à activer temporairement pour les opérations privilégiées. Actuellement cela est utilisé uniquement avec INBOX lors de sa création initiale et quand le verrouillage échoie.  Typiquement, vous pouvez utiliser « mail » pour donner accès à /var/mail.  La valeur par défaut est "".

 -- 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?
     Ne pas du tout utiliser mmap().  Cela est requis si vous stockez les index dans des systèmes de fichiers partagés (NFS ou clusterfs).  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: boolean dotlock-use-excl?
     S'appuyer sur O_EXCL lors de la création de fichiers de verrouillage.  NFS supporte O_EXCL depuis la version 3, donc cette option est sûre de nos jours.  La valeur par défaut est #t.

 -- paramètre de dovecot-configuration: string mail-fsync
     Quand utiliser les appels à fsync() ou fdatasync() :

     optimized
          Lorsque cela est nécessaire pour éviter de perdre des données importantes

     always
          Useful with e.g. NFS when write()s are delayed

     never
          Ne l'utilisez pas (ça a de meilleures performances, mais les crashs font perdre toutes les données).

     La valeur par défaut est "optimized".

 -- paramètre de dovecot-configuration: boolean mail-nfs-storage?
     Le stockage des courriels se fait sur NFS.  Utilisez cette option pour que Dovecot vide les caches NFS lorsque c'est nécessaire.  Si vous utilisez seulement un simple serveur de courriel, ce n'est pas nécessaire.  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: boolean mail-nfs-index?
     Les fichiers d'index de courriels sont sur un système de fichiers NFS.  Pour utiliser cette option, vous aurez besoin de mmap-disable? #t et fsync-disable? #f.  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: string lock-method
     Méthode de verrouillage des fichiers d'index.  Les alternatives sont fcntl, flock et dotlock.  Le verrouillage-point (dotlocking) utilise des astuces qui peuvent créer plus d'utilisation du disque que les autres méthodes de verrouillage.  Pour les utilisateurs de NFS, flock ne marche pas, et rappelez-vous de modifier mmap-disable.  La valeur par défaut est "fcntl".

 -- paramètre de dovecot-configuration: file-name mail-temp-dir
     Le répertoire dans lequel LDA/LMTP stockent temporairement les courriels de plus de 128 Ko.  La valeur par défaut est "/tmp".

 -- paramètre de dovecot-configuration: non-negative-integer first-valid-uid
     L'intervalle d'UID valides pour les utilisateurs.  Cette option est surtout utile pour s'assurer que les utilisateurs ne peuvent pas s'authentifier en tant que démon ou qu'un autre utilisateur système.  Remarquez que la connexion en root est interdite en dur dans le binaire de dovecot et qu'on ne peut pas l'autoriser même si first-valid-uid vaut 0.  La valeur par défaut est 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
     Li'ntervalle de GID valides pour les utilisateurs.  Les utilisateurs qui ont un GID non-valide comme numéro de groupe primaire ne peuvent pas se connecter.  Si l'utilisateur appartient à un groupe avec un GID non valide, ce groupe n'est pas utilisable.  La valeur par défaut est 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
     Longueur maximale autorisée pour les mots-clefs.  Elle n'est utilisée que lors de la création de nouveaux mots-clefs.  La valeur par défaut est 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
     Chemin de 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.  La valeur par défaut est "/var/run/dovecot/auth-userdb".

 -- paramètre de dovecot-configuration: file-name mail-plugin-dir
     Répertoire où trouver les greffons.  La valeur par défaut est "/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
     Le nombre minimal de courriels dans une boîte aux lettres avant de mettre à jour le fichier de cache.  Cela permet d'optimiser le comportement de Dovecot pour qu'il fasse moins d'écriture disque contre plus de lecture disque.  La valeur par défaut est 0.

 -- paramètre de dovecot-configuration: string mailbox-idle-check-interval
     Lorsque la commande IDLE est lancée, la boîte aux lettres est vérifiée de temps en temps pour voir s'il y a de nouveaux messages ou d'autres changements.  Ce paramètre défini le temps d'attente minimum entre deux vérifications.  Dovecot peut aussi utilise dnotify, inotify et kqueue pour trouver immédiatement les changements.  La valeur par défaut est "30 secs".

 -- paramètre de dovecot-configuration: boolean mail-save-crlf?
     Sauvegarder les courriels avec CR+LF plutôt que seulement LF.  Cela permet de consommer moins de CPU en envoyant ces courriels, surtout avec l'appel système sendfile() de Linux et FreeBSD.  Mais cela crée un peu plus d'utilisation du disque, ce qui peut aussi le ralentir.  Remarquez aussi que si d'autres logiciels lisent les mbox/maildirs, ils peuvent se tromper dans leur traitement de ces CR supplémentaires et causer des problèmes.  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: boolean maildir-stat-dirs?
     Par défaut la commande LIST renvoie toutes les entrées du maildir qui commencent par un point.  Activer cette option permet à Dovecot de renvoyer uniquement les entrées qui sont des répertoires.  Cela se fait avec stat() sur chaque entrée, ce qui cause plus d'utilisation du disque.  For systems setting struct dirent->d_type this check is free and it's done always regardless of this setting).  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: boolean maildir-copy-with-hardlinks?
     Lors de la copie d'un message, le faire avec des liens en dur si possible. Cela améliore un peu la performance et n'a que peu de chance d'avoir des effets secondaires.

 -- paramètre de dovecot-configuration: boolean maildir-very-dirty-syncs?
     Suppose que Dovecot est le seul MUA qui accède à Maildir : scanne le répertoire cur/ seulement lorsque son mtime change de manière inattendue ou lorsqu'il ne peut pas trouver le courriel autrement.  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: space-separated-string-list mbox-read-locks
     La méthode de verrouillage à utiliser pour verrouiller le boîtes aux lettres mbox.  Il y en a quatre :

     dotlock
          Crée un fichier <mailbox>.lock.  C'est la solution la plus ancienne et la plus sûr pour NFS.  Si vous voulez utiliser /var/mail/, les utilisateurs auront besoin de l'accès en écriture à ce répertoire.

     dotlock-try
          Comme pour dotlock, mais si elle échoue à cause d'un problème de permission ou parce qu'il n'y a pas assez d'espace disque, l'ignore.

     fcntl
          Utilisez cette méthode si possible.  Elle fonctionne aussi avec NFS si vous utilisez lockd.

     flock
          Peut ne pas exister sur tous les systèmes.  Ne fonctionne pas avec NFS.

     lockf
          Peut ne pas exister sur tous les systèmes.  Ne fonctionne pas avec NFS.

     Vous pouvez utiliser plusieurs méthodes de verrouillage ; dans ce cas l'ordre dans lequel elles sont déclarées est important pour éviter des interblocages si d'autres MTA/MUA utilisent aussi plusieurs méthodes. Certains systèmes d'exploitation ne permettent pas d'utiliser certaines méthodes en même temps.

 -- paramètre de dovecot-configuration: space-separated-string-list mbox-write-locks

 -- paramètre de dovecot-configuration: string mbox-lock-timeout
     Temps d'attente maximal pour un verrou (tous les verrous) avant d'abandonner.  La valeur par défaut est "5 mins".

 -- paramètre de dovecot-configuration: string mbox-dotlock-change-timeout
     Si le fichier dotlock existe mais que la boîte aux lettres n'est pas modifiée, remplacer le fichier de verrouillage après ce temps d'attente.  La valeur par défaut est "2 mins".

 -- paramètre de dovecot-configuration: boolean mbox-dirty-syncs?
     Lorsqu'un mbox change ne manière inattendue, il faut le lire en entier pour savoir ce qui a changé.  Si le mbox est assez grand cela peut prendre beaucoup de temps.  Comme le changement est habituellement un simple courriel supplémentaire, il serait plus rapide de lire le nouveaux courriels.  Si ce paramètre est activé, Dovecot fait cela mais revient toujours à relire le fichier mbox complet si le fichier n'est pas comme attendu.  Le seul réel inconvénient à ce paramètre est que certains MUA changent les drapeaux des messages, et dans ce cas Dovecot ne s'en rend pas immédiatement compte.  Remarquez qu'une synchronisation complète est effectuée avec les commandes SELECT, EXAMINE, EXPUNGE et CHECK.  La valeur par défaut est #t.

 -- paramètre de dovecot-configuration: boolean mbox-very-dirty-syncs?
     Comme mbox-dirty-syncs, mais ne synchronise pas complètement même avec les commandes SELECT, EXAMINE, EXPUNGE ou CHECK.  Si l'option n'est pas activée, mbox-dirty-syncs est ignorée.  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: boolean mbox-lazy-writes?
     Attendre avant d'écrire les en-têtes mbox jusqu'à la prochaine synchronisation des écritures (les commandes EXPUNGE et CHECK et quand on ferme la boîte aux lettres).  C'est surtout utile pour POP3 où les clients suppriment souvent tous les courriels.  L'inconvénient c'est que vos changements ne sont pas immédiatement visibles pour les autres MUA.  La valeur par défaut est #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
     Taille du fichier dbox maximale avant rotation.  La valeur par défaut est 10000000.

 -- paramètre de dovecot-configuration: string mdbox-rotate-interval
     Âge maximum du fichier dbox avant rotation.  Typiquement en jours.  Les jours commencent à minuit, donc 1d signifie aujourd'hui, 2d pour hier, etc. 0 pour désactiver la vérification.  La valeur par défaut est "1d".

 -- paramètre de dovecot-configuration: boolean mdbox-preallocate-space?
     Lors de la création des fichiers mdbox, préallouer immédiatement leur taille à mdbox-rotate-size.  Ce paramètre ne fonctionne actuellement que dans Linux avec certains systèmes de fichiers (ext4, xfs).  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: string mail-attachment-dir
     Les formats sdbox et mdbox supportent la sauvegarde des pièces-jointes dans des fichiers externes, ce qui permet de les stocker une seule fois.  Les autres moteurs ne le supportent pas pour le moment.

     ATTENTION : Cette fonctionnalité n'a pas été beaucoup testée.  Utilisez-la à vos risques et périls.

     Racine du répertoire où stocker les pièces-jointes.  Désactivé si vide.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: non-negative-integer mail-attachment-min-size
     Les pièces-jointes plus petites que cela ne sont pas enregistrées à part. Il est aussi possible d'écrire un greffon pour désactiver l'enregistrement externe de certaines pièces-jointes spécifiques.  La valeur par défaut est 128000.

 -- paramètre de dovecot-configuration: string mail-attachment-fs
     Moteur du système de fichier à utiliser pour sauvegarder les pièces-jointes :

     posix
          Pas de SiS (single instance storage) par Dovecot (mais cela peut aider la déduplication du système de fichier)

     sis posix
          SiS avec comparaison bit-à-bit immédiate pendant la sauvegarde

     sis-queue posix
          SiS avec déduplication et comparaison différées

     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
     Limite VSZ (taille mémoire virtuelle) par défaut pour les processus de service.  C'est surtout pour attraper et tuer les processus qui font fuiter la mémoire avant qu'ils ne l'utilisent en entier.  La valeur par défaut est 256000000.

 -- paramètre de dovecot-configuration: string default-login-user
     Utilisateur de connexion utilisé en interne par les processus de connexion. C'est l'utilisateur avec la confiance minimale pour Dovecot.  Il ne devrait avoir accès à rien du tout.  La valeur par défaut est "dovenull".

 -- paramètre de dovecot-configuration: string default-internal-user
     Utilisateur utilisé en interne par les processus non privilégiés.  Il devrait être différent de l'utilisateur de connexion, pour que les processus de connexion ne puissent pas perturber les autres processus.  La valeur par défaut est "dovecot".

 -- paramètre de dovecot-configuration: string ssl?
     Support SSL/TLS : yes, no, required.  <doc/wiki/SSL.txt>.  La valeur par défaut est "required".

 -- paramètre de dovecot-configuration: string ssl-cert
     Certificat SSL/TLS X.509 encodé en PEM (clef publique).  La valeur par défaut est "</etc/dovecot/default.pem".

 -- paramètre de dovecot-configuration: string ssl-key
     Clef privée SSL/TLS encodée en PEM.  La clef est ouverte avant l'abandon des privilèges root, donc laissez-la non-lisible pour les utilisateurs.  La valeur par défaut est "</etc/dovecot/private/default.pem".

 -- paramètre de dovecot-configuration: string ssl-key-password
     Si le fichier de clef est protégé par un mot de passe, donnez-le ici. Autrement, donnez-le en démarrant dovecot avec le paramètre -p.  Comme ce fichier est souvent lisible pour tout le monde, vous pourriez vouloir placer ce paramètre dans un autre fichier.  La valeur par défaut est "".

 -- 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?
     Indique si les certificats clients doivent réussir la vérification du CRL. La valeur par défaut est #t.

 -- paramètre de dovecot-configuration: boolean ssl-verify-client-cert?
     Demande aux clients d'envoyer un certificat.  Si vous voulez aussi le requérir, indiquez auth-ssl-require-client-cert? #t dans la section auth.  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: string ssl-cert-username-field
     Le champ du certificat à utiliser pour le nom d'utilisateur.  Les choix habituels sont commonName et X500UniqueIdentifier.  Vous devrez aussi indiquer auth-ssl-username-from-cert? #t.  La valeur par défaut est "commonName".

 -- paramètre de dovecot-configuration: string ssl-min-protocol
     Version minimale de SSL à accepter.  La valeur par défaut est "TLSv1".

 -- paramètre de dovecot-configuration: string ssl-cipher-list
     Méthodes de chiffrement à utiliser.  La valeur par défaut est "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
     Moteur cryptographique SSL à utiliser.  Pour les valeur valides, lancez « openssl engine ».  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: string postmaster-address
     Adresse à utiliser pour envoyer les courriels de rejet.  %d correspond au domaine du destinataire.  La valeur par défaut est "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?
     Si l'utilisateur dépasse le quota, renvoie un échec temporaire au lieu de rejeter le courriel.  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: file-name sendmail-path
     Binaire à utiliser pour envoyer des courriels.  La valeur par défaut est "/usr/sbin/sendmail".

 -- paramètre de dovecot-configuration: string submission-host
     Si la valeur est non vide, envoyer les courriels à ce serveur SMTP hôte[:port] au lieu de sendmail.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: string rejection-subject
     En-tête d'objet à utiliser pour les courriels de rejet.  Vous pouvez utiliser les mêmes variables que pour rejection-reason ci-dessous. La valeur par défaut est "Rejected: %s".

 -- paramètre de dovecot-configuration: string rejection-reason
     Message d'erreur pour les humains dans les courriels de rejet.  Vous pouvez utiliser ces variables :

     %n
          CRLF

     %r
          raison

     %s
          objet du courriel de départ

     %t
          destinataire

     La valeur par défaut est "Your message to <%t> was automatically rejected:%n%r".

 -- paramètre de dovecot-configuration: string recipient-delimiter
     Caractère de délimitation entre la partie locale et le détail des adresses de courriel.  La valeur par défaut est "+".

 -- paramètre de dovecot-configuration: string lda-original-recipient-header
     En-tête où l'adresse du destinataire d'origine (l'adresse RCPT TO de SMTP) est récupérée si elle n'est pas disponible ailleurs.  Le paramètre -a de dovecot-lda le remplace.  L'en-tête couramment utilisée pour cela est X-Original-To.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: boolean lda-mailbox-autocreate?
     Sauvegarder un courriel dans un fichier qui n'existe pas devrait-il le créer ?  La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: boolean lda-mailbox-autosubscribe?
     Devrait-on aussi se souscrire aux boîtes aux lettres nouvellement créées ? La valeur par défaut est #f.

 -- paramètre de dovecot-configuration: non-negative-integer imap-max-line-length
     Longueur maximale de la ligne de commande IMAP.  Certains clients génèrent des lignes de commandes très longues avec des boîtes aux lettres énormes, donc vous pourriez avoir besoin d'augmenter cette limite si vous obtenez les erreurs « Too long argument » ou « IMAP command line too large ».  La valeur par défaut est 64000.

 -- paramètre de dovecot-configuration: string imap-logout-format
     Format de la chaîne de déconnexion IMAP :

     %i
          nombre d'octets lus par le client

     %o
          nombre total d'octets envoyés au client.

     Voir doc/wiki/Variables.txt pour une liste de toutes les variables utilisables.  La valeur par défaut est "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
     Temps d'attente entre les notifications « OK Still here » lorsque le client est en IDLE.  La valeur par défaut est "2 mins".

 -- paramètre de dovecot-configuration: string imap-id-send
     Noms des champs ID et de leur valeur à envoyer aux clients.  « * » signifie la valeur par défaut.  Les champs suivants ont actuellement des valeurs par défaut : name, version, os, os-version, support-url, support-email.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: string imap-id-log
     Champs ID envoyés par le client à enregistrer.  « * » signifie tout.  La valeur par défaut est "".

 -- paramètre de dovecot-configuration: space-separated-string-list imap-client-workarounds
     Contournements pour divers bogues de certains client :

     delay-newmail
          Envoi des notifications de nouveau message EXISTS/RECENT seulement en réponse aux commandes NOOP et CHECK.  Certains clients les ignorent autrement, par exemple OSX Mail (< v2.1).  Outlook Express est encore plus cassé, sans cela il peut montrer des erreurs de type « Le message n'est plus sur le serveur ».  Remarquez que OE6 est toujours cassé même avec ce contournement si la synchronisation est à « En-têtes seulement ».

     tb-extra-mailbox-sep
          Thunderbird se mélange les pinceaux avec LAYOUT=fs (mbox et dbox) et ajoute un suffixe / supplémentaire sur les noms des boîtes aux lettres. Cette option fait que dovecot ignore le / supplémentaire au lieu de le traiter comme un nom de boîte aux lettres invalide.

     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
     Hôte autorisé dans les URL URLAUTH envoyés par les clients.  « * » les autorise tous.  La valeur par défaut est "".

Whew! Lots of configuration options.  The nice thing about it though is that Guix 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.

Cependant, vous pourriez avoir un fichier dovecot.conf déjà tout prêt.  Dans ce cas, vous pouvez passer un objet opaque-dovecot-configuration comme paramètre #:config à dovecot-service.  Comme son nom l'indique, une configuration opaque n'a pas les capacités de réflexions.

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
     Le contenu de dovecot.conf, en tant que chaîne de caractères.

Par exemple, si votre dovecot.conf est simplement la chaîne vide, vous pouvez instancier un service dovecot comme cela :

     (dovecot-service #:config
                      (opaque-dovecot-configuration
                       (string "")))

Service OpenSMTPD
.................

 -- Variable Scheme: opensmtpd-service-type
     C'est le type de service de OpenSMTPD (https://www.opensmtpd.org), dont la valeur devrait être un objet opensmtpd-configuration comme dans cet exemple :

          (service opensmtpd-service-type
                   (opensmtpd-configuration
                     (config-file (local-file "./my-smtpd.conf"))))

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

     package (par défaut : OPENSMTPD)
          Objet de paquet du serveur SMTP OpenSMTPD.

     config-file (par défaut : %DEFAULT-OPENSMTPD-FILE)
          Objet simili-fichier du fichier de configuration de OpenSMTPD à utiliser. Par défaut il écoute sur l'interface de boucle locale et accepte les courriels des utilisateurs et des démons de la machine locale, et autorise l'envoi de courriels à des serveurs distants.  Lancez man smtpd.conf pour plus d'information.

Service Exim
............

 -- Variable Scheme: exim-service-type
     C'est le type de l'agent de transfert de courriel (MTA) Exim (https://exim.org), dont la valeur devrait être un objet exim-configuration comme dans cet exemple :

          (service exim-service-type
                   (exim-configuration
                     (config-file (local-file "./my-exim.conf"))))

Pour utilise le service exim-service-type vous devez aussi avoir un service mail-aliases-service-type dans votre operating-system (même sans alias).

 -- Type de données: exim-configuration
     Type de données représentant la configuration d'exim.

     package (par défaut : EXIM)
          Objet de paquet du serveur Exim.

     config-file (par défaut : #f)
          Objet simili-fichier du fichier de configuration d'Exim à utiliser.  Si sa valeur est #f alors le service utilisera la configuration par défaut du paquet fournit dans package.  Le fichier de configuration qui en résulte est chargé après avoir mis en place les variables de configuration exim_user et exim_group.

Service d'alias de courriel
...........................

 -- Variable Scheme: mail-aliases-service-type
     C'est le type de service qui fournit /etc/aliases et qui spécifie comment délivrer les courriels aux utilisateurs du système.

          (service mail-aliases-service-type
                   '(("postmaster" "bob")
                     ("bob" "bob@example.com" "bob@example2.com")))

La configuration pour un service mail-aliases-service-type est une liste associative qui dénote comment délivrer les courriels qui arrivent au système.  Chaque entrée est de la forme (alias adresses ...) avec alias qui spécifie l'alias local et adresses qui spécifie où délivrer les courriels de cet utilisateur.

Les alias n'ont pas besoin de correspondre à des utilisateurs locaux du système.  Dans l'exemple au-dessus, il n'y a pas besoin d'une entrée postmaster dans la liste user-accounts du operating-system pour délivrer les courriels à destination de postmaster à bob (qui ensuite délivrerait le courriel à bob@example.com et bob@example2.com).

Services de messagerie
----------------------

Le module (gnu services messaging) fournit des définitions de services Guix pour les services de messageries instantanées : actuellement seul Prosody est supporté.

Service Prosody
...............

 -- Variable Scheme: prosody-service-type
     C'est le type pour le le serveur de communication XMPP Prosody (https://prosody.im).  Sa valeur doit être un enregistrement prosody-configuration comme dans cet exemple :

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

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

Par défaut, Prosody n'a pas besoin de beaucoup de configuration.  Seul un champ virtualhosts est requis : il spécifie le domaine que vous voulez voir Prosody servir.

Vous pouvez effectuer plusieurs vérifications de la configuration générée avec la commande prosodyctl check.

Prosodyctl vous aidera aussi à importer des certificats du répertoire letsencrypt pour que l'utilisateur prosody puisse y accéder. Voir 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.

Il y a aussi une manière de spécifier la configuration en tant que chaîne de caractères si vous avez un vieux fichier prosody.cfg.lua que vous voulez porter depuis un autre système ; voir la fin pour plus de détails.

Le type file-object désigne soit un objet simili-fichier (see file-like objects), soit un nom de fichier.

Les champs de prosody-configuration disponibles sont :

 -- paramètre de prosody-configuration: package prosody
     Le paquet Prosody.

 -- paramètre de prosody-configuration: file-name data-path
     Emplacement du répertoire de stockage des données de Prosody.  Voir https://prosody.im/doc/configure.  La valeur par défaut est "/var/lib/prosody".

 -- paramètre de prosody-configuration: file-object-list plugin-paths
     Répertoires de greffons supplémentaires.  Ils sont analysés dans l'ordre spécifié.  Voir https://prosody.im/doc/plugins_directory.  La valeur par défaut est ().

 -- paramètre de prosody-configuration: file-name certificates
     Chaque hôte virtuel et composant a besoin d'un certificat pour que les clients et les serveurs puissent vérifier son identité.  Prosody chargera automatiquement les clefs et les certificats dans le répertoire spécifié ici.  La valeur par défaut est "/etc/prosody/certs".

 -- paramètre de prosody-configuration: string-list admins
     C'est une liste des comptes administrateurs de ce serveur.  Remarquez que vous devez créer les comptes séparément.  Voir https://prosody.im/doc/admins et https://prosody.im/doc/creating_accounts.  Par exemple : (admins '("user1@example.com" "user2@example.net")).  La valeur par défaut est ().

 -- paramètre de prosody-configuration: boolean use-libevent?
     Active l'utilisation de libevent pour de meilleures performances sous une forte charge.  Voir https://prosody.im/doc/libevent.  La valeur par défaut est #f.

 -- paramètre de prosody-configuration: module-list modules-enabled
     C'est la liste des modules que Prosody chargera au démarrage.  Il cherchera mod_modulename.lua dans le répertoire des greffons, donc assurez-vous qu'il existe aussi.  La documentation des modules se trouve sur https://prosody.im/doc/modules.  La valeur par défaut est ("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" et "s2s" sont chargés automatiquement, mais si vous voulez les désactiver, ajoutez-les à cette liste.  La valeur par défaut est ().

 -- paramètre de prosody-configuration: file-object groups-file
     Chemin vers un fichier texte où les groupes partagés sont définis.  Si ce chemin est vide alors mod_groups ne fait rien.  Voir https://prosody.im/doc/modules/mod_groups.  La valeur par défaut est "/var/lib/prosody/sharedgroups.txt".

 -- paramètre de prosody-configuration: boolean allow-registration?
     Désactive la création de compte par défaut, pour la sécurité.  Voir https://prosody.im/doc/creating_accounts.  La valeur par défaut est #f.

 -- paramètre de prosody-configuration: maybe-ssl-configuration ssl
     Ce sont les paramètres liés à SSL/TLS.  La plupart sont désactivés pour pouvoir utiliser les paramètres par défaut de Prosody.  Si vous ne comprenez pas complètement ces options, ne les ajoutez pas à votre configuration, il est aisé de diminuer la sécurité de votre serveur en les modifiant.  Voir https://prosody.im/doc/advanced_ssl_config.

     Les champs de ssl-configuration disponibles sont :

      -- paramètre de ssl-configuration: maybe-string protocol
          Cela détermine la poignée de main à utiliser.

      -- paramètre de ssl-configuration: maybe-file-name key
          Chemin vers votre fichier de clef privée.

      -- paramètre de ssl-configuration: maybe-file-name certificate
          Chemin vers votre fichier de certificat.

      -- paramètre de ssl-configuration: file-object capath
          Chemin vers le répertoire contenant les certificats racines que vous voulez voir Prosody utiliser lors de la vérification des certificats des serveurs distants.  La valeur par défaut est "/etc/ssl/certs".

      -- paramètre de ssl-configuration: maybe-file-object cafile
          Chemin vers un fichier contenant les certificats racines auxquels Prosody devra faire confiance.  Comme capath mais avec les certificats concaténés ensemble.

      -- paramètre de ssl-configuration: maybe-string-list verify
          Une liste d'options de vérification (qui correspondent globalement aux drapeaux set_verify() d'OpenSSL).

      -- paramètre de ssl-configuration: maybe-string-list options
          Une liste d'options générales liées à SSL/TLS.  Elles correspondent globalement à set_options() d'OpenSSL.  Pour une liste complète des options disponibles dans LuaSec, voir les sources de LuaSec.

      -- paramètre de ssl-configuration: maybe-non-negative-integer depth
          Longueur maximale d'une chaîne d'autorités de certifications avant la racine.

      -- paramètre de ssl-configuration: maybe-string ciphers
          Une chaîne de méthodes de chiffrement OpenSSL.  Cela choisi les méthodes de chiffrement que Prosody offrira aux clients, et dans quel ordre de préférence.

      -- paramètre de ssl-configuration: maybe-file-name dhparam
          Un chemin vers un fichier contenant les paramètres pour l'échange de clef Diffie-Hellman.  Vous pouvez créer un tel fichier avec : openssl dhparam -out /etc/prosody/certs/dh-2048.pem 2048

      -- paramètre de ssl-configuration: maybe-string curve
          Courbe pour Diffie-Hellman sur courbe elliptique.  La valeur par défaut de Prosody est "secp384r1".

      -- paramètre de ssl-configuration: maybe-string-list verifyext
          Une liste d'options de vérification « supplémentaires ».

      -- paramètre de ssl-configuration: maybe-string password
          Mot de passe pour les clefs privées chiffrées.

 -- paramètre de prosody-configuration: boolean c2s-require-encryption?
     S'il faut forcer toutes les connexions client-serveur à être chiffrées ou non.  Voir https://prosody.im/doc/modules/mod_tls.  La valeur par défaut est #f.

 -- paramètre de prosody-configuration: string-list disable-sasl-mechanisms
     Ensemble de mécanismes qui ne seront jamais offerts.  Voir https://prosody.im/doc/modules/mod_saslauth.  La valeur par défaut est ("DIGEST-MD5").

 -- paramètre de prosody-configuration: boolean s2s-require-encryption?
     S'il faut forcer toutes les connexion serveur-serveur à être chiffrées ou non.  Voir https://prosody.im/doc/modules/mod_tls.  La valeur par défaut est #f.

 -- paramètre de prosody-configuration: boolean s2s-secure-auth?
     S'il faut requérir le chiffrement et l'authentification du certificat.  Cela fournit une sécurité idéale, mais demande que les serveurs avec lesquels vous communiquez supportent le chiffrement ET présentent un certificat valide et de confiance.  Voir https://prosody.im/doc/s2s#security.  La valeur par défaut est #f.

 -- paramètre de prosody-configuration: string-list s2s-insecure-domains
     Beaucoup de serveurs ne supportent pas le chiffrement ou ont un certificat invalide ou auto-signé.  Vous pouvez lister les domaines ici qui n'ont pas besoin de s'authentifier avec des certificats.  Ils seront authentifiés par DNS.  Voir https://prosody.im/doc/s2s#security.  La valeur par défaut est ().

 -- paramètre de prosody-configuration: string-list s2s-secure-domains
     Même si vous laissez s2s-secure-auth? désactivé, vous pouvez toujours demander un certificat valide pour certains domaine en spécifiant la liste ici.  Voir https://prosody.im/doc/s2s#security.  La valeur par défaut est ().

 -- paramètre de prosody-configuration: string authentication
     Choisi le moteur d'authentification à utiliser.  Le moteur par défaut stocke les mots de passes en texte clair et utilise la configuration de stockage des données de Prosody pour stocker les données authentifiées.  Si vous n'avez pas confiance dans le serveur, lisez https://prosody.im/doc/modules/mod_auth_internal_hashed pour plus d'information sur l'utilisation du moteur hashed.  Voir aussi https://prosody.im/doc/authentication.  La valeur par défaut est "internal_plain".

 -- paramètre de prosody-configuration: maybe-string log
     Set logging options.  Advanced logging configuration is not yet supported by the Guix Prosody Service.  See https://prosody.im/doc/logging. Defaults to "*syslog".

 -- paramètre de prosody-configuration: file-name pidfile
     Fichier où écrire le PID.  Voir https://prosody.im/doc/modules/mod_posix.  La valeur par défaut est "/var/run/prosody/prosody.pid".

 -- paramètre de prosody-configuration: maybe-non-negative-integer http-max-content-size
     Taille maximum autorisée pour le corps HTTP (en octets).

 -- paramètre de prosody-configuration: maybe-string http-external-url
     Certains modules exposent leur propre URL de diverses manières.  Cette URL est construite à partir du protocole, de l'hôte et du port utilisé.  Si Prosody se trouve derrière un proxy, l'URL publique sera http-external-url à la place.  Voir https://prosody.im/doc/http#external_url.

 -- paramètre de prosody-configuration: virtualhost-configuration-list virtualhosts
     Un hôte dans Prosody est un domaine sur lequel les comptes utilisateurs sont créés.  Par exemple si vous voulez que vos utilisateurs aient une adresse comme "john.smith@example.com" vous devrez ajouter un hôte "example.com".  Toutes les options de cette liste seront appliquées uniquement à cet hôte.

     Remarque : le nom d'hôte « virtuel » est utilisé dans la configuration pour éviter de le confondre avec le nom d'hôte physique réel de la machine qui héberge Prosody.  Une seule instance de Prosody peut servir plusieurs domaines, chacun défini comme une entrée VirtualHost dans la configuration de Prosody.  Ainsi, un serveur qui n'héberge qu'un seul domaine n'aura qu'une entrée VirtualHost.

     Voir https://prosody.im/doc/configure#virtual_host_settings.

     Les champs de virtualhost-configuration disponibles sont :

     tous ces champs de prosody-configuration : 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
          Domaine que vous souhaitez que Prosody serve.

 -- paramètre de prosody-configuration: int-component-configuration-list int-components
     Les composant sont des services supplémentaires qui sont disponibles pour les clients, habituellement sur un sous-domaine du serveur principal (comme "mycomponent.example.com").  Des exemples de composants sont des serveurs de chatroom, des répertoires utilisateurs ou des passerelles vers d'autres protocoles.

     Les composants internes sont implémentés dans des greffons spécifiques à Prosody.  Pour ajouter un composant interne, vous n'avez qu'à remplir le champ de nom d'hôte et le greffon que vous voulez utiliser pour le composant.

     Voir https://prosody.im/doc/components.  La valeur par défaut est ().

     Les champs de int-component-configuration disponibles sont :

     tous ces champs de prosody-configuration : 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
          Nom d'hôte du composant.

      -- paramètre de int-component-configuration: string plugin
          Greffon que vous voulez utiliser pour ce composant.

      -- paramètre de int-component-configuration: maybe-mod-muc-configuration mod-muc
          Le chat multi-utilisateur (MUC) est le modules de Prosody qui vous permet de créer des chatrooms/conférences pour les utilisateurs XMPP.

          Des informations générales sur la configuration des chatrooms multi-utilisateurs se trouvent dans la documentation sur les chatrooms (https://prosody.im/doc/chatrooms), que vous devriez lire si vous les découvrez.

          Voir aussi https://prosody.im/doc/modules/mod_muc.

          Les champs de mod-muc-configuration disponibles sont :

           -- paramètre de mod-muc-configuration: string name
               Le nom à renvoyer dans les réponses de découverte de services.  La valeur par défaut est "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
               Nombre maximum de messages d'historique qui seront envoyés aux membres qui viennent de rejoindre le salon.  La valeur par défaut est 20.

 -- paramètre de prosody-configuration: ext-component-configuration-list ext-components
     Les composants externes utilisent XEP-0114, que la plupart des composants supportent.  Pour ajouter un composant externe, vous remplissez simplement le champ de nom d'hôte.  Voir https://prosody.im/doc/components.  La valeur par défaut est ().

     Les champs de ext-component-configuration disponibles sont :

     tous ces champs de prosody-configuration : 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
          Mot de passe que le composant utilisera pour s'authentifier.

      -- paramètre de ext-component-configuration: string hostname
          Nom d'hôte du composant.

 -- paramètre de prosody-configuration: non-negative-integer-list component-ports
     Ports sur lesquels Prosody écoutera les connexions des composants.  La valeur par défaut est (5347).

 -- paramètre de prosody-configuration: string component-interface
     Interface sur laquelle Prosody écoutera les connexions des composants.  La valeur par défaut est "127.0.0.1".

 -- paramètre de prosody-configuration: maybe-raw-content raw-content
     Contenu brut qui sera ajouté au fichier de configuration.

Il se peut que vous ayez juste envie de lancer un fichier prosody.cfg.lua directement.  Dans ce cas, vous pouvez passer un enregistrement opaque-prosody-configuration comme valeur à prosody-service-type.  Comme son nom l'indique, une configuration opaque n'a pas de capacités de réflexion simples.  Les champs disponibles de opaque-prosody-configuration sont :

 -- paramètre de opaque-prosody-configuration: package prosody
     Le paquet prosody.

 -- paramètre de opaque-prosody-configuration: string prosody.cfg.lua
     Le contenu de prosody.cfg.lua à utiliser.

Par exemple, si votre prosody.cfg.lua est juste la chaîne vide, vous pouvez instancier un service prosody comme ceci :

     (service prosody-service-type
              (opaque-prosody-configuration
               (prosody.cfg.lua "")))

Service BitlBee
...............

BitlBee (http://bitlbee.org) est une passerelle qui fournit une interface IRC vers une variété de protocoles de messagerie instantanée comme XMPP.

 -- Variable Scheme: bitlbee-service-type
     C'est le type de service pour le démon de passerelle IRC BitlBee (http://bitlbee.org).  Sa valeur est un bitlbee-configuration (voir plus bas).

     Pour que BitlBee écoute sur le port 6667 sur localhost, ajoutez cette ligne à vos services :

          (service bitlbee-service-type)

 -- Type de données: bitlbee-configuration
     C'est la configuration de BitlBee, avec les champs suivants :

     interface (par défaut : "127.0.0.1")
     port (par défaut : 6667)
          Écoute sur l'interface réseau correspondant à l'adresse IP dans INTERFACE, sur PORT.

          Lorsque INTERFACE vaut 127.0.0.1, seuls les clients locaux peuvent se connecter ; lorsqu'elle vaut 0.0.0.0, les connexions peuvent venir de n'importe quelle interface réseau.

     package (par défaut : bitlbee)
          Le paquet BitlBee à utiliser.

     plugins (par défaut : '())
          Liste des paquets de greffons à utiliser — p. ex. bitlbee-discord.

     extra-settings (par défaut : "")
          Partie de configuration ajoutée telle-quelle au fichier de configuration de BitlBee.

Quassel Service
...............

Quassel (https://quassel-irc.org/) is a distributed IRC client, meaning that one or more clients can attach to and detach from the central core.

 -- Scheme Variable: quassel-service-type
     This is the service type for the Quassel (https://quassel-irc.org/) IRC backend daemon.  Its value is a quassel-configuration (see below).

 -- Data Type: quassel-configuration
     This is the configuration for Quassel, with the following fields:

     quassel (default: quassel)
          The Quassel package to use.

     interface (default: "::,0.0.0.0")

     port (default: 4242)
          Listen on the network interface(s) corresponding to the IPv4 or IPv6 interfaces specified in the comma delimited INTERFACE, on PORT.

     loglevel (default: "Info")
          The level of logging desired.  Accepted values are Debug, Info, Warning and Error.

Services de téléphonie
----------------------

Cette section décrit comment configurer et lancer un serveur Murmur.  Murmur est le serveur de la suite de voix-sur-IP (VoIP) Mumble (https://mumble.info).

 -- Type de données: murmur-configuration
     Le type de service pour le serveur Murmur.  Voici un exemple de configuration :

          (service murmur-service-type
                   (murmur-configuration
                    (welcome-text
                      "Welcome to this Mumble server running on Guix!")
                    (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")))

     Après avoir reconfiguré votre système, vous pouvez manuellement indiquer le mot de passe SuperUser de murmur avec la commande qui s'affiche pendant la phase d'activation.

     Il est recommandé d'enregistrer un compte utilisateur Mumble normal et de lui donner les droits admin ou modérateur.  Vous pouvez utiliser le client mumble pour vous connecter en tant que nouvel utilisateur normal, vous enregistrer et vous déconnecter.  Pour l'étape suivante, connectez-vous avec le nom SuperUser en utilisant le mot de passe SuperUser que vous avez indiqué précédemment et accordez les droits administrateur ou modérateur à vous utilisateur mumble nouvellement enregistré et créez quelques salons.

     Les champs de murmur-configuration disponibles sont :

     package (par défaut : mumble)
          Paquet qui contient bin/murmurd.

     user (par défaut : "murmur")
          Utilisateur qui lancera le serveur Murmur.

     group (par défaut : "murmur")
          Groupe de l'utilisateur qui lancera le serveur Murmur.

     port (par défaut : 64738)
          Port sur lequel le serveur écoutera.

     welcome-text (par défaut : "")
          Texte de bienvenue envoyé aux clients lors de leur connexion.

     server-password (par défaut : "")
          Mot de passe que les clients devront entrer pour se connecter.

     max-users (par défaut : 100)
          Nombre maximum d'utilisateurs qui peuvent se connecter à ce serveur en même temps.

     max-user-bandwidth (par défaut : #f)
          Trafic de voix maximum qu'un utilisateur peut envoyer par seconde.

     database-file (par défaut : "/var/lib/murmur/db.sqlite")
          Nom de fichier de la base de données sqlite.  L'utilisateur du service deviendra propriétaire du répertoire.

     log-file (par défaut : "/var/log/murmur/murmur.log")
          Nom du fichier de journal.  L'utilisateur du service deviendra propriétaire du répertoire.

     autoban-attempts (par défaut : 10)
          Nombre maximum de connexions qu'un utilisateur peut faire pendant autoban-timeframe sans être banni automatiquement pour autoban-time.

     autoban-timeframe (par défaut : 120)
          Durée du temps pendant lequel le nombre de connexions est compté.

     autoban-time (par défaut : 300)
          Durée du bannissement automatique en secondes.

     opus-threshold (par défaut : 100)
          Pourcentage des clients qui doivent supporter opus avant de passer sur le codec audio opus.

     channel-nesting-limit (par défaut : 10)
          Profondeur maximum des canaux.

     channelname-regex (par défaut : #f)
          Une chaîne de la forme d'une expression régulière Qt que les noms de canaux doivent respecter.

     username-regex (par défaut : #f)
          Une chaîne de la forme d'une expression régulière Qt que les noms d'utilisateurs doivent respecter.

     text-message-length (par défaut : 5000)
          Taille maximum en octets qu'un utilisateur peut envoyer en un seul message textuel.

     image-message-length (par défaut : (* 128 1024))
          Taille maximum en octets qu'un utilisateur peut envoyer en une seule image.

     cert-required? (par défaut : #f)
          Si la valeur est #t les clients utilisant une authentification par mot de passe faible ne seront pas acceptés.  Les utilisateurs doivent compléter l'assistant de configuration des certificats pour rejoindre le serveur.

     remember-channel? (paramètre de : #f)
          Indique si murmur devrait se rappeler du dernier canal dans lequel étaient les utilisateurs au moment de leur déconnexion et les y remettre lorsqu'ils se reconnectent.

     allow-html? (par défaut : #f)
          Indique si le html est autorisé dans les messages textuels, les commentaires utilisateurs et les descriptions des canaux.

     allow-ping? (par défaut : #f)
          Mettre à vrai expose le nombre d'utilisateurs, le nombre d'utilisateurs maximum et la bande passante maximale du serveur par client aux utilisateurs non connectés.  Dans le client Mumble, cette information est affichée dans la boîte de dialogue de connexion.

          Désactiver ce paramètre empêchera le serveur d'être publiquement listé.

     bonjour? (par défaut : #f)
          Indique si le serveur se présente sur le réseau local à travers le protocole bonjour.

     send-version? (par défaut : #f)
          Indique si la version du serveur murmur doit être exposée dans les requêtes ping.

     log-days (par défaut : 31)
          Murmur stocke aussi les journaux en base de données, qui sont accessible via RPC.  La valeur par défaut est 31 jours, mais vous pouvez le mettre à 0 pour les garder pour toujours ou à -1 pour désactiver la journalisation dans la base de données.

     obfuscate-ips? (par défaut : #t)
          Indique si les IP enregistrées doivent être cachées pour protéger la vie privée des utilisateurs.

     ssl-cert (par défaut : #f)
          Nom de fichier du certificat SSL/TLS utilisé pour les connexions chiffrées.

               (ssl-cert "/etc/letsencrypt/live/example.com/fullchain.pem")

     ssl-key (par défaut : #f)
          Chemin de fichier vers la clef privée ssl pour les connexions chiffrées.

               (ssl-key "/etc/letsencrypt/live/example.com/privkey.pem")

     ssl-dh-params (par défaut : #f)
          Nom de fichier d'un fichier encodé en PEM avec les paramètres Diffie-Hellman pour le chiffrement SSL/TLS.  Autrement vous pouvez indiquer "@ffdhe2048", "@ffdhe3072", "@ffdhe4096", "@ffdhe6144" ou "@ffdhe8192" pour utiliser les paramètres inclus de la RFC 7919.

     ssl-ciphers (par défaut : #f)
          L'option ssl-ciphers permet de choisir les suites de chiffrement disponibles pour SSL/TLS.

          Cette option est spécifiée en utilisant l'OpenSSL cipher list notation (https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT)

          Nous vous recommandons d'essayer votre chaîne de suites de chiffrements avec « openssl ciphers <chaîne> » avant de l'indiquer ici, pour avoir une idée des suites de chiffrement que vous aurez.  Après avoir indiqué cette option, nous vous recommandons d'inspecter les journaux de Murmur pour vous assurer que Murmur utilise les suites de chiffrements auxquelles vous vous attendez.

          Remarque : modifier cette option peut impacter la rétrocompatibilité de votre serveur Murmur, et peut empêcher que des clients Mumble anciens se connectent.

     public-registration (par défaut : #f)
          Doit être un enregistrement <murmur-public-registration-configuration> ou #f.

          Vous pouvez aussi enregistrer votre serveur dans la liste des serveurs publiques que le client mumble affiche au démarrage.  Vous ne pouvez pas enregistrer votre serveur si vous avez un server-password ou allow-ping à #f.

          Cela peut prendre quelques heures avant d'arriver sur la liste publique.

     file (par défaut : #f)
          Version alternative de cette configuration : si vous indiquez quelque chose, le reste est ignoré.

 -- Type de données: murmur-public-registration-configuration
     Configuration pour l'enregistrement public du service murmur.

     name
          C'est le nom d'affichage de votre serveur.  Ne pas le confondre avec le nom d'hôte.

     password
          Un mot de passe pour identifier votre enregistrement.  Les mises à jours suivantes devront utiliser le même mot de passe.  Ne le perdez pas.

     url
          Cela devrait être le lien http:// ou https:// vers votre site web.

     hostname (par défaut : #f)
          Par défaut votre serveur sera listé par son adresse IP.  Si cette option est indiquée votre serveur sera listé par son nom d'hôte.

Services de surveillance
------------------------

Service Tailon
..............

Tailon (https://tailon.readthedocs.io/) est une application web pour visualiser et chercher des fichiers de journaux.

L'exemple suivant configurera le service avec les valeurs par défaut.  Par défaut, on peut accéder à Tailon sur le pour 8080 (http://localhost:8080).

     (service tailon-service-type)

L'exemple suivant personnalise un peu plus la configuration de Tailon, en ajoutant sed à la liste des commandes autorisées.

     (service tailon-service-type
              (tailon-configuration
                (config-file
                  (tailon-configuration-file
                    (allowed-commands '("tail" "grep" "awk" "sed"))))))

 -- Type de données: tailon-configuration
     Type de données représentant la configuration de Tailon.  Ce type a les paramètres suivants :

     config-file (par défaut : (tailon-configuration-file))
          Le fichier de configuration à utiliser pour Tailon.  Ce champ peut contenir un enregistrement tailon-configuration-file ou n'importe quelle gexp (see G-Expressions).

          Par exemple, pour utiliser un fichier local à la place, on peut utiliser la fonction local-file :

               (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
     Type de données représentant les options de configuration de Tailon.  Ce type a les paramètres suivants :

     files (par défaut : (list "/var/log"))
          Liste des fichiers à afficher.  La liste peut inclure des chaînes pour des fichiers simple ou des répertoires, ou une liste, où le premier élément est le nom d'un sous-section et le reste des fichiers ou des répertoires de cette sous-section.

     bind (par défaut : "localhost:8080")
          Adresse et port sur lesquels Tailon écoute.

     relative-root (par défaut : #f)
          Chemin de l'URL à utiliser pour Tailon, ou #f pour ne pas utiliser de chemin.

     allow-transfers? (par défaut : #t)
          Permet de télécharger les journaux dans l'interface web.

     follow-names? (par défaut : #t)
          Permet de surveiller des fichiers qui n'existent pas encore.

     tail-lines (par défaut : 200)
          Nombre de lignes à lire initialement dans chaque fichier.

     allowed-commands (par défaut : (list "tail" "grep" "awk"))
          Commandes autorisées.  Par défaut, sed est désactivé.

     debug? (par défaut : #f)
          Configurez debug? à #t pour montrer les messages de débogage.

     wrap-lines (par défaut : #t)
          État initial du retour à la ligne dans l'interface web.  Configurez l'option à #t pour retourner à la ligne (par défaut) ou à #f pour ne pas retourner à la ligne au début.

     http-auth (par défaut : #f)
          Type d'authentification HTTP à utiliser.  Indiquez #f pour désactiver l'authentification (par défaut).  Les valeur supportées sont "digest" et "basic".

     users (par défaut : #f)
          Si l'authentification HTTP est activée (voir http-auth), l'accès sera restreint aux identifiants fournis ici.  Pour configurer des utilisateurs, utilisez une liste de paires, où le premier élément de la paire est le nom d'utilisateur et le second élément est le mot de passe.

               (tailon-configuration-file
                 (http-auth "basic")
                 (users     '(("user1" . "password1")
                              ("user2" . "password2"))))

Service Darkstat
................

Darkstat est un « renifleur de paquets » qui capture le trafic réseau, calcul des statistiques sur l'utilisation et sert des rapport sur HTTP.

 -- Variable: Variable Scheme darkstat-service-type
     C'est le type de service pour le service darkstat (https://unix4lyfe.org/darkstat/), sa valeur doit être un enregistrement darkstat-configuration comme dans cet exemple :

          (service darkstat-service-type
                   (darkstat-configuration
                     (interface "eno1")))

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

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

     interface
          Capture le trafic sur l'interface réseau spécifiée.

     port (par défaut : "667")
          Lie l'interface web sur le port spécifié.

     bind-address (par défaut : "127.0.0.1")
          Lie l'interface web sur l'adresse spécifiée.

     base (par défaut : "/")
          Spécifie le chemin de base des URL.  C'est utile si on accède à darkstat à travers un proxy inverse.

Service d'export de nœud de Prometheus
......................................

L'exportateur de nœuds de Prometheus rend disponible les statistiques sur le matériel et le système d'exploitation fournies par le noyau Linux pour le système de surveillance Prometheus.  Ce service devrait être déployé sur tous les nœuds physiques et les machines virtuelles, où vous voulez surveiller ces statistiques.

 -- Variable: Variable Scheme prometheus-node-exporter-service-type
     C'est le type de service pour le service prometheus-node-exporter (https://github.com/prometheus/node_exporter/), sa valeur doit être un enregistrement prometheus-node-exporter-configuration comme dans cet exemple :

          (service prometheus-node-exporter-service-type
                   (prometheus-node-exporter-configuration
                     (web-listen-address ":9100")))

 -- Type de données: prometheus-node-exporter-configuration
     Type de données représentant la configuration de node_exporter

     package (par défaut : go-github-com-prometheus-node-exporter)
          Le paquet prometheus-node-exporter à utiliser.

     web-listen-address (par défaut : ":9100")
          Lie l'interface web sur l'adresse spécifiée.

Zabbix server
.............

Zabbix provides monitoring metrics, among others network utilization, CPU load and disk space consumption:

  * High performance, high capacity (able to monitor hundreds of thousands of devices).

  * Auto-discovery of servers and network devices and interfaces.

  * Low-level discovery, allows to automatically start monitoring new items, file systems or network interfaces among others.

  * Distributed monitoring with centralized web administration.

  * Native high performance agents.

  * SLA, and ITIL KPI metrics on reporting.

  * High-level (business) view of monitored resources through user-defined visual console screens and dashboards.

  * Remote command execution through Zabbix proxies.

Available zabbix-server-configuration fields are:

 -- zabbix-server-configuration parameter: package zabbix-server
     The zabbix-server package.

 -- zabbix-server-configuration parameter: string user
     User who will run the Zabbix server.

     Defaults to "zabbix".

 -- zabbix-server-configuration parameter: group group
     Group who will run the Zabbix server.

     Defaults to "zabbix".

 -- zabbix-server-configuration parameter: string db-host
     Database host name.

     Defaults to "127.0.0.1".

 -- zabbix-server-configuration parameter: string db-name
     Database name.

     Defaults to "zabbix".

 -- zabbix-server-configuration parameter: string db-user
     Database user.

     Defaults to "zabbix".

 -- zabbix-server-configuration parameter: string db-password
     Database password.  Please, use include-files with DBPassword=SECRET inside a specified file instead.

     La valeur par défaut est "".

 -- zabbix-server-configuration parameter: number db-port
     Database port.

     Defaults to 5432.

 -- zabbix-server-configuration parameter: string log-type
     Specifies where log messages are written to:

       * system - syslog.

       * file - file specified with log-file parameter.

       * console - standard output.

     La valeur par défaut est "".

 -- zabbix-server-configuration parameter: string log-file
     Log file name for log-type file parameter.

     Defaults to "/var/log/zabbix/server.log".

 -- zabbix-server-configuration parameter: string pid-file
     Name of PID file.

     Defaults to "/var/run/zabbix/zabbix_server.pid".

 -- zabbix-server-configuration parameter: string ssl-ca-location
     The location of certificate authority (CA) files for SSL server certificate verification.

     Defaults to "/etc/ssl/certs/ca-certificates.crt".

 -- zabbix-server-configuration parameter: string ssl-cert-location
     Location of SSL client certificates.

     Defaults to "/etc/ssl/certs".

 -- zabbix-server-configuration parameter: string extra-options
     Extra options will be appended to Zabbix server configuration file.

     La valeur par défaut est "".

 -- zabbix-server-configuration parameter: include-files include-files
     You may include individual files or all files in a directory in the configuration file.

     La valeur par défaut est ().

Zabbix agent
............

Zabbix agent gathers information for Zabbix server.

Available zabbix-agent-configuration fields are:

 -- zabbix-agent-configuration parameter: package zabbix-agent
     The zabbix-agent package.

 -- zabbix-agent-configuration parameter: string user
     User who will run the Zabbix agent.

     Defaults to "zabbix".

 -- zabbix-agent-configuration parameter: group group
     Group who will run the Zabbix agent.

     Defaults to "zabbix".

 -- zabbix-agent-configuration parameter: string hostname
     Unique, case sensitive hostname which is required for active checks and must match hostname as configured on the server.

     Defaults to "Zabbix server".

 -- zabbix-agent-configuration parameter: string log-type
     Specifies where log messages are written to:

       * system - syslog.

       * file - file specified with log-file parameter.

       * console - standard output.

     La valeur par défaut est "".

 -- zabbix-agent-configuration parameter: string log-file
     Log file name for log-type file parameter.

     Defaults to "/var/log/zabbix/agent.log".

 -- zabbix-agent-configuration parameter: string pid-file
     Name of PID file.

     Defaults to "/var/run/zabbix/zabbix_agent.pid".

 -- zabbix-agent-configuration parameter: list server
     List of IP addresses, optionally in CIDR notation, or hostnames of Zabbix servers and Zabbix proxies.  Incoming connections will be accepted only from the hosts listed here.

     Defaults to ("127.0.0.1").

 -- zabbix-agent-configuration parameter: list server-active
     List of IP:port (or hostname:port) pairs of Zabbix servers and Zabbix proxies for active checks.  If port is not specified, default port is used. If this parameter is not specified, active checks are disabled.

     Defaults to ("127.0.0.1").

 -- zabbix-agent-configuration parameter: string extra-options
     Extra options will be appended to Zabbix server configuration file.

     La valeur par défaut est "".

 -- zabbix-agent-configuration parameter: include-files include-files
     You may include individual files or all files in a directory in the configuration file.

     La valeur par défaut est ().

Zabbix front-end
................

This service provides a WEB interface to Zabbix server.

Available zabbix-front-end-configuration fields are:

 -- zabbix-front-end-configuration parameter: nginx-server-configuration-list nginx
     Configuration Nginx.

 -- zabbix-front-end-configuration parameter: string db-host
     Database host name.

     La valeur par défaut est "localhost".

 -- zabbix-front-end-configuration parameter: number db-port
     Database port.

     Defaults to 5432.

 -- zabbix-front-end-configuration parameter: string db-name
     Database name.

     Defaults to "zabbix".

 -- zabbix-front-end-configuration parameter: string db-user
     Database user.

     Defaults to "zabbix".

 -- zabbix-front-end-configuration parameter: string db-password
     Database password.  Please, use db-secret-file instead.

     La valeur par défaut est "".

 -- zabbix-front-end-configuration parameter: string db-secret-file
     Secret file which will be appended to zabbix.conf.php file.  This file contains credentials for use by Zabbix front-end.  You are expected to create it manually.

     La valeur par défaut est "".

 -- zabbix-front-end-configuration parameter: string zabbix-host
     Zabbix server hostname.

     La valeur par défaut est "localhost".

 -- zabbix-front-end-configuration parameter: number zabbix-port
     Zabbix server port.

     Defaults to 10051.

Services Kerberos
-----------------

Le module (gnu services kerberos) fournit des services liés au protocole d'authentification Kerberos.

Service Krb5
............

Les programmes qui utilisent une bibliothèque cliente Kerberos s'attendent à trouver un fichier de configuration dans /etc/krb5.conf.  Ce service génère un tel fichier à partir d'une définition fournie par la déclaration de système d'exploitation.  Il ne démarre aucun démon.

Aucun fichier « keytab » n'est fourni par ce service — vous devez les créer explicitement.  Ce service est connu pour fonctionner avec la bibliothèque cliente MIT, mit-krb5.  Les autres implémentations n'ont pas été testées.

 -- Variable Scheme: krb5-service-type
     Un type de service pour les clients Kerberos 5.

Voici un exemple d'utilisation :

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

Cet exemple fournit une configuration cliente Kerberos 5 qui :

  * Reconnais deux domaines : « EXAMPLE.COM » et « ARGREX.EDU », tous deux aillant des serveurs d'administration et des centres de distribution de clefs distincts ;

  * Utilisera le domaine « EXAMPLE.COM » pr défaut si le domaine n'est pas spécifié explicitement par les clients ;

  * Acceptera les services qui ne supportent que des types de chiffrements connus pour être faibles.

Les types krb5-realm et krb5-configuration ont de nombreux champs.  Seuls les plus communs sont décrits ici.  Pour une liste complète, et plus de détails sur chacun d'entre eux, voir la documentation de MIT krb5.conf.

 -- Type de données: krb5-realm

     name
          Ce champ est une chaîne identifiant le nom d'un domaine.  Une convention courante est d'utiliser le nom pleinement qualifié de votre organisation, converti en majuscule.

     admin-server
          Ce champ est une chaîne identifiant l'hôte où le serveur d'administration tourne.

     kdc
          Ce champ est une chaîne identifiant le centre de distribution de clefs pour ce domaine.

 -- Type de données: krb5-configuration

     allow-weak-crypto? (par défaut : #f)
          Si ce drapeau est #t les services qui n'offrent que des algorithmes de chiffrement faibles seront acceptés.

     default-realm (par défaut : #f)
          Ce champ devrait être une chaîne identifiant le domaine Kerberos par défaut pour le client.  Vous devriez mettre le nom de votre domaine Kerberos dans ce champ.  Si cette valeur est #f alors un domaine doit être spécifié pour chaque principal Kerberos à l'invocation des programmes comme kinit.

     realms
          Cela doit être une liste non-vide d'objets krb5-realm, auxquels les clients peuvent accéder.  Normalement, l'un d'entre eux aura un champ name qui correspond au champ default-realm.

Service PAM krb5
................

Le service pam-krb5 permet la connexion et la gestion des mots de passe par Kerberos.  Vous aurez besoin de ce service si vous voulez que les applications qui utilisent PAM puissent authentifier automatiquement les utilisateurs avec Kerberos.

 -- Variable Scheme: pam-krb5-service-type
     Un type de service pour le module PAM Kerberos 5.

 -- Type de données: pam-krb5-configuration
     Type de données représentant la configuration du module PAM Kerberos 5.  Ce type a les paramètres suivants :

     pam-krb5 (par défaut : pam-krb5)
          Le paquet pam-krb5 à utiliser.

     minimum-uid (par défaut : 1000)
          Le plus petite ID utilisateur pour lequel les authentifications Kerberos devraient être tentées.  Les comptes locaux avec une valeur plus petite échoueront silencieusement leur authentification Kerberos.

Services web
------------

Le module (gnu services web) fournit le serveur Apache HTTP, le serveur web nginx et aussi un démon fastcgi.

Serveur Apache HTTP
...................

 -- Variable Scheme: httpd-service-type
     Type de service pour le serveur Apache HTTP (https://httpd.apache.org/) (httpd).  La valeur de ce type de service est un enregistrement httpd-configuration.

     Un exemple de configuration simple est donné ci-dessous.

          (service httpd-service-type
                   (httpd-configuration
                     (config
                       (httpd-config-file
                         (server-name "www.example.com")
                         (document-root "/srv/http/www.example.com")))))

     D'autres services peuvent aussi étendre httpd-service-type pour être ajouté à la 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\"")))))

Les détails des types d'enregistrement httpd-configuration, httpd-module, httpd-config-file et httpd-virtualhost sont donnés plus bas.

 -- Type de données: httpd-configuration
     Ce type de données représente la configuration du service httpd.

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

     pid-file (par défaut : "/var/run/httpd")
          Le fichier de pid utilisé par le service shepherd.

     config (par défaut : (httpd-config-file))
          Le fichier de configuration à utiliser avec le service httpd.  La valeur par défaut est un enregistrement httpd-config-file mais cela peut aussi être un G-expression qui génère un fichier, par exemple un plain-file.  Un fichier en dehors du dépôt peut aussi être spécifié avec une chaîne de caractères.

 -- Type de données: httpd-module
     Ce type de données représente un module pour le service httpd.

     name
          Le nom du module.

     file
          Le fichier pour le module.  Cela peut être relatif au paquet httpd utilisé, l'emplacement absolu d'un fichier ou une G-expression pour un fichier dans le dépôt, par exemple (file-append mod-wsgi "/modules/mod_wsgi.so").

 -- Variable Scheme: %default-httpd-modules
     Une liste par défaut des objets httpd-module.

 -- Type de données: httpd-config-file
     Ce type de données représente un fichier de configuration pour le service httpd.

     modules (par défaut : %default-httpd-modules)
          Les modules à charger.  Les modules supplémentaires peuvent être ajoutés ici ou chargés par des configuration supplémentaires.

          Par exemple, pour gérer les requêtes pour des fichiers PHP, vous pouvez utiliser le module mod_proxy_fcgi d'Apache avec php-fpm-service-type :

               (service httpd-service-type
                        (httpd-configuration
                         (config
                          (httpd-config-file
                           (modules (cons*
                                     (httpd-module
                                      (name "proxy_module")
                                      (file "modules/mod_proxy.so"))
                                     (httpd-module
                                      (name "proxy_fcgi_module")
                                      (file "modules/mod_proxy_fcgi.so"))
                                     %default-httpd-modules))
                           (extra-config (list "\
               <FilesMatch \\.php$>
                   SetHandler \"proxy:unix:/var/run/php-fpm.sock|fcgi://localhost/\"
               </FilesMatch>"))))))
               (service php-fpm-service-type
                        (php-fpm-configuration
                         (socket "/var/run/php-fpm.sock")
                         (socket-group "httpd")))

     server-root (par défaut : httpd)
          Le ServerRoot dans le fichier de configuration, par défaut le paquet httpd.  Les directives comme Include et LoadModule sont prises relativement à la racine du serveur.

     server-name (par défaut : #f)
          Le ServerName dans le fichier de configuration, utilisé pour spécifier le schéma de requête, le nom d'hôte et le port que le serveur utilise pour s'identifier.

          Cela n'a pas besoin d'être dans la configuration du serveur, et peut être spécifié dans les hôtes virtuels.  La valeur par défaut est #f pour ne pas spécifier de ServerName.

     document-root (par défaut : "/srv/http")
          Le DocumentRoot depuis lequel les fichiers seront servis.

     listen (par défaut : '("80"))
          La liste des valeurs pour les directives Listen dans le fichier de configuration.  La valeur devrait être une liste de chaînes, où chacune spécifie le port sur lequel écouter et éventuellement une adresse IP et un protocole à utiliser.

     pid-file (par défaut : "/var/run/httpd")
          Le PidFile à utiliser.  Cela devrait correspondre à pid-file indiqué dans httpd-configuration pour que le service Shepherd soit correctement configuré.

     error-log (par défaut : "/var/log/httpd/error_log")
          Le ErrorLog où le serveur écrit les journaux d'erreurs.

     user (par défaut : "httpd")
          Le User en tant que lequel le serveur répondra aux requêtes.

     group (par défaut : "httpd")
          Le Group que le serveur utilisera pour répondre aux requêtes.

     extra-config (par défaut : (list "TypesConfig etc/httpd/mime.types"))
          Une liste plate de chaînes et de G-expressions qui seront ajoutées à la fin du fichier de configuration.

          N'importe quelle valeur avec laquelle le service est étendu sera ajouté à cette liste.

 -- Type de données: httpd-virtualhost
     Ce type de données représente la configuration d'un hôte virtuel pour le service httpd.

     Ils devraient être ajoutés à extra-config dans 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
          L'adresse et le port pour la directive VirtualHost.

     contents
          Le contenu de la directive VirtualHost, cela devrait être une liste de chaîne et de G-expressions.

NGINX
.....

 -- Variable Scheme: nginx-service-type
     Type de service pour le serveur web NGinx (https://nginx.org/).  La valeur de ce service est un enregistrement <nginx-configuration>.

     Un exemple de configuration simple est donné ci-dessous.

          (service nginx-service-type
                   (nginx-configuration
                     (server-blocks
                       (list (nginx-server-configuration
                               (server-name '("www.example.com"))
                               (root "/srv/http/www.example.com"))))))

     En plus d'ajouter des blocs de serveurs dans la configuration du service directement, ce service peut être étendu par d'autres services pour ajouter des blocs de serveurs, comme dans cet exemple :

          (simple-service 'my-extra-server nginx-service-type
                          (list (nginx-server-configuration
                                  (root "/srv/http/extra-website")
                                  (try-files (list "$uri" "$uri/index.html")))))

Au démarrage, nginx n'a pas encore lu son fichier de configuration, donc il utilise les fichiers par défaut pour les messages d'erreur.  S'il échoue à charger sa configuration, c'est là où les messages seront enregistrés.  Après la lecture du fichier de configuration, le fichier de journal d'erreur par défaut change en fonction de celle-ci.  Dans notre cas, les messages d'erreur au démarrage se trouvent dans /var/run/nginx/logs/error.log et après la configuration dans /var/log/nginx/error.log.  Ce second emplacement peut être modifié avec l'option de configuration LOG-DIRECTORY.

 -- Type de données: nginx-configuration
     Ce type de données représente la configuration de NGinx.  Certaines configurations peuvent se faire ici et d'autres fournissent des types d'enregistrement ou éventuellement, on peut fournir un fichier de configuration.

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

     log-directory (par défaut : "/var/log/nginx")
          Le répertoire dans lequel NGinx écrira ses fichiers journaux.

     run-directory (par défaut : "/var/run/nginx")
          Le répertoire dans lequel NGinx créera un fichier de pid et écrira des fichiers temporaires.

     server-blocks (par défaut : '())
          Une liste de blocs serveur à créer dans le fichier de configuration généré, dont les éléments sont de type <nginx-server-configuration>.

          L'exemple suivant paramètre NGinx pour servir www.example.com depuis le répertoire /srv/http/www.example.com sans utiliser 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 : '())
          Une liste de blocs amont à créer dans le fichier de configuration généré, dont les éléments sont de type <nginx-upstream-configuration>.

          Configurer les serveurs amont à travers les upstream-blocks peut être utile en combinaison avec locations dans les enregistrements <nginx-server-configuration>.  L'exemple suivant crée une configuration de serveur avec une configuration « location » qui sera mandataire pour une configuration amont, qui gérera les requêtes avec deux serveurs.

               (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)
          Si un fichier de configuration FILE est fourni, il sera utilisé au lieu de générer un fichier de configuration à partir des log-directory, run-directory, server-blocks et upstream-blocks fournis.  Pour un bon fonctionnement, ces arguments devraient correspondre à ce qui se trouve dans FILE pour s'assurer que les répertoires sont créé lorsque le service est activé.

          Cela peut être utile si vous avez déjà un fichier de configuration existant ou s'il n'est pas possible de faire ce dont vous avez besoin avec les autres parties de l'enregistrement nginx-configuration.

     server-names-hash-bucket-size (par défaut : #f)
          Taille du seau pour les tables de hashage des noms de serveurs, par dauft #f pour utilise la taille des lignes de cache du processeur.

     server-names-hash-bucket-max-size (par défaut : #f)
          Taille maximum des seaux pour les tables de hashage des serveurs de noms.

     extra-content (par défaut : "")
          Contenu supplémentaire du bloc http.  Cela devrait être une chaîne ou un G-expression.

 -- Type de données: nginx-server-configuration
     Type de données représentant la configuration d'un bloc serveur de nginx. Ce type a les paramètres suivants :

     listen (par défaut : '("80" "443 ssl"))
          Chaque directive listen indique l'adresse et le port pour le protocole IP ou le chemin d'un socket UNIX-domain sur lequel le serveur acceptera les connexions.  On peut spécifier l'adresse et le port, ou juste l'adresse ou juste le port.  Une adresse peut aussi être un nom d'hôte, par exemple :

               '("127.0.0.1:8000" "127.0.0.1" "8000" "*:8000" "localhost:8000")

     server-name (par défaut : (list 'default))
          Une liste de noms de serveurs que ce serveur représente.  'default représente le serveur par défaut pour les connexions qui ne correspondent à aucun autre serveur.

     root (par défaut : "/srv/http")
          Racine du site web que sert nginx.

     locations (par défaut : '())
          Une liste d'enregistrements nginx-location-configuration ou nginx-named-location-configuration à utiliser dans ce bloc serveur.

     index (par défaut : (list "index.html"))
          Fichiers d'index à chercher lorsque les clients demandent un répertoire. S'il ne peut pas être trouvé, Nginx enverra la liste des fichiers dans le répertoire.

     try-files (par défaut : '())
          Une liste de fichiers dont l'existence doit être vérifiée dans l'ordre spécifié.  nginx utilisera le premier fichier trouvé pour satisfaire la requête.

     ssl-certificate (par défaut : #f)
          Où trouver les certificats pour les connexions sécurisées.  Indiquez #f si vous n'avez pas de certificats et que vous ne voulez pas utiliser HTTPS.

     ssl-certificate-key (par défaut : #f)
          Où trouver la clef privée pour les connexions sécurisées.  Indiquez #f si vous n'avez pas de clef et que vous ne voulez pas utiliser HTTPS.

     server-tokens? (par défaut : #f)
          Indique si le serveur devrait ajouter sa configuration dans les réponses.

     raw-content (par défaut : '())
          Une liste de lignes brutes à ajouter dans le bloc serveur.

 -- Type de données: nginx-upstream-configuration
     Type de données représentant la configuration d'un bloc upstream nginx.  Ce type a les paramètres suivants :

     name
          Nome de ces groupe de serveurs.

     serveurs
          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
     Type de données représentant la configuration d'un bloc location nginx.  Ce type a les paramètres suivants :

     uri
          URI qui correspond à ce bloc.

     body
          Corps du block location, spécifié comme une liste de chaînes de caractères. Cela peut contenir de nombreuses directives de configuration.  Par exemple, pour passer des requêtes à un groupe de serveurs amont définis dans un bloc nginx-upstream-configuration, la directive suivante peut être spécifiée dans le corps : (list "proxy_pass http://upstream-name;").

 -- Type de données: nginx-named-location-configuration
     Type de données représentant la configuration d'un bloc location nginx nommé.  Les blocs location nommés sont utilisé les redirections de requêtes et pas pour le traitement des requêtes normales.  Ce type a les paramètres suivants :

     name
          Nom pour identifier ce bloc location.

     body
          See nginx-location-configuration body, comme le corps d'un bloc location nommé peut être utilisé de la même manière que nginx-location-configuration body.  Une restriction est que le corps d'un bloc location nommé ne peut pas contenir de bloc location.

Cache Varnish
.............

Varnish est un serveur de cache rapide qui se trouve entre les applications web et les utilisateurs.  Il sert de serveur mandataire pour les requêtes des clients et met les URL accédées en cache pour que plusieurs requêtes à la même ressource ne crée qu'une requête au moteur.

 -- Variable Scheme: varnish-service-type
     Type de service pour le démon Varnish.

 -- Type de données: varnish-configuration
     Type de données représentant la configuration du service varnish.  Ce type a les paramètres suivants :

     package (par défaut : varnish)
          Le paquet Varnish à utiliser.

     name (par défaut : "default")
          Un nom pour cet instance de Varnish.  Varnish va créer un répertoire dans /var/varnish/ avec ce nom et gardera des fichiers temporaires à cet endroit.  Si le nom commence par une barre oblique, il est interprété comme un nom de répertoire absolu.

          Pass the -n argument to other Varnish programs to connect to the named instance, e.g. varnishncsa -n default.

     backend (par défaut : "localhost:8080")
          Le moteur à utiliser.  Cette option n'a pas d'effet si vcl est vrai.

     vcl (par défaut : #f)
          Le programme VCL (Varnish Configuration Language) à lancer.  Si la valeur est #f, Varnsh servira de mandataire pour backend avec la configuration par défaut.  Sinon, ce doit être un objet simili-fichier avec une syntaxe VCL valide.

          Par exemple, pour créer un miroir de www.gnu.org (http://www.gnu.org) avec VCL vous pouvez faire quelque chose comme cela :

               (define %gnu-mirror
                 (plain-file
                  "gnu.vcl"
                  "vcl 4.1;
               backend gnu { .host = "www.gnu.org"; }"))

               (operating-system
                 ...
                 (services (cons (service varnish-service-type
                                          (varnish-configuration
                                           (listen '(":80"))
                                           (vcl %gnu-mirror)))
                                 %base-services)))

          On peut inspecter la configuration d'une instance Varnish actuellement lancée en utilisant le programme varnishadm.

          Consultez le guide utilisateur de varnish (https://varnish-cache.org/docs/) et le livre varnish (https://book.varnish-software.com/4.0/) pour une documentation complète sur Varnish et son langage de configuration.

     listen (par défaut : '("localhost:80"))
          Liste des adresses sur lesquelles écoute Varnish.

     storage (par défaut : '("malloc,128m"))
          Liste de moteurs de stockage qui seront disponibles en VCL.

     parameters (par défaut : '())
          Liste des paramètres à l'exécution de la forme '(("parameter" . "value")).

     extra-options (par défaut : '())
          Arguments supplémentaires à passer au processus varnishd.

FastCGI
.......

FastCGI est une interface entre le frontal et le moteur d'un service web. C'est un dispositif quelque peu désuet ; les nouveaux services devraient généralement juste parler HTTP entre le frontal et le moteur.  Cependant il y a un certain nombre de services de moteurs comme PHP ou l'accès aux dépôts Git optimisé en HTTP qui utilisent FastCGI, donc nous le supportons dans Guix.

Pour utiliser FastCGI, vous configurez le serveur web frontal (p. ex. nginx) pour envoyer un sous-ensemble de ses requêtes au moteur fastcgi, qui écoute sur un socket UNIX ou TCP local.  Il y a un programme fcgiwrap intermédiaire qui se trouve entre le processus du moteur et le serveur web. Le frontal indique quel moteur lancer, en passant cette information au processus fcgiwrap.

 -- Variable Scheme: fcgiwrap-service-type
     Un type de service pour le mandataire FastCGI fcgiwrap.

 -- Type de données: fcgiwrap-configuration
     Data type representing the configuration of the fcgiwrap service. 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)
          Le socket sur lequel le processus fcgiwrap écoute, en tant que chaîne de caractères.  Les valeurs valides de SOCKET sont unix:/PATH/TO/UNIX/SOCKET, tcp:DOT.TED.QU.AD:PORT et tcp6:[IPV6_ADDR]:port.

     user (par défaut : fcgiwrap)
     group (par défaut : fcgiwrap)
          Les noms de l'utilisateur et du groupe, en tant que chaînes de caractères, sous lesquels lancer le processus fcgiwrap.  Le service fastcgi s'assurera que si l'utilisateur demande les noms d'utilisateurs et de groupes fcgiwrap l'utilisateur et le groupe correspondant seront présents sur le système.

          Il est possible de configurer un service web soutenu par FastCGI pour passer les informations d'authentification HTTP depuis le frontal jusqu'au moteur, et de permettre à fcgiwrap dans lancer le processus de moteur avec l'utilisateur correspondant.  Pour activer cette fonctionnalité sur le moteur, lancez fcgiwrap en tant qu'utilisateur et groupe root.  Remarquez que cette fonctionnalité doit aussi être configurée sur le frontal.

PHP-FPM (FastCGI Process Manager) est une implémentation FastCGI de PHP alternative avec quelques fonctionnalités supplémentaires utiles pour les sites de toutes tailles.

Ces fonctionnalités comprennent :

  * La création de processus adaptative

  * Des statistiques de base (comme le mod_status d'Apache)

  * La gestion des processus avancée avec arrêt et démarrage sans heurts

  * La possibilité de démarrer des processus de travail avec différents uid/gid/chroot/environnement et différents php.ini (à la place de safe_mode)

  * L'enregistrement des journaux sur stdout et stderr

  * Le redémarrage d'urgence dans le cas de la destruction accidentelle du cache des opcodes

  * Le support des téléversements accélérés

  * Le support de « showlog »

  * Des améliorations à FastCGI, comme fastcgi_finish_request() - une fonction spéciale pour terminer la requête et nettoyer toutes les données tout en continuant à faire d'autres choses qui prennent du temps (conversion vidéo, gestion des stats, etc…).

... and much more.

 -- Variable Scheme: php-fpm-service-type
     Un type de service pour php-fpm.

 -- Type de données: php-fpm-configuration
     Type de données pour la configuration du service php-fpm.

     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"))
          L'adresse sur laquelle accepter les requêtes FastCGI.  Les syntaxes valides sont :

          "ip.add.re.ss:port"
               Écoute sur un socket TCP sur l'adresse spécifiée sur un port spécifié.

          "port"
               Écoute sur un socket TCP sur toutes les adresse sur un port spécifique.

          "/path/to/unix/socket"
               Écoute sur un socket unix.

     user (par défaut : php-fpm)
          Utilisateur à qui appartiendra le processus de travail de php.

     group (par défaut : php-fpm)
          Groupe du processus de travail.

     socket-user (par défaut : php-fpm)
          Utilisateur qui peut parler au socket php-fpm.

     socket-group (par défaut : php-fpm)
          Groupe qui peut parler au socket php-fpm.

     pid-file (par défaut : (string-append "/var/run/php" (version-major (package-version php)) "-fpm.pid"))
          Le pid de php-fpm est écrit dans ce fichier une fois que le service a démarré.

     log-file (par défaut : (string-append "/var/log/php" (version-major (package-version php)) "-fpm.log"))
          Fichier de journal pour le processus maître de php-fpm.

     process-manager (par défaut : (php-fpm-dynamic-process-manager-configuration))
          Configuration détaillée pour le gestionnaire de processus de php-fpm.  Il doit s'agir soit de :

          <php-fpm-dynamic-process-manager-configuration>,

          <php-fpm-static-process-manager-configuration> ou

          <php-fpm-on-demand-process-manager-configuration>

     display-errors (par défaut : #f)
          Détermine si les erreurs et les avertissements php doivent être envoyés aux clients et affichés dans leur navigateur.  Cela est utile pour un développement php local, mais un risque pour la sécurité pour les sites publics, comme les messages d'erreur peuvent révéler des mots de passes et des données personnelles.

     timezone (default #f)
          Specifies php_admin_value[date.timezone] parameter.

     workers-logfile (par défaut : (string-append "/var/log/php" (version-major (package-version php)) "-fpm.www.log"))
          Ce fichier enregistrera la sortie stderr des processus de travail de php.  On peut indiquer #f pour désactiver la journalisation.

     file (par défaut : #f)
          Une version alternative de la configuration complète.  Vous pouvez utiliser la fonction mixed-text-file ou un chemin de fichier absolu.

 -- Type de données: php-fpm-dynamic-process-manager-configuration
     Type de données pour le gestionnaire de processus dynamic de php-fpm.  Avec le gestionnaire de processus dynamic, des processus de travail de secours sont gardés en fonction des limites configurées.

     max-children (par défaut : 5)
          Nombre maximum de processus de travail.

     start-servers (par défaut : 2)
          Nombre de processus de travail au démarrage.

     min-spare-servers (par défaut : 1)
          Nombre de processus de travail de secours minimum qui doivent rester à disposition.

     max-spare-servers (par défaut : 3)
          Nombre maximum de processus de travail de secours qui peuvent rester à disposition.

 -- Type de données: php-fpm-static-process-manager-configuration
     Type de données pour le gestionnaire de processus static de php-fpm. Avec le gestionnaire de processus static, un nombre constant de processus de travail est créé.

     max-children (par défaut : 5)
          Nombre maximum de processus de travail.

 -- Type de données: php-fpm-on-demand-process-manager-configuration
     Type de données pour le gestionnaire de processus on-demand de php-fpm.  Avec le gestionnaire de processus on-demand, les processus de travail ne sont créés que lorsque les requêtes arrivent.

     max-children (par défaut : 5)
          Nombre maximum de processus de travail.

     process-idle-timeout (par défaut : 10)
          La durée en secondes après laquelle un processus sans requête sera tué.

 -- Procédure Scheme: nginx-php-fpm-location
     [#:nginx-package nginx]
     [socket (string-append "/var/run/php"
     (version-major (package-version php))
     "-fpm.sock")]
     Une fonction d'aide pour ajouter rapidement php à un nginx-server-configuration.

Une configuration simple de services pour php ressemble à ceci :

     (services (cons* (service dhcp-client-service-type)
                      (service php-fpm-service-type)
                      (service nginx-service-type
                               (nginx-server-configuration
                                (server-name '("example.com"))
                                (root "/srv/http/")
                                (locations
                                 (list (nginx-php-location)))
                                (listen '("80"))
                                (ssl-certificate #f)
                                (ssl-certificate-key #f)))
                      %base-services))

Le générateur d'avatar de chat est un simple service pour démontrer l'utilisation de php-fpm dans Nginx.  Il permet de générer des avatars de chats à partir d'une graine, par exemple le hash de l'adresse de courriel d'un utilisateur.

 -- Scheme Procedure: cat-avatar-generator-service
     [#:cache-dir "/var/cache/cat-avatar-generator"]
     [#:package cat-avatar-generator]
     [#:configuration (nginx-server-configuration)]
     Renvoie un nginx-server-configuration qui hérite de configuration. Il étend la configuration nginx pour ajouter un bloc de serveur qui sert package, une version de cat-avatar-generator.  Pendant l'exécution, cat-avatar-generator pourra utiliser cache-dir comme répertoire de cache.

Une configuration simple de cat-avatar-generator ressemble à ceci :

     (services (cons* (cat-avatar-generator-service
                       #:configuration
                       (nginx-server-configuration
                         (server-name '("example.com"))))
                      ...
                      %base-services))

Hpcguix-web
...........

Le programme https://github.com/UMCUGenetics/hpcguix-web/ (hpcguix-web) est une interface web personnalisable pour naviguer dans les paquets Guix, initialement conçue pour les utilisateurs des grappes de calcul de haute performance (HPC).

 -- Variable Scheme: hpcguix-web-service-type
     Le type de service pour hpcguix-web.

 -- Type de données: hpcguix-web-configuration
     Type de données pour la configuration du service hpcguix-web.

     specs
          Une gexp (see G-Expressions) spécifiant la configuration du service hpcguix-web.  Les éléments principaux disponibles dans cette spec sont :

          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 '()))
               Paquet d'extensions pour hpcguix-web.

          menu (par défaut : '())
               Entrée supplémentaire dans la page menu.

          channels (par défaut : %default-channels)
               Liste des canaux depuis lesquels la liste des paquets est construite (see Canaux).

          package-list-expiration (par défaut : (* 12 3600))
               Le temps d'expiration, en secondes, après lequel la liste des paquets est reconstruite depuis les dernières instance des canaux donnés.

          Voir le dépôt hpcguix-web pour un exemple complet (https://github.com/UMCUGenetics/hpcguix-web/blob/master/hpcweb-configuration.scm)

     package (par défaut : hpcguix-web)
          Le paquet hpcguix-web à utiliser.

Une déclaration de service hpcguix-web typique ressemble à cela :

     (service hpcguix-web-service-type
              (hpcguix-web-configuration
               (specs
                #~(define site-config
                    (hpcweb-configuration
                     (title-prefix "Guix-HPC - ")
                     (menu '(("/about" "ABOUT"))))))))

     Le service hpcguix-web met régulièrement à jour la liste des paquets qu'il publie en récupérant les canaux depuis Git.  Pour cela, il doit accéder aux certificats X.509 pour qu'il puisse authentifier les serveurs Git quand il communique en HTTPS, et il suppose que /etc/ssl/certs contient ces certificats.

     Ainsi, assurez-vous d'ajouter nss-certs ou un autre paquet de certificats dans le champ packages de votre configuration. Certificats X.509 pour plus d'informations sur les certificats X.509.

Services de certificats
-----------------------

Le module (gnu services certbot) fournit un service qui récupère automatiquement un certificat TLS valide de l'autorité de certification Let's Encrypt.  Ces certificats peuvent ensuite être utilisés pour servir du contenu de manière sécurisée sur HTTPS et d'autres protocoles basés sur TLS, en sachant que le client sera capable de vérifier l'authenticité du serveur.

Let's Encrypt (https://letsencrypt.org/) fournit l'outil certbot pour automatiser le processus de certification.  Cet outil génère d'abord un clef sur le serveur de manière sécurisée.  Ensuite il demande à l'autorité de certification Let's Encrypt de signer la clef.  La CA vérifie que la requête provient de l'hôte en question en utilisant un protocole de défi-réponse, ce qui requiert que le serveur fournisse sa réponse par HTTP. Si ce protocole se passe sans encombre, la CA signe la clef et on obtient un certificat.  Ce certificat est valide pour une durée limitée et donc, pour continuer à fournir des services en TLS, le serveur doit régulièrement demander à la CA de renouveler sa 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 est lancé deux fois par jour, à une minute aléatoire dans l'heure. Il ne fera rien sauf si vos certificats doivent être renouvelés ou sont révoqués, mais le lancer régulièrement permettra à vos services de rester en ligne si Let's Encrypt décide de révoquer votre certificat.

En utilisant ce service, vous acceptez le document « ACME Subscriber Agreement », qu'on peut trouver ici : https://acme-v01.api.letsencrypt.org/directory.

 -- Variable Scheme: certbot-service-type
     Un type de service pour le client Let's Encrypt certbot.  Sa valeur doit être un enregistrement certbot-configuration comme dans cet exemple :

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

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

 -- Type de données: certbot-configuration
     Type données représentant la configuration du service certbot.  Ce type a les paramètres suivants :

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

     webroot (par défaut : /var/www)
          Le répertoire depuis lequel servir les fichiers du défi/réponse de Let's Encrypt.

     certificates (par défaut : ())
          Une liste de certificates-configuration pour lesquels générer des certificats et demander des signatures.  Chaque certificat a un name et plusieurs domains.

     email
          Courriel obligatoire utilisé pour la création de compte, le contact en cas de problème et des notifications importantes sur le compte.

     rsa-key-size (par défaut : 2048)
          Taille de la clef RSA.

     default-location (par défaut : voir plus bas)
          Le nginx-location-configuration par défaut.  Comme certbot doit pouvoir servir les défis et les réponses, il doit être capable de lancer un serveur web.  Cela se fait en étendant le service web nginx avec un nginx-server-configuration qui écoute sur les DOMAINS sur le port 80 et qui a un nginx-location-configuration pour le chemin /.well-known/ utilisé par Let's Encrypt.  See Services web pour plus d'information sur les types de données de la configuration de nginx.

          Les requêtes vers d'autres URL correspondra à default-location, qui, s'il est présent, sera ajout é à tous les nginx-server-configuration.

          Par défaut, le default-location sera une redirection de http://DOMAIN/… vers https://DOMAIN/…, en vous laissant définir ce que vous voulez servir sur votre site en https.

          Passez #f pour ne pas utiliser de location par défaut.

 -- Type de données: certificate-configuration
     Type de données représentant la configuration d'un certificat.  Ce type a les paramètres suivants :

     name (par défaut : voir plus bas)
          Ce nom est utilisé par Certbot pour ses tâches quotidiennes et dans les chemins de fichiers ; il n'affecte pas le contenu des certificats eux-mêmes.  Pour voir les noms des certificats, lancez certbot certificates.

          Sa valeur par défaut est le premier domaine spécifié.

     domains (par défaut : ())
          Le premier domaine spécifié sera le CN du sujet du certificat, et tous les domaines seront les noms alternatifs du sujet dans le certificat.

     deploy-hook (par défaut : #f)
          Commande à lancer dans un shell une fois par certificat récupéré avec succès.  Pour cette commande, la variable $RENEWED_LINEAGE pointera sur le sous-répertoire live (par exemple, "/etc/letsencrypt/live/example.com") contenant le nouveau certificat et la clef ; la variable $RENEWED_DOMAINS contiendra les noms de domaines séparés par des espaces (par exemple "example.com www.example.com").

Pour chaque certificate-configuration, le certificat est sauvegardé dans /etc/letsencrypt/live/NAME/fullchain.pem et la clef est sauvegardée dans /etc/letsencrypt/live/NAME/privkey.pem.

Services DNS
------------

Le module (gnu services dns) fournit des services liés au système de noms de domaines (DNS).  Il fournit un service de serveur pour héberger un serveur DNS faisant autorité pour plusieurs zones, en esclave ou en maître.  Ce service utilise Knot DNS (https://www.knot-dns.cz/).  Il fournit aussi un service de cache et de renvoie DNS pour le LAN, qui utilise dnsmasq (http://www.thekelleys.org.uk/dnsmasq/doc.html).

Service Knot
............

Voici un exemple de configuration pour un serveur faisant autorité sur deux zone, un maître et un esclave :

     (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
     C'est le type pour le serveur DNS Knot.

     Knot DNS est un serveur DNS faisant autorité, ce qui signifie qu'il peut servir plusieurs zones, c'est-à-dire des noms de domaines que vous achetez à un registrar.  Ce serveur n'est pas un résolveur, ce qui signifie qu'il ne peut pas résoudre les noms pour lesquels il ne fait pas autorité.  Ce serveur peut être configuré pour servir des zones comme un serveur maître ou comme un serveur esclave, en fonction des zones.  Les zones esclaves récupèrent leurs données des maîtres, et seront servies comme faisant autorité.  Du point de vue d'un résolveur, il n'y a pas de différence entre un maître et un esclave (NdT : Voir la conférence en Français de Stéphane Bortzmeyer pour en apprendre plus sur le DNS : https://iletaitunefoisinternet.fr/dns-bortzmeyer/index.html).

     Les types de données suivants sont utilisés pour configurer le serveur DNS Knot :

 -- Type de données: knot-key-configuration
     Type de données représentant une clef.  Ce type a les paramètres suivants :

     id (par défaut : "")
          Un identifiant pour d'autres champs de configuration qui se réfèrent à cette clef.  Les ID doivent être uniques et non vides.

     algorithm (par défaut : #f)
          L'algorithme à utiliser.  Choisissez entre #f, 'hmac-md5, 'hmac-sha1, 'hmac-sha224, 'hmac-sha256, 'hmac-sha384 et 'hmac-sha512.

     secret (par défaut : "")
          La clef secrète elle-même.

 -- Type de données: knot-acl-configuration
     Type de données représentant une configuration de liste de contrôle d'accès (ACL).  Ce type a les paramètres suivants :

     id (par défaut : "")
          Un identifiant pour d'autres champs de configuration qui se réfèrent à cette clef.  Les ID doivent être uniques et non vides.

     address (par défaut : '())
          Une liste ordonnée d'adresses IP, de sous-réseaux ou d'intervalles de réseaux représentés par des chaînes de caractères.  La requête doit correspondre à l'une d'entre elles.  La valeur vide signifie que l'adresse n'a pas besoin de correspondre.

     key (par défaut : '())
          Une liste ordonnées de références à des clefs représentés par des chaînes. La chaîne doit correspondre à un ID définie dans un knot-key-configuration.  Aucune clef signifie qu'une clef n'est pas nécessaire pour correspondre à l'ACL.

     action (par défaut : '())
          Une liste ordonnée d'actions permises ou interdites par cet ACL.  Les valeurs possibles sont une liste de zéro ou plus d'éléments entre 'transfer, 'notify et 'update.

     deny? (par défaut : #f)
          Lorsque la valeur est vraie, l'ACL définie des restrictions.  Les actions listées sont interdites.  Lorsque la valeur est fausse, les actions listées sont autorisées.

 -- Type de données: zone-entry
     Type de données représentant une entrée dans un fichier de zone.  Ce type a les paramètres suivants :

     name (par défaut : "@")
          Le nom de l'enregistrement.  "@" se réfère à l'origine de la zone. Les noms sont relatifs à l'origine de la zone. Par exemple, dans la zone example.org, "ns.example.org" se réfère en fait à ns.example.org.example.org.  Les noms qui finissent par un point sont absolus, ce qui signifie que "ns.example.org." se réfère bien à ns.example.org.

     ttl (par défaut : "")
          La durée de vie (TTL) de cet enregistrement.  S'il n'est pas indiqué, le TTL par défaut est utilisé.

     class (par défaut : "IN")
          La classe de l'enregistrement.  Knot ne supporte actuellement que "IN" et partiellement "CH".

     type (par défaut : "A")
          Le type d'enregistrement.  Les types usuels sont A (une adresse IPv4), NS (serveur de nom) et MX (serveur de courriel).  Bien d'autres types sont définis.

     data (par défaut : "")
          Les données contenues dans l'enregistrement.  Par exemple une adresse IP associée à un enregistrement A, ou un nom de domaine associé à un enregistrement NS.  Rappelez-vous que les noms de domaines sont relatifs à l'origine à moins qu'ils ne finissent par un point.

 -- Type de données: zone-file
     Type données représentant le contenu d'un fichier de zone.  Ce type a les paramètres suivants :

     entries (par défaut : '())
          La liste des entrées.  On s'occupe de l'enregistrement SOA, donc vous n'avez pas besoin de l'ajouter dans la liste des entrées.  Cette liste devrait contenir une entrée pour votre serveur DNS primaire faisant autorité.  En plus d'utiliser une liste des entrées directement, vous pouvez utiliser define-zone-entries pour définir un objet contenant la liste des entrées plus facilement, que vous pouvez ensuite passer au champ entries de zone-file.

     origin (par défaut : "")
          Le nom de votre zone.  Ce paramètre ne peut pas être vide.

     ns (par défaut : "ns")
          Le domaine de votre serveur DNS primaire faisant autorité.  Le nom est relatif à l'origine, à moins qu'il finisse par un point.  Il est nécessaire que ce serveur DNS primaire corresponde à un enregistrement NS dans la zone et qu'il soit associé à une adresse IP dans la liste des entrées.

     mail (par défaut : "hostmaster")
          Une adresse de courriel pour vous contacter en tant que propriétaire de la zone.  Cela se transforme en <mail>@<origin>.

     serial (par défaut : 1)
          Le numéro de série de la zone.  Comme c'est utilisé pour vérifier les changements à la fois par les esclaves et par les résolveurs, il est nécessaire qu'il ne décroisse jamais.  Incrémentez-le toujours quand vous faites un changement sur votre zone.

     refresh (par défaut : (* 2 24 3600))
          La fréquence à laquelle les esclaves demanderont un transfert de zone. Cette valeur est un nombre de secondes.  On peut le calculer avec des multiplications ou avec (string->duration).

     retry (par défaut : (* 15 60))
          La période après laquelle un esclave essaiera de contacter son maître lorsqu'il échoue à le faire la première fois.

     expiry (par défaut : (* 14 24 3600))
          TTL par défaut des enregistrements.  Les enregistrements existants sont considérés corrects pour au moins cette durée.  Après cette période, les résolveurs invalideront leur cache et vérifieront de nouveau qu'ils existent toujours.

     nx (par défaut : 3600)
          TTL par défaut des enregistrement inexistants.  Ce TTL est habituellement court parce que vous voulez que vous nouveaux domaines soient disponibles pour tout le monde le plus rapidement possible.

 -- Type de données: knot-remote-configuration
     Type de données représentant une configuration de serveurs distants.  Ce type a les paramètres suivants :

     id (par défaut : "")
          Un identifiant pour que les autres champs de configuration se réfèrent à ce serveur distant.  les ID doivent être uniques et non vides.

     address (par défaut : '())
          Une liste ordonnée d'adresses IP de destination.  Ces adresses sont essayées en séquence.  Un port facultatif peut être donné avec le séparateur @.  Par exemple (list "1.2.3.4" "2.3.4.5@53").  Le port par défaut est le 53.

     via (par défaut : '())
          Une liste ordonnée d'adresses IP sources.  Une liste vide fera choisir une IP source appropriée à Knot.  Un port facultatif peut être donné avec le séparateur @.  La valeur par défaut est de choisir aléatoirement.

     key (par défaut : #f)
          Une référence à une clef, c'est-à-dire une chaîne contenant l'identifiant d'une clef définie dans un champ knot-key-configuration.

 -- Type de données: knot-keystore-configuration
     Type de données représentant une base de clefs pour garder les clefs dnssec.  Ce type a les paramètres suivants :

     id (par défaut : "")
          L'id de cette base de clefs.  Il ne doit pas être vide.

     backend (par défaut : 'pem)
          Le moteur de stockage des clefs.  Cela peut être 'pem ou 'pkcs11.

     config (par défaut : "/var/lib/knot/keys/keys")
          La chaîne de configuration pour le moteur.  Voici un exemple pour PKCS#11 : "pkcs11:token=knot;pin-value=1234 /gnu/store/.../lib/pkcs11/libsofthsm2.so".  Pour le moteur pem, la chaîne représente un chemin dans le système de fichiers.

 -- Type de données: knot-policy-configuration
     Type de données représentant une politique dnssec.  Knot DNS est capable de signer automatiquement vos zones.  Il peut soit générer et gérer vos clefs automatiquement ou utiliser des clefs que vous générez.

     Dnssec est habituellement implémenté avec deux clefs : une KSK (key signing key) qui est utilisé pour signer une seconde, la ZSK (zone signing key) qui est utilisée pour signer la zone.  Pour pouvoir être de confiance, la KSK doit être présente dans la zone parente (normalement un domaine de haut niveau).  Si votre registrar supporte dnssec, vous devrez leur envoyer le hash de votre KSK pour qu'il puisse ajouter un enregistrement DS dans la zone parente.  Ce n'est pas automatique et vous devrez le faire à chaque fois que vous changerez votre KSK.

     La politique définie aussi la durée de vie des clefs.  Habituellement, la ZSK peut être changée facilement et utilise des fonctions cryptographiques plus faibles (avec un paramètre plus faible) pour signer les enregistrements rapidement, donc elles sont changées très régulièrement.  La KSK en revanche requiert une interaction manuelle avec le registrar, donc elle change moins souvent et utilise des paramètres plus robustes puisqu'elle ne signe qu'un seul enregistrement.

     Ce type a les paramètres suivants :

     id (par défaut : "")
          L'id de la politique.  Il ne doit pas être vide.

     keystore (par défaut : "default")
          Une référence à une base de clefs, c'est-à-dire une chaîne contenant l'identifiant d'une base de clefs définie dans un champ knot-keystore-configuration.  L'identifiant "default" signifie la base par défaut (une base de données kasp initialisée par ce service).

     manual? (par défaut : #f)
          Indique si la clef est gérée manuellement ou automatiquement.

     single-type-signing? (par défaut : #f)
          Lorsque la valeur est #t, utilise le schéma de signature Single-Type

     algorithm (par défaut : "ecdsap256sha256")
          Un algorithme de clef de signature et de signatures.

     ksk-size (par défaut : 256)
          La longueur de la KSK.  Remarquez que cette valeur est correcte pour l'algorithme par défaut, mais ne serait pas sécurisée pour d'autres algorithmes.

     zsk-size (par défaut : 256)
          La longueur de la ZSK.  Remarquez que cette valeur est correcte pour l'algorithme par défaut, mais ne serait pas sécurisée pour d'autres algorithmes.

     dnskey-ttl (par défaut : 'default)
          La valeur du TTL pour les enregistrements DNSKEY ajoutés au sommet de la zone.  La valeur spéciale 'default signifie la même valeur que le TTL du SOA de la zone.

     zsk-lifetime (par défaut : (* 30 24 3600))
          La période entre la publication d'une ZSK et l'initialisation d'un nouveau changement.

     propagation-delay (par défaut : (* 24 3600))
          Un délai supplémentaire pour chaque étape du changement.  Cette valeur devrait être assez grande pour couvrir le temps de propagation des données entre le serveur primaire et tous les secondaires.

     rrsig-lifetime (par défaut : (* 14 24 3600))
          Une période de validité des nouvelles signatures.

     rrsig-refresh (par défaut : (* 7 24 3600))
          Une période qui indique combien de temps avant l'expiration d'une signature elle sera rafraîchie.

     nsec3? (par défaut : #f)
          Lorsque la valeur est #t, on utilisera NSEC3 au lien de NSEC.

     nsec3-iterations (par défaut : 5)
          Le nombre de fois supplémentaires que le hash est effectué.

     nsec3-salt-length (par défaut : 8)
          La longueur du champ de sel en octets, ajouté au nom du propriétaire avant de hasher.

     nsec3-salt-lifetime (par défaut : (* 30 24 3600))
          La période de validité des nouveaux champs sel.

 -- Type de données: knot-zone-configuration
     Type de données représentant la zone servie par Knot.  ce type a les paramètres suivants :

     domain (par défaut : "")
          Le domaine servi par cette configuration.  Il ne doit pas être vide.

     file (par défaut : "")
          Le fichier où la zone est sauvegardée.  Ce paramètre est ignoré pour les zones maîtres.  La valeur vide signifie l'emplacement par défaut qui dépend du nom de domaine.

     zone (par défaut : (zone-file))
          Le contenu du fichier de zone.  Ce paramètre est ignoré par les zones esclaves.  Il doit contenir un enregistrement zone-file.

     master (par défaut : '())
          Une liste des serveurs distants maîtres.  Lorsque la liste est vide, cette zone est un maître.  Lorsque la valeur est indiquée, cette zone est un esclave.  C'est al liste des identifiants des serveurs distants.

     ddns-master (par défaut : #f)
          Le maître principal.  Lorsque la valeur est vide, la valeur par défaut est le premier maître de la liste des maîtres.

     notify (par défaut : '())
          Une liste d'identifiants de groupe de serveurs esclaves.

     acl (par défaut : '())
          Une liste d'identifiants d'ACL.

     semantic-checks? (par défaut : #f)
          Lorsque la valeur est indiquée, cela ajoute plus de vérifications sémantiques à la zone.

     disable-any? (par défaut : #f)
          Lorsque la valeur est vraie, cela interdit les requêtes de type ANY.

     zonefile-sync (par défaut : 0)
          Le délai entre une modification en mémoire et sur le disque.  0 signifie une synchronisation immédiate.

     serial-policy (par défaut : 'increment)
          Une politique entre 'increment et 'unixtime.

 -- Type de données: knot-configuration
     Type de données représentant la configuration de Knot.  Ce type a les paramètres suivants :

     knot (par défaut : knot)
          Le paquet Knot.

     run-directory (par défaut : "/var/run/knot")
          Le répertoire de travail.  Ce répertoire sera utilisé pour le fichier pid et les sockets.

     listen-v4 (par défaut : "0.0.0.0")
          Une adresse IP sur laquelle écouter.

     listen-v6 (par défaut : "::")
          Une adresse IP sur laquelle écouter.

     listen-port (par défaut : 53)
          Un port sur lequel écouter.

     keys (par défaut : '())
          La liste des knot-key-configuration utilisés par cette configuration.

     acls (par défaut : '())
          La liste des knot-acl-configuration utilisés par cette configuration.

     remotes (par défaut : '())
          La liste des knot-remote-configuration utilisés par cette configuration.

     zones (par défaut : '())
          La liste des knot-zone-configuration utilisés par cette configuration.

Services Dnsmasq
................

 -- Variable Scheme: dnsmasq-service-type
     C'est le type du service dnsmasq, dont la valeur devrait être un objet dnsmasq-configuration comme dans cet exemple :

          (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)
          L'objet de paquet du serveur dnsmasq.

     no-hosts? (par défaut : #f)
          Lorsque la valeur est vraie, ne pas lire les noms d'hôte dans /etc/hosts.

     port (par défaut : 53)
          Le port sur lequel écouter.  Le mettre à zéro désactive complètement les réponses DNS, ce qui ne laisse que les fonctions DHCP et TFTP.

     local-service? (par défaut : #t)
          Accepte les requêtes DNS seulement des hôtes dont les adresses sont sur le sous-réseau local, c.-à-d. sur un sous-réseau pour lequel une interface existe sur le serveur.

     listen-addresses (par défaut : '())
          Écoute sur le adresses IP données.

     resolv-file (par défaut : "/etc/resolv.conf")
          Le fichier où lire l'adresse IP des serveurs de noms en amont.

     no-resolv? (par défaut : #f)
          Lorsque la valeur est vraie, ne pas lire RESOLV-FILE.

     servers (par défaut : '())
          Spécifiez l'adresse IP des serveurs en amont directement.

     cache-size (par défaut : 150)
          Indique la taille du cache de dnsmasq.  Indiquer 0 désactive le cache.

     negative-cache? (par défaut : #t)
          Lorsque la valeur est fausse, désactive le cache des réponses négatives.

Service ddclient
................

Le service ddclient décrit plus bas lance le démon ddclient, qui prend en charge la mise à jour automatique des entrées DNS pour les fournisseurs de service comme Dyn (https://dyn.com/dns/).

L'exemple suivant montre comment instantier le service avec sa configuration par défaut :

     (service ddclient-service-type)

Remarquez que ddclient a besoin d'accéder à des identifiants stockés dans un fichier de secrets, par défaut /etc/ddclient/secrets (voir secret-file plus bas).  On s'attend à ce que vous créiez ce fichier manuellement, de manière externe à guix (vous pourriez ajouter ce fichier dans une partie de votre configuration, par exemple avec plain-file, mais il serait lisible pour tout le monde via /gnu/store).  Vois les exemples dans le répertoire share/ddclient du paquet ddclient.

Les champs de ddclient-configuration disponibles sont :

 -- paramètre de ddclient-configuration: package ddclient
     Le paquet ddclient.

 -- paramètre de ddclient-configuration: integer daemon
     La période après laquelle ddclient réessaiera de vérifier l'IP et le nom de domaine.

     La valeur par défaut est 300.

 -- paramètre de ddclient-configuration: boolean syslog
     Utiliser syslog pour la sortie.

     La valeur par défaut est #t.

 -- paramètre de ddclient-configuration: string mail
     Courriel de l'utilisateur.

     La valeur par défaut est "root".

 -- paramètre de ddclient-configuration: string mail-failure
     Courriel de l'utilisateur pour les échecs.

     La valeur par défaut est "root".

 -- paramètre de ddclient-configuration: string pid
     Le fichier de PID de ddclient.

     La valeur par défaut est "/var/run/ddclient/ddclient.pid".

 -- paramètre de ddclient-configuration: boolean ssl
     Activer le support de SSL.

     La valeur par défaut est #t.

 -- paramètre de ddclient-configuration: string user
     Spécifie le nm d'utilisateur ou l'ID qui est utilisé pour lancer le programme ddclient.

     La valeur par défaut est "ddclient".

 -- paramètre de ddclient-configuration: string group
     Groupe de l'utilisateur qui lancera le programme ddclient.

     La valeur par défaut est "ddclient".

 -- paramètre de ddclient-configuration: string secret-file
     Fichier de secrets qui sera ajouté au fichier ddclient.conf.  Ce fichier contient les paramètres d'authentification utilisés par ddclient. On s'attend à ce que vous le créiez manuellement.

     La valeur par défaut est "/etc/ddclient/secrets.conf".

 -- paramètre de ddclient-configuration: list extra-options
     Options supplémentaires qui seront ajoutées au fichier ddclient.conf.

     La valeur par défaut est ().

Services VPN
------------

Le module (gnu services vpn) fournit des services liés aux réseaux privés virtuels (VPN).  Il fournit un srevice client pour que votre machine se connecte à un VPN et un service serveur pour que votre machine héberge un VPN.  Les deux services utilisent OpenVPN (https://openvpn.net/).

 -- Procédure Scheme: openvpn-client-service
     [#:config (openvpn-client-configuration)]

     Renvoie un service qui lance openvpn, un démon VPN, en tant que client.

 -- Procédure Scheme: openvpn-server-service
     [#:config (openvpn-server-configuration)]

     Renvoie un service qui lance openvpn, un démon VPN, en tant que serveur.

     Les deux services peuvent être lancés en même temps.

Les champs de openvpn-client-configuration disponibles sont :

 -- paramètre de openvpn-client-configuration: package openvpn
     Le paquet OpenVPN.

 -- paramètre de openvpn-client-configuration: string pid-file
     Le fichier de PID d'OpenVPN.

     La valeur par défaut est "/var/run/openvpn/openvpn.pid".

 -- paramètre de openvpn-client-configuration: proto proto
     Le protocole (UDP ou TCP) utilisé pour ouvrir un canal entre les clients et les serveurs.

     La valeur par défaut est udp.

 -- paramètre de openvpn-client-configuration: dev dev
     Le périphérique utilisé pour représenter la connexion VPN.

     La valeur par défaut est tun.

 -- paramètre de openvpn-client-configuration: string ca
     L'autorité de certification qui sert à vérifier les connexions.

     La valeur par défaut est "/etc/openvpn/ca.crt".

 -- paramètre de openvpn-client-configuration: string cert
     Le certificat de la machine sur laquelle tourne le démon.  Il devrait être signé par l'autorité indiquée dans ca.

     La valeur par défaut est "/etc/openvpn/client.crt".

 -- paramètre de openvpn-client-configuration: string key
     La clef de la machine sur laquelle tourne le démon.  Elle doit être la clef dont le certificat est donné dans cert.

     La valeur par défaut est "/etc/openvpn/client.key".

 -- paramètre de openvpn-client-configuration: boolean comp-lzo?
     Indique s'il faut utiliser l'algorithme de compression lzo.

     La valeur par défaut est #t.

 -- paramètre de openvpn-client-configuration: boolean persist-key?
     Ne pas relire les fichiers de clefs entre les SIGUSR1 et les --ping-restart.

     La valeur par défaut est #t.

 -- paramètre de openvpn-client-configuration: boolean persist-tun?
     Ne pas fermer et rouvrir les périphériques TUN/TAP ou lancer de scripts de démarrage/d'arrêt entre les SIGUSR1 et les --ping-restart.

     La valeur par défaut est #t.

 -- paramètre de openvpn-client-configuration: number verbosity
     Niveau de verbosité.

     La valeur par défaut est 3.

 -- paramètre de openvpn-client-configuration: tls-auth-client tls-auth
     Ajoute une couche d'authentification HMAC supplémentaire au dessus du canal de contrôle TLS pour se protéger contre les attaques DoS.

     La valeur par défaut est #f.

 -- paramètre de openvpn-client-configuration: key-usage verify-key-usage?
     Indique s'il faut vérifier que le certificat du serveur a l'extension d'utilisation.

     La valeur par défaut est #t.

 -- paramètre de openvpn-client-configuration: bind bind?
     Se lier à un port spécifique.

     La valeur par défaut est #f.

 -- paramètre de openvpn-client-configuration: resolv-retry resolv-retry?
     Réessayer de résoudre l'adresse du serveur.

     La valeur par défaut est #t.

 -- paramètre de openvpn-client-configuration: openvpn-remote-list remote
     Une liste de serveurs distants sur lesquels se connecter.

     La valeur par défaut est ().

     Les champs de openvpn-remote-configuration disponibles sont :

      -- paramètre de openvpn-remote-configuration: string name
          Nom du serveur.

          La valeur par défaut est "my-server".

      -- paramètre de openvpn-remote-configuration: number port
          Numéro de port sur lequel écoute le serveur.

          La valeur par défaut est 1194.

Les champs de openvpn-server-configuration disponibles sont :

 -- paramètre de openvpn-server-configuration: package openvpn
     Le paquet OpenVPN.

 -- paramètre de openvpn-server-configuration: string pid-file
     Le fichier de PID d'OpenVPN.

     La valeur par défaut est "/var/run/openvpn/openvpn.pid".

 -- paramètre de openvpn-server-configuration: proto proto
     Le protocole (UDP ou TCP) utilisé pour ouvrir un canal entre les clients et les serveurs.

     La valeur par défaut est udp.

 -- paramètre de openvpn-server-configuration: dev dev
     Le périphérique utilisé pour représenter la connexion VPN.

     La valeur par défaut est tun.

 -- paramètre de openvpn-server-configuration: string ca
     L'autorité de certification qui sert à vérifier les connexions.

     La valeur par défaut est "/etc/openvpn/ca.crt".

 -- paramètre de openvpn-server-configuration: string cert
     Le certificat de la machine sur laquelle tourne le démon.  Il devrait être signé par l'autorité indiquée dans ca.

     La valeur par défaut est "/etc/openvpn/client.crt".

 -- paramètre de openvpn-server-configuration: string key
     La clef de la machine sur laquelle tourne le démon.  Elle doit être la clef dont le certificat est donné dans cert.

     La valeur par défaut est "/etc/openvpn/client.key".

 -- paramètre de openvpn-server-configuration: boolean comp-lzo?
     Indique s'il faut utiliser l'algorithme de compression lzo.

     La valeur par défaut est #t.

 -- paramètre de openvpn-server-configuration: boolean persist-key?
     Ne pas relire les fichiers de clefs entre les SIGUSR1 et les --ping-restart.

     La valeur par défaut est #t.

 -- paramètre de openvpn-server-configuration: boolean persist-tun?
     Ne pas fermer et rouvrir les périphériques TUN/TAP ou lancer de scripts de démarrage/d'arrêt entre les SIGUSR1 et les --ping-restart.

     La valeur par défaut est #t.

 -- paramètre de openvpn-server-configuration: number verbosity
     Niveau de verbosité.

     La valeur par défaut est 3.

 -- paramètre de openvpn-server-configuration: tls-auth-server tls-auth
     Ajoute une couche d'authentification HMAC supplémentaire au dessus du canal de contrôle TLS pour se protéger contre les attaques DoS.

     La valeur par défaut est #f.

 -- paramètre de openvpn-server-configuration: number port
     Spécifie le numéro de port sur lequel les serveurs écoutent.

     La valeur par défaut est 1194.

 -- paramètre de openvpn-server-configuration: ip-mask server
     Une ip et un masque de sous-réseau spécifiant le sous-réseau dans le réseau virtuel.

     La valeur par défaut est "10.8.0.0 255.255.255.0".

 -- paramètre de openvpn-server-configuration: cidr6 server-ipv6
     Une notation CIDR pour spécifier le sous-réseau IPv6 dans le réseau virtuel.

     La valeur par défaut est #f.

 -- paramètre de openvpn-server-configuration: string dh
     Le fichier de paramètres Diffie-Hellman.

     La valeur par défaut est "/etc/openvpn/dh2048.pem".

 -- paramètre de openvpn-server-configuration: string ifconfig-pool-persist
     Le fichier qui enregistre les IP des clients.

     La valeur par défaut est "/etc/openvpn/ipp.txt".

 -- paramètre de openvpn-server-configuration: gateway redirect-gateway?
     Lorsque la valeur est vraie, le serveur agira comme une passerelle pour ses clients.

     La valeur par défaut est #f.

 -- paramètre de openvpn-server-configuration: boolean client-to-client?
     Lorsque la valeur est vraie, les clients sont autorisés à se parler entre eux dans le VPN.

     La valeur par défaut est #f.

 -- paramètre de openvpn-server-configuration: keepalive keepalive
     Fait que des messages de ping sont envoyés régulièrement dans les deux sens pour que chaque côté sache quand l'autre n'est plus disponible. keepalive a besoin d'une paire.  Le premier élément est la période d'envoi du ping, et le second élément est le délai d'attente avant de considéré que l'autre côté n'est plus disponible.

 -- paramètre de openvpn-server-configuration: number max-clients
     Le nombre maximum de clients.

     La valeur par défaut est 100.

 -- paramètre de openvpn-server-configuration: string status
     Le fichier de statut.  Ce fichier montre un court rapport sur les connexions actuelles.  Il est tronqué et réécrit toutes les minutes.

     La valeur par défaut est "/var/run/openvpn/status".

 -- paramètre de openvpn-server-configuration: openvpn-ccd-list client-config-dir
     La liste des configuration pour certains clients.

     La valeur par défaut est ().

     Les champs de openvpn-ccd-configuration disponibles sont :

      -- paramètre de openvpn-ccd-configuration: string name
          Nom du client.

          La valeur par défaut est "client".

      -- paramètre de openvpn-ccd-configuration: ip-mask iroute
          Le réseau du client.

          La valeur par défaut est #f.

      -- paramètre de openvpn-ccd-configuration: ip-mask ifconfig-push
          IP du client sur le VPN.

          La valeur par défaut est #f.

Système de fichiers en réseau
-----------------------------

Le module (gnu services nfs) fournit les services suivants, qui sont tous utilisés pour monter et exporter des arborescences de répertoires en network file systems (NFS).

Service RPC Bind
................

Le service RPC Bind fournit un dispositif pour faire correspondre les numéros de programmes à des adresses universelles.  De nombreux services liés à NFS utilisent ce dispositif.  Donc il est automatiquement démarré lorsqu'un service qui en dépend est démarré.

 -- Variable Scheme: rpcbind-service-type
     Un type de service pour le démon RPC portmapper.

 -- Type de données: rpcbind-configuration
     Type données représentant la configuration du service RPC Bind.  Ce type a les paramètres suivants :

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

     warm-start? (par défaut : #t)
          Si ce paramètre est #t, alors le démon lira un fichier d'état au démarrage ce qui lui fait recharger les informations d'états sauvegardés par une instance précédente.

Pseudo-système de fichiers Pipefs
.................................

Le système de fichiers pipefs est utilisé pour transférer des données liées à NFS entre le noyau et les programmes en espace utilisateur.

 -- Variable Scheme: pipefs-service-type
     Un type de service pour le pseudo-système de fichiers pipefs.

 -- Type de données: pipefs-configuration
     Type de données représentant la configuration du service du pseudo-système de fichiers pipefs.  Ce type a les paramètres suivants :

     mount-point (par défaut : "/var/lib/nfs/rpc_pipefs")
          Le répertoire dans lequel le système de fichiers est attaché.

Service de démon GSS
....................

Le démon du système de sécurité global (GSS) fournit une sécurité forte pour les protocoles basés sur des RPC.  Avant d'échanger des requêtes RPC, un client RPC doit établir un contexte sécurisé.  Typiquement cela se fait avec la commande Kerberos kinit ou automatiquement à la connexion avec les services PAM (see Services Kerberos).

 -- Variable Scheme: gss-service-type
     Un type de service pour le démon du système de sécurité global (GSS).

 -- Type de données: gss-configuration
     Type de données représentant la configuration du service du démon GSS.  Ce type a les paramètres suivants :

     nfs-utils (par défaut : nfs-utils)
          Le paquet dans lequel la commande rpc.gssd se trouve.

     pipefs-directory (par défaut : "/var/lib/nfs/rpc_pipefs")
          Le répertoire où le système de fichier pipefs doit être monté.

Service de démon IDMAP
......................

Le service du démon idmap fournit une correspondance entre les ID utilisateur et les noms d'utilisateurs.  Typiquement, cela est requis pour accéder aux systèmes de fichiers montés via NFSv4.

 -- Variable Scheme: idmap-service-type
     Un type de service pour le démon de correspondance d'identité (IDMAP).

 -- Type de données: idmap-configuration
     Type de données représentant la configuration du service du démon IDMAP.  Ce type a les paramètres suivants :

     nfs-utils (par défaut : nfs-utils)
          Le paquet dans lequel se trouve la commande rpc.idmapd.

     pipefs-directory (par défaut : "/var/lib/nfs/rpc_pipefs")
          Le répertoire où le système de fichier pipefs doit être monté.

     domain (par défaut : #f)
          Le nom de domaine NFSv4 local.  Il faut que ce soit une chaîne de caractères ou #f.  Si la valeur est #f le démon utilisera le nom de domaine pleinement qualifié de l'hôte.

Intégration continue
--------------------

Cuirass (https://git.savannah.gnu.org/cgit/guix/guix-cuirass.git) est un outil d'intégration continue pour Guix.  On peut l'utiliser aussi bien pour le développement que pour fournir des substituts à d'autres (see Substituts).

Le module (gnu services cuirass) fournit le service suivant.

 -- Procédure Scheme: cuirass-service-type
     Le type du service Cuirass.  Sa valeur doit être un objet cuirass-configuration, décrit ci-dessous.

Pour ajouter des travaux de construction, vous devez indiquer le champ specifications de la configuration.  Voici un exemple de service qui récupère le dépôt Guix et construit les paquets depuis un manifeste. Certains des paquets sont définis dans l'entrée "custom-packages", qui est l'équivalent de GUIX_PACKAGE_PATH.

     (define %cuirass-specs
       #~(list
          '((#:name . "my-manifest")
            (#:load-path-inputs . ("guix"))
            (#:package-path-inputs . ("custom-packages"))
            (#:proc-input . "guix")
            (#:proc-file . "build-aux/cuirass/gnu-system.scm")
            (#:proc . cuirass-jobs)
            (#:proc-args . ((subset . "manifests")
                            (systems . ("x86_64-linux"))
                            (manifests . (("config" . "guix/manifest.scm")))))
            (#:inputs . (((#:name . "guix")
                          (#:url . "git://git.savannah.gnu.org/guix.git")
                          (#:load-path . ".")
                          (#:branch . "master")
                          (#:no-compile? . #t))
                         ((#:name . "config")
                          (#:url . "git://git.example.org/config.git")
                          (#:load-path . ".")
                          (#:branch . "master")
                          (#:no-compile? . #t))
                         ((#:name . "custom-packages")
                          (#:url . "git://git.example.org/custom-packages.git")
                          (#:load-path . ".")
                          (#:branch . "master")
                          (#:no-compile? . #t)))))))

     (service cuirass-service-type
              (cuirass-configuration
               (specifications %cuirass-specs)))

Tandis que les informations liés aux travaux de construction sont directement dans les spécifications, les paramètres globaux pour le processus cuirass sont accessibles dans les autres champs de cuirass-configuration.

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

     log-file (par défaut : "/var/log/cuirass.log")
          Emplacement du fichier de journal.

     cache-directory (par défaut : "/var/cache/cuirass")
          Emplacement du cache du dépôt.

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

     group (par défaut : "cuirass")
          Groupe du propriétaire du processus cuirass.

     interval (par défaut : 60)
          Nombre de secondes entre les mises à jour du dépôt suivis des travaux de Cuirass.

     database (par défaut : "/var/lib/cuirass/cuirass.db")
          Emplacement de la base de données sqlite qui contient les résultats de construction et les spécifications précédemment ajoutées.

     ttl (par défaut : (* 30 24 3600))
          Spécifie la durée de vie (TTL) en seconde des racines du ramasse-miette qui sont enregistrés comme des résultats de construction.  Cela signifie que les résultats de construction ne seront pas glanés pendant au moins TTL secondes.

     port (par défaut : 8081)
          Numéro de port utilisé pour le serveur HTTP.

     --listen=HÔTE
          Écoute sur l'interface réseau de HOST.  La valeur par défaut est d'accepter les connexions depuis localhost.

     specifications (par défaut : #~'())
          Une gexp (see G-Expressions) qui s'évalue en une liste de spécifications, où une spécification est une liste d'association (see Associations Lists (GNU Guile Reference Manual)) dont les clefs sont des mots-clefs (#:exemple-de-mot-clef) comme dans l'exemple plus haut.

     use-substitutes? (par défaut : #f)
          Cela permet d'utiliser des substituts pour éviter de construire toutes les dépendance d'un travail depuis les sources.

     one-shot? (par défaut : #f)
          N'évaluer les spécification et construire les dérivations qu'une seule fois.

     fallback? (par défaut : #f)
          Lorsque la substitution d'un binaire pré-construit échoue, revenir à la construction locale du paquet.

     cuirass (par défaut : cuirass)
          Le paquet Cuirass à utiliser.

Services de gestion de l'énergie
--------------------------------

démon TLP
.........

Le module (gnu services pm) fournit une définition de service Guix pour l'outil de gestion d'énergie Linux TLP.

TLP active plusieurs modes un espace utilisateur et dans le noyau. Contrairement à upower-service, ce n'est pas un outil passif de surveillance, puisqu'il applique des paramètres personnalisés à chaque fois qu'il détecte une nouvelle source d'énergie.  Vous pouvez trouver plus d'informations sur la page d'accueil de TLP (http://linrunner.de/en/tlp/tlp.html).

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

          (service tlp-service-type)

Par défaut TLP n'a pas besoin de beaucoup de configuration mais la plupart des paramètres de TLP peuvent être modifiés avec tlp-configuration.

Chaque définition de paramètre est précédée par son type ; par exemple, boolean foo indique que le paramètre foo doit être spécifié comme un booléen.  Les types qui commencent par maybe- dénotent des paramètres qui n'apparaîtront pas dans la configuration de TLP lorsque leur valeur est 'disabled.

Les champs de tlp-configuration disponibles sont :

 -- paramètre de tlp-configuration: package tlp
     Le paquet TLP.

 -- paramètre de tlp-configuration: boolean tlp-enable?
     Indiquez vrai si vous souhaitez activer TLP.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: string tlp-default-mode
     Mode par défaut lorsqu'aucune source d'énergie ne peut être détectée.  Les possibilités sont AC et BAT.

     La valeur par défaut est "AC".

 -- paramètre de tlp-configuration: non-negative-integer disk-idle-secs-on-ac
     Nombre de secondes que le noyau Linux doit attendre après que les disques s'arrêtent pour se synchroniser quand il est sur secteur.

     La valeur par défaut est 0.

 -- paramètre de tlp-configuration: non-negative-integer disk-idle-secs-on-bat
     Comme disk-idle-ac mais en mode batterie.

     La valeur par défaut est 2.

 -- paramètre de tlp-configuration: non-negative-integer max-lost-work-secs-on-ac
     Périodicité du nettoyage des pages invalidées, en secondes.

     La valeur par défaut est 15.

 -- paramètre de tlp-configuration: non-negative-integer max-lost-work-secs-on-bat
     Comme max-lost-work-secs-on-ac mais en mode batterie.

     La valeur par défaut est 60.

 -- paramètre de tlp-configuration: maybe-space-separated-string-list cpu-scaling-governor-on-ac
     Gouverneur de fréquence d'horloge sur secteur.  Avec le pilote intel_pstate, les possibilités sont powersave et performance.  Avec le pilote acpi-cpufreq, les possibilités sont ondemand, powersave, performance et conservative.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-space-separated-string-list cpu-scaling-governor-on-bat
     Comme cpu-scaling-governor-on-ac mais en mode batterie.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-scaling-min-freq-on-ac
     Indique la fréquence d'horloge minimale pour le gouverneur sur secteur.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-scaling-max-freq-on-ac
     Indique la fréquence d'horloge maximale pour le gouverneur sur secteur.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-scaling-min-freq-on-bat
     Indique la fréquence d'horloge minimale pour le gouverneur sur batterie.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-scaling-max-freq-on-bat
     Indique la fréquence d'horloge maximale pour le gouverneur sur batterie.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-min-perf-on-ac
     Limite le P-état minimum pour contrôler la dissipation de puissance dans le CPU, sur secteur.  Les valeurs sont indiqués comme un pourcentage des performances disponibles.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-max-perf-on-ac
     Limite le P-état maximum pour contrôler la dissipation de puissance dans le CPU, sur secteur.  Les valeurs sont indiqués comme un pourcentage des performances disponibles.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-min-perf-on-bat
     Comme cpu-min-perf-on-ac mais en mode batterie.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-non-negative-integer cpu-max-perf-on-bat
     Comme cpu-max-perf-on-ac mais en mode batterie.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-boolean cpu-boost-on-ac?
     Active la fonctionnalité turbo boost du CPU sur secteur.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-boolean cpu-boost-on-bat?
     Comme cpu-boost-on-ac? mais en mode batterie.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: boolean sched-powersave-on-ac?
     Permet au noyau Linux de minimiser le nombre de cœurs/hyper-threads CPU utilisés lorsque la charge est faible.

     La valeur par défaut est #f.

 -- paramètre de tlp-configuration: boolean sched-powersave-on-bat?
     Comme sched-powersave-on-ac? mais en mode batterie.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: boolean nmi-watchdog?
     Active le chien de garde NMI du noyau Linux.

     La valeur par défaut est #f.

 -- paramètre de tlp-configuration: maybe-string phc-controls
     Pour les noyaux Linux avec le correctif PHC, change le voltage du CPU.  Une valeur serait par exemple "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
     Indique le niveau de performance du CPU par rapport à la politique de gestion de l'énergie sur secteur.  Les possibilités sont performance, normal et powersave.

     La valeur par défaut est "performance".

 -- paramètre de tlp-configuration: string energy-perf-policy-on-bat
     Comme energy-perf-policy-ac mais en mode batterie.

     La valeur par défaut est "powersave".

 -- paramètre de tlp-configuration: space-separated-string-list disks-devices
     Périphériques de disque dur.

 -- paramètre de tlp-configuration: space-separated-string-list disk-apm-level-on-ac
     Niveau de gestion de l'énergie avancé des disques durs.

 -- paramètre de tlp-configuration: space-separated-string-list disk-apm-level-on-bat
     Comme disk-apm-bat mais en mode batterie.

 -- paramètre de tlp-configuration: maybe-space-separated-string-list disk-spindown-timeout-on-ac
     Délai d'attente pour arrêter de faire tourner les disques.  Une valeur doit être spécifiée pour chaque disque dur déclaré.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-space-separated-string-list disk-spindown-timeout-on-bat
     Comme disk-spindown-timeout-on-ac mais en mode batterie.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-space-separated-string-list disk-iosched
     Sélectionne l'ordonnanceur d'entrées-sorties pour le disque.  Une valeur doit être spécifiée pour chaque disque déclaré.  Les possibilités sont par exemple cfq, deadline et noop.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: string sata-linkpwr-on-ac
     Niveau de gestion de l'énergie des lien SATA aggressive (ALPM).  Les possibilités sont min_power, medium_power et max_performance.

     La valeur par défaut est "max_performance".

 -- paramètre de tlp-configuration: string sata-linkpwr-on-bat
     Comme sata-linkpwr-ac mais en mode batterie.

     La valeur par défaut est "min_power".

 -- paramètre de tlp-configuration: maybe-string sata-linkpwr-blacklist
     Exclu les périphériques SATA spécifiés de la gestion de l'énergie des liens.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-on-off-boolean ahci-runtime-pm-on-ac?
     Active la gestion de l'énergie à l'exécution pour les contrôleurs AHCI et les disques, sur secteur

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-on-off-boolean ahci-runtime-pm-on-bat?
     Comme ahci-runtime-pm-on-ac mais en mode batterie.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: non-negative-integer ahci-runtime-pm-timeout
     Secondes d'inactivités avant de suspendre les disques.

     La valeur par défaut est 15.

 -- paramètre de tlp-configuration: string pcie-aspm-on-ac
     Niveau de gestion de l'énergie des états actifs de PCI Express.  Les possibilités sont default, performance et powersave.

     La valeur par défaut est "performance".

 -- paramètre de tlp-configuration: string pcie-aspm-on-bat
     Comme pcie-aspm-ac mais en mode batterie.

     La valeur par défaut est "powersave".

 -- paramètre de tlp-configuration: string radeon-power-profile-on-ac
     Niveau de vitesse de l'horloge des cartes graphiques Radeon.  Les possibilités sont low, mid, high, auto et default.

     La valeur par défaut est "high".

 -- paramètre de tlp-configuration: string radeon-power-profile-on-bat
     Comme radeon-power-ac mais en mode batterie.

     La valeur par défaut est "low".

 -- paramètre de tlp-configuration: string radeon-dpm-state-on-ac
     Méthode de gestion de l'énergie dynamique de Radeon (DPM).  Les possibilités sont battery et performance.

     La valeur par défaut est "performance".

 -- paramètre de tlp-configuration: string radeon-dpm-state-on-bat
     Comme radeon-dpm-state-ac mais en mode batterie.

     La valeur par défaut est "battery".

 -- paramètre de tlp-configuration: string radeon-dpm-perf-level-on-ac
     Niveau de performance de DPM.  Les possibilités sont auto, low et high.

     La valeur par défaut est "auto".

 -- paramètre de tlp-configuration: string radeon-dpm-perf-level-on-bat
     Comme radeon-dpm-perf-ac mais en mode batterie.

     La valeur par défaut est "auto".

 -- paramètre de tlp-configuration: on-off-boolean wifi-pwr-on-ac?
     Mode de gestion de l'énergie wifi.

     La valeur par défaut est #f.

 -- paramètre de tlp-configuration: on-off-boolean wifi-pwr-on-bat?
     Comme wifi-power-ac? mais en mode batterie.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: y-n-boolean wol-disable?
     Désactive wake on LAN.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: non-negative-integer sound-power-save-on-ac
     Durée d'attente en secondes avant d'activer la gestion de l'énergie audio sur les périphériques Intel HDA et AC97.  La valeur 0 désactive la gestion de l'énergie.

     La valeur par défaut est 0.

 -- paramètre de tlp-configuration: non-negative-integer sound-power-save-on-bat
     Comme sound-powersave-ac mais en mode batterie.

     La valeur par défaut est 1.

 -- paramètre de tlp-configuration: y-n-boolean sound-power-save-controller?
     Désactive le contrôleur en mode de gestion de l'énergie sur les périphériques Intel HDA.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: boolean bay-poweroff-on-bat?
     Active le périphérique optique AltraBay/MediaBay en mode batterie.  Le périphérique peut être de nouveau alimenté en lâchant (et en réinsérant) le levier d'éjection ou en appuyant sur le bouton d'éjection sur les modèles plus récents.

     La valeur par défaut est #f.

 -- paramètre de tlp-configuration: string bay-device
     Nom du périphérique optique à éteindre.

     La valeur par défaut est "sr0".

 -- paramètre de tlp-configuration: string runtime-pm-on-ac
     Gestion de l'énergie à l'exécution sur les bus PCI(e).  Les possibilités sont on et auto.

     La valeur par défaut est "on".

 -- paramètre de tlp-configuration: string runtime-pm-on-bat
     Comme runtime-pm-ac mais en mode batterie.

     La valeur par défaut est "auto".

 -- paramètre de tlp-configuration: boolean runtime-pm-all?
     Gestion de l'énergie à l'exécution pour tous les bus PCI(e), sauf ceux en liste noire.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: maybe-space-separated-string-list runtime-pm-blacklist
     Exclue les adresses des périphériques PCI(e) spécifiés de la gestion de l'énergie à l'exécution.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: space-separated-string-list runtime-pm-driver-blacklist
     Exclue les périphériques PCI(e) assignés aux pilotes spécifiés de la gestion de l'énergie à l'exécution.

 -- paramètre de tlp-configuration: boolean usb-autosuspend?
     Active la fonctionnalité de mise en veille automatique de l'USB.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: maybe-string usb-blacklist
     Exclue les périphériques spécifiés de la mise en veille automatique de l'USB.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: boolean usb-blacklist-wwan?
     Exclue les périphériques WWAN de la mise en veille automatique de l'USB.

     La valeur par défaut est #t.

 -- paramètre de tlp-configuration: maybe-string usb-whitelist
     Inclue les périphériques spécifiés dans la mise en veille automatique de l'USB, même s'ils sont déjà exclus par le pilote ou via usb-blacklist-wwan?.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: maybe-boolean usb-autosuspend-disable-on-shutdown?
     Active la mise en veille de l'USB avant l'arrêt.

     La valeur par défaut est disabled.

 -- paramètre de tlp-configuration: boolean restore-device-state-on-startup?
     Restaure l'état des périphériques radio (bluetooth, wifi, wwan) du dernier arrêt au démarrage du système.

     La valeur par défaut est #f.

démon Thermald
..............

Le module (gnu services pm) fournit une interface pour thermald, un service de gestion de l'horloge CPU qui aide à éviter la surchauffe.

 -- Variable Scheme: thermald-service-type
     C'est le type de service pour thermald (https://01.org/linux-thermal-daemon/), le démon de température de Linux, responsable du contrôle de l'état thermique des processeurs et d'éviter la surchauffe.

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

     ignore-cpuid-check? (par défaut : #f)
          Ignore la vérification des modèles CPU supportés avec cpuid.

     thermald (par défaut : THERMALD)
          Objet du paquet de thermald.

Services audio
--------------

Le module (gnu services audio) fournit un service qui lance MPD (le démon de lecture de musique).

Music Player Daemon
...................

Le démon de lecture de musique (MPD) est un service qui joue de la musique tout en étant contrôlé depuis la machine locale ou à travers le réseau par divers clients.

L'exemple suivant montre comment on peut lancer mpd en tant qu'utilisateur "bob" sur le port 6666.  Il utilise pulseaudio pour la sortie audio.

     (service mpd-service-type
              (mpd-configuration
               (user "bob")
               (port "6666")))

 -- Variable Scheme: mpd-service-type
     Le type de service pour mpd.

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

     user (par défaut : "mpd")
          L'utilisateur qui lance mpd.

     music-dir (par défaut : "~/Music")
          Le répertoire à scanner pour trouver les fichiers de musique.

     playlist-dir (par défaut : "~/.mpd/playlists")
          Le répertoire où stocker les playlists.

     port (par défaut : "6600")
          Le port sur lequel lancer mpd.

     address (par défaut : "any")
          L'adresse sur laquelle se lie mpd.  Pour utiliser un socket Unix domain, un chemin absolu peut être spécifié ici.

services de virtualisation
--------------------------

Le module (gnu services virtualization) fournit des services pour les démons libvirt et virtlog, ainsi que d'autres services liés à la virtualisation.

démon libvirt
.............

libvirtd est le démon côté serveur du système de gestion de virtualisation libvirt.  Ce démon tourne sur des serveurs hôtes et effectue les taches de gestion requises pour les clients virtualisés.

 -- Variable Scheme: libvirt-service-type
     C'est le type du démon libvirt (https://libvirt.org).  Sa valeur doit être un 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
     Paquet libvirt.

 -- paramètre de libvirt-configuration: boolean listen-tls?
     Indique s'il faut écouter des connexions TLS sécurisées sur le port TCP/IP public.  Vous devez remplir le champ listen pour que cela ait un effet.

     Il est nécessaire de mettre en place une CA et de créer un certificat serveur avant d'utiliser cette fonctionnalité.

     La valeur par défaut est #t.

 -- paramètre de libvirt-configuration: boolean listen-tcp?
     Écoute des connexions non-chiffrées sur le port TCP/IP public.  Vous devez remplir le champ listen pour que cela ait un effet.

     L'utilisation des sockets TCP requiert une authentification SASL par défaut.  Seuls les mécanismes SASL qui supportent le chiffrement des données sont permis.  Il s'agit de DIGEST_MD5 et GSSAPI (Kerberos5).

     La valeur par défaut est #f.

 -- paramètre de libvirt-configuration: string tls-port
     Pour pour accepter les connexions TLS sécurisées.  Il peut s'agir d'un numéro de port ou d'un nom de service.

     La valeur par défaut est "16514".

 -- paramètre de libvirt-configuration: string tcp-port
     Pour sur lequel accepter les connexions TCP non sécurisées.  Cela peut être un numéro de port ou un nom de service.

     La valeur par défaut est "16509".

 -- paramètre de libvirt-configuration: string listen-addr
     Adresse IP ou nom d'hôte utilisé pour les connexions des clients.

     La valeur par défaut est "0.0.0.0".

 -- paramètre de libvirt-configuration: boolean mdns-adv?
     Indique s'il faut publier le service libvirt en mDNS.

     Autrement, vous pouvez désactiver cela pour tous les services en stoppant le démon Avahi.

     La valeur par défaut est #f.

 -- paramètre de libvirt-configuration: string mdns-name
     Nom publié par défaut sur mDNS.  Cela doit être unique sur le réseau local.

     La valeur par défaut est "Virtualization Host <hostname>".

 -- paramètre de libvirt-configuration: string unix-sock-group
     Groupe propriétaire du socket Unix domain.  Cela peut être utilisé pour permettre à un ensemble d'utilisateurs « de confiance » de gérer les fonctionnalités sans devenir root.

     La valeur par défaut est "root".

 -- paramètre de libvirt-configuration: string unix-sock-ro-perms
     Permission Unix pour le socket en lecture seule.  Il est utilisé pour surveiller le statut des VM uniquement.

     La valeur par défaut est "0777".

 -- paramètre de libvirt-configuration: string unix-sock-rw-perms
     Permission Unix pour le socket en lecture-écriture.  La valeur par défaut n'autorise que root.  Si PolicyKit est activé sur le socket, la valeur par défaut change et permet tout le monde (c.-à-d. 0777).

     La valeur par défaut est "0770".

 -- paramètre de libvirt-configuration: string unix-sock-admin-perms
     permissions Unix pour le socket d'administration.  La valeur par défaut ne permet que le propriétaire (root), ne la changez pas à moins que vous ne soyez sûr de savoir à qui vous exposez cet accès.

     La valeur par défaut est "0777".

 -- paramètre de libvirt-configuration: string unix-sock-dir
     Le répertoire dans lequel les sockets sont créés.

     La valeur par défaut est "/var/run/libvirt".

 -- paramètre de libvirt-configuration: string auth-unix-ro
     Schéma d'authentification pour les socket Unix en lecture-seule.  Par défaut les permissions des socket permettent à n'importe qui de se connecter.

     La valeur par défaut est "polkit".

 -- paramètre de libvirt-configuration: string auth-unix-rw
     Schéma d'authentification pour les socket UNIX en lecture-écriture.  Par défaut les permissions du socket ne permettent que root.  Si le support de PolicyKit a été compilé dans libvirt, la valeur par défaut utilise l'authentification « polkit ».

     La valeur par défaut est "polkit".

 -- paramètre de libvirt-configuration: string auth-tcp
     Schéma d'authentification pour les sockets TCP.  Si vous n'avez pas activé SASL, alors tout le trafic TCP est en clair.  Ne le faites pas en dehors de scénario de développement ou de test.

     La valeur par défaut est "sasl".

 -- paramètre de libvirt-configuration: string auth-tls
     Schéma d'authentification pour les sockets TLS.  Les sockets TLS sont déjà chiffrés par la couche TLS, et une authentification limitée est effectuée avec les certificats.

     Il est possible d'utiliser de n'importe quel mécanisme d'authentification SASL en utilisant « sasl » pour cette option.

     La valeur par défaut est "none".

 -- paramètre de libvirt-configuration: optional-list access-drivers
     Schéma de contrôle d'accès à l'API.

     Par défaut un utilisateur authentifié peut accéder à toutes les API.  Les pilotes d'accès peuvent placer des restrictions là-dessus.

     La valeur par défaut est ().

 -- paramètre de libvirt-configuration: string key-file
     Chemin de fichier de la clef du serveur.  Si la valeur est une chaîne vide, aucune clef privée n'est chargée.

     La valeur par défaut est "".

 -- paramètre de libvirt-configuration: string cert-file
     Chemin de fichier de la clef du serveur.  Si la chaîne est vide, aucun certificat n'est chargé.

     La valeur par défaut est "".

 -- paramètre de libvirt-configuration: string ca-file
     Chemin de fichier de la clef du serveur.  Si la chaîne est vide, aucun certificat de CA n'est chargé.

     La valeur par défaut est "".

 -- paramètre de libvirt-configuration: string crl-file
     Chemin de la liste de révocation des certificats.  Si la chaîne est vide, aucun CRL n'est chargé.

     La valeur par défaut est "".

 -- paramètre de libvirt-configuration: boolean tls-no-sanity-cert
     Désactive la vérification de nos propres certificats serveurs.

     Lorsque libvirtd démarre il effectue des vérifications de routine sur ses propres certificats.

     La valeur par défaut est #f.

 -- paramètre de libvirt-configuration: boolean tls-no-verify-cert
     Désactive la vérification des certificats clients.

     La vérification des certificats clients est le mécanisme d'authentification principal.  Tout client qui ne présent pas de certificat signé par la CA sera rejeté.

     La valeur par défaut est #f.

 -- paramètre de libvirt-configuration: optional-list tls-allowed-dn-list
     Liste blanche des Distinguished Name x509 autorisés.

     La valeur par défaut est ().

 -- paramètre de libvirt-configuration: optional-list sasl-allowed-usernames
     Liste blanche des noms d'utilisateur SASL permis.  Le format des noms d'utilisateurs dépend du mécanisme d'authentification SASL.

     La valeur par défaut est ().

 -- paramètre de libvirt-configuration: string tls-priority
     Modifie la chaîne de priorité TLS par défaut fixée à la compilation.  La valeur par défaut est typiquement « NORMAL » à moins qu'elle n'ait été modifiée à la compilation.  Ne l'indiquez que si vous voulez que libvirt agisse différemment des paramètres par défaut globaux.

     La valeur par défaut est "NORMAL".

 -- paramètre de libvirt-configuration: integer max-clients
     Nombre maximum de connexions clientes en même temps sur tous les sockets.

     La valeur par défaut est 5000.

 -- paramètre de libvirt-configuration: integer max-queued-clients
     Longueur maximum de la queue de connexions en attente d'acceptation du démon.  Remarquez que certains protocoles supportant la retransmission peuvent obéir à ce paramètre pour qu'une connexion ultérieure réussisse.

     La valeur par défaut est 1000.

 -- paramètre de libvirt-configuration: integer max-anonymous-clients
     Longueur maximum de la queue des clients acceptés mais pas authentifiés. Indiquez zéro pour désactiver ce paramètre.

     La valeur par défaut est 20.

 -- paramètre de libvirt-configuration: integer min-workers
     Nombre de processus de travail démarrés initialement.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer max-workers
     Nombre maximum de threads de travail.

     Si le nombre de clients actifs dépasse min-workers, plus de threads seront démarrés, jusqu'à la limite de max_workers.  Typiquement vous voulez que max_workers soit égal au nombre maximum de clients permis.

     La valeur par défaut est 20.

 -- paramètre de libvirt-configuration: integer prio-workers
     Nombre de travailleurs prioritaires.  Si tous les threads de travail du groupe ci-dessus sont bloqués, certains appels marqués comme prioritaires (notamment domainDestroy) peuvent être exécutés par ce groupe.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer max-requests
     Limite globale totale sur les appels RPC concurrents.

     La valeur par défaut est 20.

 -- paramètre de libvirt-configuration: integer max-client-requests
     Limite de requêtes concurrentes depuis une connexion cliente unique. Pour éviter qu'un client ne monopolise le serveur, vous devriez indiquer une petite partie des paramètres global max_requests et max_workers.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer admin-min-workers
     Comme min-workers mais pour l'interface d'administration.

     La valeur par défaut est 1.

 -- paramètre de libvirt-configuration: integer admin-max-workers
     Comme max-workers mais pour l'interface d'administration.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer admin-max-clients
     Comme max-clients mais pour l'interface d'administration.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer admin-max-queued-clients
     Comme max-queued-clients mais pour l'interface d'administration.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer admin-max-client-requests
     Comme max-client-requests mais pour l'interface d'administration.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer log-level
     Niveau de journalisation.  4 : erreurs, 3 : avertissements, 2 : information, 1 : débogage.

     La valeur par défaut est 3.

 -- paramètre de libvirt-configuration: string log-filters
     Filtres de journalisation.

     Un filtre qui permet de sélectionner plusieurs niveaux de journalisation pour une catégorie donnée.  Le format d'un filtre est :

       * x:nom

       * x:+nom

     où nom est une chaîne de caractères qui correspond à la catégorie donnée dans VIR_LOG_INIT() au début de chaque fichier source de libvirt, p. ex. « remote », « qemu » ou « util.json » (le nom dans le filtre peut être une sous-chaîne du nom complet de la catégorie, pour pouvoir correspondre à plusieurs catégories similaires), le préfixe facultatif « + » dit à libvirt d'enregistrer les traces de piles pour chaque message qui correspond au nom, et x est le niveau minimal des messages qui devraient être enregistrés :

       * 1 : DEBUG

       * 2 : INFO

       * 3 : WARNING

       * 4 : ERROR

     On peut définir plusieurs filtres dans une seule déclaration de filtres, ils doivent juste être séparés par des espaces.

     La valeur par défaut est "3:remote 4:event".

 -- paramètre de libvirt-configuration: string log-outputs
     Sorties de débogage.

     Une sortie est l'un des endroits où les journaux sont enregistrés.  Le format d'une sortie peut être :

     x:stderr
          la sortie va vers stderr

     x:syslog:nom
          utilise syslog comme sortie et utilise le nom donné comme identifiant

     x:file:chemin_fichier
          la sortie va vers un fichier, avec le chemin donné

     x:journald
          la sortie va vers le système de journalisation journald

     Dans tous les cas, le préfixe x est le niveau minimal, qui agit comme un filtre

       * 1 : DEBUG

       * 2 : INFO

       * 3 : WARNING

       * 4 : ERROR

     Plusieurs sorties peuvent être définies, elles doivent juste être séparées par des espaces.

     La valeur par défaut est "3:stderr".

 -- paramètre de libvirt-configuration: integer audit-level
     Permet de modifier l'utilisation du sous-système d'audit.

       * 0 : désactive tout audit

       * 1 : active l'audit, seulement s'il est activé sur l'hôte

       * 2 : active l'audit, et quitte s'il est désactivé sur l'hôte.

     La valeur par défaut est 1.

 -- paramètre de libvirt-configuration: boolean audit-logging
     Envoie les messages d'audit via l'infrastructure de journalisation de libvirt

     La valeur par défaut est #f.

 -- paramètre de libvirt-configuration: optional-string host-uuid
     UUID de l'hôte.  L'UUID ne doit pas avoir tous ses nombres identiques.

     La valeur par défaut est "".

 -- paramètre de libvirt-configuration: string host-uuid-source
     Source où lire l'UUID de l'hôte.

       * smbios : récupère l'UUID à partir de dmidecode -s system-uuid

       * machine-id : récupère l'UUID à partir de /etc/machine-id

     Si dmidecode ne fournit pas un UUID valide, un UUID temporaire sera généré.

     La valeur par défaut est "smbios".

 -- paramètre de libvirt-configuration: integer keepalive-interval
     Un message keepalive est envoyé au client après keepalive_interval secondes d'inactivité pour vérifier si le client répond toujours.  Si la valeur est -1, libvirtd n'enverra jamais de requête keepalive ; cependant les clients peuvent toujours en envoyer et le démon y répondra.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer keepalive-count
     Nombre maximum de messages keepalive qui peuvent être envoyés au client sans réponse avant que la connexion ne soit considérée comme cassée.

     En d'autres termes, la connexion est approximativement fermée après keepalive_interval * (keepalive_count + 1) secondes après le dernier message reçu de la part du client.  Lorsque keepalive-count est à 0, les connexions seront automatiquement fermées après keepalive-interval secondes d'inactivité sans envoyer le moindre message keepalive.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer admin-keepalive-interval
     Comme précédemment, mais pour l'interface d'administration.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer admin-keepalive-count
     Comme précédemment, mais pour l'interface d'administration.

     La valeur par défaut est 5.

 -- paramètre de libvirt-configuration: integer ovs-timeout
     Délai d'attente pour les appels Open vSwitch.

     L'utilitaire ovs-vsctl est utilisé pour la configuration et son option de délai d'attente est à 5 secondes pour éviter qu'une attente infinie ne bloque libvirt.

     La valeur par défaut est 5.

démon Virrlog
.............

Le service virtlogd est un démon côté serveur qui fait partie de libvirt, utilisé pour gérer les journaux des consoles des machines virtuelles.

Ce démon n'est pas utilisé directement par les clients libvirt, mais il est appelé pour eux par libvirtd.  En maintenant les journaux dans un démon séparé, le démon libvirtd principal peut être redémarré sans risque de perte de journaux.  Le démon virtlogd a la possibilité de ré-exécuter exec() sur lui-même quand il reçoit SIGUSR1, pour permettre des mises à jour à chaux sans temps mort.

 -- Variable Scheme: virtlog-service-type
     Le type de service pour le démon virtlogd.  Sa valeur doit être un virtlog-configuration.

          (service virtlog-service-type
                   (virtlog-configuration
                    (max-clients 1000)))

 -- paramètre de virtlog-configuration: integer log-level
     Niveau de journalisation.  4 : erreurs, 3 : avertissements, 2 : information, 1 : débogage.

     La valeur par défaut est 3.

 -- paramètre de virtlog-configuration: string log-filters
     Filtres de journalisation.

     Un filtre qui permet de sélectionner plusieurs niveaux de journalisation pour une catégorie donnée.  Le format d'un filtre est :

       * x:nom

       * x:+nom

     où nom est une chaîne de caractères qui correspond à la catégorie donnée dans VIR_LOG_INIT() au début de chaque fichier source de libvirt, p. ex. « remote », « qemu » ou « util.json » (le nom dans le filtre peut être une sous-chaîne du nom complet de la catégorie, pour pouvoir correspondre à plusieurs catégories similaires), le préfixe facultatif « + » dit à libvirt d'enregistrer les traces de piles pour chaque message qui correspond au nom, et x est le niveau minimal des messages qui devraient être enregistrés :

       * 1 : DEBUG

       * 2 : INFO

       * 3 : WARNING

       * 4 : ERROR

     On peut définir plusieurs filtres dans une seule déclaration de filtres, ils doivent juste être séparés par des espaces.

     La valeur par défaut est "3:remote 4:event".

 -- paramètre de virtlog-configuration: string log-outputs
     Sorties de débogage.

     Une sortie est l'un des endroits où les journaux sont enregistrés.  Le format d'une sortie peut être :

     x:stderr
          la sortie va vers stderr

     x:syslog:nom
          utilise syslog comme sortie et utilise le nom donné comme identifiant

     x:file:chemin_fichier
          la sortie va vers un fichier, avec le chemin donné

     x:journald
          la sortie va vers le système de journalisation journald

     Dans tous les cas, le préfixe x est le niveau minimal, qui agit comme un filtre

       * 1 : DEBUG

       * 2 : INFO

       * 3 : WARNING

       * 4 : ERROR

     Plusieurs sorties peuvent être définies, elles doivent juste être séparées par des espaces.

     La valeur par défaut est "3:stderr".

 -- paramètre de virtlog-configuration: integer max-clients
     Nombre maximum de connexions clientes en même temps sur tous les sockets.

     La valeur par défaut est 1024.

 -- paramètre de virtlog-configuration: integer max-size
     Taille de fichier maximale avant roulement.

     La valeur par défaut est 2MB.

 -- paramètre de virtlog-configuration: integer max-backups
     Nombre maximal de fichiers de sauvegardes à garder.

     La valeur par défaut est 3.

Émulation transparente avec QEMU
................................

qemu-binfmt-service-type fournit le support de l'émulation transparente de binaires construits pour des architectures différentes — p. ex. il permet d'exécuter de manière transparente des programmes ARMv sur une machine x86_64.  Cela se fait en combinant l'émulateur QEMU (https://www.qemu.org) et la fonctionnalité binfmt_misc du noyau Linux.

 -- Variable Scheme: qemu-binfmt-service-type
     Le type du service QEMU/binfmt pour l'émulation transparente.  Sa valeur doit être un objet qemu-binfmt-configuration, qui spécifie le paquet QEMU à utiliser ainsi que l'architecture que vous voulez émuler :

          (service qemu-binfmt-service-type
                   (qemu-binfmt-configuration
                     (platforms (lookup-qemu-platforms "arm" "aarch64" "ppc"))))

     Dans cet exemple, on active l'émulation transparente pour les plateformes ARM et aarch64.  Lancer herd stop qemu-binfmt l'éteint et lancer herd start qemu-binfmt le rallume (see the herd command (The GNU Shepherd Manual)).

 -- Type de données: qemu-binfmt-configuration
     La configuration du service qemu-binfmt.

     platforms (par défaut : '())
          La liste des plates-formes émulées par QEMU.  Chaque élément doit être un objet platform object tel que renvoyé par lookup-qemu-platforms (voir plus bas).

     guix-support? (par défaut : #f)
          Lorsque la valeur est vraie, QEMU et toutes ses dépendances sont ajoutés à l'environnement de construction de guix-daemon (see --chroot-directory option).  Cela permet d'utiliser les gestionnaires binfmt_misc dans l'environnement de cosntruction, ce qui signifie que vous pouvez construire des programmes pour d'autres architectures de manière transparente.

          Par exemple, supposons que vous soyez sur une machine x86_64 et que vous avez ce services :

               (service qemu-binfmt-service-type
                        (qemu-binfmt-configuration
                          (platforms (lookup-qemu-platforms "arm"))
                          (guix-support? #t)))

          Vous pouvez lancer :

               guix build -s armhf-linux inkscape

          et cela construira Inkscape pour ARMv7 comme s'il s'agissait d'une construction native, de manière transparente avec QEMU pour émuler un CPU ARMv7.  Plutôt pratique si vous voulez tester un paquet construit pour une architecture à laquelle vous n'avez pas accès !

     qemu (par défaut : qemu)
          Le paquet QEMU à utiliser.

 -- Procédure Scheme: lookup-qemu-platforms PLATFORMS...
     Renvoie la liste des objets de plates-formes QEMU correspondant à PLATFORMS....  PLATFORMS doit être une liste de chaînes de caractères correspondant aux noms de plates-formes, comme "arm", "sparc", "mips64el" etc.

 -- Procédure Scheme: qemu-platform? OBJ
     Renvoie vrai s iOBJ est un objet de plate-forme.

 -- Procédure Scheme: qemu-platform-name PLATFORM
     Renvoie le nom de PLATFORM — une chaîne comme "arm".

Services de contrôle de version
-------------------------------

Le module (gnu services version-control) fournit un service pour permettre l'accès à distance à des dépôts Git locaux.  Il y a trois options : en utilisant git-daemon-service qui fournit un accès aux dépôts via le protocole non sécurisé git:// basé sur TCP, en étendant le serveur web nginx pour relayer les requêtes vers git-http-backend ou en fournissant une interface web avec cgit-service-type.

 -- Procédure Scheme: git-daemon-service [#:config (git-daemon-configuration)]

     Renvoie un service qui lance git daemon, un serveur TCP simple pour exposer des dépôts sur le protocole Git pour des accès anonymes.

     L'argument facultatif CONFIG devrait être un objet <git-daemon-configuration>, par défaut il permet l'accès en lecture-seule aux dépôts exportés (En créant le fichier magique « git-daemon-export-ok » dans le répertoire du dépôt.) dans /srv/git.

 -- Type de données: git-daemon-configuration
     Type de données représentnt la configuration de git-daemon-service.

     package (par défaut : GIT)
          Objet de paquet du système de contrôle de version distribué Git.

     export-all? (par défaut : #F)
          Indique s'il faut permettre l'accès à tous les dépôts Git, même s'ils n'ont pas le fichier git-daemon-export-ok.

     base-path (par défaut : /srv/git)
          Indique s'il faut traduire toutes les requêtes de chemins relativement au chemin actuel.  Si vous lancez le démon git avec (BASE-PATH "/SRV/GIT") sur example.com, si vous essayez ensuite de récupérer git://example.com/hello.git, le démon git interprétera ce chemin comme étant /srv/git/hello.git.

     user-path (par défaut : #F)
          Indique s'il faut permettre la notation ~user dans les requêtes. Lorsque spécifié avec une chaîne vide, les requêtes à git://host/~alice/foo sont des requêtes d'accès au dépôt foo dans le répertoire personnel de l'utilisateur alice.  Si (USER-PATH "CHEMIN") est spécifié, la même requête est interprétée comme accédant au répertoire chemin/foo dans le répertoire personnel de l'utilisateur alice.

     listen (par défaut : '())
          Indique s'il faut écouter sur des adresses IP ou des noms d'hôtes particuliers, par défaut tous.

     port (par défaut : #F)
          Indique s'il faut écouter sur un port particulier, par défaut le 9418.

     whitelist (par défaut : '())
          Si la liste n'est pas vide, n'autoriser l'accès qu'aux dossiers spécifiés.

     extra-options (par défaut : '())
          Options supplémentaires qui seront passées à git daemon, lancez man git-daemon pour plus d'informations.

Le protocole git:// ne permet pas l'authentification.  Lorsque vous récupérez un dépôt via git://, vous ne pouvez pas savoir si les données que vous recevez ont été modifiées ou si elles viennent bien de l'hôte spécifié, et votre connexion pourrait être espionnée.  Il est préférable d'utiliser un protocole de transport authentifié et chiffré, comme https.  Bien que Git vous permette de servir des dépôts avec un serveur web peu sophistiqué basé sur les fichiers, il y a un protocole plus rapide implémenté par le programme git-http-backend.  Ce programme est le moteur des services web Git corrects.  Il est conçu pour se trouver derrière un mandataire FastCGI.  See Services web pour plus d'informations sur la manière de lancer le démon fcgiwrap nécessaire.

Guix a un type de données de configuration séparé pour servir des dépôts Git par HTTP.

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

     package (par défaut : GIT)
          Objet de paquet du système de contrôle de version distribué Git.

     git-root (par défaut : /srv/git)
          Répertoire contenant les dépôts Git à exposer au monde.

     export-all? (par défaut : #F)
          Indique s'il faut exposer l'accès de tous les dépôts Git dans GIT-ROOT, même s'ils n'ont pas le fichier git-daemon-export-ok.

     uri-path (par défaut : /git/)
          Préfixe du chemin pour l'accès Git.  Avec le préfixe /git/ par défaut, cela traduira http://SERVER/git/REPO.git en /sr/git/REPO.git.  Les requêtes dont les chemins d'URI ne commencent pas par ce préfixe ne seront pas passées à cette instance de Git.

     fcgiwrap-socket (par défaut : 127.0.0.1:9000)
          Le socket sur lequel le démon fcgiwrap écoute.  See Services web.

Il n'y a pas de git-http-service-type, actuellement ; à la place vous pouvez créer un nginx-location-configuration à partir d'un git-http-configuration puis ajouter cela au serveur web.

 -- Procédure Scheme: git-http-nginx-location-configuration
     [config=(git-http-configuration)]
     Calcule un nginx-location-configuration qui correspond à la configuration http Git donnée.  Voici un exemple de définition de service nginx qui sert le répertoire /srv/git par défaut en HTTPS :

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

     Ce exemple suppose que vous utilisez Let's Encrypt pour récupérer votre certificat TLS.  See Services de certificats.  Le service certbot par défaut redirigera tout le trafic HTTP de git.my-host.org en HTTPS. Vous devrez aussi ajouter un mandataire fcgiwrap à vos services systèmes.  See Services web.

Service Cgit
............

Cgit (https://git.zx2c4.com/cgit/) est une interface web pour des dépôts Git écrite en C.

L'exemple suivant configurera le service avec les valeurs par défaut.  Par défaut, on peut accéder à Cgit sur le port  (http://localhost:80).

     (service cgit-service-type)

Le type file-object désigne soit un objet simili-fichier (see file-like objects), soit une chaîne.

Les champs de cgit-configuration disponibles sont :

 -- paramètre de cgit-configuration: package package
     Le paquet cgit.

 -- paramètre de cgit-configuration: nginx-server-configuration-list nginx
     Configuration Nginx.

 -- paramètre de cgit-configuration: file-object about-filter
     Spécifie une commande qui doit être invoquée pour formater le contenu des pages « à propos » (au plus haut niveau et pour chaque dépôt).

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string agefile
     Spécifie un chemin, relativement à chaque dépôt, qui peut être utilisé pour spécifier la date et l'heure du plus récent commit du dépôt.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: file-object auth-filter
     Spécifie une commande qui sera invoquée pour authentifier l'accès au dépôt.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string branch-sort
     Drapeau qui, lorsqu'il vaut age, active le trie par date dans la liste des branches, et le trie par nom lorsqu'il vaut name.

     La valeur par défaut est "name".

 -- paramètre de cgit-configuration: string cache-root
     Chemin utilisé pour stocker les entrées de cache de cgit.

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

 -- paramètre de cgit-configuration: integer cache-static-ttl
     Nombre qui spécifie le temps de vie, en minute, des versions en cache des pages du dépôt accédées par leur SHA-1.

     La valeur par défaut est -1.

 -- paramètre de cgit-configuration: integer cache-dynamic-ttl
     Nombre qui spécifie le temps de vie, en minutes, des version en cache des pages du dépôt accédées sans leur SHA1.

     La valeur par défaut est 5.

 -- paramètre de cgit-configuration: integer cache-repo-ttl
     Nombre qui spécifie le temps de vie, en minute, des version en cache de la page de résumé du dépôt.

     La valeur par défaut est 5.

 -- paramètre de cgit-configuration: integer cache-root-ttl
     Nombre qui spécifie le temps de vie, en minutes, de la version en cache de la page d'index du dépôt.

     La valeur par défaut est 5.

 -- paramètre de cgit-configuration: integer cache-scanrc-ttl
     Nombre qui spécifie le temps de vie, en minutes, de la version en cache du résultat du scan d'un chemin dans le dépôt Git.

     La valeur par défaut est 15.

 -- paramètre de cgit-configuration: integer cache-about-ttl
     Nombre qui spécifie le temps de vie, en minutes, de la version en cache de la page « à propos » du dépôt.

     La valeur par défaut est 15.

 -- paramètre de cgit-configuration: integer cache-snapshot-ttl
     Nombre qui spécifie le temps de vie, en minutes, de la version en cache des archives.

     La valeur par défaut est 5.

 -- paramètre de cgit-configuration: integer cache-size
     Le nombre maximum d'entrées dans le cache de cgit.  Lorsque la valeur est 0, le cache est désactivé.

     La valeur par défaut est 0.

 -- paramètre de cgit-configuration: boolean case-sensitive-sort?
     Indique si le tri des éléments est sensible à la casse.

     La valeur par défaut est #t.

 -- paramètre de cgit-configuration: list clone-prefix
     Liste des préfixes communs qui, lorsqu'ils sont combinés à l'URL du dépôt, génèrent des URL de clone valides pour le dépôt.

     La valeur par défaut est ().

 -- paramètre de cgit-configuration: list clone-url
     Liste des modèles clone-url

     La valeur par défaut est ().

 -- paramètre de cgit-configuration: file-object commit-filter
     Commande qui sera invoquée pour formater les messages de commit.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string commit-sort
     Drapeau qui, s'il vaut date, active le tri par date strict dans le messages de commit, et le tri topologique strict lorsqu'il vaut topo.

     La valeur par défaut est "git log".

 -- paramètre de cgit-configuration: file-object css
     URL qui spécifie le document css à inclure dans les pages cgit.

     La valeur par défaut est "/share/cgit/cgit.css".

 -- paramètre de cgit-configuration: file-object email-filter
     Spécifie une commande qui sera invoquée pour formater les noms et l'adresse de courriel des commiteurs, des auteurs et des taggueurs, représentés à plusieurs endroits dans l'interface cgit.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: boolean embedded?
     Drapeau qui, s'il vaut #t, fera générer un fragment HTML à cgit qu'il sera possible d'inclure dans d'autres pages HTML.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-commit-graph?
     Drapeau qui, lorsqu'il vaut #t, fera afficher un historique en ASCII-art à gauche des messages de commit dans la page de log du dépôt.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-filter-overrides?
     Drapeau qui, lorsqu'il vaut #t, permet à tous les paramètres de filtrage d'être modifiés dans des fichiers cgitrc spécifiques au dépôt.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-follow-links?
     Drapeau qui, s'il vaut #t, permet aux utilisateurs de suivre un fichier dans la vue « log ».

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-http-clone?
     Si la valeur est #t, cgit agira comme un point d'accès HTTP idiot pour les clones Git.

     La valeur par défaut est #t.

 -- paramètre de cgit-configuration: boolean enable-index-links?
     Drapeau qui, s'il vaut #t, fera générer des liens « résumé », « commit » et « arborescence » supplémentaires poru chaque dépôt dans l'index des dépôts.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-index-owner?
     Drapeau qui, s'il vaut #t, fera afficher le propriétaire de chaque dépôt dans l'index des dépôts.

     La valeur par défaut est #t.

 -- paramètre de cgit-configuration: boolean enable-log-filecount?
     Drapeau qui, s'il vaut #t, fera afficher à cgit le nombre de fichiers modifiés pour chaque commit sur la page de log du dépôt.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-log-linecount?
     Drapeau qui, s'il vaut #t, fera afficher à cgit le nombre de lignes ajoutées et enlevées pour chaque commit de la page de log du dépôt.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-remote-branches?
     Drapeau qui, s'il vaut #t, fera afficher les branches distantes dans les vues du résumé et des références.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-subject-links?
     Drapeau qui, s'il vaut 1, fera utiliser à cgit le sujet du commit parent comme texte du lien lors de la génération des liens vers les commits parents dans la vue des commits.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-html-serving?
     Drapeau qui, s'il vaut #t, fera utiliser à cgit l esujet du commit parent comme texte du lien lors de la génération des liens vers le commit parent dans la vue des commits.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean enable-tree-linenumbers?
     Drapeau qui, s'il vaut #t, fera générer à cgit des liens vers le numéro de ligne pour les blobs en texte brut affichés dans la vue de l'arborescence.

     La valeur par défaut est #t.

 -- paramètre de cgit-configuration: boolean enable-git-config?
     Drapeau qui, s'il vaut #t, permettra à cgit d'utiliser la configuration Git pour spécifier des paramètres spécifiques au dépôt.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: file-object favicon
     URL utilisée comme lien vers un icône pour 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
     Le contenu du fichier spécifié dans cette option sera inclus directement dans la section HEAD HTML de toutes les pages.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string header
     Le contenu du fichier spécifié avec cette option sera inclus directement au début de toutes les pages.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: file-object include
     Nom d'un fichier de configuration à inclure avant que le reste du fichier de configuration actuel ne soit analysé.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string index-header
     Le contenu du fichier spécifié avec cette option sera inclus directement au dessus de l'index des dépôts.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string index-info
     Le contenu du fichier spécifié avec cette option sera inclus directement en dessous de l'en-tête sur la page d'index du dépôt.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: boolean local-time?
     Drapeau qui, s'il vaut #t, fera afficher à cgit l'heure et la date de commit et de tag dans le fuseau horaire du serveur.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: file-object logo
     URL qui spécifie la source d'une image utilisé comme logo sur toutes les pages cgit.

     La valeur par défaut est "/share/cgit/cgit.png".

 -- paramètre de cgit-configuration: string logo-link
     URL chargée lors du clic sur l'image du logo de cgit.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: file-object owner-filter
     Commande qui sera invoquée pour formater la colonne propriétaire sur la page principale.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: integer max-atom-items
     Nombre d'éléments à afficher dans la vue des flux atom.

     La valeur par défaut est 10.

 -- paramètre de cgit-configuration: integer max-commit-count
     Nombre d'éléments à lister par page dans la vue « log ».

     La valeur par défaut est 50.

 -- paramètre de cgit-configuration: integer max-message-length
     Nombre caractères de messages de commit à afficher dans la vue « log ».

     La valeur par défaut est 80.

 -- paramètre de cgit-configuration: integer max-repo-count
     Spécifie le nombre d'éléments à lister par page sur la page de l'index des dépôts.

     La valeur par défaut est 50.

 -- paramètre de cgit-configuration: integer max-repodesc-length
     Spécifie le nombre maximum de caractères de description de dépôts à afficher sur la page d'index des dépôts.

     La valeur par défaut est 80.

 -- paramètre de cgit-configuration: integer max-blob-size
     Spécifie la taille maximale d'un blob pour lequel afficher du HTML en kilo-octets.

     La valeur par défaut est 0.

 -- paramètre de cgit-configuration: string max-stats
     Période de statistiques maximale.  Les valeurs valides sont week, month, quarter et year.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: mimetype-alist mimetype
     Type mime pour l'extension de fichier spécifiée.

     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
     Spécifie le fichier à utiliser pour la recherche automatique de type mime.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string module-link
     Texte qui sera utilisé comme chaîne de formatage pour un lien hypertexte lorsqu'un sous-module est affiché dans la liste du répertoire.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: boolean nocache?
     Si la valeur est #t, le cache est désactivé.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean noplainemail?
     Si la valeur est #t, l'affichage des adresse de courriel des auteurs sera désactivé.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: boolean noheader?
     Drapeau qui, s'il vaut #t, fera omettre à cgit l'en-tête standard sur toutes les pages.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: project-list project-list
     UNe liste de sous-répertoires dans repository-directory, relativement à lui, qui devrait être chargé comme des dépôts Git.  Une liste vide signifie que tous les sous-répertoires seront chargés.

     La valeur par défaut est ().

 -- paramètre de cgit-configuration: file-object readme
     Texte utilisé comme valeur par défaut pour cgit-repo-readme.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: boolean remove-suffix?
     Si la valeur est #t et que repository-directory est activé, si un dépôt avec un suffixe de .git est trouvé, ce suffixe sera supprimé de l'URL et du nom.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: integer renamelimit
     Nombre maximum de fichiers à considérer lors de la détection des renommages.

     La valeur par défaut est -1.

 -- paramètre de cgit-configuration: string repository-sort
     La manière dont les dépôt de chaque section sont rangés.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: robots-list robots
     Texte utilisé comme contenu du méta-attribut robots.

     La valeur par défaut est ("noindex" "nofollow").

 -- paramètre de cgit-configuration: string root-desc
     Texte affiché en dessous de l'en-tête de la page d'index des dépôts.

     La valeur par défaut est "a fast webinterface for the git dscm".

 -- paramètre de cgit-configuration: string root-readme
     Le contenu du fichier spécifié avec cette option sera inclus directement en dessous du lien « à propos » sur la page d'index du dépôt.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string root-title
     Texte affiché sur la page d'index des dépôts.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: boolean scan-hidden-path
     Si la valeur est #t et que repository-directory est activé, repository-directory recherchera de manière récursive dans les répertoires dont le nom commence par un point.  Sinon, repository-directory restera hors de ces répertoires, considérés comme « cachés ».  Remarquez que cela ne s'applique pas au répertoire « .git » dans le dépôts.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: list snapshots
     Texte qui spécifie l'ensemble des formats d'archives par défaut pour lesquelles cgit générera un lien.

     La valeur par défaut est ().

 -- paramètre de cgit-configuration: repository-directory repository-directory
     Nom du répertoire à scanner pour trouver les dépôts (représente scan-path).

     La valeur par défaut est "/srv/git".

 -- paramètre de cgit-configuration: string section
     Le nom de la section de dépôts actuelle — tous les dépôts définis après ce point hériterons du nom de section actuel.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string section-sort
     Drapeau qui, s'il vaut 1, triera les sections dans la liste des dépôts par nom.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: integer section-from-path
     Un nombre qui, s'il est défini avant repository-directory, spécifier combien d'éléments de chemin de chaque chemin de dépôt utiliser comme nom de section par défaut.

     La valeur par défaut est 0.

 -- paramètre de cgit-configuration: boolean side-by-side-diffs?
     Si la valeur est #t, afficher des diffs côte à côte au lieu des unidiffs par défaut.

     La valeur par défaut est #f.

 -- paramètre de cgit-configuration: file-object source-filter
     Spécifie une commande qui sera invoquée pour formater les blobs en texte brut dans la vue de l'arborescence.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: integer summary-branches
     Spécifie le nombre de branches à afficher dans la vue de résumé du dépôt.

     La valeur par défaut est 10.

 -- paramètre de cgit-configuration: integer summary-log
     Spécifie le nombre d'élément du journal à afficher dans la vue résumé du dépôt.

     La valeur par défaut est 10.

 -- paramètre de cgit-configuration: integer summary-tags
     Spécifie le nombre de tags à afficher dans la vue résumé du dépôt.

     La valeur par défaut est 10.

 -- paramètre de cgit-configuration: string strict-export
     Nom de fichier qui, s'il est spécifié, doit être présent dans le dépôt pour que cgit accorde l'accès à ce dépôt.

     La valeur par défaut est "".

 -- paramètre de cgit-configuration: string virtual-root
     URL qui, si elle est spécifiée, sera utilisée comme racine pour tous les liens cgit.

     La valeur par défaut est "/".

 -- paramètre de cgit-configuration: repository-cgit-configuration-list repositories
     Une liste d'enregistrements cgit-repo à utiliser avec config.

     La valeur par défaut est ().

     Les champs de repository-cgit-configuration disponibles sont :

      -- paramètre de repository-cgit-configuration: repo-list snapshots
          Un masque de formats d'archives pour ce dépôt pour lesquelles cgit générera un lien, restreint par le paramètre snapshots global.

          La valeur par défaut est ().

      -- paramètre de repository-cgit-configuration: repo-file-object source-filter
          Modifie le source-filter par défaut.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string url
          URL relative utilisée pour accéder au dépôt.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-file-object about-filter
          Modifie le paramètre about-filter par défaut.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string branch-sort
          Drapeau qui, s'il vaut age, active le tri par date dans la liste des branches, et lorsqu'il vaut name, le tri par nom.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-list clone-url
          Un liste d'URL qui peuvent être utilisées pour cloner ce dépôt.

          La valeur par défaut est ().

      -- paramètre de repository-cgit-configuration: repo-file-object commit-filter
          Modifie le paramètre commit-filter par défaut.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string commit-sort
          Drapeau qui, s'il vaut date, active le tri par date strict dans le messages de commit, et le tri topologique strict lorsqu'il vaut topo.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string defbranch
          Le nom de la branche par défaut de ce dépôt.  Si cette branche n'existe pas dans le dépôt, le premier nom de branche (trié) sera utilisé par défaut. Par défaut la branche pointée par HEAD, ou « master » s'il n'y a pas de HEAD convenable.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string desc
          La valeur à afficher comme description du dépôt.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string homepage
          La valeur à afficher comme page d'accueil du dépôt.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-file-object email-filter
          Modifie le paramètre email-filter par défaut.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: maybe-repo-boolean enable-commit-graph?
          Un drapeau qui peut être utilisé pour désactiver le paramètre enable-commit-graph? global.

          La valeur par défaut est disabled.

      -- paramètre de repository-cgit-configuration: maybe-repo-boolean enable-log-filecount?
          Un drapeau qui peut être utilisé pour désactiver le paramètre enable-log-filecount? global.

          La valeur par défaut est disabled.

      -- paramètre de repository-cgit-configuration: maybe-repo-boolean enable-log-linecount?
          Un drapeau qui peut être utilisé pour désactiver le paramètre enable-log-linecount? global.

          La valeur par défaut est disabled.

      -- paramètre de repository-cgit-configuration: maybe-repo-boolean enable-remote-branches?
          Drapeau qui, s'il vaut #t, fera afficher les branches distantes dans les vues du résumé et des références.

          La valeur par défaut est disabled.

      -- paramètre de repository-cgit-configuration: maybe-repo-boolean enable-subject-links?
          Un drapeau qui peut être utilisé pour modifier le paramètre enable-subject-links? global.

          La valeur par défaut est disabled.

      -- paramètre de repository-cgit-configuration: maybe-repo-boolean enable-html-serving?
          Un drapeau qui peut être utilisé pour modifier le paramètre enable-html-serving? global.

          La valeur par défaut est disabled.

      -- paramètre de repository-cgit-configuration: repo-boolean hide?
          Drapeau qui, s'il vaut #t, cache le dépôt de l'index des dépôts.

          La valeur par défaut est #f.

      -- paramètre de repository-cgit-configuration: repo-boolean ignore?
          Drapeau qui, s'il vaut #t,  ignore le dépôt.

          La valeur par défaut est #f.

      -- paramètre de repository-cgit-configuration: repo-file-object logo
          URL qui spécifie la source d'une image qui sera utilisée comme logo sur les pages de ce dépôt.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string logo-link
          URL chargée lors du clic sur l'image du logo de cgit.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-file-object owner-filter
          Modifie le paramètre owner-filter par défaut.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string module-link
          Texte qui sera utilisé comme chaîne de formatage pour un lien hypertexte lorsqu'un sous-module est affiché dans une liste de fichiers.  Les arguments pour la chaîne de formatage sont le chemin et le SHA1 du commit du sous-module.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: module-link-path module-link-path
          Texte qui sera utilisé comme chaîne de formatage lorsqu'un sous-module avec un chemin spécifié sera affiché dans une liste de fichiers.

          La valeur par défaut est ().

      -- paramètre de repository-cgit-configuration: repo-string max-stats
          Modifie la période de statistique maximale par défaut.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string name
          La valeur à afficher comme nom de dépôt.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string owner
          Une valeur utilisée pour identifier le propriétaire du dépôt.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string path
          Un chemin absolu vers le répertoire du dépôt.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string readme
          Un chemin (relatif au dépôt) qui spécifie un fichier à inclure directement comme page « À propos » pour ce dépôt.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-string section
          Le nom de la section de dépôts actuelle — tous les dépôts définis après ce point hériterons du nom de section actuel.

          La valeur par défaut est "".

      -- paramètre de repository-cgit-configuration: repo-list extra-options
          Options supplémentaires ajoutées à la fin du fichier cgitrc.

          La valeur par défaut est ().

 -- paramètre de cgit-configuration: list extra-options
     Options supplémentaires ajoutées à la fin du fichier cgitrc.

     La valeur par défaut est ().

Cependant, vous pourriez vouloir simplement récupérer un cgitrc et l'utiliser.  Dans ce cas, vous pouvez passer un opaque-cgit-configuration comme enregistrement à cgit-service-type.  Comme son nom l'indique, une configuration opaque n'a pas de capacité de réflexion facile.

Les champs de opaque-cgit-configuration disponibles sont :

 -- paramètre de opaque-cgit-configuration: package cgit
     Le paquet cgit.

 -- paramètre de opaque-cgit-configuration: string string
     Le contenu de cgitrc, en tant que chaîne de caractère.

Par exemple, si votre cgitrc est juste la chaîne vide, vous pouvez instancier un service cgit ainsi :

     (service cgit-service-type
              (opaque-cgit-configuration
               (cgitrc "")))

Service Gitolite
................

Gitolite (http://gitolite.com/gitolite/) est un outil pour héberger des dépôts Git sur un serveur central.

Gitolite peut gérer plusieurs dépôts et utilisateurs et supporte une configuration flexible des permissions pour les utilisateurs sur ces dépôts.

L'exemple suivant configure Gitolite en utilisant l'utilisateur git par défaut et la clef SSH fournie.

     (service gitolite-service-type
              (gitolite-configuration
                (admin-pubkey (plain-file
                                "yourname.pub"
                                "ssh-rsa AAAA... guix@example.com"))))

Gitolite est configuré via un dépôt d'administration spécial que vous pouvez cloner.  Par exemple, si vous hébergez Gitolite sur example.com, vous pouvez lancer la commande suivante pour cloner le dépôt d'administration :

     git clone git@example.com:gitolite-admin

Lorsque le service Gitolite est activé, la clef admin-pubkey fournie sera insérée dans le répertoire keydir du dépôt gitolite-admin.  Si cela change le dépôt, un commit sera effectué avec le message « gitolite setup by GNU Guix ».

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

     package (par défaut : GITOLITE)
          Le paquet Gitolite à utiliser.

     user (par défaut : GIT)
          Utilisateur pour utiliser Gitolite.  Cela sera l'utilisateur à utiliser pour accéder à Gitolite par SSH.

     group (par défaut : GIT)
          Groupe à utiliser pour Gitolite.

     home-directory (par défaut : "/VAR/LIB/GITOLITE")
          Répertoire dans lequel stocker la configuration et les dépôts de Gitolite.

     rc-file (par défaut : (GITOLITE-RC-FILE))
          Un objet « simili-fichier » (see file-like objects) représentant la configuration de Gitolite.

     admin-pubkey (par défaut : #F)
          Un objet « simili-fichier » (see file-like objects) utilisé pour paramétrer Gitolite.  Il sera inséré dans le répertoire keydir dans le dépôt gitolite-admin.

          Pour spécifier la clef SSH comme chaîne de caractère, utilisez la fonction plain-file.

               (plain-file "yourname.pub" "ssh-rsa AAAA... guix@example.com")

 -- Type de données: gitolite-rc-file
     Type de données représentant le fichier RC de Gitolite.

     umask (par défaut : #o0077)
          Cela contrôle les permissions que Gitolite propose sur les dépôts et leur contenu.

          Une valeur comme #o0027 donnera accès en lecture au groupe utilisé par Gitolite (par défaut : git).  Cel aest nécessaire lorsque vous utilise Gitolite avec un logiciel comme cgit ou gitweb.

     git-config-keys (par défaut : "")
          Gitolite vous permet de modifier les configurations git avec le mot-clef « config ».  Ce paramètre vous permet de contrôler les clefs de configuration acceptables.

     roles (par défaut : '(("READERS" . 1) ("WRITERS" . )))
          Indique les noms des rôles qui peuvent être utilisés par les utilisateurs avec la commande perms.

     enable (par défaut : '("help" "desc" "info" "perms" "writable" "ssh-authkeys" "git-config" "daemon" "gitweb"))
          Ce paramètre contrôle les commandes et les fonctionnalités à activer dans Gitolite.

Services de jeu
---------------

Le service de la Bataille pour Wesnoth
......................................

La Bataille pour Wesnoth (https://wesnoth.org) est un jeu de stratégie en tour par tour dans un univers fantastique, avec plusieurs campagnes solo et des parties multijoueurs (en réseau et en local).

 -- Variable: Variable Scheme wesnothd-service-type
     Type de service pour le service wesnothd.  Sa valeur doit être un objet wesnothd-configuration.  Pour lancer wesnothd avec la configuration par défaut, instanciez-le ainsi :

          (service wesnothd-service-type)

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

     package (par défaut : wesnoth-server)
          Le paquet de serveur de wesnoth à utiliser.

     port (par défaut : 15000)
          Le pour sur lequel lier le serveur.

Services divers
---------------

Service d'empreintes digitales
..............................

Le module (gnu services fingerprint) fournit un service DBus pour lire et identifier les empreintes digitales via un lecteur d'empreinte.

 -- Variable Scheme: fprintd-service-type
     Le type de service pour fprintd, qui fournit des capacités de lecture d'empreinte.

          (service fprintd-service-type)

Service de contrôle du système
..............................

Le module (gnu services sysctl) fournit un service pour configurer les paramètres du noyau au démarrage.

 -- Variable Scheme: sysctl-service-type
     Le type de service pour sysctl, qui modifie les paramètres du noyau dans /proc/sys/.  Pour activer le transfert d'IPv4, vous pouvez l'instancier ainsi :

          (service sysctl-service-type
                   (sysctl-configuration
                     (settings '(("net.ipv4.ip_forward" . "1")))))

 -- Type de données: sysctl-configuration
     Le type de données représentant la configuration de sysctl.

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

     settings (par défaut : '())
          Une liste d'association spécifiant les paramètres du noyau et leur valeur.

Service du démon PC/SC Smart Card
.................................

Le module (gnu services security-token) fournit le service suivant qui lance pcscd, le démon PC/SC Smart Card.  pcscd est le démon pour  pcsc-lite et MuscleCard.  C'est un gestionnaire de ressource qui coordonne les communications avec les lecteurs de smart cards, les smart cards et les jetons cryptographiques connectés au système.

 -- Variable Scheme: pcscd-service-type
     Le type de service pour le service pcscd.  Sa valeur doit être un objet pcscd-configuration.  Pour lancer pcscd dans sa configuration par défaut, instantiez-le avec :

          (service pcscd-service-type)

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

     pcsc-lite (par défaut : pcsc-lite)
          Le paquet pcsc-lite qui fournit pcscd.

     usb-drivers (par défaut : (list ccid))
          Liste des paquets qui fournissent des pilotes USB à pcscd.  Les pilotes doivent être dans pcsc/drivers dans le répertoire du dépôt du paquet.

Service Lirc
............

Le module (gnu services lirc) fournit le service suivant.

 -- Procédure Scheme: lirc-service [#:lirc lirc]
     [#:device #f] [#:driver #f] [#:config-file #f]
     [#:extra-options '()]
     Renvoie un service qui lance LIRC (http://www.lirc.org), un démon qui décode les signaux infrarouges des télécommandes.

     Éventuellement, DEVICE, DRIVER et CONFIG-FILE (le nom du fichier de configuration) peuvent être spécifiés.  Voir le manuel de lircd pour plus de détails.

     Enfin, EXTRA-OPTIONS est une liste d'options de la ligne de commande supplémentaires à passer à lircd.

Service Spice
.............

Le module (gnu services spice) fournit le service suivant.

 -- Procédure Scheme: spice-vdagent-service [#:spice-vdagent]
     Renvoie un service qui lance VDAGENT (http://www.spice-space.org), un démon qui permet le partage du presse-papier avec une vm et de configurer la résolution d'affichage du client lorsque la fenêtre de la console graphique est redimensionnée.

Services de dictionnaires
-------------------------

Le module (gnu services dict) fournit le service suivant :

 -- Procédure Scheme: dicod-service [#:config (dicod-configuration)]
     Renvoie un service qui lance le démon dicod, une implémentation du serveur DICT (see Dicod (GNU Dico Manual)).

     L'argument CONFIG facultatif spécifie la configuration pour dicod, qui devrait être un objet <dicod-configuration>, par défaut il sert le dictionnaire international collaboratif de GNU pour l'anglais.

     Vous pouvez ajouter open localhost à votre fichier ~/.dico pour faire de localhost le serveur par défaut du client dico (see Initialization File (GNU Dico Manual)).

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

     dico (par défaut : DICO)
          Objet de paquet du serveur de dictionnaire GNU Dico.

     interfaces (par défaut : '("LOCALHOST"))
          C'est la liste des adresses IP et des ports et éventuellement des noms de fichiers de socket sur lesquels écouter (see listen directive (GNU Dico Manual)).

     handlers (par défaut : '())
          Liste des objets <dicod-handler> qui définissent des gestionnaires (des instances de modules).

     databases (par défaut : (LIST %DICOD-DATABASE:GCIDE))
          Liste d'objets <dicod-database> qui définissent des dictionnaires à servir.

 -- Type de données: dicod-handler
     Type de données représentant un gestionnaire de dictionnaire (instance de module).

     name
          Nom du gestionnaire (instance de module).

     module (par défaut : #F)
          Nom du module dicod du gestionnaire (instance).  Si la valeur est #f, le module a le même nom que le gestionnaire.  (see Modules (GNU Dico Manual)).

     options
          Liste de chaînes ou de gexps représentant les arguments pour le gestionnaire de module.

 -- Type de données: dicod-database
     Type de données représentant une base de données de dictionnaire.

     name
          Nom de la base de données, qui sera utilisée dans les commande DICT.

     handler
          Nom du gestionnaire dicod (instance de module) utilisé par cette base de données (see Handlers (GNU Dico Manual)).

     complex? (par défaut : #F)
          Indique si la configuration est pour une base de données complexe.  La configuration complexe a besoin d'un objet <dicod-handler> correspondant, sinon inutile.

     options
          Liste de chaînes ou de gexps représentant les arguments pour la base de données (see Databases (GNU Dico Manual)).

 -- Variable Scheme: %dicod-database:gcide
     Un objet <dicod-database> servant le dictionnaire international collaboratif en anglais via le paquet gcide.

Voici un exemple de configuration de dicod-service.

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

Docker Service
..............

The (gnu services docker) module provides the following service.

 -- Scheme Variable: docker-service-type

     This is the type of the service that runs Docker (http://www.docker.com), a daemon that can execute application bundles (sometimes referred to as ``containers'') in isolated environments.

 -- Data Type: docker-configuration
     This is the data type representing the configuration of Docker and Containerd.

     package (default: docker)
          The Docker package to use.

     containerd (default: CONTAINERD)
          The Containerd package to use.

Programmes setuid
=================

Certains programmes doivent être lancés avec les privilèges « root » même lorsqu'ils sont lancés par un utilisateur non privilégié.  Un exemple notoire est le programme passwd, que les utilisateurs peuvent appeler pour modifier leur mot de passe et qui doit accéder à /etc/passwd et /etc/shadow — ce qui est normalement réservé à root, pour des raisons de sécurité évidentes.  Pour contourner cela, ces exécutables sont setuid-root, ce qui signifie qu'ils seront toujours lancés avec les privilèges root (see How Change Persona (The GNU C Library Reference Manual), pour plus d'informations sur le mécanisme setuid).

Le dépôt lui-même ne peut pas contenir de programmes setuid ; cela serait un problème de sécurité puisque n'importe quel utilisateur du système peut écrire une dérivation qui rempli le dépôt (see Le dépôt).  Donc, un mécanisme différent est utilisé : au lieu de changer le bit setuid directement sur les fichiers qui sont dans le dépôt, nous laissons à l'administrateur système le soit de déclarer les programmes qui devraient être setuid root.

Le champ setuid-programs d'une déclaration operating-system contient une liste de G-expressions qui dénotent les noms des programmes à rendre setuid-root (see Utiliser le système de configuration).  Par exemple, le programme passwd, qui fait partie du paquet Shadow, peut être désigné par cette G-expression (see G-Expressions) :

     #~(string-append #$shadow "/bin/passwd")

Un ensemble de programmes par défaut est défini par la variable %setuid-programs du module (gnu system).

 -- Variable Scheme: %setuid-programs
     Une liste de G-expressions qui dénotent les programmes communément setuid-root.

     La liste inclus des commandes comme passwd, ping, su et sudo.

Sous le capot, les programmes setuid sont créés dans le répertoire /run/setuid-programs au moment de l'activation du système.  Les fichiers dans ce répertoire se réfèrent aux « vrais » binaires, qui sont dans le dépot.

Certificats X.509
=================

Les serveurs web disponibles par HTTPS (c'est-à-dire HTTP sur le mécanisme de la couche de transport sécurisée, TLS) envoient aux clients un certificat X.509 que les clients peuvent utiliser pour authentifier le serveur.  Pour cela, les clients vérifient que le certificat du serveur est signé par une autorité de certification (AC ou CA).  Mais pour vérifier la signature de la CA, les clients doivent d'abord avoir récupéré le certificat de la CA.

Les navigateurs web comme GNU IceCat incluent leur propre liste de certificats, pour qu'ils puissent vérifier les signatures des CA directement.

Cependant, la plupart des autres programmes qui peuvent parler HTTPS — wget, git, w3m, etc — doivent savoir où trouver les certificats des CA.

In Guix, 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).  Guix includes one such package, nss-certs, which is a set of CA certificates provided as part of Mozilla's Network Security Services.

Remarquez qu'il ne fait pas partie de %BASE-PACKAGES, donc vous devez explicitement l'ajouter.  Le répertoire /etc/ssl/certs, là où la plupart des applications et bibliothèques vont rechercher les certificats par défaut, pointe vers les certificats installés globalement.

Les utilisateurs non privilégiés, dont les utilisateurs de Guix sur une distro externe, peuvent aussi installer leur propre paquet de certificats dans leur profil.  Un certain nombre de variables d'environnement doivent être définies pour que les applications et les bibliothèques puissent les trouver.  En particulier, la bibliothèque OpenSSL honore les variables SSL_CERT_DIR et SSL_CERT_FILE.  Certaines applications ajoutent leurs propres variables, par exemple le système de contrôle de version Git honore le lot de certificats pointé par la variable d'environnement GIT_SSL_CAINFO.  Ainsi, vous lanceriez quelque chose comme ceci :

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

Un autre exemple serait R, qui requière que la variable d'environnement CURL_CA_BUNDLE pointe sur le lot de certificats, donc vous lanceriez quelque chose comme ceci :

     $ guix package -i nss-certs
     $ export CURL_CA_BUNDLE="$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt"

Pour d'autres applications vous pourriez avoir besoin de chercher la variable d'environnement requise dans leur documentation.

Name Service Switch
===================

Le module (gnu system nss) fournit des liaisons pour le fichier de configuration du name service switch ou NSS de la libc (see NSS Configuration File (The GNU C Library Reference Manual)).  En résumé, NSS est un mécanisme qui permet à la libc d'être étendue avec de nouvelles méthodes de résolution de « noms » dans les bases de données du système, comme les noms d'hôtes, les noms des services, les comptes utilisateurs et bien plus (see System Databases and Name Service Switch (The GNU C Library Reference Manual)).

La configuration de NSS spécifie, pour chaque base de données du système, quelle méthode de résolution utiliser, et comment les diverses méthodes sont enchaînées — par exemple, sous certaines circonstances, NSS devrait essayer la méthode suivante de la liste.  La configuration de NSS est donnée dans le champ name-service-switch de la déclaration operating-system (see name-service-switch).

Par exemple, la déclation ci-dessous configure NSS pour utiliser le moteur nss-mdns (http://0pointer.de/lennart/projects/nss-mdns/), qui supporte la résolution de nom d'hôte sur le DNS multicast (mDNS) pour les noms d'hôtes terminant par .local :

     (name-service-switch
        (hosts (list %files    ;first, check /etc/hosts

                     ;; Si ce qui précède n'a pas fonctionné, essayer
                     ;; avec « mdns_minimal ».
                     (name-service
                       (name "mdns_minimal")

                       ;; « mdns_minimal » fait autorité pour
                       ;; « .local ».  Lorsqu'il renvoie « pas trouvé »,
                       ;; inutile d'essayer la méthode suivante.
                       (reaction (lookup-specification
                                  (not-found => return))))

                     ;; Puis revenir sur DNS.
                     (name-service
                       (name "dns"))

                     ;; Enfin, essayer avec « mdns complet ».
                     (name-service
                       (name "mdns")))))

Ne vous inquiétez pas : la variable %mdns-host-lookup-nss (voir plus bas) contient cette configuration, donc vous n'avez pas besoin de tout taper si vous voulez simplement que la résolution de nom en .local fonctionne.

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-type (see avahi-service-type), 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).

Pour votre confort, les variables suivantes contiennent des configurations NSS typiques.

 -- Variable Scheme: %default-nss
     C'est la configuration NSS par défaut, un objet name-service-switch.

 -- Variable Scheme: %mdns-host-lookup-nss
     C'est la configuration NSS avec le support de la résolution de noms sur DNS multicast (mDNS) pour les noms d'hôtes en .local.

La référence pour la configuration de NSS est donnée ci-dessous.  C'est une correspondance directe avec le format de fichier de la bibliothèque C, donc référez-vous au manuel de la bibliothèque C pour plus d'informations (see NSS Configuration File (The GNU C Library Reference Manual)).  Comparé au format de fichier de configuration de NSS, cette configuration a l'avantage non seulement d'ajouter ces bonnes vieilles parenthèses, mais aussi des vérifications statiques ; vous saurez s'il y a des erreurs de syntaxe et des coquilles dès que vous lancerez guix system.

 -- Type de données: name-service-switch

     C'est le type de données représentant la configuration de NSS.  Chaque champ ci-dessous représente l'un des système de bases de données supportés.

     aliases
     ethers
     group
     gshadow
     hosts
     initgroups
     netgroup
     networks
     password
     public-key
     rpc
     services
     shadow
          Les bases de données du système gérées par NSS.  Chaque champ doit être une liste d'objets <name-service> (voir plus bas).

 -- Type de données: name-service

     C'est le type de données représentant un service de noms et l'action de résolution associée.

     name
          Une chaîne dénotant le service de nom (see Services in the NSS configuration (The GNU C Library Reference Manual)).

          Remarquez que les services de dnoms listés ici doivent être visibles à nscd.  Cela se fait en passant la liste des paquets fournissant les services de noms à l'argument #:name-services de nscd-service (see nscd-service).

     reaction
          Une action spécifiée par la macro lookup-specification (see Actions in the NSS configuration (The GNU C Library Reference Manual)).  Par exemple :

               (lookup-specification (unavailable => continue)
                                     (success => return))

Disque de RAM initial
=====================

Pour le démarrage, on passe au noyau Linux-Libre un disque de RAM initial ou initrd.  Un initrd contient un système de fichier racine temporaire ainsi qu'un script d'initialisation.  Ce dernier est responsable du montage du vrai système de fichier racine et du chargement des modules du noyau qui peuvent être nécessaires à cette tâche.

Le champ initrd-modules d'une déclaration operating-system vous permet de spécifier les modules du noyau Linux-Libre qui doivent être disponibles dans l'initrd.  En particulier, c'est là où vous devez lister les modules requis pour effectivement piloter le disque dur où se trouve la partition racine — bien que la valeur par défaut de initrd-modules couvre la plupart des cas.  Par exemple, en supposant que vous ayez besoin du module megaraid_sas en plus des modules par défaut pour accéder à votre système de fichiers racine, vous écririez :

     (operating-system
       ;; ...
       (initrd-modules (cons "megaraid_sas" %base-initrd-modules)))

 -- Variable Scheme: %base-initrd-modules
     C'est la liste des modules du noyau inclus dans l'initrd par défaut.

En plus, si vous avez besoin de paramétrages plus bas niveau, le champ initrd d'une déclaration operating-system vous permet de spécifier quel initrd vous voudriez utiliser.  Le module (gnu system linux-initrd) fournit trois manières de construire un initrd : la procédure base-initrd de haut niveau et les procédures raw-initrd et expression->initrd de bas niveau.

La procédure base-initrd est conçue pour couvrir la plupart des usages courants.  Par exemple, si vous voulez ajouter des modules du noyau à charger au démarrage, vous pouvez définir le champ initrd de votre déclaration de système d'exploitation ainsi :

     (initrd (lambda (file-systems . rest)
               ;; Crée un initrd standard mais paramètre le réseau
               ;; avec les paramètres que QEMU attend par défaut.
               (apply base-initrd file-systems
                      #:qemu-networking? #t
                      rest)))

La procédure base-initrd gère aussi les cas d'utilisation courants qui concernent l'utilisation du système comme client QEMU, ou comme un système « live » avec un système de fichier racine volatile.

La procédure base-initrd est construite à partir de la procédure raw-initrd.  Contrairement à base-initrd, raw-initrd ne fait rien à haut-niveau, comme essayer de deviner les modules du noyau et les paquets qui devraient être inclus dans l'initrd.  Un exemple d'utilisation de raw-initrd serait si un utilisateur a une configuration personnalisée du noyau Linux et que les modules du noyau inclus par défaut par base-initrd ne sont pas disponibles.

Le disque de RAM initial produit par base-initrd ou raw-initrd honore plusieurs options passées par la ligne de commande du noyau Linux (c'est-à-dire les arguments passés via la commande linux de GRUB ou l'option -append de QEMU), notamment :

--load=BOOT
     Dit au disque de RAM initial de charger BOOT, un fichier contenant un programme Scheme, une fois qu'il a monté le système de fichier racine.

     Guix 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
     Monte ROOT comme système de fichier racine.  ROOT peut être un nom de périphérique comme /dev/sda1, une étiquette de système de fichiers ou un UUID de système de fichiers.

--system=SYSTÈME
     S'assure que /run/booted-system et /run/current-system pointent vers SYSTEM.

modprobe.blacklist=MODULES...
     Dit au disque de RAM initial ainsi qu'à la commande modprobe (du paquet kmod) de refuser de charger MODULES.  MODULES doit être une liste de noms de modules séparés par des virgules — p. ex. usbkbd,9pnet.

--repl
     Démarre une boucle lecture-évaluation-affichage (REPL) depuis le disque de RAM initial avant qu'il n'essaye de charger les modules du noyau et de monter le système de fichiers racine.  Notre équipe commerciale appelle cela boot-to-Guile.  Le Schemeur en vous va adorer.  See Using Guile Interactively (GNU Guile Reference Manual), pour plus d'information sur le REPL de Guile.

Maintenant que vous connaissez toutes les fonctionnalités des disques de RAM initiaux produits par base-initrd et raw-initrd, voici comment l'utiliser le personnalisé plus avant.

 -- Procédure Scheme: raw-initrd FILE-SYSTEMS
     [#:linux-modules '()] [#:mapped-devices '()]
     [#:helper-packages '()] [#:qemu-networking? #f] [#:volatile-root? #f]
     Renvoie une dérivation qui construit un initrd.  FILE-SYSTEMS est une liste de systèmes de fichiers à monter par l'initrd, éventuellement en plus du système de fichier racine spécifié sur la ligne de commande du noyau via --root.  LINUX-MODULES est une liste de modules du noyau à charger au démarrage.  MAPPED-DEVICES est une liste de correspondances de périphériques à réaliser avant que les FILE-SYSTEMS ne soient montés (see Périphériques mappés).  HELPER-PACKAGES est une liste de paquets à copier dans l'initrd.  Elle peut inclure e2fsck/static ou d'autres paquets requis par l'initrd pour vérifier le système de fichiers racine.

     Lorsque QEMU-NETWORKING? est vrai, paramètre le réseau avec les paramètres QEMU standards.  Lorsque VIRTIO? est vrai, charge des modules supplémentaires pour que l'initrd puisse être utilisé comme client QEMU avec les pilotes I/O para-virtualisés.

     Lorsque VOLATILE-ROOT? est vrai, le système de fichier racine est inscriptible mais tous les changements seront perdus.

 -- Procédure Scheme: base-initrd FILE-SYSTEMS
     [#:mapped-devices '()] [#:qemu-networking? #f] [#:volatile-root? #f]
     [#:linux-modules '()]
     Renvoie un objet simili-fichier contenant un initrd générique, avec les modules du noyau de LINUX.  FILE-SYSTEMS est une liste de systèmes de fichiers à monter par l'initrd, éventuellement en plus du système de fichiers racine spécifié sur la ligne de commande du noyau via --root.  MAPPED-DEVICES est une liste de correspondances de périphériques à réaliser avant de monter les FILE-SYSTEMS.

     QEMU-NETWORKING? et VOLATILE-ROOT? se comportent comme pour raw-initrd.

     L'initrd est automatiquement remplie avec tous les modules du noyau requis pour FILE-SYSTEMS et pour les options données.  On peut lister des modules supplémentaires dans LINUX-MODULES.  Ils seront ajoutés à l'initrd et chargés au démarrage dans l'ordre dans lequel ils apparaissent.

Inutile de le dire, les initrds que nous produisons et utilisons incluent une version de Guile liée statiquement, et le programme d'initialisation est un programme Guile.  Cela donne beaucoup de flexibilité.  La procédure expression->initrd construit un tel initrd, étant donné le programme à lancer dans cet initrd.

 -- Procédure Scheme: expression->initrd EXP
     [#:guile %guile-static-stripped] [#:name "guile-initrd"]
     Renvoie un objet simili-fichier contenant un initrd Linux (une archive cpio compressée avec gzip) contenant GUILE et qui évalue EXP, une G-expression, au démarrage.  Toutes les dérivations référencées par EXP sont automatiquement copiées dans l'initrd.

Configuration du chargeur d'amorçage
====================================

Le système d'exploitation supporte plusieurs chargeurs d'amorçage.  La configuration du chargeur d'amorçage se fait avec la déclaration bootloader-configuration.  Tous les champs de cette structure sont indépendants du chargeur d'amorçage sauf un, bootloader qui indique le chargeur d'amorçage à configurer et à installer.

Certains chargeurs d'amorçage ne respectent pas tous les champs de bootloader-configuration.  Par exemple, le chargeur d'amorçage extlinux ne supporte pas les thèmes et ignore donc le champ theme.

 -- Type de données: bootloader-configuration
     Le type d'une déclaration de configuration de chargeur d'amorçage.

     bootloader
          Le chargeur d'amorçage à utiliser, comme objet bootloader.  Pour l'instant grub-bootloader, grub-efi-bootloader, extlinux-bootloader et u-boot-bootloader sont supportés.

          grub-efi-bootloader permet de démarrer sur un système moderne qui utilise l'UEFI (Unified Extensible Firmware Interface).  C'est ce que vous devriez utiliser si l'image d'installation contient un répertoire /sys/firmware/efi lorsque vous démarrez dessus sur votre machine.

          grub-bootloader vous permet de démarrer en particulier sur des machines Intel en mode BIOS « legacy ».

          Les chargeurs d'amorçage disponibles sont décrits dans les modules (gnu bootloader ...).  En particulier, (gnu bootloader u-boot) contient des définitions de chargeurs d'amorçage pour une large gamme de systèmes ARM et AArch, à l'aide du chargeur d'amorçage U-Boot (http://www.denx.de/wiki/U-Boot/)

     target
          C'est une chaîne qui dénote la cible sur laquelle installer le chargeur d'amorçage.

          L'interprétation dépend du chargeur d'amorçage en question.  Pour grub-bootloader par exemple, cela devrait être un nom de périphérique compris par la commande installer du chargeur d'amorçage, comme /dev/sda ou (hd0) (see Invoking grub-install (GNU GRUB Manual)).  Pour grub-efi-bootloader, cela devrait être le point de montage du système de fichiers EFI, typiquement /boot/efi.

     menu-entries (par défaut : ())
          Une liste éventuellement vide d'objets menu-entry (voir plus bas), dénotant les entrées qui doivent apparaître dans le menu du chargeur d'amorçage, en plus de l'entrée pour le système actuel et l'entrée pointant vers les générations précédentes.

     default-entry (par défaut : 0)
          L'index de l'entrée du menu de démarrage par défaut.  L'index 0 correspond au système actuel.

     timeout (par défaut : 5)
          Le nombre de secondes à attendre une entrée clavier avant de démarrer. Indiquez 0 pour démarre immédiatement, et -1 pour attendre indéfiniment.

     theme (par défaut : #F)
          L'objet de thème du chargeur d'amorçage décrivant le thème utilisé.  Si aucun thème n'est fournit, certains chargeurs d'amorçage peuvent utiliser un thème par défaut, c'est le cas de GRUB.

     terminal-outputs (par défaut : 'gfxterm)
          Les terminaux de sortie utilisés par le menu de démarrage du chargeur d'amorçage, en tant que liste de symboles.  GRUB accepte les valeurs console, serial, serial_{0-3}, gfxterm, vga_text, mda_text, morse et pkmodem.  Ce champ correspond à la variable GRUB GRUB_TERMINAL_OUTPUT (see Simple configuration (GNU GRUB manual)).

     terminal-inputs (par défaut : '())
          Les terminaux d'entrée utilisés par le menu de démarrage du chargeur d'amorçage, en tant que liste de symboles.  Pour GRUB, la valeur par défaut est le terminal natif de la plate-forme déterminé à l'exécution.  GRUB accepte les valeurs console, serial, serial_{0-3}, at_keyboard et usb_keyboard.  Ce champ correspond à la variable GRUB GRUB_TERMINAL_INPUT (see Simple configuration (GNU GRUB manual)).

     serial-unit (par défaut : #f)
          L'unitié série utilisée par le chargeur d'amorçage, en tant qu'entier entre 0 et 3.  Pour GRUB, il est choisi à l'exécution ; actuellement GRUB choisi 0, ce qui correspond à COM1 (see Serial terminal (GNU GRUB manual)).

     serial-speed (par défaut : #f)
          La vitesse de l'interface série, en tant qu'entier.  Pour GRUB, la valeur par défaut est choisie à l'exécution ; actuellement GRUB choisi 9600 bps (see Serial terminal (GNU GRUB manual)).

Si vous voulez lister des entrées du menu de démarrage supplémentaires via le champ menu-entries ci-dessus, vous devrez les créer avec la forme menu-entry.  Par exemple, imaginons que vous souhaitiez pouvoir démarrer sur une autre distro (c'est difficile à concevoir !), vous pourriez alors définir une entrée du menu comme ceci :

     (menu-entry
       (label "L'autre distro")
       (linux "/boot/old/vmlinux-2.6.32")
       (linux-arguments '("root=/dev/sda2"))
       (initrd "/boot/old/initrd"))

Les détails suivent.

 -- Type de données: menu-entry
     Le type d'une entrée dans le menu du chargeur d'amorçage.

     label
          L'étiquette à montrer dans le menu — p. ex. "GNU".

     linux
          L'image du noyau Linux à démarrer, par exemple :

               (file-append linux-libre "/bzImage")

          Pour GRUB, il est aussi possible de spécifier un périphérique explicitement dans le chemin de fichier avec la convention de nommage de GRUB (see Naming convention (GNU GRUB manual)), par exemple :

               "(hd0,msdos1)/boot/vmlinuz"

          Si le périphérique est spécifié explicitement comme au-dessus, le champ device est complètement ignoré.

     linux-arguments (par défaut : ())
          La liste des arguments de la ligne de commande du noyau supplémentaires — p. ex. ("console=ttyS0").

     initrd
          Une G-expression ou une chaîne dénotant le nom de fichier du disque de RAM initial à utiliser (see G-Expressions).

     device (par défaut : #f)
          Le périphérique où le noyau et l'initrd se trouvent — c.-à-d. pour GRUB, l'option root de cette entrée de menu (see root (GNU GRUB manual)).

          Cela peut être une étiquette de système de fichiers (une chaîne), un UUID de système de fichiers (un vecteur d'octets, see Systèmes de fichiers) ou #f, auquel cas le chargeur d'amorçage recherchera le périphérique contenant le fichier spécifié par le champ linux (see search (GNU GRUB manual)).  Cela ne doit pas être un nom de périphérique donné par l'OS comme /dev/sda1.

Pour l'instant seul GRUB supporte les thèmes.  On crée un thème GRUB avec la forme grub-theme, qui n'est pas encore documentée.

 -- Variable Scheme: %default-theme
     C'est le thème par défaut de GRUB utilisé par le système d'exploitation si aucun champ theme n'est spécifié dans l'enregistrement bootloader-configuration.

     Il contient une image de fond sympathique avec les logos de GNU et de Guix.

Invoquer guix system
====================

Une fois que vous avez écrit une déclaration de système d'exploitation comme nous l'avons vu dans les sections précédentes, elle peut être instanciée avec la commande guix system.  Voici le résumé de la commande :

     guix system OPTIONS... ACTION FILE

FILE doit être le nom d'un fichier contenant une déclaration operating-system.  ACTION spécifie comme le système d'exploitation est instancié.  Actuellement les valeurs suivantes sont supportées :

search
     Affiche les définitions des types de services disponibles qui correspondent aux expressions régulières données, triées par pertinence.

          $ guix system search console font
          name: console-fonts
          location: gnu/services/base.scm:773:2
          extends: shepherd-root
          description: Installe des polices données sur les ttys spécifiés (les polices sont par console virtuelle sous GNU/Linux).  la valeur de ces service est une liste de paires
          + de tty/police comme ceci :
          +
          +      '(("tty1" . "LatGrkCyr-8x16"))
          relevance: 16

          name: mingetty
          location: gnu/services/base.scm:1144:2
          extends: shepherd-root
          description: Fournit la connexion en console avec le programme `mingetty'.
          relevance: 4

          name: login
          location: gnu/services/base.scm:819:2
          extends: pam
          description: Fournit un service de connexion en console tel que spécifié par sa valeur de configuration, un objet `login-configuration'.
          relevance: 4

          ...

     Comme pour guix package --search, le résultat est écrit au format recutils, ce qui rend facile le filtrage de la sortie (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 Guix System.).

     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 this command will arrange for it to be upgraded the next time it is stopped (e.g. by herd stop X or herd restart X).

     Cette commande crée une nouvelle génération dont le numéro est un de plus que la génération actuelle (rapportée par guix system list-generations).  Si cette génération existe déjà, elle sera réécrite. Ce comportement correspond à celui de guix package (see Invoquer guix package).

     Elle ajoute aussi une entrée de menu du chargeur d'amorçage pour la nouvelle configuration, à moins que --no-bootloader ne soit passé.  Pour GRUB, elle déplace les entrées pour les anciennes configurations dans un sous-menu, ce qui vous permet de choisir une ancienne génération au démarrage si vous en avez besoin.

          Il est grandement recommandé de lancer guix pull une fois avant de lancer guix system reconfigure pour la première fois (see Invoquer guix pull).  Sans cela, vous verriez une version plus ancienne de Guix une fois reconfigure terminé.

switch-generation
     Passe à une génération existante du système.  Cette action change automatiquement le profil système vers la génération spécifiée.  Elle réarrange aussi les entrées existantes du menu du chargeur d'amorçage du système.  Elle fait de l'entrée du menu pour la génération spécifiée l'entrée par défaut et déplace les entrées pour les autres générations dans un sous-menu, si cela est supporté par le chargeur d'amorçage utilisé.  Lors du prochain démarrage du système, la génération du système spécifiée sera utilisée.

     Le chargeur d'amorçage lui-même n'est pas réinstallé avec cette commande. Ainsi, le chargeur d'amorçage est utilisé avec un fichier de configuration plus à jour.

     La génération cible peut être spécifiée explicitement par son numéro de génération.  Par exemple, l'invocation suivante passerait à la génération 7 du système :

          guix system switch-generation 7

     La génération cible peut aussi être spécifiée relativement à la génération actuelle avec la forme +N ou -N, où +3 signifie « trois générations après la génération actuelle » et -1 signifie « une génération précédent la génération actuelle ».  Lorsque vous spécifiez un nombre négatif comme -1, il doit être précédé de -- pour éviter qu'il ne soit compris comme une option.  Par exemple :

          guix system switch-generation -- -1

     Actuellement, l'effet de l'invocation de cette action est uniquement de passer au profil du système vers une autre génération existante et de réarranger le menu du chargeur d'amorçage. Pour vraiment commencer à utiliser la génération spécifiée, vous devez redémarrer après avoir lancé cette action.  Dans le futur, elle sera corrigée pour faire la même chose que reconfigure, comme réactiver et désactiver les services.

     Cette action échouera si la génération spécifiée n'existe pas.

roll-back
     Passe à la génération précédente du système.  Au prochain démarrage, la génération précédente sera utilisée.  C'est le contraire de reconfigure, et c'est exactement comme invoquer switch-generation avec pour argument -1.

     Actuellement, comme pour switch-generation, vous devez redémarrer après avoir lancé cette action pour vraiment démarrer sur la génération précédente du système.

delete-generations
     Delete system generations, making them candidates for garbage collection (see Invoquer guix gc, for information on how to run the ``garbage collector'').

     This works in the same way as guix package --delete-generations (see --delete-generations).  With no arguments, all system generations but the current one are deleted:

          guix system delete-generations

     You can also select the generations you want to delete.  The example below deletes all the system generations that are more than two month old:

          guix system delete-generations 2m

     Running this command automatically reinstalls the bootloader with an updated list of menu entries---e.g., the ``old generations'' sub-menu in GRUB no longer lists the generations that have been deleted.

build
     Construit la dérivation du système d'exploitation, ce qui comprend tous les fichiers de configuration et les programmes requis pour démarrer et lancer le système.  Cette action n'installe rien.

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 Guix System.  For instance:

          guix system init my-os-config.scm /mnt

     copie tous les éléments du dépôt requis par la configuration spécifiée dans my-os-config.scm dans /mnt.  Cela comprend les fichiers de configuration, les paquets, etc.  Elle crée aussi d'autres fichiers essentiels requis pour que le système fonctionne correctement — p. ex. les répertoires /etc, /var et /run et le fichier /bin/sh.

     Cette commande installe aussi le chargeur d'amorçage sur la cible spécifiée dans my-os-config, à moins que l'option --no-bootloader ne soit passée.

vm
     Build a virtual machine that contains the operating system declared in FILE, and return a script to run that virtual machine (VM).

          The vm action and others below 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).

     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

     La VM partage sont dépôt avec le système hôte.

     Vous pouvez partager des fichiers supplémentaires entre l'hôte et la VM avec les options en ligne de commande --share et --expose : la première spécifie un répertoire à partager avec accès en écriture, tandis que le deuxième fournit un accès en lecture-seule au répertoire partagé.

     L'exemple ci-dessous crée une VM dans laquelle le répertoire personnel de l'utilisateur est accessible en lecture-seule, et où le répertoire /exchange est une correspondance en lecture-écriture à $HOME/tmp sur l'hôte :

          guix system vm my-config.scm \
             --expose=$HOME --share=$HOME/tmp=/exchange

     Sur GNU/Linux, le comportement par défaut consiste à démarrer directement sur le noyau ; cela a l'avantage de n'avoir besoin que d'une toute petite image disque puisque le dépôt de l'hôte peut ensuite être monté.

     L'option --full-boot force une séquence de démarrage complète, en commençant par le chargeur d'amorçage.  Cela requiert plus d'espace disque puisqu'une image racine contenant au moins le noyau, l'initrd et les fichiers de données du chargeur d'amorçage doit être créé.  On peut utiliser l'option --image-size pour spécifier la taille de l'image.

vm-image
disk-image
docker-image
     Renvoie une machine virtuelle, une image disque ou une image Docker du système d'exploitation déclaré dans FILE qui se suffit à elle-même. Par défaut, guix system estime la taille de l'image requise pour stocker le système, mais vous pouvez utiliser l'option --image-size pour spécifier une valeur.  Les images Docker sont construites pour contenir exactement ce dont elles ont besoin, donc l'option --image-size est ignorée dans le cas de docker-image.

     Vous pouvez spécifier le type de système de fichiers racine avec l'option --file-system-type.  La valeur par défaut est ext4.

     When using vm-image, the returned image is in qcow2 format, which the QEMU emulator can efficiently use. See Running Guix in a VM, for more information on how to run the image in a virtual machine.

     Lorsque vous utilisez disk-image, une image disque brute est produite ; elle peut être copiée telle quelle sur un périphérique USB.  En supposant que /dev/sdc est le périphérique correspondant à une clef USB, on peut copier l'image dessus avec la commande suivante :

          # dd if=$(guix system disk-image my-os.scm) of=/dev/sdc

     En utilisant docker-image, on produit une image Docker.  Guix construit l'image de zéro, et non à partir d'une image Docker de base pré-existante.  En conséquence, elle contient exactly ce que vous avez défini dans le fichier de configuration du système.  Vous pouvez ensuite charger l'image et lancer un conteneur Docker avec des commande comme :

          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 Guix 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
     Renvoie un script qui lance le système d'exploitation déclaré dans FILE dans un conteneur.  Les conteneurs sont un ensemble de mécanismes d'isolation légers fournis par le noyau Linux-libre.  Les conteneurs sont substantiellement moins gourmands en ressources que les machines virtuelles complètes car le noyau, les objets partagés et d'autres ressources peuvent être partagés avec le système hôte ; cela signifie aussi une isolation moins complète.

     Actuellement, le script doit être lancé en root pour pouvoir supporter plus d'un utilisateur et d'un groupe.  Le conteneur partage son dépôt avec le système hôte.

     Comme avec l'action vm (see guix system vm), des systèmes de fichiers supplémentaires peuvent être partagés entre l'hôte et le conteneur avec les options --share et --expose :

          guix system container my-config.scm \
             --expose=$HOME --share=$HOME/tmp=/exchange

          Cette option requiert Linux-libre  ou supérieur.

OPTIONS peut contenir n'importe quelle option commune de construction (see Options de construction communes).  En plus, OPTIONS peut contenir l'une de ces options :

--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 Guix system installer see Construire l'image d'installation).

--system=SYSTÈME
-s SYSTÈME
     Essaye de construire pour SYSTEM au lieu du type du système hôte. Cela fonction comme pour guix build (see Invoquer guix build).

--derivation
-d
     Renvoie le nom du fichier de dérivation du système d'exploitation donné sans rien construire.

--file-system-type=TYPE
-t TYPE
     Pour l'action disk-image, crée un système de fichier du TYPE donné sur l'image.

     Lorsque cette option est omise, guix system utilise ext4.

     --file-system-type=iso9660 produit une image ISO-9660, qu'il est possible de graver sur un CD ou un DVD.

--image-size=SIZE
     Pour les actions vm-image et disk-image, crée une image de la taille donnée SIZE.  SIZE peut être un nombre d'octets ou contenir un suffixe d'unité (see size specifications (GNU Coreutils)).

     Lorsque cette option est omise, guix system calcule une estimation de la taille de l'image en fonction de la taille du système déclaré dans 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
     Passe les vérifications de sécurité avant l'installation.

     Par défaut, guix system init et guix system reconfigure effectuent des vérifications de sécurité : ils s'assurent que les systèmes de fichiers qui apparaissent dans la déclaration operating-system existent vraiment (see Systèmes de fichiers) et que les modules de noyau Linux qui peuvent être requis au démarrage sont listés dans initrd-modules (see Disque de RAM initial).  Passer cette option saute ces vérifications complètement.

--on-error=STRATEGY
     Applique STRATEGY lorsqu'une erreur arrive lors de la lecture de FILE.  STRATEGY peut être l'une des valeurs suivantes :

     nothing-special
          Rapporte l'erreur de manière concise et quitte.  C'est la stratégie par défaut.

     backtrace
          Pareil, mais affiche aussi une trace de débogage.

     debug
          Rapporte l'erreur et entre dans le débogueur Guile.  À partir de là, vous pouvez lancer des commandes comme ,bt pour obtenir une trace de débogage, ,locals pour afficher les valeurs des variables locales et plus généralement inspecter l'état du programme.  See Debug Commands (GNU Guile Reference Manual), pour une liste de commandes de débogage disponibles.

Once you have built, configured, re-configured, and re-re-configured your Guix 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
     Affiche un résumé de chaque génération du système d'exploitation disponible sur le disque, dans un format lisible pour un humain.  C'est similaire à l'option --list-generations de guix package (see Invoquer guix package).

     Éventuellement, on peut spécifier un motif, avec la même syntaxe utilisée pour guix package --list-generations, pour restreindre la liste des générations affichées.  Par exemple, la commande suivante affiche les générations de moins de 10 jours :

          $ guix system list-generations 10d

La commande guix system a même plus à proposer !  Les sous-commandes suivantes vous permettent de visualiser comme vos services systèmes sont liés les uns aux autres :

extension-graph
     Affiche le graphe d'extension des services du système d'exploitation défini dans FILE au format Dot/Graphviz sur la sortie standard (see Composition de services, pour plus d'informations sur l'extension des services).

     La commande :

          $ guix system extension-graph FILE | dot -Tpdf > services.pdf

     produit un fichier PDF montrant les relations d'extension entre les services.

shepherd-graph
     Affiche le graphe de dépendance des services shepherd du système d'exploitation défini dans FILE au format Dot/Graphviz sur la sortie standard.  See Services Shepherd, pour plus d'informations et un exemple de graphe.

Running Guix in a Virtual Machine
=================================

To run Guix in a virtual machine (VM), one can either use the pre-built Guix 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.

Si vous construisez votre propre image, vous devez la copier en dehors du dépôt (see Le dépôt) et vous donner la permission d'écrire sur la copie avant de pouvoir l'utiliser.  Lorsque vous invoquez QEMU, vous devez choisir un émulateur système correspondant à votre plate-forme matérielle.  Voici une invocation minimale de QEMU qui démarrera le résultat de guix system vm-image sur un matériel x8_64.

     $ qemu-system-x86_64 \
        -net user -net nic,model=virtio \
        -enable-kvm -m 256 /tmp/qemu-image

Voici la signification de ces options :

qemu-system-x86_64
     Cela spécifie la plate-forme matérielle à émuler.  Elle doit correspondre à l'hôte.

-net user
     Active la pile réseau non privilégiée en mode utilisateur.  L'OS émulé peut accéder à l'hôte mais pas l'inverse.  C'est la manière la plus simple de connecter le client.

-net nic,model=virtio
     Vous devez créer une interface réseau d'un modèle donné.  Si vous ne créez pas de NIC, le démarrage échouera.  En supposant que votre plate-forme est x86_64, vous pouvez récupérer une liste des modèles de NIC disponibles en lançant qemu-system-x86_64 -net nic,model=help.

-enable-kvm
     Si votre système a des extensions de virtualisation matérielle, activer le support des machines virtuelles de Linux (KVM) accélérera les choses.

-m 256
     RAM disponible sur l'OS émulé, en mébioctets.  La valeur par défaut est 128 Mo, ce qui peut ne pas suffire pour certaines opérations.

/tmp/qemu-image
     Le nom de fichier de l'image qcow2.

Le script run-vm.sh par défaut renvoyé par une invocation de guix system vm n'ajoute pas le drapeau -net user par défaut.  Pour avoir accès au réseau dans la vm, ajoutez le (dhcp-client-service) à votre définition et démarrez la VM avec `guix system vm config.scm` -net user.  Un problème important avec -net user pour le réseau, est que ping ne fonctionnera pas, car il utilise le protocole ICMP.  Vous devrez utiliser une autre commande pour vérifier la connectivité réseau, par exemple guix download.

Se connecter par SSH
--------------------

Pour activer SSH dans une VM vous devez ajouter un serveur SSH comme (dropbear-service) ou (lsh-service) à votre VM.  Le service (lsh-service) ne peut actuellement pas démarrer sans supervision.  Il a besoin que vous tapiez quelques caractères pour initialiser le générateur d'aléatoire.  En plus vous devez transférer le port 22, par défaut, à l'hôte.  Vous pouvez faire cela avec :

     `guix system vm config.scm` -net user,hostfwd=tcp::10022-:22

Pour vous connecter à la VM vous pouvez lancer

     ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 10022

Le -p donne le port auquel vous voulez vous connecter à ssh, -o UserKnownHostsFile=/dev/null évite que ssh ne se plaigne à chaque fois que vous modifiez le fichier config.scm et -o StrictHostKeyChecking=no évite que vous n'ayez à autoriser une connexion à un hôte inconnu à chaque fois que vous vous connectez.

Utiliser virt-viewer avec Spice
-------------------------------

Alternativement au client graphique qemu par défaut vous pouvez utiliser remote-viewer du paquet virt-viewer.  Pour vous connecter, passez le drapeau -spice port=5930,disable-ticketing à qemu.  Voir les sections précédentes pour plus d'informations sur comment faire cela.

Spice a aussi de chouettes fonctionnalités comme le partage de votre presse-papier avec la VM.  Pour activer cela vous devrez aussi passer les drapeaux suivants à 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

Vous devrez aussi ajouter le see Spice service.

Définir des services
====================

Les sections précédentes montrent les services disponibles et comment on peut les combiner dans une déclaration operating-system.  Mais, déjà, comment les définir ?  Et qu'est-ce qu'un service au fait ?

Composition de services
-----------------------

Ici nous définissons un service comme étant, assez largement, quelque chose qui étend la fonctionnalité d'un système d'exploitation.  Souvent un service est un processus — un démon — démarré lorsque le système démarre : un serveur ssh, un serveur web, le démon de construction de Guix, etc.  Parfois un service est un démon dont l'exécution peut être déclenchée par un autre démon — p. ex. un serveur FTP démarré par inetd ou un service D-Bus activé par dbus-daemon.  Parfois, un service ne correspond pas à un démon.  Par exemple, le service « de comptes » récupère la liste des comptes utilisateurs et s'assure qu'ils existent bien lorsque le système est lancé ; le service « udev » récupère les règles de gestion des périphériques et les rend disponible au démon eudev ; le service /etc rempli le répertoire /etc du système.

Guix system services are connected by extensions.  For instance, the secure shell service extends the Shepherd---the initialization system, running as PID 1---by giving it the command lines to start and stop the secure shell daemon (see openssh-service-type); 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).

En définitive, les services et leurs relation « d'extensions » forment un graphe orienté acyclique (DAG).  Si nous représentons les services comme des boîtes et les extensions comme des flèches, un système typique pourrait fournir quelque chose comme cela :

Graphe d'extension des services typique.

En bas, on voit le service système qui produit le répertoire contenant tout et lançant et démarrant le système, renvoyé par la commande guix system build.  See Référence de service, pour apprendre les autres types de services montrés ici.  See the guix system extension-graph command, pour plus d'informations sur la manière de générer cette représentation pour une définition de système d'exploitation particulière.

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.

La section suivante décrit l'interface de programmation des types de services et des services.

Types service et services
-------------------------

Un type de service est un nœud dans le DAG décrit plus haut. Commençons avec un exemple simple, le type de service pour le démon de construction de Guix (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))))

Il définit trois choses :

 1. Un nom, dont le seul but de rendre l'inspection et le débogage plus faciles.

 2. Une liste d'extensions de services, où chaque extension désigne le type de service cible et une procédure qui, étant donné les paramètres du service, renvoie une liste d'objets pour étendre le service de ce type.

     Chaque type de service a au moins une extension de service.  La seule exception est le type de service boot, qui est le service ultime.

 3. Éventuellement, une valeur par défaut pour les instances de ce type.

Dans cet exemple, GUIX-SERVICE-TYPE étend trois services :

shepherd-root-service-type
     La procédure GUIX-SHEPHERD-SERVICE définit comment le service du Shepherd est étendu.  En fait, elle renvoie un objet <shepherd-service> qui définit comment guix-daemon est démarré et stoppé (see Services Shepherd).

account-service-type
     Cette extension pour ce service est calculée par GUIX-ACCOUNTS, qui renvoie une liste d'objets user-group et user-account représentant les comptes des utilisateurs de construction (see Invoquer guix-daemon).

activation-service-type
     Ici, GUIX-ACTIVATION est une procédure qui renvoie une gexp, qui est un bout de code qui s'exécute au moment de l'activation — p. ex. lorsque le service est démarré.

Un service de ce type est instancié de cette manière :

     (service guix-service-type
              (guix-configuration
                (build-accounts 5)
                (use-substitutes? #f)))

Le deuxième argument de la forme service est une valeur représentant les paramètres de cet instance spécifique du service. See guix-configuration, pour plus d'informations sur le type de données guix-configuration.  Lorsque la valeur est omise, la valeur par défaut spécifiée par guix-service-type est utilisée :

     (service guix-service-type)

GUIX-SERVICE-TYPE est très simple car il étend d'autres services mais ne peut pas être étendu.

Le type de service pour un service extensible ressemble à ceci :

     (define udev-service-type
       (service-type (name 'udev)
                     (extensions
                      (list (service-extension shepherd-root-service-type
                                               udev-shepherd-service)))

                     (compose concatenate)       ; concatène la liste des règles
                     (extend (lambda (config rules)
                               (match config
                                 (($ <udev-configuration> udev initial-rules)
                                  (udev-configuration
                                   (udev udev)   ; le paquet udev à utiliser
                                   (rules (append initial-rules rules)))))))))

C'est le type de service pour le le démon de gestion des périphériques eudev (https://wiki.gentoo.org/wiki/Project:Eudev).  Comparé à l'exemple précédent, en plus d'une extension de SHEPHERD-ROOT-SERVICE-TYPE, on trouve deux nouveaux champs :

compose
     C'est la procédure pour composer la liste des extensions de services de ce type.

     Les services peuvent étendre le service udev en lui passant des listes de règles ; on compose ces extensions simplement en les concaténant.

extend
     Cette procédure définie comme la valeur du service est étendue avec la composition des extensions.

     Les extensions Udev sont composés en une liste de règles, mais la valeur du service udev est elle-même un enregistrement <udev-configuration>. Donc ici, nous étendons cet enregistrement en ajoutant la liste des règle contribuées à la liste des règles qu'il contient déjà.

description
     C'est une chaîne donnant un aperçu du type de service.  Elle peut contenir du balisage Texinfo (see Overview (GNU Texinfo)).  La commande guix system search permet de rechercher dans ces chaînes et de les afficher (see Invoquer guix system).

Il ne peut y avoir qu'une instance d'un type de service extensible comme UDEV-SERVICE-TYPE.  S'il y en avait plus, les spécification service-extension seraient ambiguës.

Toujours ici ? La section suivante fournit une référence de l'interface de programmation des services.

Référence de service
--------------------

Nous avons vu un résumé des types de services (see Types service et services).  Cette section fournit une référence sur la manière de manipuler les services et les types de services.  Cette interface est fournie par le module (gnu services).

 -- Procédure Scheme: service TYPE [VALUE]
     Renvoie un nouveau service de type TYPE, un objet <service-type> (voir plus bas).  VALUEpeut être n'importe quel objet ; il représente les paramètres de cette instance particulière du service.

     Lorsque VALUE est omise, la valeur par défaut spécifiée par TYPE est utilisée ; si TYPE ne spécifie pas de valeur par défaut, une erreur est levée.

     Par exemple ceci :

          (service openssh-service-type)

     est équivalent à ceci :

          (service openssh-service-type
                   (openssh-configuration))

     Dans les deux cas le résultat est une instance de openssh-service-type avec la configuration par défaut.

 -- Procédure Scheme: service? OBJ
     Renvoie vrai si OBJ est un service.

 -- Procédure Scheme: service-kind SERVICE
     Renvoie le type de SERVICE — c.-à-d. un objet <service-type>.

 -- Procédure Scheme: service-value SERVICE
     Renvoie la valeur associée à SERVICE.  Elle représente ses paramètres.

Voici un exemple de la manière dont un service est créé et manipulé :

     (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

La forme modify-services fournit une manière pratique de modifier les paramètres de certains services d'une liste comme %BASE-SERVICES (see %base-services).  Elle s'évalue en une liste de services.  Bien sûr, vous pouvez toujours utiliser les combinateurs de liste standards comme map et fold pour cela (see List Library (GNU Guile Reference Manual)) ; modify-services fournit simplement une manière plus concise pour ce besoin commun.

 -- Syntaxe Scheme: modify-services SERVICES
     (TYPE VARIABLE => BODY) ...

     Modifie les services listés dans SERVICES en fonction des clauses données.  Chaque clause à la forme :

          (TYPE VARIABLE => BODY)

     où TYPE est un type de service — p. ex. guix-service-type — et VARIABLE est un identifiant lié dans BODY aux paramètres du service — p. ex. une instance de guix-configuration — du service original de ce TYPE.

     La variable BODY devrait s'évaluer en de nouveaux paramètres de service, qui seront utilisés pour configurer le nouveau service.  Ce nouveau service remplacera l'original dans la liste qui en résulte.  Comme les paramètres d'un service sont créés avec define-record-type*, vous pouvez écrire un BODY court qui s'évalue en de nouveaux paramètres pour le services en utilisant inherit, fourni par define-record-type*.

     See Utiliser le système de configuration pour des exemples d'utilisation.

Suit l'interface de programmation des types de services.  Vous devrez la connaître pour écrire de nouvelles définitions de services, mais pas forcément lorsque vous cherchez des manières simples de personnaliser votre déclaration operating-system.

 -- Type de données: service-type
     C'est la représentation d'un type de service (see Types service et services).

     name
          C'est un symbole, utilisé seulement pour simplifier l'inspection et le débogage.

     extensions
          Une liste non-vide d'objets <service-extension> (voir plus bas).

     compose (par défaut : #f)
          S'il s'agit de #f, le type de service dénote des services qui ne peuvent pas être étendus — c.-à-d. qui ne reçoivent pas de « valeurs » d'autres services.

          Sinon, ce doit être une procédure à un argument.  La procédure est appelée par fold-services et on lui passe une liste de valeurs collectées par les extensions.  Elle peut renvoyer n'importe quelle valeur simple.

     extend (par défaut : #f)
          Si la valeur est #f, les services de ce type ne peuvent pas être étendus.

          Sinon, il doit s'agir 'une procédure à deux arguments : fold-services l'appelle et lui passe la valeur initiale du service comme premier argument et le résultat de l'application de compose sur les valeurs d'extension en second argument.  Elle doit renvoyer une valeur qui est une valeur de paramètre valide pour l'instance du service.

     See Types service et services, pour des exemples.

 -- Procédure Scheme: service-extension TARGET-TYPE
     COMPUTE
     Renvoie une nouvelle extension pour les services de type TARGET-TYPE. COMPUTE doit être une procédure à un argument : fold-services l'appelle et lui passe la valeur associée au service qui fournit cette extension ; elle doit renvoyer une valeur valide pour le service cible.

 -- Procédure Scheme: service-extension? OBJ
     Renvoie vrai si OBJ est une extension de service.

Parfois, vous voudrez simplement étendre un service existant.  Cela implique de créer un nouveau type de service et de spécifier l'extension qui vous intéresse, ce qui peut être assez verbeux ; la procédure simple-service fournit un raccourci pour ce cas.

 -- Procédure Scheme: simple-service NAME TARGET VALUE
     Renvoie un service qui étend TARGET avec VALUE.  Cela fonctionne en créant un type de service singleton NAME, dont le service renvoyé est une instance.

     Par exemple, cela étend mcron (see Exécution de tâches planifiées) avec une tâche supplémentaire :

          (simple-service 'my-mcron-job mcron-service-type
                          #~(job '(next-hour (3)) "guix gc -F 2G"))

Au cœur de l'abstraction des services se cache la procédure fold-services, responsable de la « compilation » d'une liste de services en un répertoire unique qui contient tout ce qui est nécessaire au démarrage et à l'exécution du système — le répertoire indiqué par la commande guix system build (see Invoquer guix system).  En soit, elle propage les extensions des services le long du graphe des services, en mettant à jour chaque paramètre des nœuds sur son chemin, jusqu'à atteindre le nœud racine.

 -- Procédure Scheme: fold-services SERVICES
     [#:target-type SYSTEM-SERVICE-TYPE]
     Replie SERVICES en propageant leurs extensions jusqu'à la racine de type TARGET-TYPE ; renvoie le service racine ajusté de cette manière.

Enfin, le module (gnu services) définie aussi divers types de services essentiels, dont certains sont listés ci-dessous.

 -- Variable Scheme: system-service-type
     C'est la racine du graphe des services.  Il produit le répertoire du système renvoyé par la commande guix system build.

 -- Variable Scheme: boot-service-type
     Le type du service « boot », qui produit le script de démarrage.  Le script de démarrage est ce que le disque de RAM initial lance au démarrage.

 -- Variable Scheme: etc-service-type
     Le type du service /etc.  Ce service est utilisé pour créer des fichiers dans /etc et peut être étendu en lui passant des tuples nom/fichier comme ceci :

          (list `("issue" ,(plain-file "issue" "Bienvenue !\n")))

     Dans cet exemple, l'effet serait d'ajouter un fichier /etc/issue pointant vers le fichier donné.

 -- Variable Scheme: setuid-program-service-type
     Le type du « service setuid ».  Ce service récupère des listes de noms de fichiers exécutables, passés en tant que gexps, et les ajoute à l'ensemble des programmes setuid root sur le système (see Programmes setuid).

 -- Variable Scheme: profile-service-type
     De type du service qui rempli le profil du système — c.-à-d. les programmes dans /run/current-system/profile.  Les autres services peuvent l'étendre en lui passant des listes de paquets à ajouter au profil du système.

Services Shepherd
-----------------

The (gnu services shepherd) module provides a way to define services managed by the GNU Shepherd, which is the initialization system---the first process that is started when the system boots, also known as PID 1 (see Introduction (The GNU Shepherd Manual)).

Les services dans le Shepherd peuvent dépendre les uns des autres.  Par exemple, le démon SSH peut avoir besoin d'être démarré après le démon syslog, qui à son tour doit être démarré après le montage des systèmes de fichiers.  Le système d'exploitation simple déclaré précédemment (see Utiliser le système de configuration) crée un graphe de service comme ceci :

Graphe de service typique du shepherd.

Vous pouvez générer un tel graphe pour n'importe quelle définition de système d'exploitation avec la commande guix system shepherd-graph (see guix system shepherd-graph).

La variable %SHEPHERD-ROOT-SERVICE est un objet de service représentant le PID 1, de type SHEPHERD-ROOT-SERVICE-TYPE ; il peut être étendu en lui passant des listes d'objets <shepherd-service>.

 -- Type de données: shepherd-service
     Le type de données représentant un service géré par le Shepherd.

     provision
          C'est une liste de symboles dénotant ce que le service fournit.

          Ce sont les noms qui peuvent être passés à herd start, herd status et les commandes similaires (see Invoking herd (The GNU Shepherd Manual)).  See the provides slot (The GNU Shepherd Manual), pour plus de détails.

     requirements (par défaut : '())
          Liste de symboles dénotant les services du Shepherd dont celui-ci dépend.

     respawn? (par défaut : #t)
          Indique s'il faut redémarrer le service lorsqu'il s'arrête, par exemple si le processus sous-jacent meurt.

     start
     stop (par défaut : #~(const #f))
          Les champs start et stop se réfèrent à la capacité du Shepherd de démarrer et d'arrêter des processus (see Service De- and Constructors (The GNU Shepherd Manual)).  Ils sont donnés comme des G-expressions qui sont étendues dans le fichier de configuration du Shepherd (see G-Expressions).

     actions (par défaut : '())
          C'est une liste d'objets shepherd-action (voir plus bas) définissant des actions supportées par le service, en plus des actions start et stop standards.  Les actions listées ici sont disponibles en tant que sous-commande de herd.

               herd ACTION SERVICE [ARGUMENTS...]

     documentation
          Une chaîne de documentation, montrée lorsqu'on lance :

               herd doc SERVICE-NAME

          où SERVICE-NAME est l'un des symboles dans PROVISION (see Invoking herd (The GNU Shepherd Manual)).

     modules (par défaut : %DEFAULT-MODULES)
          C'est la liste des modules qui doivent être dans le contexte lorsque start et stop sont évalués.

 -- Type de données: shepherd-action
     C'est le type de données qui définie des actions supplémentaires implémentées par un service Shepherd (voir au-dessus).

     name
          Symbole nommant l'action

     documentation
          C'est une chaîne de documentation pour l'action.  Elle peut être consultée avec :

               herd doc SERVICE action ACTION

     procedure
          Cela devrait être une gexp qui s'évalue en une procédure à au moins un argument, la « valeur de lancement » du service (see Slots of services (The GNU Shepherd Manual)).

     L'exemple suivant définie une action nommée dire-bonjour qui salue amicalement l'utilisateur :

          (shepherd-action
            (name 'dire-bonjour)
            (documentation "Dit salut !")
            (procedure #~(lambda (running . args)
                           (format #t "Salut, l'ami ! arguments : ~s\n"
                                   args)
                           #t)))

     En supposant que cette action est ajoutée dans le service example, vous pouvez écrire :

          # herd dire-bonjour example
          Salut, l'ami ! arguments : ()
          # herd dire-bonjour example a b c
          Salut, l'ami ! arguments : ("a" "b" "c")

     Comme vous pouvez le voir, c'est une manière assez sophistiquée de dire bonjour.  See Service Convenience (The GNU Shepherd Manual), pour plus d'informations sur les actions.

 -- Variable Scheme: shepherd-root-service-type
     Le type de service pour le « service racine » du Shepherd — c.-à-d. le PID 1.

     C'est le type de service que les extensions ciblent lorqu'elles veulent créer un service shepherd (see Types service et services, pour un exemple).  Chaque extension doit passer une liste de <shepherd-service>.

 -- Variable Scheme: %shepherd-root-service
     Ce service représente le PID 1.

Documentation
*************

Dans la plupart des cas les paquets installés avec Guix ont une documentation.  Il y a deux formats de documentation principaux : « Info », un format hypertexte navigable utilisé par les logiciels GNU et les « pages de manuel » (ou « pages de man »), le format de documentation linéaire traditionnel chez Unix.  Les manuels Info sont disponibles via la commande info ou avec Emacs, et les pages de man sont accessibles via la commande man.

Vous pouvez chercher de la documentation pour les logiciels installés sur votre système par mot-clef.  Par exemple, la commande suivante recherche des informations sur « TLS » dans les manuels Info :

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

La commande suivante recherche le même mot-clef dans les pages de man :

     $ man -k TLS
     SSL (7)              - OpenSSL SSL/TLS library
     certtool (1)         - GnuTLS certificate tool
     ...{}

Ces recherches sont purement locales à votre ordinateur donc vous savez que la documentation trouvée correspond à ce qui est effectivement installé, vous pouvez y accéder hors ligne et votre vie privée est préservée.

Une fois que vous avez ces résultats, vous pouvez visualiser la documentation appropriée avec, disons :

     $ info "(gnutls)Core TLS API"

ou :

     $ man certtool

Les manuels Info contiennent des sections et des indexs ainsi que des hyperliens comme ce qu'on trouve sur les pages Web.  Le lecteur info (see Info reader (Stand-alone GNU Info)) et sa contre-partie dans Emacs (see Misc Help (The GNU Emacs Manual)) fournissent des raccourcis claviers intuitifs pour naviguer dans les manuels  see Getting Started (Info: An Introduction) pour trouver une introduction sur la navigation dans info.

Installer les fichiers de débogage
**********************************

Les binaires des programmes, produits par les compilateurs GCC par exemple, sont typiquement écrits au format ELF, avec une section contenant des informations de débogage.  Les informations de débogage sont ce qui permet au débogueur, GDB, de relier le code binaire et le code source ; elles sont requises pour déboguer un programme compilé dans de bonnes 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).

Heureusement, les utilitaires binaires de GNU (Binutils) et GDB fournissent un mécanisme qui permet aux utilisateurs d'avoir le meilleur des deux mondes : les informations de débogage peuvent être nettoyées des binaires et stockées dans des fichiers séparés.  GDB peut ensuite charger les informations de débogage depuis ces fichiers, lorsqu'elles sont disponibles (see Separate Debug Files (Debugging with GDB)).

La distribution GNU se sert de cela pour stocker les informations de débogage dans le sous-répertoire lib/debug d'une sortie séparée du paquet appelée sans grande imagination debug (see Des paquets avec plusieurs résultats).  Les utilisateurs peuvent choisir d'installer la sortie debug d'un paquet lorsqu'ils en ont besoin.  Par exemple, la commande suivante installe les informations de débogage pour la bibliothèque C de GNU et pour GNU Guile.

     guix package -i glibc:debug guile:debug

On doit ensuite dire à GDB de chercher les fichiers de débogage dans le profil de l'utilisateur, en remplissant la variable debug-file-directory (vous pourriez aussi l'instancier depuis le fichier ~/.gdbinit, see Startup (Debugging with GDB)) :

     (gdb) set debug-file-directory ~/.guix-profile/lib/debug

À partir de maintenant, GDB récupérera les informations de débogage dans les fichiers .debug de ~/.guix-profile/lib/debug.

EN plus, vous voudrez sans doute que GDB puisse montrer le code source débogué.  Pour cela, vous devrez désarchiver le code source du paquet qui vous intéresse (obtenu via guix build --source, see Invoquer guix build) et pointer GDB vers ce répertoire des sources avec la commande directory (see directory (Debugging with GDB)).

Le mécanisme de la sortie debug dans Guix est implémenté par le gnu-build-system (see Systèmes de construction).  Actuellement, ce n'est pas obligatoire — les informations de débogage sont disponibles uniquement si les définitions déclarent explicitement une sortie debug.  Cela pourrait être modifié tout en permettant aux paquets de s'en passer dans le futur si nos serveurs de construction peuvent tenir la charge.  Pour vérifier si un paquet a une sortie debug, utilisez guix package --list-available (see Invoquer guix package).

Mises à jour de sécurité
************************

Parfois, des vulnérabilités importantes sont découvertes dans les paquets logiciels et doivent être corrigées.  Les développeurs de Guix essayent de suivre les vulnérabilités connues et d'appliquer des correctifs aussi vite que possible dans la branche master de Guix (nous n'avons pas encore de branche « stable » contenant seulement des mises à jour de sécurité). L'outil guix lint aide les développeurs à trouver les versions vulnérables des paquets logiciels dans la distribution.

     $ guix lint -c cve
     gnu/packages/base.scm:652:2: glibc@2.21: probablement vulnérable à CVE-2015-1781, CVE-2015-7547
     gnu/packages/gcc.scm:334:2: gcc@4.9.3: probablement vulnérable à CVE-2015-5276
     gnu/packages/image.scm:312:2: openjpeg@2.1.0: probablement vulnérable à CVE-2016-1923, CVE-2016-1924
     ...

See Invoquer guix lint, pour plus d'informations.

     À la version VERSION, la fonctionnalité ci-dessous est considérée comme « bêta ».

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

Pour corriger cela, Guix implémente les greffes, un mécanisme qui permet un déploiement rapide des mises à jour de sécurité critiques sans le coût associé à une reconstruction complète de la distribution.  L'idée est de reconstruire uniquement le paquet qui doit être corrigé puis de le « greffer » sur les paquets qui sont explicitement installés par l'utilisateur et qui se référaient avant au paquet d'origine.  Le coût d'une greffe est typiquement très bas, et plusieurs ordres de grandeurs moins élevé que de reconstruire tout la chaîne de dépendance.

Par exemple, supposons qu'une mise à jour de sécurité doive être appliquée à Bash.  Les développeurs de Guix fourniront une définition de paquet pour le Bash « corrigé », disons BASH-FIXED, de la manière habituelle (see Définition des paquets).  Ensuite, la définition originale du paquet est augmentée avec un champ replacement qui pointe vers le paquet contenant le correctif de sécurité :

     (define bash
       (package
         (name "bash")
         ;; ...
         (replacement bash-fixed)))

À partir de maintenant, tout paquet dépendant directement ou indirectement de Bash — rapporté par guix gc --requisites (see Invoquer guix gc) — installé est automatiquement « réécrit » pour se référer à BASH-FIXED au lieu de BASH.  Ce processus de greffe prend du temps en proportion de la taille du paquet, typiquement moins d'une minute pour un paquet de taille « moyenne » sur une machine récente.  La greffe est récursive : lorsqu'une dépendance indirecte a besoin d'être greffée, la greffe se « propage » jusqu'au paquet que l'utilisateur installe.

Actuellement la longueur du nom et la version de la greffe et du paquet qu'il remplace (BASH-FIXED et BASH dans l'exemple ci-dessus) doivent être identiques.  Cette restriction vient surtout du fait que la greffe fonctionne en corrigeant les fichiers, dont des fichiers binaires, directement.  D'autres restrictions peuvent apparaître : par exemple, si vous ajoutez une greffe à un paquet fournissant une bibliothèque partagée, la bibliothèque partagée originale et son remplacement doivent avoir le même SONAME et être compatibles au niveau binaire.

L'option en ligne de commande --no-grafts vous permet d'éviter les greffes (see --no-grafts).  Donc la commande :

     guix build bash --no-grafts

renvoie le nom de fichier dans les dépôt du Bash original, alors que :

     guix build bash

renvoie le nom de fichier du Bash « corrigé » de remplacement.  Cela vous permet de distinguer les deux variantes de Bash.

Pour vérifier à quel Bash votre profil se réfère, vous pouvez lancer (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 Guix system generation:

     guix gc -R `guix system build my-config.scm` | grep bash

Enfin, pour vérifier quelles processus Bash lancés vous utilisez, vous pouvez utiliser la commande lsof :

     lsof | grep /gnu/store/.*bash

Bootstrapping
*************

Dans notre contexte, le bootstrap se réfère à la manière dont la distribution est construite « à partir de rien ».  Rappelez-vous que l'environnement de construction d'une dérivation ne contient rien d'autre que les entrées déclarées (see Introduction).  Donc il y a un problème évident de poule et d'œuf : comment le premier paquet est-il construit ? Comment le premier compilateur est-il construit ?  Remarquez que c'est une question qui intéressera uniquement le hacker curieux, pas l'utilisateur normal, donc vous pouvez sauter cette section sans avoir honte si vous vous considérez comme un « utilisateur normal ».

Le système GNU est surtout fait de code C, avec la libc en son cœur.  Le système de construction GNU lui-même suppose la disponibilité d'un shell Bourne et d'outils en ligne de commande fournis par GNU Coreutils, Awk, Findutils, sed et grep.  En plus, les programmes de construction — les programmes qui exécutent ./configure, make etc — sont écrits en Guile Scheme (see Dérivations).  En conséquence, pour pouvoir construire quoi que ce soit, de zéro, Guix a besoin de binaire pré-construits de Guile, GCC, Binutils, la libc et des autres paquets mentionnés plus haut — les binaires de bootstrap.

Ces binaires de bootstrap sont pris comme des acquis, bien qu'on puisse les recréer (ça arrive plus tard).

Se préparer à utiliser les binaires de bootstrap
================================================

Graphe de dépendance des premières dérivations de bootstrap

La figure ci-dessus montre le tout début du graphe de dépendances de la distribution, correspondant aux définitions des paquets du module (gnu packages bootstrap).  Une figure similaire peut être générée avec guix graph (see Invoquer guix graph),  de cette manière :

     guix graph -t derivation \
       -e '(@@ (gnu packages bootstrap) %bootstrap-gcc)' \
       | dot -Tps > t.ps

À ce niveau de détails, les choses sont légèrement complexes.  Tout d'abord, Guile lui-même consiste en an exécutable ELF, avec plusieurs fichiers Scheme sources et compilés qui sont chargés dynamiquement quand il est exécuté. Cela est stocké dans l'archive guile-2.0.7.tar.xz montrée dans ce graphe.  Cette archive fait parti de la distribution « source » de Guix, et est insérée dans le dépôt avec add-to-store (see Le dépôt).

Mais comment écrire une dérivation qui décompresse cette archive et l'ajoute au dépôt ?  Pour résoudre ce problème, la dérivation guile-bootstrap-2.0.drv — la première qui est construite — utilise bash comme constructeur, qui lance build-bootstrap-guile.sh, qui à son tour appelle tar pour décompresser l'archive.  Ainsi, bash, tar, xz et mkdir sont des binaires liés statiquement, qui font aussi partie de la distribution source de Guix, dont le seul but est de permettre à l'archive de Guile d'être décompressée.

Une fois que guile-bootstrap-2.0.drv est construit, nous avons un Guile fonctionnel qui peut être utilisé pour exécuter les programmes de construction suivants.  Sa première tâche consiste à télécharger les archives contenant les autres binaires pré-construits — c'est ce que la dérivation .tar.xz.drv fait.  Les modules Guix comme ftp-client.scm sont utilisés pour cela.  Les dérivations module-import.drv importent ces modules dans un répertoire dans le dépôt, en utilisant la disposition d'origine.  Les dérivations module-import-compiled.drv compilent ces modules, et les écrivent dans un répertoire de sortie avec le bon agencement.  Cela correspond à l'argument #:modules de build-expression->derivation (see Dérivations).

Enfin, les diverses archives sont décompressées par les dérivations gcc-bootstrap-0.drv, glibc-bootstrap-0.drv, etc, à partir de quoi nous avons une chaîne de compilation C fonctionnelle.

Construire les outils de construction
=====================================

Le bootstrap est complet lorsque nous avons une chaîne d'outils complète qui ne dépend pas des outils de bootstrap pré-construits dont on vient de parler.  Ce pré-requis d'indépendance est vérifié en s'assurant que les fichiers de la chaîne d'outil finale ne contiennent pas de référence vers les répertoires /gnu/store des entrées de bootstrap.  Le processus qui mène à cette chaîne d'outils « finale » est décrit par les définitions de paquets qui se trouvent dans le module (gnu packages commencement).

La commande guix graph nous permet de « dézoomer » comparé au graphe précédent, en regardant au niveau des objets de paquets plutôt que des dérivations individuelles — rappelez-vous qu'un paquet peut se traduire en plusieurs dérivations, typiquement une dérivation pour télécharger ses sources, une pour les modules Guile dont il a besoin et une pour effectivement compiler le paquet depuis les sources.  La commande :

     guix graph -t bag \
       -e '(@@ (gnu packages commencement)
               glibc-final-with-bootstrap-bash)' | dot -Tps > t.ps

produit le graphe de dépendances qui mène à la bibliothèque C « finale » (Vous remarquerez qu'elle s'appelle glibc-intermediate, ce qui suggère qu'elle n'est pas tout à fait finale, mais c'est une bonne approximation tout de même.), que voici :

Graphe de dépendance des premiers paquets

Le premier outil construit avec les binaires de bootstrap est GNU Make — appelé make-boot0 ci-dessus — qui est un prérequis de tous les paquets suivants .  Ensuite, Findutils et Diffutils sont construits.

Ensuite vient la première passe de Binutils et GCC, construits comme des pseudo outils croisés — c.-à-d. dont --target égal à --host.  Ils sont utilisés pour construire la libc.  Grâce à cette astuce de compilation croisée, la libc est garantie de ne contenir aucune référence à la chaîne d'outils initiale.

À partir de là, les Bintulis et GCC finaux (pas visibles ci-dessus) sont construits.  GCC utilise ld du Binutils final et lie les programme avec la libc qui vient d'être construite.  Cette chaîne d'outils est utilisée pour construire les autres paquets utilisés par Guix et par le système de construction de GNU : Guile, Bash, Coreutils, etc.

Et voilà !  À partir de là nous avons l'ensemble complet des outils auxquels s'attend le système de construction GNU.  Ils sont dans la variable %final-inputs du module (gnu packages commencement) et sont implicitement utilisés par tous les paquets qui utilisent le gnu-build-system (see gnu-build-system).

Construire les binaires de bootstrap
====================================

Comme la chaîne d'outils finale ne dépend pas des binaires de bootstrap, ils ont rarement besoin d'être mis à jour.  Cependant, il est utile d'avoir une manière de faire cela automatiquement, dans le cas d'une mise à jour et c'est ce que le module (gnu packages make-bootstrap) fournit.

La commande suivante construit les archives contenant les binaires de bootstrap (Guile, Binutils, GCC, la libc et une archive contenant un mélange de Coreutils et d'autres outils en ligne de commande de base) :

     guix build bootstrap-tarballs

Les archives générées sont celles qui devraient être référencées dans le module (gnu packages bootstrap) au début de cette section.

Vous êtes toujours là ?  Alors peut-être que maintenant vous vous demandez, quand est-ce qu'on atteint un point fixe ?  C'est une question intéressante !  La réponse est inconnue, mais si vous voulez enquêter plus profondément (et que vous avez les ressources en puissance de calcul et en capacité de stockage pour cela), dites-le nous.

Réduire l'ensemble des binaires de bootstrap
============================================

Nous binaires de bootstrap incluent actuellement GCC, Guile, etc.  C'est beaucoup de code binaire !  Pourquoi est-ce un problème ?  C'est un problème parce que ces gros morceaux de code binaire sont en pratique impossibles à auditer, ce qui fait qu'il est difficile d'établir quel code source les a produit.  Chaque binaire non auditable nous rend aussi vulnérable à des portes dérobées dans les compilateurs comme le décrit Ken Thompson dans le papier de 1984 Reflections on Trusting Trust.

Cela est rendu moins inquiétant par le fait que les binaires de bootstrap ont été générés par une révision antérieure de Guix.  Cependant, il leur manque le niveau de transparence que l'on obtient avec le reste des paquets du graphe de dépendance, où Guix nous donne toujours une correspondance source-binaire.  Ainsi, notre but est de réduire l'ensemble des binaires de bootstrap au minimum.

Le site web Bootstrappable.org (http://bootstrappable.org) liste les projets en cours à ce sujet.  L'un d'entre eux parle de remplacer le GCC de bootstrap par une série d'assembleurs, d'interpréteurs et de compilateurs d'une complexité croissante, qui pourraient être construits à partir des sources à partir d'un assembleur simple et auditable.  Votre aide est la bienvenue !

Porter vers une nouvelle plateforme
***********************************

Comme nous en avons discuté plus haut, la distribution GNU est auto-contenue, et cela est possible en se basant sur des « binaires de bootstrap » pré-construits (see Bootstrapping).  Ces binaires sont spécifiques au noyau de système d'exploitation, à l'architecture CPU et à l'interface applicative binaire (ABI).  Ainsi, pour porter la distribution sur une plateforme qui n'est pas encore supportée, on doit construire ces binaires de bootstrap et mettre à jour le module (gnu packages bootstrap) pour les utiliser sur cette plateforme.

Heureusement, Guix peut effectuer une compilation croisée de ces binaires de bootstrap.  Lorsque tout va bien, et en supposant que la chaîne d'outils GNU supporte la plateforme cible, cela peut être aussi simple que de lancer une commande comme ceci :

     guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs

Pour que cela fonctione, la procédure glibc-dynamic-linker dans (gnu packages bootstrap) doit être augmentée pour renvoyer le bon nom de fichier pour l'éditeur de lien dynamique de la libc sur cette plateforme ; de même, il faut indiquer cette nouvelle platefore à system->linux-architecture dans (gnu packages linux).

Une fois qu'ils sont construits, le module (gnu packages bootstrap) doit être mis à jour pour se référer à ces binaires sur la plateforme cible.  C'est à dire que les hashs et les URL des archives de bootstrap pour la nouvelle plateforme doivent être ajoutés avec ceux des plateformes actuellement supportées.  L'archive de bootstrap de Guile est traitée séparément : elle doit être disponible localement, et gnu/local.mk a une règle pour la télécharger pour les architectures supportées ; vous devez également ajouter une règle pour la nouvelle plateforme.

En pratique, il peut y avoir des complications.  Déjà, il se peut que le triplet GNU étendu qui spécifie l'ABI (comme le suffixe eabi ci-dessus) ne soit pas reconnu par tous les outils GNU.  Typiquement, la glibc en reconnais certains, alors que GCC utilise un drapeau de configure --with-abi supplémentaire (voir gcc.scm pour trouver des exemples où ce cas est géré).  Ensuite, certains des paquets requis pourraient échouer à se construire pour cette plateforme.  Enfin, les binaires générés pourraient être cassé pour une raison ou une autre.

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