1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: \n"
10 "Report-Msgid-Bugs-To: ludo@gnu.org\n"
11 "POT-Creation-Date: 2018-04-29 20:48+0200\n"
12 "PO-Revision-Date: 2018-04-13 22:46+0200\n"
13 "Last-Translator: Julien Lepiller <julien@lepiller.eu>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
19 "#-#-#-#-# contributing.fr.po #-#-#-#-#\n"
20 "X-Generator: Poedit 2.0.6\n"
21 "#-#-#-#-# guix.fr.po #-#-#-#-#\n"
22 "X-Generator: Poedit 2.0.6\n"
24 #. #-#-#-#-# contributing.pot (guix 0.14.0.4289-6527) #-#-#-#-#
26 #. #-#-#-#-# guix.pot (guix 0.14.0.4289-6527) #-#-#-#-#
28 #: doc/contributing.texi:1 doc/contributing.texi:2 doc/guix.texi:106
35 #: doc/contributing.texi:9
37 "This project is a cooperative effort, and we need your help to make it grow! "
38 "Please get in touch with us on @email{guix-devel@@gnu.org} and @code{#guix} "
39 "on the Freenode IRC network. We welcome ideas, bug reports, patches, and "
40 "anything that may be helpful to the project. We particularly welcome help "
41 "on packaging (@pxref{Packaging Guidelines})."
43 "Ce projet est un effort coopératif et nous avons besoin de votre aide pour "
44 "le faire grandir ! Contactez-nous sur @email{guix-devel@@gnu.org} et "
45 "@code{#guix} sur le réseau IRC Freenode. Nous accueillons les idées, les "
46 "rapports de bogues, les correctifs et tout ce qui pourrait aider le projet. "
47 "Nous apprécions particulièrement toute aide sur la création de paquets "
48 "(@pxref{Consignes d'empaquetage})."
51 #: doc/contributing.texi:10
53 msgid "code of conduct, of contributors"
54 msgstr "code de conduite, des contributeurs"
57 #: doc/contributing.texi:11
59 msgid "contributor covenant"
60 msgstr "convention de contribution"
63 #: doc/contributing.texi:17
65 "We want to provide a warm, friendly, and harassment-free environment, so "
66 "that anyone can contribute to the best of their abilities. To this end our "
67 "project uses a ``Contributor Covenant'', which was adapted from @url{http://"
68 "contributor-covenant.org/}. You can find a local version in the @file{CODE-"
69 "OF-CONDUCT} file in the source tree."
71 "Nous souhaitons fournir un environnement chaleureux, amical et sans "
72 "harcèlement pour que tout le monde puisse contribuer au mieux de ses "
73 "capacités. Pour cela notre projet a une « Convention de contribution » "
74 "adaptée de @url{http://contributor-covenant.org/}. Vous pouvez trouver une "
75 "version locale dans le fichier @file{CODE-OF-CONDUCT} dans l'arborescence "
79 #: doc/contributing.texi:21
81 "Contributors are not required to use their legal name in patches and on-line "
82 "communication; they can use any name or pseudonym of their choice."
84 "Les contributeurs n'ont pas besoin d'utiliser leur nom légal dans leurs "
85 "correctifs et leurs communications en ligne ; ils peuvent utiliser n'importe "
86 "quel nom ou pseudonyme de leur choix."
88 #. #-#-#-#-# contributing.pot (guix 0.14.0.4289-6527) #-#-#-#-#
90 #. #-#-#-#-# guix.pot (guix 0.14.0.4289-6527) #-#-#-#-#
92 #: doc/contributing.texi:28 doc/contributing.texi:30 doc/contributing.texi:31
95 msgid "Building from Git"
96 msgstr "Construire depuis Git"
99 #: doc/contributing.texi:28 doc/guix.texi:282
100 msgid "The latest and greatest."
103 #. #-#-#-#-# contributing.pot (guix 0.14.0.4289-6527) #-#-#-#-#
105 #. #-#-#-#-# guix.pot (guix 0.14.0.4289-6527) #-#-#-#-#
107 #: doc/contributing.texi:28 doc/contributing.texi:102 doc/contributing.texi:103
110 msgid "Running Guix Before It Is Installed"
111 msgstr "Lancer Guix avant qu'il ne soit installé"
114 #: doc/contributing.texi:28 doc/guix.texi:282
115 msgid "Hacker tricks."
116 msgstr "Astuces pour les hackers."
118 #. #-#-#-#-# contributing.pot (guix 0.14.0.4289-6527) #-#-#-#-#
120 #. #-#-#-#-# guix.pot (guix 0.14.0.4289-6527) #-#-#-#-#
122 #: doc/contributing.texi:28 doc/contributing.texi:169 doc/contributing.texi:170
125 msgid "The Perfect Setup"
126 msgstr "La configuration parfaite"
129 #: doc/contributing.texi:28 doc/guix.texi:282
130 msgid "The right tools."
131 msgstr "Les bons outils."
133 #. #-#-#-#-# contributing.pot (guix 0.14.0.4289-6527) #-#-#-#-#
135 #. #-#-#-#-# guix.pot (guix 0.14.0.4289-6527) #-#-#-#-#
137 #: doc/contributing.texi:28 doc/contributing.texi:228 doc/contributing.texi:229
138 #: doc/guix.texi:282 doc/guix.texi:284
141 msgstr "Style de code"
144 #: doc/contributing.texi:28 doc/guix.texi:282
145 msgid "Hygiene of the contributor."
146 msgstr "Hygiène du contributeur."
148 #. #-#-#-#-# contributing.pot (guix 0.14.0.4289-6527) #-#-#-#-#
150 #. #-#-#-#-# guix.pot (guix 0.14.0.4289-6527) #-#-#-#-#
152 #: doc/contributing.texi:28 doc/contributing.texi:326 doc/contributing.texi:327
155 msgid "Submitting Patches"
156 msgstr "Envoyer des correctifs"
159 #: doc/contributing.texi:28 doc/guix.texi:282
160 msgid "Share your work."
161 msgstr "Partager votre travail."
164 #: doc/contributing.texi:35
166 "If you want to hack Guix itself, it is recommended to use the latest version "
167 "from the Git repository:"
169 "Si vous souhaitez travailler sur Guix lui-même, il est recommandé d'utiliser "
170 "la dernière version du dépôt Git :"
173 #: doc/contributing.texi:38
175 msgid "git clone https://git.savannah.gnu.org/git/guix.git\n"
176 msgstr "git clone https://git.savannah.gnu.org/git/guix.git\n"
179 #: doc/contributing.texi:43
181 "When building Guix from a checkout, the following packages are required in "
182 "addition to those mentioned in the installation instructions "
183 "(@pxref{Requirements})."
185 "Lors de la construction de Guix depuis un extrait, les paquets suivants sont "
186 "requis en plus de ceux mentionnés dans les instructions d'installation "
187 "(@pxref{Prérequis})."
190 #: doc/contributing.texi:45
192 msgid "@url{http://gnu.org/software/autoconf/, GNU Autoconf};"
193 msgstr "@url{http://gnu.org/software/autoconf/, GNU Autoconf};"
196 #: doc/contributing.texi:46
198 msgid "@url{http://gnu.org/software/automake/, GNU Automake};"
199 msgstr "@url{http://gnu.org/software/automake/, GNU Automake};"
202 #: doc/contributing.texi:47
204 msgid "@url{http://gnu.org/software/gettext/, GNU Gettext};"
205 msgstr "@url{http://gnu.org/software/gettext/, GNU Gettext};"
208 #: doc/contributing.texi:48
210 msgid "@url{http://gnu.org/software/texinfo/, GNU Texinfo};"
211 msgstr "@url{http://gnu.org/software/texinfo/, GNU Texinfo};"
214 #: doc/contributing.texi:49
216 msgid "@url{http://www.graphviz.org/, Graphviz};"
217 msgstr "@url{http://www.graphviz.org/, Graphviz};"
220 #: doc/contributing.texi:50
222 msgid "@url{http://www.gnu.org/software/help2man/, GNU Help2man (optional)}."
223 msgstr "@url{http://www.gnu.org/software/help2man/, GNU Help2man (facultatif)}."
226 #: doc/contributing.texi:57
228 "The easiest way to set up a development environment for Guix is, of course, "
229 "by using Guix! The following command starts a new shell where all the "
230 "dependencies and appropriate environment variables are set up to hack on "
233 "La manière la plus simple de configurer un environnement de développement "
234 "pour Guix est, bien sûr, d'utiliser Guix ! La commande suivante démarre un "
235 "nouveau shell où toutes les dépendances et les variables d'environnements "
236 "appropriées sont configurés pour travailler sur Guix :"
239 #: doc/contributing.texi:60
241 msgid "guix environment guix\n"
242 msgstr "guix environment guix\n"
245 #: doc/contributing.texi:64
247 "@xref{Invoking guix environment}, for more information on that command. "
248 "Extra dependencies can be added with @option{--ad-hoc}:"
250 "@xref{Invoquer guix environment}, pour plus d'information sur cette "
251 "commande. On peut ajouter des dépendances supplémentaires avec @option{--ad-"
255 #: doc/contributing.texi:67
257 msgid "guix environment guix --ad-hoc help2man git strace\n"
258 msgstr "guix environment guix --ad-hoc help2man git strace\n"
261 #: doc/contributing.texi:71
263 "Run @command{./bootstrap} to generate the build system infrastructure using "
264 "Autoconf and Automake. If you get an error like this one:"
266 "Lancez @command{./bootstrap} pour générer l'infrastructure du système de "
267 "construction avec Autoconf et Automake. Si vous avez une erreur comme :"
270 #: doc/contributing.texi:74
272 msgid "configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES\n"
273 msgstr "configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES\n"
276 #: doc/contributing.texi:83
278 "it probably means that Autoconf couldn’t find @file{pkg.m4}, which is "
279 "provided by pkg-config. Make sure that @file{pkg.m4} is available. The "
280 "same holds for the @file{guile.m4} set of macros provided by Guile. For "
281 "instance, if you installed Automake in @file{/usr/local}, it wouldn’t look "
282 "for @file{.m4} files in @file{/usr/share}. In that case, you have to invoke "
283 "the following command:"
285 "cela signifie probablement qu'Autoconf n'a pas pu trouver @file{pkg.m4} qui "
286 "est fournit par pkg-config. Assurez-vous que @file{pkg.m4} est disponible. "
287 "C'est aussi vrai pour l'ensemble de macros de @file{guile.m4} fournies par "
288 "Guile. Par exemple, si vous avez installé Automake dans @file{/usr/local}, "
289 "il ne cherchera pas les fichiers @file{.m4} dans @file{/usr/share}. Dans ce "
290 "case vous devez invoquer la commande suivante :"
293 #: doc/contributing.texi:86
295 msgid "export ACLOCAL_PATH=/usr/share/aclocal\n"
296 msgstr "export ACLOCAL_PATH=/usr/share/aclocal\n"
299 #: doc/contributing.texi:90
301 "@xref{Macro Search Path,,, automake, The GNU Automake Manual}, for more "
304 "@xref{Macro Search Path,,, automake, The GNU Automake Manual}, pour plus "
308 #: doc/contributing.texi:95
310 "Then, run @command{./configure} as usual. Make sure to pass @code{--"
311 "localstatedir=@var{directory}} where @var{directory} is the "
312 "@code{localstatedir} value used by your current installation (@pxref{The "
313 "Store}, for information about this)."
315 "Ensuite, lancez @command{./configure} comme d'habitude. Assurez-vous de "
316 "passer @code{--localstatedir=@var{directory}} où @var{directory} est la "
317 "valeur @code{localstatedir} utilisée par votre installation actuelle "
318 "(@pxref{Le dépôt} pour plus d'informations à ce propos)."
321 #: doc/contributing.texi:100
323 "Finally, you have to invoke @code{make check} to run tests (@pxref{Running "
324 "the Test Suite}). If anything fails, take a look at installation "
325 "instructions (@pxref{Installation}) or send a message to the @email{guix-"
326 "devel@@gnu.org, mailing list}."
328 "Finalement, vous devez invoquer @code{make check} pour lancer les tests "
329 "(@pxref{Lancer la suite de tests}). Si quelque chose échoue, jetez un œil "
330 "aux instructions d'installation (@pxref{Installation}) ou envoyez un message "
331 "à la list @email{guix-devel@@gnu.org}."
334 #: doc/contributing.texi:109
336 "In order to keep a sane working environment, you will find it useful to test "
337 "the changes made in your local source tree checkout without actually "
338 "installing them. So that you can distinguish between your ``end-user'' hat "
339 "and your ``motley'' costume."
341 "Pour garder un environnement de travail sain, il est utile de tester les "
342 "changement localement sans les installer pour de vrai. Pour pouvoir "
343 "distinguer votre rôle « d'utilisateur final » de celui parfois haut en "
344 "couleur de « développeur »."
347 #: doc/contributing.texi:117
349 "To that end, all the command-line tools can be used even if you have not run "
350 "@code{make install}. To do that, prefix each command with @command{./pre-"
351 "inst-env} (the @file{pre-inst-env} script lives in the top build tree of "
352 "Guix), as in@footnote{The @option{-E} flag to @command{sudo} guarantees that "
353 "@code{GUILE_LOAD_PATH} is correctly set such that @command{guix-daemon} and "
354 "the tools it uses can find the Guile modules they need.}:"
356 "Pour cela, tous les outils en ligne de commande sont utilisables même sans "
357 "avoir lancé @code{make install}. Vous devez pour cela préfixer chaque "
358 "commande par @command{./pre-inst-env} (le script @file{pre-inst-env} se "
359 "trouve dans le répertoire de plus haut niveau de l'arborescence des sources "
360 "de Guix) comme cela@footnote{L'option @option{-E} de @command{sudo} garantie "
361 "que @code{GUILE_LOAD_PATH} est bien paramétré pour @command{guix-daemon} et "
362 "les outils qu'il utilise puissent trouver les modules Guile dont ils ont "
366 #: doc/contributing.texi:121
369 "$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild\n"
370 "$ ./pre-inst-env guix build hello\n"
372 "$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild\n"
373 "$ ./pre-inst-env guix build hello\n"
376 #: doc/contributing.texi:125
377 msgid "Similarly, for a Guile session using the Guix modules:"
378 msgstr "De même, pour une session Guile qui utilise les modules Guix :"
381 #: doc/contributing.texi:128
384 "$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))'\n"
387 "$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))'\n"
391 #: doc/contributing.texi:130
393 msgid ";;; (\"x86_64-linux\")\n"
394 msgstr ";;; (\"x86_64-linux\")\n"
397 #: doc/contributing.texi:133
403 #: doc/contributing.texi:134
405 msgid "read-eval-print loop"
406 msgstr "read-eval-print loop"
409 #: doc/contributing.texi:137
411 "@dots{} and for a REPL (@pxref{Using Guile Interactively,,, guile, Guile "
412 "Reference Manual}):"
414 "@dots{} et pour un REPL (@pxref{Using Guile Interactively,,, guile, Guile "
418 #: doc/contributing.texi:152
421 "$ ./pre-inst-env guile\n"
422 "scheme@@(guile-user)> ,use(guix)\n"
423 "scheme@@(guile-user)> ,use(gnu)\n"
424 "scheme@@(guile-user)> (define snakes\n"
426 " (lambda (package lst)\n"
427 " (if (string-prefix? \"python\"\n"
428 " (package-name package))\n"
429 " (cons package lst)\n"
432 "scheme@@(guile-user)> (length snakes)\n"
435 "$ ./pre-inst-env guile\n"
436 "scheme@@(guile-user)> ,use(guix)\n"
437 "scheme@@(guile-user)> ,use(gnu)\n"
438 "scheme@@(guile-user)> (define snakes\n"
440 " (lambda (package lst)\n"
441 " (if (string-prefix? \"python\"\n"
442 " (package-name package))\n"
443 " (cons package lst)\n"
446 "scheme@@(guile-user)> (length snakes)\n"
450 #: doc/contributing.texi:156
452 "The @command{pre-inst-env} script sets up all the environment variables "
453 "necessary to support this, including @env{PATH} and @env{GUILE_LOAD_PATH}."
455 "Le script @command{pre-inst-env} paramètre toutes les variables "
456 "d'environnement nécessaires, dont @env{PATH} et @env{GUILE_LOAD_PATH}."
459 #: doc/contributing.texi:167
461 "Note that @command{./pre-inst-env guix pull} does @emph{not} upgrade the "
462 "local source tree; it simply updates the @file{~/.config/guix/latest} "
463 "symlink (@pxref{Invoking guix pull}). Run @command{git pull} instead if you "
464 "want to upgrade your local source tree.@footnote{If you would like to set up "
465 "@command{guix} to use your Git checkout, you can point the @file{~/.config/"
466 "guix/latest} symlink to your Git checkout directory. If you are the sole "
467 "user of your system, you may also consider pointing the @file{/root/.config/"
468 "guix/latest} symlink to point to @file{~/.config/guix/latest}; this way it "
469 "will always use the same @command{guix} as your user does.}"
471 "Remarquez que @command{./pre-inst-env guix pull} ne met @emph{pas} à jour "
472 "l'arborescence des sources locale ; il met seulement à jour le lien "
473 "symbolique @file{~/.config/guix/latest} (@pxref{Invoquer guix pull}). Lancez "
474 "@command{git pull} à la place si vous voulez mettre à jour votre "
475 "arborescence des sources locale@footnote{Si vous voulez paramétrer "
476 "@command{guix} pour qu'il utilise votre dépôt Git, vous pouvez faire pointer "
477 "le lien symbolique @file{~/.config/guix/latest} vers le répertoire contenant "
478 "ce dépôt. Si vous le seul utilisateur du système, vous pouvez aussi "
479 "considérer faire pointer le lien symbolique @file{/root/.config/guix/latest} "
480 "vers @file{~/.config/guix/latest} ; comme ça root aura toujours la même "
481 "commande @command{guix} que votre utilisateur}."
484 #: doc/contributing.texi:177
486 "The Perfect Setup to hack on Guix is basically the perfect setup used for "
487 "Guile hacking (@pxref{Using Guile in Emacs,,, guile, Guile Reference "
488 "Manual}). First, you need more than an editor, you need @url{http://www.gnu."
489 "org/software/emacs, Emacs}, empowered by the wonderful @url{http://nongnu."
490 "org/geiser/, Geiser}."
492 "La configuration parfaite pour travailler sur Guix est simplement la "
493 "configuration parfaite pour travailler en Guile (@pxref{Using Guile in "
494 "Emacs,,, guile, Guile Reference Manual}). Tout d'abord, vous avez besoin de "
495 "mieux qu'un éditeur de texte, vous avez besoin de @url{http://www.gnu.org/"
496 "software/emacs, Emacs}, amélioré par le superbe @url{http://nongnu.org/"
500 #: doc/contributing.texi:185
502 "Geiser allows for interactive and incremental development from within Emacs: "
503 "code compilation and evaluation from within buffers, access to on-line "
504 "documentation (docstrings), context-sensitive completion, @kbd{M-.} to jump "
505 "to an object definition, a REPL to try out your code, and more "
506 "(@pxref{Introduction,,, geiser, Geiser User Manual}). For convenient Guix "
507 "development, make sure to augment Guile’s load path so that it finds source "
508 "files from your checkout:"
510 "Geiser permet le développement interactif et incrémental depuis Emacs : la "
511 "compilation du code et son évaluation depuis les buffers, l'accès à la "
512 "documentation en ligne (docstrings), la complétion sensible au contexte, "
513 "@kbd{M-.} pour sauter à la définition d'un objet, un REPL pour tester votre "
514 "code, et bien plus (@pxref{Introduction,,, geiser, Geiser User Manual}). "
515 "Pour travailler confortablement sur Guix, assurez-vous de modifier le chemin "
516 "de chargement de Guile pour qu'il trouve les fichiers source de votre dépôt :"
519 #: doc/contributing.texi:190
522 ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n"
523 "(with-eval-after-load 'geiser-guile\n"
524 " (add-to-list 'geiser-guile-load-path \"~/src/guix\"))\n"
526 ";; @r{Si l'extrait est dans ~/src/guix.}\n"
527 "(with-eval-after-load 'geiser-guile\n"
528 " (add-to-list 'geiser-guile-load-path \"~/src/guix\"))\n"
531 #: doc/contributing.texi:198
533 "To actually edit the code, Emacs already has a neat Scheme mode. But in "
534 "addition to that, you must not miss @url{http://www.emacswiki.org/emacs/"
535 "ParEdit, Paredit}. It provides facilities to directly operate on the syntax "
536 "tree, such as raising an s-expression or wrapping it, swallowing or "
537 "rejecting the following s-expression, etc."
541 #: doc/contributing.texi:199
543 msgid "code snippets"
544 msgstr "extraits de code"
547 #: doc/contributing.texi:200
553 #: doc/contributing.texi:201
555 msgid "reducing boilerplate"
556 msgstr "réduire la quantité de code commun"
559 #: doc/contributing.texi:208
561 "We also provide templates for common git commit messages and package "
562 "definitions in the @file{etc/snippets} directory. These templates can be "
563 "used with @url{http://joaotavora.github.io/yasnippet/, YASnippet} to expand "
564 "short trigger strings to interactive text snippets. You may want to add the "
565 "snippets directory to the @var{yas-snippet-dirs} variable in Emacs."
567 "Nous fournissons aussi des modèles pour les messages de commit git communs "
568 "et les définitions de paquets dans le répertoire @file{etc/snippets}. Ces "
569 "modèles s'utilisent avec @url{http://joaotavora.github.io/yasnippet/, "
570 "YASnippet} pour développer des chaînes courtes de déclenchement en extraits "
571 "de texte interactifs. Vous pouvez ajouter le répertoire des modèles dans la "
572 "variables @var{yas-snippet-dirs} d'Emacs."
575 #: doc/contributing.texi:213
578 ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n"
579 "(with-eval-after-load 'yasnippet\n"
580 " (add-to-list 'yas-snippet-dirs \"~/src/guix/etc/snippets\"))\n"
582 ";; @r{Si l'extrait est dans ~/src/guix.}\n"
583 "(with-eval-after-load 'yasnippet\n"
584 " (add-to-list 'yas-snippet-dirs \"~/src/guix/etc/snippets\"))\n"
587 #: doc/contributing.texi:220
589 "The commit message snippets depend on @url{https://magit.vc/, Magit} to "
590 "display staged files. When editing a commit message type @code{add} "
591 "followed by @kbd{TAB} to insert a commit message template for adding a "
592 "package; type @code{update} followed by @kbd{TAB} to insert a template for "
593 "updating a package."
595 "Les extraits de messages de commit dépendent de @url{https://magit.vc/, "
596 "Magit} pour afficher les fichiers sélectionnés. Lors de la modification d'un "
597 "message de commit, tapez @code{add} suivi de @kbd{TAB} pour insérer un "
598 "modèle de message de commit pour ajouter un paquet ; tapez @code{update} "
599 "suivi de @kbd{TAB} pour insérer un modèle pour la mise à jour d'un paquet."
602 #: doc/contributing.texi:226
604 "The main snippet for @code{scheme-mode} is triggered by typing "
605 "@code{package...} followed by @kbd{TAB}. This snippet also inserts the "
606 "trigger string @code{origin...}, which can be expanded further. The "
607 "@code{origin} snippet in turn may insert other trigger strings ending on "
608 "@code{...}, which also can be expanded further."
610 "L'extrait principal pour @code{scheme-mode} est lancé en tapant "
611 "@code{package…} suivi par @kbd{TAB}. Cet extrait insère aussi la chaîne de "
612 "déclenchement @code{origin…}, qui peut aussi être étendue. L'extrait "
613 "@code{origin} lui-même peut aussi insérer des chaînes de déclenchement qui "
614 "finissent sur @code{…}, qui peuvent aussi être étendues."
617 #: doc/contributing.texi:234
619 "In general our code follows the GNU Coding Standards (@pxref{Top,,, "
620 "standards, GNU Coding Standards}). However, they do not say much about "
621 "Scheme, so here are some additional rules."
623 "En général notre code suit le Standard de Code GNU (@pxref{Top,,, standards, "
624 "GNU Coding Standards}). Cependant, il ne parle pas beaucoup de Scheme, donc "
625 "voici quelques règles supplémentaires."
627 #. #-#-#-#-# contributing.pot (guix 0.14.0.4289-6527) #-#-#-#-#
629 #. #-#-#-#-# guix.pot (guix 0.14.0.4289-6527) #-#-#-#-#
631 #: doc/contributing.texi:240 doc/contributing.texi:242
632 #: doc/contributing.texi:243 doc/guix.texi:289
634 msgid "Programming Paradigm"
635 msgstr "Paradigme de programmation"
638 #: doc/contributing.texi:240 doc/guix.texi:289
639 msgid "How to compose your elements."
640 msgstr "Comment composer vos éléments."
642 #. #-#-#-#-# contributing.pot (guix 0.14.0.4289-6527) #-#-#-#-#
644 #. #-#-#-#-# guix.pot (guix 0.14.0.4289-6527) #-#-#-#-#
646 #: doc/contributing.texi:240 doc/contributing.texi:249
647 #: doc/contributing.texi:250 doc/guix.texi:289
653 #: doc/contributing.texi:240 doc/guix.texi:289
654 msgid "Where to store your code?"
655 msgstr "Où stocker votre code ?"
657 #. #-#-#-#-# contributing.pot (guix 0.14.0.4289-6527) #-#-#-#-#
659 #. #-#-#-#-# guix.pot (guix 0.14.0.4289-6527) #-#-#-#-#
661 #: doc/contributing.texi:240 doc/contributing.texi:260
662 #: doc/contributing.texi:261 doc/guix.texi:289
664 msgid "Data Types and Pattern Matching"
665 msgstr "Types de données et reconnaissance de motif"
668 #: doc/contributing.texi:240 doc/guix.texi:289
669 msgid "Implementing data structures."
670 msgstr "Implémenter des structures de données."
672 #. #-#-#-#-# contributing.pot (guix 0.14.0.4289-6527) #-#-#-#-#
674 #. #-#-#-#-# guix.pot (guix 0.14.0.4289-6527) #-#-#-#-#
676 #: doc/contributing.texi:240 doc/contributing.texi:274
677 #: doc/contributing.texi:275 doc/guix.texi:289
679 msgid "Formatting Code"
680 msgstr "Formatage du code"
683 #: doc/contributing.texi:240 doc/guix.texi:289
684 msgid "Writing conventions."
685 msgstr "Conventions d'écriture."
688 #: doc/contributing.texi:248
690 "Scheme code in Guix is written in a purely functional style. One exception "
691 "is code that involves input/output, and procedures that implement low-level "
692 "concepts, such as the @code{memoize} procedure."
694 "Le code Scheme dans Guix est écrit dans un style purement fonctionnel. Le "
695 "code qui s'occupe des entrées-sorties est une exception ainsi que les "
696 "procédures qui implémentent des concepts bas-niveau comme la procédure "
700 #: doc/contributing.texi:256
702 "Guile modules that are meant to be used on the builder side must live in the "
703 "@code{(guix build @dots{})} name space. They must not refer to other Guix "
704 "or GNU modules. However, it is OK for a ``host-side'' module to use a build-"
707 "Les modules Guile qui sont sensés être utilisés du côté de la construction "
708 "doivent se trouver dans l'espace de nom @code{(guix build @dots{})}. Ils ne "
709 "doivent pas se référer à d'autres modules Guix ou GNU. Cependant il est "
710 "correct pour un module « côté hôte » de dépendre d'un module coté "
714 #: doc/contributing.texi:259
716 "Modules that deal with the broader GNU system should be in the @code{(gnu "
717 "@dots{})} name space rather than @code{(guix @dots{})}."
719 "Les modules qui s'occupent du système GNU général devraient se trouver dans "
720 "l'espace de nom @code{(gnu @dots{})} plutôt que @code{(guix @dots{})}."
723 #: doc/contributing.texi:268
725 "The tendency in classical Lisp is to use lists to represent everything, and "
726 "then to browse them ``by hand'' using @code{car}, @code{cdr}, @code{cadr}, "
727 "and co. There are several problems with that style, notably the fact that "
728 "it is hard to read, error-prone, and a hindrance to proper type error "
731 "La tendance en Lisp classique est d'utiliser des listes pour tout "
732 "représenter et de naviguer dedans « à la main ( avec @code{car}, @code{cdr}, "
733 "@code{cadr} et compagnie. Il y a plusieurs problèmes avec ce style, "
734 "notamment le fait qu'il soit dur à lire, source d'erreur et un obstacle aux "
735 "rapports d'erreur bien typés."
738 #: doc/contributing.texi:273
740 "Guix code should define appropriate data types (for instance, using "
741 "@code{define-record-type*}) rather than abuse lists. In addition, it should "
742 "use pattern matching, via Guile’s @code{(ice-9 match)} module, especially "
743 "when matching lists."
745 "Le code de Guix devrait définir des types de données appropriées (par "
746 "exemple, avec @code{define-record-type*}) plutôt que d'abuser des listes. En "
747 "plus, il devrait utiliser la recherche de motifs, via le module Guile "
748 "@code{(ice-9 match)}, surtout pour rechercher dans des listes."
751 #: doc/contributing.texi:277
753 msgid "formatting code"
754 msgstr "formater le code"
757 #: doc/contributing.texi:278
760 msgstr "style de code"
763 #: doc/contributing.texi:285
765 "When writing Scheme code, we follow common wisdom among Scheme programmers. "
766 "In general, we follow the @url{http://mumble.net/~campbell/scheme/style.txt, "
767 "Riastradh's Lisp Style Rules}. This document happens to describe the "
768 "conventions mostly used in Guile’s code too. It is very thoughtful and well "
769 "written, so please do read it."
771 "Lorsque nous écrivons du code Scheme, nous suivons la sagesse commune aux "
772 "programmeurs Scheme. En général, nous suivons les @url{http://mumble.net/"
773 "~campbell/scheme/style.txt, règles de style de Riastradh}. Ce document "
774 "décrit aussi les conventions utilisées dans le code de Guile. Il est bien "
775 "pensé et bien écrit, alors n'hésitez pas à le lire."
778 #: doc/contributing.texi:292
780 "Some special forms introduced in Guix, such as the @code{substitute*} macro, "
781 "have special indentation rules. These are defined in the @file{.dir-locals."
782 "el} file, which Emacs automatically uses. Also note that Emacs-Guix "
783 "provides @code{guix-devel-mode} mode that indents and highlights Guix code "
784 "properly (@pxref{Development,,, emacs-guix, The Emacs-Guix Reference "
787 "Certaines formes spéciales introduites dans Guix comme la macro "
788 "@code{substitute*} ont des règles d'indentation spécifiques. Elles sont "
789 "définies dans le fichier @file{.dir-locals.el} qu'Emacs utilise "
790 "automatiquement. Remarquez aussi qu'Emacs-Guix fournit le mode @code{guix-"
791 "devel-mode} qui indente et colore le code Guix correctement "
792 "(@pxref{Development,,, emacs-guix, The Emacs-Guix Reference Manual})."
795 #: doc/contributing.texi:293
797 msgid "indentation, of code"
798 msgstr "indentation, du code"
801 #: doc/contributing.texi:294
803 msgid "formatting, of code"
804 msgstr "formatage, du code"
807 #: doc/contributing.texi:297
809 "If you do not use Emacs, please make sure to let your editor knows these "
810 "rules. To automatically indent a package definition, you can also run:"
812 "Si vous n'utilisez pas Emacs, assurez-vous que votre éditeur connaisse ces "
813 "règles. Pour indenter automatiquement une définition de paquet, vous pouvez "
817 #: doc/contributing.texi:300
819 msgid "./etc/indent-code.el gnu/packages/@var{file}.scm @var{package}\n"
820 msgstr "./etc/indent-code.el gnu/packages/@var{file}.scm @var{package}\n"
823 #: doc/contributing.texi:306
825 "This automatically indents the definition of @var{package} in @file{gnu/"
826 "packages/@var{file}.scm} by running Emacs in batch mode. To indent a whole "
827 "file, omit the second argument:"
829 "Cela indente automatiquement la définition de @var{package} dans @file{gnu/"
830 "packages/@var{file}.scm} en lançant Emacs en mode commande. Pour indenter un "
831 "fichier complet, n'indiquez pas de second argument :"
834 #: doc/contributing.texi:309
836 msgid "./etc/indent-code.el gnu/services/@var{file}.scm\n"
837 msgstr "./etc/indent-code.el gnu/services/@var{file}.scm\n"
840 #: doc/contributing.texi:311
842 msgid "Vim, Scheme code editing"
846 #: doc/contributing.texi:317
848 "If you are editing code with Vim, we recommend that you run @code{:set "
849 "autoindent} so that your code is automatically indented as you type. "
850 "Additionally, @uref{https://www.vim.org/scripts/script.php?script_id=3998, "
851 "@code{paredit.vim}} may help you deal with all these parentheses."
855 #: doc/contributing.texi:321
857 "We require all top-level procedures to carry a docstring. This requirement "
858 "can be relaxed for simple private procedures in the @code{(guix build "
859 "@dots{})} name space, though."
861 "Nous demandons que toutes les procédure de premier niveau contiennent une "
862 "chaîne de documentation. Ce pré-requis peut être relâché pour les procédures "
863 "privées simples dans l'espace de nom @code{(guix build @dots{})} cependant."
866 #: doc/contributing.texi:324
868 "Procedures should not have more than four positional parameters. Use "
869 "keyword parameters for procedures that take more than four parameters."
871 "Les procédures ne devraient pas avoir plus de quatre paramètres positionnés. "
872 "Utilisez des paramètres par mot-clefs pour les procédures qui prennent plus "
873 "de quatre paramètres."
876 #: doc/contributing.texi:333
878 "Development is done using the Git distributed version control system. Thus, "
879 "access to the repository is not strictly necessary. We welcome "
880 "contributions in the form of patches as produced by @code{git format-patch} "
881 "sent to the @email{guix-patches@@gnu.org} mailing list."
883 "Le développement se fait avec le système de contrôle de version Git. Ainsi, "
884 "l'accès au dépôt n'est pas strictement nécessaire. Nous accueillons les "
885 "contributions sous forme de correctifs produits par @code{git format-patch} "
886 "envoyés sur la liste de diffusion @email{guix-patches@@gnu.org}."
889 #: doc/contributing.texi:340
891 "This mailing list is backed by a Debbugs instance accessible at "
892 "@uref{https://bugs.gnu.org/guix-patches}, which allows us to keep track of "
893 "submissions. Each message sent to that mailing list gets a new tracking "
894 "number assigned; people can then follow up on the submission by sending "
895 "email to @code{@var{NNN}@@debbugs.gnu.org}, where @var{NNN} is the tracking "
896 "number (@pxref{Sending a Patch Series})."
898 "Cette liste de diffusion est gérée par une instance Debbugs accessible à "
899 "l'adresse @uref{https://bugs.gnu.org/guix-patches}, qui nous permet de "
900 "suivre les soumissions. Chaque message envoyé à cette liste se voit "
901 "attribuer un numéro de suivi ; les gens peuvent ensuite répondre à cette "
902 "soumission en envoyant un courriel à @code{@var{NNN}@@debbugs.gnu.org}, où "
903 "@var{NNN} est le numéro de suivi (@pxref{Envoyer une série de correctifs})."
906 #: doc/contributing.texi:344
908 "Please write commit logs in the ChangeLog format (@pxref{Change Logs,,, "
909 "standards, GNU Coding Standards}); you can check the commit history for "
912 "Veuillez écrire les messages de commit dans le format ChangeLog "
913 "(@pxref{Change Logs,,, standards, GNU Coding Standards}) ; vous pouvez "
914 "regarder l'historique des commits pour trouver des exemples."
917 #: doc/contributing.texi:347
919 "Before submitting a patch that adds or modifies a package definition, please "
920 "run through this check list:"
922 "Avant de soumettre un correctif qui ajoute ou modifie la définition d'un "
923 "paquet, veuillez vérifier cette check-list :"
926 #: doc/contributing.texi:354
928 "If the authors of the packaged software provide a cryptographic signature "
929 "for the release tarball, make an effort to verify the authenticity of the "
930 "archive. For a detached GPG signature file this would be done with the "
931 "@code{gpg --verify} command."
933 "Si les auteurs du paquet logiciel fournissent une signature cryptographique "
934 "pour l'archive, faîtes un effort pour vérifier l'authenticité de l'archive. "
935 "Pour un fichier de signature GPG détaché, cela se fait avec la commande "
936 "@code{gpg --verify}."
939 #: doc/contributing.texi:358
941 "Take some time to provide an adequate synopsis and description for the "
942 "package. @xref{Synopses and Descriptions}, for some guidelines."
944 "Prenez un peu de temps pour fournir un synopsis et une description adéquats "
945 "pour le paquet. Voir @xref{Synopsis et descriptions} pour quelques lignes "
949 #: doc/contributing.texi:363
951 "Run @code{guix lint @var{package}}, where @var{package} is the name of the "
952 "new or modified package, and fix any errors it reports (@pxref{Invoking guix "
955 "Lancez @code{guix lint @var{paquet}}, où @var{paquet} est le nom du nouveau "
956 "paquet ou du paquet modifié, et corrigez les erreurs qu'il rapporte "
957 "(@pxref{Invoquer guix lint})."
960 #: doc/contributing.texi:367
962 "Make sure the package builds on your platform, using @code{guix build "
965 "Assurez-vous que le paquet se construise sur votre plate-forme avec "
966 "@code{guix build @var{paquet}}."
969 #: doc/contributing.texi:369
972 msgstr "construction groupée"
975 #: doc/contributing.texi:372
977 "Make sure the package does not use bundled copies of software already "
978 "available as separate packages."
980 "Assurez-vous que le paquet n'utilise pas de copie groupée d'un logiciel déjà "
981 "disponible dans un paquet séparé."
984 #: doc/contributing.texi:381
986 "Sometimes, packages include copies of the source code of their dependencies "
987 "as a convenience for users. However, as a distribution, we want to make "
988 "sure that such packages end up using the copy we already have in the "
989 "distribution, if there is one. This improves resource usage (the dependency "
990 "is built and stored only once), and allows the distribution to make "
991 "transverse changes such as applying security updates for a given software "
992 "package in a single place and have them affect the whole system---something "
993 "that bundled copies prevent."
995 "Parfois, les paquets incluent des copie du code source de leurs dépendances "
996 "pour le confort de leurs utilisateurs. Cependant, en tant que distribution, "
997 "nous voulons nous assurer que ces paquets utilisent bien les copient que "
998 "nous avons déjà dans la distribution si elles existent. Cela améliore "
999 "l'utilisation des ressources (la dépendance n'est construite et stockée "
1000 "qu'une seule fois) et permet à la distribution de faire des changements "
1001 "transversaux comme appliquer des correctifs de sécurité pour un paquet donné "
1002 "depuis un unique emplacement et qu'ils affectent tout le système, ce "
1003 "qu'empêchent les copies groupées."
1006 #: doc/contributing.texi:388
1008 "Take a look at the profile reported by @command{guix size} (@pxref{Invoking "
1009 "guix size}). This will allow you to notice references to other packages "
1010 "unwillingly retained. It may also help determine whether to split the "
1011 "package (@pxref{Packages with Multiple Outputs}), and which optional "
1012 "dependencies should be used."
1014 "Regardez le profile rapporté par @command{guix size} (@pxref{Invoking guix "
1015 "size}). Cela vous permettra de remarquer des références à d'autres paquets "
1016 "qui ont été retenus. Il peut aussi aider à déterminer s'il faut découper le "
1017 "paquet (@pxref{Des paquets avec plusieurs résultats}) et quelle dépendance "
1018 "facultative utiliser."
1021 #: doc/contributing.texi:393
1023 "For important changes, check that dependent package (if applicable) are not "
1024 "affected by the change; @code{guix refresh --list-dependent @var{package}} "
1025 "will help you do that (@pxref{Invoking guix refresh})."
1027 "Pour les changements important, vérifiez que les paquets qui en dépendent "
1028 "(s'ils existent) ne sont pas affectés par le changement ; @code{guix refresh "
1029 "--list-dependant @var{paquet}} vous aidera (@pxref{Invoquer guix refresh})."
1032 #: doc/contributing.texi:395
1034 msgid "branching strategy"
1035 msgstr "stratégie de branche"
1038 #: doc/contributing.texi:396
1040 msgid "rebuild scheduling strategy"
1041 msgstr "stratégie de planification des reconstructions"
1044 #: doc/contributing.texi:399
1046 "Depending on the number of dependent packages and thus the amount of "
1047 "rebuilding induced, commits go to different branches, along these lines:"
1049 "Suivant le nombre de paquets dépendants et donc le nombre de reconstruction "
1050 "induites, les commits vont vers des branches différentes, suivant ces "
1054 #: doc/contributing.texi:401
1056 msgid "300 dependent packages or less"
1057 msgstr "300 paquets dépendants ou moins"
1060 #: doc/contributing.texi:403
1061 msgid "@code{master} branch (non-disruptive changes)."
1062 msgstr "branche @code{master} (changements non-disruptifs)."
1065 #: doc/contributing.texi:404
1067 msgid "between 300 and 1,200 dependent packages"
1068 msgstr "entre 300 et 1 200 paquets dépendants"
1071 #: doc/contributing.texi:409
1073 "@code{staging} branch (non-disruptive changes). This branch is intended to "
1074 "be merged in @code{master} every 3 weeks or so. Topical changes (e.g., an "
1075 "update of the GNOME stack) can instead go to a specific branch (say, "
1076 "@code{gnome-updates})."
1078 "branche @code{staging} (changemets non-disruptifs). Cette branche devrait "
1079 "être fusionnées dans @code{master} tous les 3 semaines. Les changements par "
1080 "thèmes (par exemple une mise à jour de la pile GNOME) peuvent aller dans une "
1081 "branche spécifique (disons, @code{gnome-updates})."
1084 #: doc/contributing.texi:410
1086 msgid "more than 1,200 dependent packages"
1087 msgstr "plus de 1 200 paquets dépendants"
1090 #: doc/contributing.texi:414
1092 "@code{core-updates} branch (may include major and potentially disruptive "
1093 "changes). This branch is intended to be merged in @code{master} every 2.5 "
1096 "branche @code{core-updates} (peut inclure des changements majeurs et "
1097 "potentiellement disruptifs). Cette branche devrait être fusionnée dans "
1098 "@code{master} tous les 2,5 mois environ."
1101 #: doc/contributing.texi:421
1103 "All these branches are tracked by our build farm and merged into "
1104 "@code{master} once everything has been successfully built. This allows us "
1105 "to fix issues before they hit users, and to reduce the window during which "
1106 "pre-built binaries are not available."
1108 "Toutes ces branches sont gérées par notre ferme de construction et "
1109 "fusionnées dans @code{master} une fois que tout a été construit "
1110 "correctement. Cela nous permet de corriger des problèmes avant qu'ils "
1111 "n'atteignent les utilisateurs et réduit la fenêtre pendant laquelle les "
1112 "binaires pré-construits ne sont pas disponibles."
1115 #: doc/contributing.texi:423
1117 msgid "determinism, of build processes"
1118 msgstr "déterminisme, du processus de construction"
1121 #: doc/contributing.texi:424
1123 msgid "reproducible builds, checking"
1124 msgstr "construction reproductibles, vérification"
1127 #: doc/contributing.texi:428
1129 "Check whether the package's build process is deterministic. This typically "
1130 "means checking whether an independent build of the package yields the exact "
1131 "same result that you obtained, bit for bit."
1133 "Vérifiez si le processus de construction du paquet est déterministe. Cela "
1134 "signifie typiquement vérifier qu'une construction indépendante du paquet "
1135 "renvoie exactement le même résultat que vous avez obtenu, bit à bit."
1138 #: doc/contributing.texi:431
1140 "A simple way to do that is by building the same package several times in a "
1141 "row on your machine (@pxref{Invoking guix build}):"
1143 "Une manière simple de le faire est de reconstruire le paquet plusieurs fois "
1144 "à la suite sur votre machine (@pxref{Invoquer guix build}) :"
1147 #: doc/contributing.texi:434
1149 msgid "guix build --rounds=2 my-package\n"
1150 msgstr "guix build --rounds=2 mon-paquet\n"
1153 #: doc/contributing.texi:438
1155 "This is enough to catch a class of common non-determinism issues, such as "
1156 "timestamps or randomly-generated output in the build result."
1158 "Cela est suffisant pour trouver une classe de non-déterminisme commune, "
1159 "comme l'horodatage ou des sorties générées aléatoirement dans le résultat de "
1163 #: doc/contributing.texi:448
1165 "Another option is to use @command{guix challenge} (@pxref{Invoking guix "
1166 "challenge}). You may run it once the package has been committed and built "
1167 "by @code{hydra.gnu.org} to check whether it obtains the same result as you "
1168 "did. Better yet: Find another machine that can build it and run "
1169 "@command{guix publish}. Since the remote build machine is likely different "
1170 "from yours, this can catch non-determinism issues related to the hardware---"
1171 "e.g., use of different instruction set extensions---or to the operating "
1172 "system kernel---e.g., reliance on @code{uname} or @file{/proc} files."
1174 "Une autre option consiste à utiliser @command{guix challenge} "
1175 "(@pxref{Invoquer guix challenge}). Vous pouvez lancer la commande une fois "
1176 "que les paquets ont été commités et construits par @code{hydra.gnu.org} pour "
1177 "vérifier s'il obtient le même résultat que vous. Mieux encore : trouvez une "
1178 "autre machine qui peut le construire et lancez @command{guix publish}. Puis "
1179 "la machine distante est sûrement différente de la vôtre, cela peut trouver "
1180 "des problèmes de non-déterminisme liés au matériel — par exemple utiliser "
1181 "une extension du jeu d'instruction — ou du noyau du système d'exploitation — "
1182 "par exemple se reposer sur @code{uname} ou les fichiers de @file{/proc}."
1185 #: doc/contributing.texi:454
1187 "When writing documentation, please use gender-neutral wording when referring "
1188 "to people, such as @uref{https://en.wikipedia.org/wiki/Singular_they, "
1189 "singular ``they''@comma{} ``their''@comma{} ``them''}, and so forth."
1191 "Lorsque vous écrivez de la documentation, utilisez une formulation au genre "
1192 "neutre lorsque vous vous référez à des personnes, comme le @uref{https://fr."
1193 "wikipedia.org/wiki/They_singulier, ``they''@comma{} ``their''@comma{} "
1194 "``them'' singulier} (en anglais)."
1197 #: doc/contributing.texi:458
1199 "Verify that your patch contains only one set of related changes. Bundling "
1200 "unrelated changes together makes reviewing harder and slower."
1202 "Vérifiez que votre correctif contienne seulement un ensemble de changements "
1203 "liés. Grouper des changements non liés ensemble rend la revue plus difficile "
1207 #: doc/contributing.texi:461
1209 "Examples of unrelated changes include the addition of several packages, or a "
1210 "package update along with fixes to that package."
1212 "Ajouter plusieurs paquet ou une mise à jour d'un paquet avec des corrections "
1213 "dans ce paquet sont des exemples de changements sans rapport."
1216 #: doc/contributing.texi:466
1218 "Please follow our code formatting rules, possibly running the @command{etc/"
1219 "indent-code.el} script to do that automatically for you (@pxref{Formatting "
1222 "Suivez nos règles de formatage de code, éventuellement en lançant le script "
1223 "@command{et/indent-code.el} pour le faire automatiquement (@pxref{Formatage "
1227 #: doc/contributing.texi:476
1229 "When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as a "
1230 "subject. You may use your email client or the @command{git send-email} "
1231 "command (@pxref{Sending a Patch Series}). We prefer to get patches in plain "
1232 "text messages, either inline or as MIME attachments. You are advised to pay "
1233 "attention if your email client changes anything like line breaks or "
1234 "indentation which could potentially break the patches."
1236 "Lorsque vous envoyez un correctif à la liste de diffusion, utilisez "
1237 "@samp{[PATCH] @dots{}} comme sujet. Vous pouvez utiliser votre client de "
1238 "courriel ou la commande @command{git send-email} (@pxref{Envoyer une série "
1239 "de correctifs}). Nous préférons recevoir des correctifs en texte brut, soit "
1240 "en ligne, soit en pièce-jointe MIME. Nous vous conseillons de faire "
1241 "attention si votre client de courriel change par exemple les retours à la "
1242 "ligne ou l'indentation, ce qui peut casser les correctifs."
1245 #: doc/contributing.texi:479
1247 "When a bug is resolved, please close the thread by sending an email to "
1248 "@email{@var{NNN}-done@@debbugs.gnu.org}."
1250 "Lorsqu'un bogue est résolu, veuillez fermer le fil en envoyant un courriel à "
1251 "@email{@var{NNN}-done@@debbugs.gnu.org}."
1254 #: doc/contributing.texi:480 doc/contributing.texi:482
1256 msgid "Sending a Patch Series"
1257 msgstr "Envoyer une série de correctifs"
1260 #: doc/contributing.texi:482
1262 msgid "patch series"
1263 msgstr "série de correctifs"
1266 #: doc/contributing.texi:483
1268 msgid "git send-email"
1269 msgstr "git send-email"
1272 #: doc/contributing.texi:484
1274 msgid "git-send-email"
1275 msgstr "git-send-email"
1278 #: doc/contributing.texi:492
1280 "When sending a patch series (e.g., using @code{git send-email}), please "
1281 "first send one message to @email{guix-patches@@gnu.org}, and then send "
1282 "subsequent patches to @email{@var{NNN}@@debbugs.gnu.org} to make sure they "
1283 "are kept together. See @uref{https://debbugs.gnu.org/Advanced.html, the "
1284 "Debbugs documentation} for more information."
1286 "Lorsque vous envoyez une série de correctifs (p.e. avec @code{git send-"
1287 "email}), envoyez d'abord une premier message à @email{guix-patches@@gnu.org} "
1288 "puis envoyez le reste des correctifs à @email{@var{NNN}@@debbugs.gnu.org} "
1289 "pour vous assurer qu'ils seront groupés ensemble. Voyez @uref{https://"
1290 "debbugs.gnu.org/Advanced.html, la documentation de Debbugs} pour plus "
1295 msgid "@documentencoding UTF-8"
1297 "@documentencoding UTF-8\n"
1298 "@documentlanguage fr"
1301 #: doc/guix.texi:7 doc/guix.texi:77
1303 msgid "GNU Guix Reference Manual"
1304 msgstr "Manuel de référence de GNU Guix"
1309 msgid "version.texi"
1310 msgstr "version-fr.texi"
1315 "Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017, 2018 Ludovic "
1316 "Courtès@* Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@* Copyright "
1317 "@copyright{} 2013 Nikita Karetnikov@* Copyright @copyright{} 2014, 2015, "
1318 "2016 Alex Kost@* Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* "
1319 "Copyright @copyright{} 2014 Pierre-Antoine Rault@* Copyright @copyright{} "
1320 "2015 Taylan Ulrich Bayırlı/Kammer@* Copyright @copyright{} 2015, 2016, 2017 "
1321 "Leo Famulari@* Copyright @copyright{} 2015, 2016, 2017, 2018 Ricardo "
1322 "Wurmus@* Copyright @copyright{} 2016 Ben Woodcroft@* Copyright @copyright{} "
1323 "2016, 2017, 2018 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018 "
1324 "Efraim Flashner@* Copyright @copyright{} 2016 John Darrington@* Copyright "
1325 "@copyright{} 2016, 2017 Nils Gillmann@* Copyright @copyright{} 2016, 2017 "
1326 "Jan Nieuwenhuizen@* Copyright @copyright{} 2016 Julien Lepiller@* Copyright "
1327 "@copyright{} 2016 Alex ter Weele@* Copyright @copyright{} 2017, 2018 Clément "
1328 "Lassieur@* Copyright @copyright{} 2017 Mathieu Othacehe@* Copyright "
1329 "@copyright{} 2017 Federico Beffa@* Copyright @copyright{} 2017 Carlo "
1330 "Zancanaro@* Copyright @copyright{} 2017 Thomas Danckaert@* Copyright "
1331 "@copyright{} 2017 humanitiesNerd@* Copyright @copyright{} 2017 Christopher "
1332 "Allan Webber@* Copyright @copyright{} 2017 Marius Bakke@* Copyright "
1333 "@copyright{} 2017 Hartmut Goebel@* Copyright @copyright{} 2017 Maxim "
1334 "Cournoyer@* Copyright @copyright{} 2017, 2018 Tobias Geerinckx-Rice@* "
1335 "Copyright @copyright{} 2017 George Clemmer@* Copyright @copyright{} 2017 "
1336 "Andy Wingo@* Copyright @copyright{} 2017, 2018 Arun Isaac@* Copyright "
1337 "@copyright{} 2017 nee@* Copyright @copyright{} 2018 Rutger Helling@* "
1338 "Copyright @copyright{} 2018 Oleg Pykhalov@* Copyright @copyright{} 2018 Mike "
1341 "Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017, 2018 Ludovic "
1342 "Courtès@* Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@* Copyright "
1343 "@copyright{} 2013 Nikita Karetnikov@* Copyright @copyright{} 2014, 2015, "
1344 "2016 Alex Kost@* Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* "
1345 "Copyright @copyright{} 2014 Pierre-Antoine Rault@* Copyright @copyright{} "
1346 "2015 Taylan Ulrich Bayırlı/Kammer@* Copyright @copyright{} 2015, 2016, 2017 "
1347 "Leo Famulari@* Copyright @copyright{} 2015, 2016, 2017, 2018 Ricardo "
1348 "Wurmus@* Copyright @copyright{} 2016 Ben Woodcroft@* Copyright @copyright{} "
1349 "2016, 2017, 2018 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018 "
1350 "Efraim Flashner@* Copyright @copyright{} 2016 John Darrington@* Copyright "
1351 "@copyright{} 2016, 2017 Nils Gillmann@* Copyright @copyright{} 2016, 2017 "
1352 "Jan Nieuwenhuizen@* Copyright @copyright{} 2016 Julien Lepiller@* Copyright "
1353 "@copyright{} 2016 Alex ter Weele@* Copyright @copyright{} 2017, 2018 Clément "
1354 "Lassieur@* Copyright @copyright{} 2017 Mathieu Othacehe@* Copyright "
1355 "@copyright{} 2017 Federico Beffa@* Copyright @copyright{} 2017 Carlo "
1356 "Zancanaro@* Copyright @copyright{} 2017 Thomas Danckaert@* Copyright "
1357 "@copyright{} 2017 humanitiesNerd@* Copyright @copyright{} 2017 Christopher "
1358 "Allan Webber@* Copyright @copyright{} 2017 Marius Bakke@* Copyright "
1359 "@copyright{} 2017 Hartmut Goebel@* Copyright @copyright{} 2017 Maxim "
1360 "Cournoyer@* Copyright @copyright{} 2017, 2018 Tobias Geerinckx-Rice@* "
1361 "Copyright @copyright{} 2017 George Clemmer@* Copyright @copyright{} 2017 "
1362 "Andy Wingo@* Copyright @copyright{} 2017, 2018 Arun Isaac@* Copyright "
1363 "@copyright{} 2017 nee@* Copyright @copyright{} 2018 Rutger Helling@* "
1364 "Copyright @copyright{} 2018 Oleg Pykhalov@* Copyright @copyright{} 2018 Mike "
1370 "Permission is granted to copy, distribute and/or modify this document under "
1371 "the terms of the GNU Free Documentation License, Version 1.3 or any later "
1372 "version published by the Free Software Foundation; with no Invariant "
1373 "Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the "
1374 "license is included in the section entitled ``GNU Free Documentation "
1377 "Vous avez la permission de copier, distribuer ou modifier ce document sous "
1378 "les termes de la Licence GNU Free Documentation, version 1.3 ou toute "
1379 "version ultérieure publiée par la Free Software Foundation ; sans section "
1380 "invariante, texte de couverture et sans texte de quatrième de couverture. "
1381 "Une copie de la licence est incluse dans la section intitulée « GNU Free "
1382 "Documentation License »."
1384 #. type: dircategory
1387 msgid "System administration"
1388 msgstr "Administration système"
1392 msgid "Guix: (guix)"
1393 msgstr "Guix: (guix)"
1397 msgid "Manage installed software and system configuration."
1398 msgstr "Gérer les logiciels installés et la configuration du système."
1402 msgid "guix package: (guix)Invoking guix package"
1403 msgstr "guix package : (guix)Invoquer guix package"
1407 msgid "Installing, removing, and upgrading packages."
1408 msgstr "Intaller, supprimer et mettre à jour des paquets."
1412 msgid "guix gc: (guix)Invoking guix gc"
1413 msgstr "guix gc : (guix)Invoquer guix gc"
1417 msgid "Reclaiming unused disk space."
1418 msgstr "Récupérer de l'espace disque inutilisé."
1422 msgid "guix pull: (guix)Invoking guix pull"
1423 msgstr "guix pull : (guix)Invoquer guix pull"
1427 msgid "Update the list of available packages."
1428 msgstr "Mettre à jour la liste des paquets disponibles."
1432 msgid "guix system: (guix)Invoking guix system"
1433 msgstr "guix system : (guix)Invoquer guix system"
1437 msgid "Manage the operating system configuration."
1438 msgstr "Gérer la configuration du système d'exploitation."
1440 #. type: dircategory
1443 msgid "Software development"
1444 msgstr "Développement logiciel"
1448 msgid "guix environment: (guix)Invoking guix environment"
1449 msgstr "guix environment : (guix)Invoquer guix environment"
1453 msgid "Building development environments with Guix."
1454 msgstr "Construire des environnements de construction avec Guix."
1458 msgid "guix build: (guix)Invoking guix build"
1459 msgstr "guix build : (guix)Invoquer guix build"
1463 msgid "Building packages."
1464 msgstr "Construire des paquets."
1468 msgid "guix pack: (guix)Invoking guix pack"
1469 msgstr "guix pack : (guix) Invoquer guix pack"
1473 msgid "Creating binary bundles."
1474 msgstr "Créer des lots binaires."
1479 msgid "Using the GNU Guix Functional Package Manager"
1480 msgstr "Utiliser le gestionnaire de paquet fonctionnel GNU Guix"
1485 msgid "The GNU Guix Developers"
1486 msgstr "Les développeurs de GNU Guix"
1490 msgid "Edition @value{EDITION} @* @value{UPDATED} @*"
1491 msgstr "Édition @value{EDITION} @* @value{UPDATED} @*"
1508 "This document describes GNU Guix version @value{VERSION}, a functional "
1509 "package management tool written for the GNU system."
1511 "Cette documentation décrit GNU Guix version @value{VERSION}, un outils de "
1512 "gestion de paquets fonctionnel écrit pour le système GNU."
1515 #: doc/guix.texi:106 doc/guix.texi:294 doc/guix.texi:295
1517 msgid "Introduction"
1518 msgstr "Introduction"
1521 #: doc/guix.texi:106
1522 msgid "What is Guix about?"
1523 msgstr "Qu'est-ce que Guix ?"
1526 #: doc/guix.texi:106 doc/guix.texi:116 doc/guix.texi:367 doc/guix.texi:368
1528 msgid "Installation"
1529 msgstr "Installation"
1532 #: doc/guix.texi:106
1533 msgid "Installing Guix."
1534 msgstr "Installer Guix."
1537 #: doc/guix.texi:106 doc/guix.texi:131 doc/guix.texi:1652 doc/guix.texi:1653
1539 msgid "Package Management"
1540 msgstr "Gestion de paquets"
1543 #: doc/guix.texi:106
1544 msgid "Package installation, upgrade, etc."
1545 msgstr "Installation des paquets, mises à jour, etc."
1548 #: doc/guix.texi:106 doc/guix.texi:151 doc/guix.texi:3106 doc/guix.texi:3107
1550 msgid "Programming Interface"
1551 msgstr "Interface de programmation"
1554 #: doc/guix.texi:106
1555 msgid "Using Guix in Scheme."
1556 msgstr "Utiliser Guix en Scheme."
1559 #: doc/guix.texi:106 doc/guix.texi:165 doc/guix.texi:5362 doc/guix.texi:5363
1562 msgstr "Utilitaires"
1565 #: doc/guix.texi:106
1566 msgid "Package management commands."
1567 msgstr "Commandes de gestion de paquets."
1570 #: doc/guix.texi:106 doc/guix.texi:190 doc/guix.texi:7981 doc/guix.texi:7982
1572 msgid "GNU Distribution"
1573 msgstr "Distribution GNU"
1576 #: doc/guix.texi:106
1577 msgid "Software for your friendly GNU system."
1578 msgstr "Des logiciels pour un système GNU convivial."
1581 #: doc/guix.texi:106
1582 msgid "Your help needed!"
1583 msgstr "Nous avons besoin de votre aide !"
1586 #: doc/guix.texi:111 doc/guix.texi:22338 doc/guix.texi:22339
1588 msgid "Acknowledgments"
1589 msgstr "Remerciements"
1592 #: doc/guix.texi:111
1597 #: doc/guix.texi:111 doc/guix.texi:22360 doc/guix.texi:22361
1599 msgid "GNU Free Documentation License"
1600 msgstr "La licence GNU Free Documentation"
1603 #: doc/guix.texi:111
1604 msgid "The license of this manual."
1605 msgstr "La licence de ce manuel."
1608 #: doc/guix.texi:111 doc/guix.texi:22366 doc/guix.texi:22367
1610 msgid "Concept Index"
1611 msgstr "Index des concepts"
1614 #: doc/guix.texi:111
1616 msgstr "Les concepts."
1619 #: doc/guix.texi:111 doc/guix.texi:22370 doc/guix.texi:22371
1621 msgid "Programming Index"
1622 msgstr "Index de programmation"
1625 #: doc/guix.texi:111
1626 msgid "Data types, functions, and variables."
1627 msgstr "Types de données, fonctions et variables."
1630 #: doc/guix.texi:114
1631 msgid "--- The Detailed Node Listing ---"
1632 msgstr "--- Liste détaillée des nœuds ---"
1635 #: doc/guix.texi:123 doc/guix.texi:398 doc/guix.texi:400 doc/guix.texi:401
1637 msgid "Binary Installation"
1638 msgstr "Installation binaire"
1641 #: doc/guix.texi:123 doc/guix.texi:398
1642 msgid "Getting Guix running in no time!"
1643 msgstr "Commencer à utiliser Guix en un rien de temps !"
1646 #: doc/guix.texi:123 doc/guix.texi:398 doc/guix.texi:596 doc/guix.texi:597
1648 msgid "Requirements"
1652 #: doc/guix.texi:123 doc/guix.texi:398
1653 msgid "Software needed to build and run Guix."
1654 msgstr "Logiciels requis pour construire et lancer Guix."
1657 #: doc/guix.texi:123 doc/guix.texi:398 doc/guix.texi:678 doc/guix.texi:679
1659 msgid "Running the Test Suite"
1660 msgstr "Lancer la suite de tests"
1663 #: doc/guix.texi:123 doc/guix.texi:398
1664 msgid "Testing Guix."
1665 msgstr "Tester Guix."
1668 #: doc/guix.texi:123 doc/guix.texi:125 doc/guix.texi:398 doc/guix.texi:743
1669 #: doc/guix.texi:744
1671 msgid "Setting Up the Daemon"
1672 msgstr "Paramétrer le démon"
1675 #: doc/guix.texi:123 doc/guix.texi:398
1676 msgid "Preparing the build daemon's environment."
1677 msgstr "Préparer l'environnement du démon de construction."
1680 #: doc/guix.texi:123 doc/guix.texi:398 doc/guix.texi:1176
1682 msgid "Invoking guix-daemon"
1683 msgstr "Invoquer guix-daemon"
1686 #: doc/guix.texi:123 doc/guix.texi:398
1687 msgid "Running the build daemon."
1688 msgstr "Lancer le démon de construction."
1691 #: doc/guix.texi:123 doc/guix.texi:398 doc/guix.texi:1441 doc/guix.texi:1442
1693 msgid "Application Setup"
1694 msgstr "Réglages applicatifs"
1697 #: doc/guix.texi:123 doc/guix.texi:398
1698 msgid "Application-specific setup."
1699 msgstr "Réglages spécifiques pour les application."
1702 #: doc/guix.texi:129 doc/guix.texi:763 doc/guix.texi:765 doc/guix.texi:766
1704 msgid "Build Environment Setup"
1705 msgstr "Réglages de l'environnement de construction"
1708 #: doc/guix.texi:129 doc/guix.texi:763
1709 msgid "Preparing the isolated build environment."
1710 msgstr "Préparer l'environnement de construction isolé."
1713 #: doc/guix.texi:129 doc/guix.texi:763 doc/guix.texi:882
1715 msgid "Daemon Offload Setup"
1716 msgstr "Réglages du délestage du démon"
1719 #: doc/guix.texi:129 doc/guix.texi:763
1720 msgid "Offloading builds to remote machines."
1721 msgstr "Envoyer des constructions à des machines distantes."
1724 #: doc/guix.texi:129 doc/guix.texi:763 doc/guix.texi:1090 doc/guix.texi:1091
1726 msgid "SELinux Support"
1727 msgstr "Support de SELinux"
1730 #: doc/guix.texi:129 doc/guix.texi:763
1731 msgid "Using an SELinux policy for the daemon."
1732 msgstr "Utiliser une politique SELinux pour le démon."
1735 #: doc/guix.texi:140 doc/guix.texi:1682 doc/guix.texi:1684 doc/guix.texi:1685
1738 msgstr "Fonctionnalités"
1741 #: doc/guix.texi:140 doc/guix.texi:1682
1742 msgid "How Guix will make your life brighter."
1743 msgstr "Comment Guix va rendre votre vie plus heureuse."
1746 #: doc/guix.texi:140 doc/guix.texi:1682 doc/guix.texi:1761
1748 msgid "Invoking guix package"
1749 msgstr "Invoquer guix package"
1752 #: doc/guix.texi:140 doc/guix.texi:1682
1753 msgid "Package installation, removal, etc."
1754 msgstr "Installation, suppression, etc. de paquets."
1757 #: doc/guix.texi:140 doc/guix.texi:142 doc/guix.texi:1682 doc/guix.texi:2245
1758 #: doc/guix.texi:2246
1764 #: doc/guix.texi:140 doc/guix.texi:1682
1765 msgid "Downloading pre-built binaries."
1766 msgstr "Télécharger des binaire déjà construits."
1769 #: doc/guix.texi:140 doc/guix.texi:1682 doc/guix.texi:2478 doc/guix.texi:2479
1771 msgid "Packages with Multiple Outputs"
1772 msgstr "Des paquets avec plusieurs résultats"
1775 #: doc/guix.texi:140 doc/guix.texi:1682
1776 msgid "Single source package, multiple outputs."
1777 msgstr "Un seul paquet source, plusieurs résultats."
1780 #: doc/guix.texi:140 doc/guix.texi:1682 doc/guix.texi:2532
1782 msgid "Invoking guix gc"
1783 msgstr "Invoquer guix gc"
1786 #: doc/guix.texi:140 doc/guix.texi:1682
1787 msgid "Running the garbage collector."
1788 msgstr "Lancer le ramasse-miettes."
1791 #: doc/guix.texi:140 doc/guix.texi:1682 doc/guix.texi:2720
1793 msgid "Invoking guix pull"
1794 msgstr "Invoquer guix pull"
1797 #: doc/guix.texi:140 doc/guix.texi:1682
1798 msgid "Fetching the latest Guix and distribution."
1799 msgstr "Récupérer la dernière version de Guix et de la distribution."
1802 #: doc/guix.texi:140 doc/guix.texi:1682 doc/guix.texi:2781
1804 msgid "Invoking guix pack"
1805 msgstr "Invoquer guix pack"
1808 #: doc/guix.texi:140 doc/guix.texi:1682
1809 msgid "Creating software bundles."
1810 msgstr "Créer des lots de logiciels."
1813 #: doc/guix.texi:140 doc/guix.texi:1682 doc/guix.texi:2941
1815 msgid "Invoking guix archive"
1816 msgstr "Invoquer guix archive"
1819 #: doc/guix.texi:140 doc/guix.texi:1682
1820 msgid "Exporting and importing store files."
1821 msgstr "Exporter et importer des fichiers du dépôt."
1824 #: doc/guix.texi:149 doc/guix.texi:2268 doc/guix.texi:2270 doc/guix.texi:2271
1826 msgid "Official Substitute Server"
1827 msgstr "Serveur de substituts officiel"
1830 #: doc/guix.texi:149 doc/guix.texi:2268
1831 msgid "One particular source of substitutes."
1832 msgstr "Une source particulière de substituts."
1835 #: doc/guix.texi:149 doc/guix.texi:2268 doc/guix.texi:2300 doc/guix.texi:2301
1837 msgid "Substitute Server Authorization"
1838 msgstr "Autoriser un serveur de substituts"
1841 #: doc/guix.texi:149 doc/guix.texi:2268
1842 msgid "How to enable or disable substitutes."
1843 msgstr "Comment activer ou désactiver les substituts."
1846 #: doc/guix.texi:149 doc/guix.texi:2268 doc/guix.texi:2373 doc/guix.texi:2374
1848 msgid "Substitute Authentication"
1849 msgstr "Authentification des substituts"
1852 #: doc/guix.texi:149 doc/guix.texi:2268
1853 msgid "How Guix verifies substitutes."
1854 msgstr "Coment Guix vérifie les substituts."
1857 #: doc/guix.texi:149 doc/guix.texi:2268 doc/guix.texi:2408 doc/guix.texi:2409
1859 msgid "Proxy Settings"
1860 msgstr "Paramètres de serveur mandataire"
1863 #: doc/guix.texi:149 doc/guix.texi:2268
1864 msgid "How to get substitutes via proxy."
1865 msgstr "Comment récupérer des substituts à travers un serveur mandataire."
1868 #: doc/guix.texi:149 doc/guix.texi:2268 doc/guix.texi:2420 doc/guix.texi:2421
1870 msgid "Substitution Failure"
1871 msgstr "Échec de substitution"
1874 #: doc/guix.texi:149 doc/guix.texi:2268
1875 msgid "What happens when substitution fails."
1876 msgstr "Qu'arrive-t-il quand la substitution échoue."
1879 #: doc/guix.texi:149 doc/guix.texi:2268 doc/guix.texi:2448 doc/guix.texi:2449
1881 msgid "On Trusting Binaries"
1882 msgstr "De la confiance en des binaires"
1885 #: doc/guix.texi:149 doc/guix.texi:2268
1886 msgid "How can you trust that binary blob?"
1887 msgstr "Comment pouvez-vous avoir confiance en un paquet binaire ?"
1890 #: doc/guix.texi:158 doc/guix.texi:160 doc/guix.texi:3141 doc/guix.texi:3143
1891 #: doc/guix.texi:3144
1893 msgid "Defining Packages"
1894 msgstr "Définition des paquets"
1897 #: doc/guix.texi:158 doc/guix.texi:3141
1898 msgid "Defining new packages."
1899 msgstr "Définir de nouveaux paquets."
1902 #: doc/guix.texi:158 doc/guix.texi:3141 doc/guix.texi:3607 doc/guix.texi:3608
1904 msgid "Build Systems"
1905 msgstr "Systèmes de construction"
1908 #: doc/guix.texi:158 doc/guix.texi:3141
1909 msgid "Specifying how packages are built."
1910 msgstr "Spécifier comment construire les paquets."
1913 #: doc/guix.texi:158 doc/guix.texi:3141 doc/guix.texi:4183 doc/guix.texi:4184
1919 #: doc/guix.texi:158 doc/guix.texi:3141
1920 msgid "Manipulating the package store."
1921 msgstr "Manipuler le dépôt de paquets."
1924 #: doc/guix.texi:158 doc/guix.texi:3141 doc/guix.texi:4333 doc/guix.texi:4334
1927 msgstr "Dérivations"
1930 #: doc/guix.texi:158 doc/guix.texi:3141
1931 msgid "Low-level interface to package derivations."
1932 msgstr "Interface de bas-niveau avec les dérivations de paquets."
1935 #: doc/guix.texi:158 doc/guix.texi:3141 doc/guix.texi:4511 doc/guix.texi:4512
1937 msgid "The Store Monad"
1938 msgstr "La monad du dépôt"
1941 #: doc/guix.texi:158 doc/guix.texi:3141
1942 msgid "Purely functional interface to the store."
1943 msgstr "Interface purement fonctionnelle avec le dépôt."
1946 #: doc/guix.texi:158 doc/guix.texi:3141 doc/guix.texi:4820 doc/guix.texi:4821
1948 msgid "G-Expressions"
1949 msgstr "G-Expressions"
1952 #: doc/guix.texi:158 doc/guix.texi:3141
1953 msgid "Manipulating build expressions."
1954 msgstr "Manipuler les expressions de construction."
1957 #: doc/guix.texi:163 doc/guix.texi:3389 doc/guix.texi:3392
1959 msgid "package Reference"
1960 msgstr "Référence de paquet"
1963 #: doc/guix.texi:163 doc/guix.texi:3389
1964 msgid "The package data type."
1965 msgstr "Le type de donnée des paquets."
1968 #: doc/guix.texi:163 doc/guix.texi:3389 doc/guix.texi:3519
1970 msgid "origin Reference"
1971 msgstr "Référence d'origine"
1974 #: doc/guix.texi:163 doc/guix.texi:3389
1975 msgid "The origin data type."
1976 msgstr "Le type de données d'origine."
1979 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:5388
1981 msgid "Invoking guix build"
1982 msgstr "Invoquer guix build"
1985 #: doc/guix.texi:181 doc/guix.texi:5386
1986 msgid "Building packages from the command line."
1987 msgstr "Construire des paquets depuis la ligne de commande."
1990 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:5968
1992 msgid "Invoking guix edit"
1993 msgstr "Invoquer guix edit"
1996 #: doc/guix.texi:181 doc/guix.texi:5386
1997 msgid "Editing package definitions."
1998 msgstr "Modifier les définitions de paquets."
2001 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:5994
2003 msgid "Invoking guix download"
2004 msgstr "Invoquer guix download"
2007 #: doc/guix.texi:181 doc/guix.texi:5386
2008 msgid "Downloading a file and printing its hash."
2009 msgstr "Télécharger un fichier et afficher son hash."
2012 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:6047
2014 msgid "Invoking guix hash"
2015 msgstr "Invoquer guix hash"
2018 #: doc/guix.texi:181 doc/guix.texi:5386
2019 msgid "Computing the cryptographic hash of a file."
2020 msgstr "Calculer le hash cryptographique d'un fichier."
2023 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:6109
2025 msgid "Invoking guix import"
2026 msgstr "Invoquer guix import"
2029 #: doc/guix.texi:181 doc/guix.texi:5386
2030 msgid "Importing package definitions."
2031 msgstr "Importer des définitions de paquets."
2034 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:6476
2036 msgid "Invoking guix refresh"
2037 msgstr "Invoquer guix refresh"
2040 #: doc/guix.texi:181 doc/guix.texi:5386
2041 msgid "Updating package definitions."
2042 msgstr "Mettre à jour les définitions de paquets."
2045 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:6723
2047 msgid "Invoking guix lint"
2048 msgstr "Invoquer guix lint"
2051 #: doc/guix.texi:181 doc/guix.texi:5386
2052 msgid "Finding errors in package definitions."
2053 msgstr "Trouver des erreurs dans les définitions de paquets."
2056 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:6814
2058 msgid "Invoking guix size"
2059 msgstr "Invoquer guix size"
2062 #: doc/guix.texi:181 doc/guix.texi:5386
2063 msgid "Profiling disk usage."
2064 msgstr "Profiler l'utilisation du disque."
2067 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:6930
2069 msgid "Invoking guix graph"
2070 msgstr "Invoquer guix graph"
2073 #: doc/guix.texi:181 doc/guix.texi:5386
2074 msgid "Visualizing the graph of packages."
2075 msgstr "Visualiser le graphe des paquets."
2078 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:7109
2080 msgid "Invoking guix environment"
2081 msgstr "Invoquer guix environment"
2084 #: doc/guix.texi:181 doc/guix.texi:5386
2085 msgid "Setting up development environments."
2086 msgstr "Mettre en place des environnements de développement."
2089 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:7428
2091 msgid "Invoking guix publish"
2092 msgstr "Invoquer guix publish"
2095 #: doc/guix.texi:181 doc/guix.texi:5386
2096 msgid "Sharing substitutes."
2097 msgstr "Partager des substituts."
2100 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:7645
2102 msgid "Invoking guix challenge"
2103 msgstr "Invoquer guix challenge"
2106 #: doc/guix.texi:181 doc/guix.texi:5386
2107 msgid "Challenging substitute servers."
2108 msgstr "Défier les serveurs de substituts."
2111 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:7784
2113 msgid "Invoking guix copy"
2114 msgstr "Invoquer guix copy"
2117 #: doc/guix.texi:181 doc/guix.texi:5386
2118 msgid "Copying to and from a remote store."
2119 msgstr "Copier vers et depuis un dépôt distant."
2122 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:7847
2124 msgid "Invoking guix container"
2125 msgstr "Invoquer guix container"
2128 #: doc/guix.texi:181 doc/guix.texi:5386
2129 msgid "Process isolation."
2130 msgstr "Isolation de processus."
2133 #: doc/guix.texi:181 doc/guix.texi:5386 doc/guix.texi:7901
2135 msgid "Invoking guix weather"
2136 msgstr "Invoquer guix weather"
2139 #: doc/guix.texi:181 doc/guix.texi:5386
2140 msgid "Assessing substitute availability."
2141 msgstr "Mesurer la disponibilité des substituts."
2144 #: doc/guix.texi:183 doc/guix.texi:5389
2146 msgid "Invoking @command{guix build}"
2147 msgstr "Invoquer @command{guix build}"
2150 #: doc/guix.texi:188 doc/guix.texi:5440 doc/guix.texi:5442 doc/guix.texi:5443
2152 msgid "Common Build Options"
2153 msgstr "Options de construction communes"
2156 #: doc/guix.texi:188 doc/guix.texi:5440
2157 msgid "Build options for most commands."
2158 msgstr "Options de construction pour la plupart des commandes."
2161 #: doc/guix.texi:188 doc/guix.texi:5440 doc/guix.texi:5584 doc/guix.texi:5585
2163 msgid "Package Transformation Options"
2164 msgstr "Options de transformation de paquets"
2167 #: doc/guix.texi:188 doc/guix.texi:5440
2168 msgid "Creating variants of packages."
2169 msgstr "Créer des variantes de paquets."
2172 #: doc/guix.texi:188 doc/guix.texi:5440 doc/guix.texi:5684 doc/guix.texi:5685
2174 msgid "Additional Build Options"
2175 msgstr "Options de construction supplémentaires"
2178 #: doc/guix.texi:188 doc/guix.texi:5440
2179 msgid "Options specific to 'guix build'."
2180 msgstr "Options spécifiques à « guix build »."
2183 #: doc/guix.texi:188 doc/guix.texi:5440 doc/guix.texi:5888 doc/guix.texi:5889
2185 msgid "Debugging Build Failures"
2186 msgstr "Débogage des échecs de construction"
2189 #: doc/guix.texi:188 doc/guix.texi:5440
2190 msgid "Real life packaging experience."
2191 msgstr "La vie d'un empaqueteur."
2194 #: doc/guix.texi:200 doc/guix.texi:202 doc/guix.texi:8053 doc/guix.texi:8058
2195 #: doc/guix.texi:8059
2197 msgid "System Installation"
2198 msgstr "Installation du système"
2201 #: doc/guix.texi:200 doc/guix.texi:8053
2202 msgid "Installing the whole operating system."
2203 msgstr "Installer le système d'exploitation complet."
2206 #: doc/guix.texi:200 doc/guix.texi:212 doc/guix.texi:8053 doc/guix.texi:8674
2207 #: doc/guix.texi:8675
2209 msgid "System Configuration"
2210 msgstr "Configuration système"
2213 #: doc/guix.texi:200 doc/guix.texi:8053
2214 msgid "Configuring the operating system."
2215 msgstr "Configurer le système d'exploitation."
2218 #: doc/guix.texi:200 doc/guix.texi:8053 doc/guix.texi:21351 doc/guix.texi:21352
2220 msgid "Documentation"
2221 msgstr "Documentation"
2224 #: doc/guix.texi:200 doc/guix.texi:8053
2225 msgid "Browsing software user manuals."
2226 msgstr "Visualiser les manuels d'utilisateur des logiciels."
2229 #: doc/guix.texi:200 doc/guix.texi:8053 doc/guix.texi:21415 doc/guix.texi:21416
2231 msgid "Installing Debugging Files"
2232 msgstr "Installer les fichiers de débogage"
2235 #: doc/guix.texi:200 doc/guix.texi:8053
2236 msgid "Feeding the debugger."
2237 msgstr "Nourrir le débogueur."
2240 #: doc/guix.texi:200 doc/guix.texi:8053 doc/guix.texi:21481 doc/guix.texi:21482
2242 msgid "Security Updates"
2243 msgstr "Mises à jour de sécurité"
2246 #: doc/guix.texi:200 doc/guix.texi:8053
2247 msgid "Deploying security fixes quickly."
2248 msgstr "Déployer des correctifs de sécurité rapidement."
2251 #: doc/guix.texi:200 doc/guix.texi:8053 doc/guix.texi:21601 doc/guix.texi:21602
2253 msgid "Package Modules"
2254 msgstr "Modules de paquets"
2257 #: doc/guix.texi:200 doc/guix.texi:8053
2258 msgid "Packages from the programmer's viewpoint."
2259 msgstr "Les paquets du point de vu du programmeur."
2262 #: doc/guix.texi:200 doc/guix.texi:265 doc/guix.texi:8053 doc/guix.texi:21655
2263 #: doc/guix.texi:21656
2265 msgid "Packaging Guidelines"
2266 msgstr "Consignes d'empaquetage"
2269 #: doc/guix.texi:200 doc/guix.texi:8053
2270 msgid "Growing the distribution."
2271 msgstr "Faire grandir la distribution."
2274 #: doc/guix.texi:200 doc/guix.texi:8053 doc/guix.texi:22106 doc/guix.texi:22107
2276 msgid "Bootstrapping"
2277 msgstr "Bootstrapping"
2280 #: doc/guix.texi:200 doc/guix.texi:8053
2281 msgid "GNU/Linux built from scratch."
2282 msgstr "GNU/Linux depuis zéro."
2285 #: doc/guix.texi:200 doc/guix.texi:8053 doc/guix.texi:22290
2291 #: doc/guix.texi:200 doc/guix.texi:8053
2292 msgid "Targeting another platform or kernel."
2293 msgstr "Cibler une autre plateforme ou un autre noyau."
2296 #: doc/guix.texi:210 doc/guix.texi:1126 doc/guix.texi:8090 doc/guix.texi:8092
2297 #: doc/guix.texi:8093
2300 msgstr "Limitations"
2303 #: doc/guix.texi:210 doc/guix.texi:8090
2304 msgid "What you can expect."
2305 msgstr "Ce à quoi vous attendre."
2308 #: doc/guix.texi:210 doc/guix.texi:8090 doc/guix.texi:8136 doc/guix.texi:8137
2310 msgid "Hardware Considerations"
2311 msgstr "Considérations matérielles"
2314 #: doc/guix.texi:210 doc/guix.texi:8090
2315 msgid "Supported hardware."
2316 msgstr "Matériel supporté."
2319 #: doc/guix.texi:210 doc/guix.texi:8090 doc/guix.texi:8171 doc/guix.texi:8172
2321 msgid "USB Stick and DVD Installation"
2322 msgstr "Installation depuis une clef USB ou un DVD"
2325 #: doc/guix.texi:210 doc/guix.texi:8090
2326 msgid "Preparing the installation medium."
2327 msgstr "Préparer le média d'installation."
2330 #: doc/guix.texi:210 doc/guix.texi:8090 doc/guix.texi:8269 doc/guix.texi:8270
2332 msgid "Preparing for Installation"
2333 msgstr "Préparer l'installation"
2336 #: doc/guix.texi:210 doc/guix.texi:8090
2337 msgid "Networking, partitioning, etc."
2338 msgstr "Réseau, partitionnement, etc."
2341 #: doc/guix.texi:210 doc/guix.texi:8090 doc/guix.texi:8508 doc/guix.texi:8509
2343 msgid "Proceeding with the Installation"
2344 msgstr "Effectuer l'installation"
2347 #: doc/guix.texi:210 doc/guix.texi:8090
2348 msgid "The real thing."
2349 msgstr "Pour de vrai."
2352 #: doc/guix.texi:210 doc/guix.texi:8090 doc/guix.texi:8605
2354 msgid "Installing GuixSD in a VM"
2355 msgstr "Installer GuixSD dans une VM"
2358 #: doc/guix.texi:210 doc/guix.texi:8090
2359 msgid "GuixSD playground."
2360 msgstr "Jouer avec GuixSD."
2363 #: doc/guix.texi:210 doc/guix.texi:8090 doc/guix.texi:8659 doc/guix.texi:8660
2365 msgid "Building the Installation Image"
2366 msgstr "Construire l'image d'installation"
2369 #: doc/guix.texi:210 doc/guix.texi:8090
2370 msgid "How this comes to be."
2371 msgstr "D'où vient tout cela."
2374 #: doc/guix.texi:228 doc/guix.texi:8715 doc/guix.texi:8717 doc/guix.texi:8718
2376 msgid "Using the Configuration System"
2377 msgstr "Utiliser le système de configuration"
2380 #: doc/guix.texi:228 doc/guix.texi:8715
2381 msgid "Customizing your GNU system."
2382 msgstr "Personnaliser votre système GNU."
2385 #: doc/guix.texi:228 doc/guix.texi:8715 doc/guix.texi:8933
2387 msgid "operating-system Reference"
2388 msgstr "Référence de système d'exploitation"
2391 #: doc/guix.texi:228 doc/guix.texi:8715
2392 msgid "Detail of operating-system declarations."
2393 msgstr "Détail sur la déclaration de système d'exploitation."
2396 #: doc/guix.texi:228 doc/guix.texi:8715 doc/guix.texi:9087 doc/guix.texi:9088
2398 msgid "File Systems"
2399 msgstr "Systèmes de fichiers"
2402 #: doc/guix.texi:228 doc/guix.texi:8715
2403 msgid "Configuring file system mounts."
2404 msgstr "Configurer les montages de systèmes de fichiers."
2407 #: doc/guix.texi:228 doc/guix.texi:8715 doc/guix.texi:9250 doc/guix.texi:9251
2409 msgid "Mapped Devices"
2410 msgstr "Périphériques mappés"
2413 #: doc/guix.texi:228 doc/guix.texi:8715
2414 msgid "Block device extra processing."
2415 msgstr "Gestion des périphériques de bloc."
2418 #: doc/guix.texi:228 doc/guix.texi:8715 doc/guix.texi:9371 doc/guix.texi:9372
2420 msgid "User Accounts"
2421 msgstr "Comptes utilisateurs"
2424 #: doc/guix.texi:228 doc/guix.texi:8715
2425 msgid "Specifying user accounts."
2426 msgstr "Spécifier des comptes utilisateurs."
2429 #: doc/guix.texi:228 doc/guix.texi:1449 doc/guix.texi:8715 doc/guix.texi:9506
2430 #: doc/guix.texi:9507
2433 msgstr "Régionalisation"
2436 #: doc/guix.texi:228 doc/guix.texi:8715
2437 msgid "Language and cultural convention settings."
2438 msgstr "Paramétrer la langue et les conventions culturelles."
2441 #: doc/guix.texi:228 doc/guix.texi:230 doc/guix.texi:8715 doc/guix.texi:9646
2442 #: doc/guix.texi:9647
2448 #: doc/guix.texi:228 doc/guix.texi:8715
2449 msgid "Specifying system services."
2450 msgstr "Spécifier les services du système."
2453 #: doc/guix.texi:228 doc/guix.texi:8715 doc/guix.texi:19720 doc/guix.texi:19721
2455 msgid "Setuid Programs"
2456 msgstr "Programmes setuid"
2459 #: doc/guix.texi:228 doc/guix.texi:8715
2460 msgid "Programs running with root privileges."
2461 msgstr "Programmes tournant avec les privilèges root."
2464 #: doc/guix.texi:228 doc/guix.texi:1594 doc/guix.texi:8715 doc/guix.texi:19766
2465 #: doc/guix.texi:19767
2467 msgid "X.509 Certificates"
2468 msgstr "Certificats X.509"
2471 #: doc/guix.texi:228 doc/guix.texi:8715
2472 msgid "Authenticating HTTPS servers."
2473 msgstr "Authentifier les serveurs HTTPS."
2476 #: doc/guix.texi:228 doc/guix.texi:1492 doc/guix.texi:8715 doc/guix.texi:19829
2477 #: doc/guix.texi:19830
2479 msgid "Name Service Switch"
2480 msgstr "Name Service Switch"
2483 #: doc/guix.texi:228 doc/guix.texi:8715
2484 msgid "Configuring libc's name service switch."
2485 msgstr "Configurer le « name service switch » de la libc."
2488 #: doc/guix.texi:228 doc/guix.texi:8715 doc/guix.texi:19967 doc/guix.texi:19968
2490 msgid "Initial RAM Disk"
2491 msgstr "Disque de RAM initial"
2494 #: doc/guix.texi:228 doc/guix.texi:8715
2495 msgid "Linux-Libre bootstrapping."
2496 msgstr "Démarrage de Linux-Libre."
2499 #: doc/guix.texi:228 doc/guix.texi:8715 doc/guix.texi:20127 doc/guix.texi:20128
2501 msgid "Bootloader Configuration"
2502 msgstr "Configuration du chargeur d'amorçage"
2505 #: doc/guix.texi:228 doc/guix.texi:8715
2506 msgid "Configuring the boot loader."
2507 msgstr "Configurer le chargeur d'amorçage."
2510 #: doc/guix.texi:228 doc/guix.texi:8715 doc/guix.texi:20298
2512 msgid "Invoking guix system"
2513 msgstr "Invoquer guix system"
2516 #: doc/guix.texi:228 doc/guix.texi:8715
2517 msgid "Instantiating a system configuration."
2518 msgstr "Instantier une configuration du système."
2521 #: doc/guix.texi:228 doc/guix.texi:8715 doc/guix.texi:20723
2523 msgid "Running GuixSD in a VM"
2524 msgstr "Lancer GuixSD dans une VM"
2527 #: doc/guix.texi:228 doc/guix.texi:8715
2528 msgid "How to run GuixSD in a virtual machine."
2529 msgstr "Comment lancer GuixSD dans une machine virtuelle."
2532 #: doc/guix.texi:228 doc/guix.texi:258 doc/guix.texi:8715 doc/guix.texi:20834
2533 #: doc/guix.texi:20835
2535 msgid "Defining Services"
2536 msgstr "Définir des services"
2539 #: doc/guix.texi:228 doc/guix.texi:8715
2540 msgid "Adding new service definitions."
2541 msgstr "Ajouter de nouvelles définitions de services."
2543 #. type: subsubsection
2544 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:9720 doc/guix.texi:9721
2546 msgid "Base Services"
2547 msgstr "Services de base"
2550 #: doc/guix.texi:256 doc/guix.texi:9718
2551 msgid "Essential system services."
2552 msgstr "Services systèmes essentiels."
2554 #. type: subsubsection
2555 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:10488 doc/guix.texi:10489
2557 msgid "Scheduled Job Execution"
2561 #: doc/guix.texi:256 doc/guix.texi:9718
2562 msgid "The mcron service."
2565 #. type: subsubsection
2566 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:10583 doc/guix.texi:10584
2568 msgid "Log Rotation"
2572 #: doc/guix.texi:256 doc/guix.texi:9718
2573 msgid "The rottlog service."
2576 #. type: subsubsection
2577 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:10685 doc/guix.texi:10686
2579 msgid "Networking Services"
2583 #: doc/guix.texi:256 doc/guix.texi:9718
2584 msgid "Network setup, SSH daemon, etc."
2587 #. type: subsubsection
2588 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:11431 doc/guix.texi:11432
2594 #: doc/guix.texi:256 doc/guix.texi:9718
2595 msgid "Graphical display."
2598 #. type: subsubsection
2599 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:11677 doc/guix.texi:11678
2601 msgid "Printing Services"
2605 #: doc/guix.texi:256 doc/guix.texi:9718
2606 msgid "Local and remote printer support."
2609 #. type: subsubsection
2610 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:12514 doc/guix.texi:12515
2612 msgid "Desktop Services"
2616 #: doc/guix.texi:256 doc/guix.texi:9718
2617 msgid "D-Bus and desktop services."
2620 #. type: subsubsection
2621 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:12807 doc/guix.texi:12808
2623 msgid "Database Services"
2627 #: doc/guix.texi:256 doc/guix.texi:9718
2628 msgid "SQL databases, key-value stores, etc."
2631 #. type: subsubsection
2632 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:12931 doc/guix.texi:12932
2634 msgid "Mail Services"
2638 #: doc/guix.texi:256 doc/guix.texi:9718
2639 msgid "IMAP, POP3, SMTP, and all that."
2642 #. type: subsubsection
2643 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:14383 doc/guix.texi:14384
2645 msgid "Messaging Services"
2649 #: doc/guix.texi:256 doc/guix.texi:9718
2650 msgid "Messaging services."
2653 #. type: subsubsection
2654 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:14851 doc/guix.texi:14852
2656 msgid "Telephony Services"
2660 #: doc/guix.texi:256 doc/guix.texi:9718
2661 msgid "Telephony services."
2664 #. type: subsubsection
2665 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:15056 doc/guix.texi:15057
2667 msgid "Monitoring Services"
2671 #: doc/guix.texi:256 doc/guix.texi:9718
2672 msgid "Monitoring services."
2675 #. type: subsubsection
2676 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:15209 doc/guix.texi:15210
2678 msgid "Kerberos Services"
2682 #: doc/guix.texi:256 doc/guix.texi:9718
2683 msgid "Kerberos services."
2686 #. type: subsubsection
2687 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:15335 doc/guix.texi:15336
2689 msgid "Web Services"
2693 #: doc/guix.texi:256 doc/guix.texi:9718
2694 msgid "Web servers."
2697 #. type: subsubsection
2698 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:15944 doc/guix.texi:15945
2700 msgid "Certificate Services"
2704 #: doc/guix.texi:256 doc/guix.texi:9718
2705 msgid "TLS certificates via Let's Encrypt."
2708 #. type: subsubsection
2709 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:16090 doc/guix.texi:16091
2711 msgid "DNS Services"
2715 #: doc/guix.texi:256 doc/guix.texi:9718
2716 msgid "DNS daemons."
2719 #. type: subsubsection
2720 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:16494 doc/guix.texi:16495
2722 msgid "VPN Services"
2726 #: doc/guix.texi:256 doc/guix.texi:9718
2727 msgid "VPN daemons."
2730 #. type: subsubsection
2731 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:16852 doc/guix.texi:16853
2733 msgid "Network File System"
2737 #: doc/guix.texi:256 doc/guix.texi:9718
2738 msgid "NFS related services."
2741 #. type: subsubsection
2742 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:16967 doc/guix.texi:16968
2744 msgid "Continuous Integration"
2748 #: doc/guix.texi:256 doc/guix.texi:9718
2749 msgid "The Cuirass service."
2752 #. type: subsubsection
2753 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:17063 doc/guix.texi:17064
2755 msgid "Power management Services"
2759 #: doc/guix.texi:256 doc/guix.texi:9718
2760 msgid "The TLP tool."
2763 #. type: subsubsection
2764 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:17591 doc/guix.texi:17592
2766 msgid "Audio Services"
2770 #: doc/guix.texi:256 doc/guix.texi:9718
2775 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:17641
2777 msgid "Virtualization Services"
2781 #: doc/guix.texi:256 doc/guix.texi:9718
2782 msgid "Virtualization services."
2785 #. type: subsubsection
2786 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:18434 doc/guix.texi:18435
2788 msgid "Version Control Services"
2792 #: doc/guix.texi:256 doc/guix.texi:9718
2793 msgid "Providing remote access to Git repositories."
2796 #. type: subsubsection
2797 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:19528 doc/guix.texi:19529
2799 msgid "Game Services"
2803 #: doc/guix.texi:256 doc/guix.texi:9718
2804 msgid "Game servers."
2807 #. type: subsubsection
2808 #: doc/guix.texi:256 doc/guix.texi:9718 doc/guix.texi:19559 doc/guix.texi:19560
2810 msgid "Miscellaneous Services"
2814 #: doc/guix.texi:256 doc/guix.texi:9718
2815 msgid "Other services."
2818 #. type: subsubsection
2819 #: doc/guix.texi:263 doc/guix.texi:20846 doc/guix.texi:20848
2820 #: doc/guix.texi:20849
2822 msgid "Service Composition"
2823 msgstr "Composition de services"
2826 #: doc/guix.texi:263 doc/guix.texi:20846
2827 msgid "The model for composing services."
2828 msgstr "Le modèle de composition des services."
2830 #. type: subsubsection
2831 #: doc/guix.texi:263 doc/guix.texi:20846 doc/guix.texi:20904
2832 #: doc/guix.texi:20905
2834 msgid "Service Types and Services"
2835 msgstr "Types service et services"
2838 #: doc/guix.texi:263 doc/guix.texi:20846
2839 msgid "Types and services."
2840 msgstr "Types et services."
2842 #. type: subsubsection
2843 #: doc/guix.texi:263 doc/guix.texi:20846 doc/guix.texi:21041
2844 #: doc/guix.texi:21042
2846 msgid "Service Reference"
2847 msgstr "Référence de service"
2850 #: doc/guix.texi:263 doc/guix.texi:20846
2851 msgid "API reference."
2852 msgstr "Référence de l'API."
2854 #. type: subsubsection
2855 #: doc/guix.texi:263 doc/guix.texi:20846 doc/guix.texi:21266
2856 #: doc/guix.texi:21267
2858 msgid "Shepherd Services"
2859 msgstr "Services Shepherd"
2862 #: doc/guix.texi:263 doc/guix.texi:20846
2863 msgid "A particular type of service."
2864 msgstr "Un type de service particulier."
2867 #: doc/guix.texi:274 doc/guix.texi:21730 doc/guix.texi:21732
2868 #: doc/guix.texi:21733
2870 msgid "Software Freedom"
2871 msgstr "Liberté logiciel"
2874 #: doc/guix.texi:274 doc/guix.texi:21730
2875 msgid "What may go into the distribution."
2876 msgstr "Ce que la distribution peut contenir."
2879 #: doc/guix.texi:274 doc/guix.texi:21730 doc/guix.texi:21760
2880 #: doc/guix.texi:21761
2882 msgid "Package Naming"
2883 msgstr "Conventions de nommage"
2886 #: doc/guix.texi:274 doc/guix.texi:21730
2887 msgid "What's in a name?"
2888 msgstr "Qu'est-ce qu'un bon nom ?"
2891 #: doc/guix.texi:274 doc/guix.texi:21730 doc/guix.texi:21785
2892 #: doc/guix.texi:21786
2894 msgid "Version Numbers"
2895 msgstr "Numéros de version"
2898 #: doc/guix.texi:274 doc/guix.texi:21730
2899 msgid "When the name is not enough."
2900 msgstr "Lorsque le nom n'est pas suffisant."
2903 #: doc/guix.texi:274 doc/guix.texi:21730 doc/guix.texi:21876
2904 #: doc/guix.texi:21877
2906 msgid "Synopses and Descriptions"
2907 msgstr "Synopsis et descriptions"
2910 #: doc/guix.texi:274 doc/guix.texi:21730
2911 msgid "Helping users find the right package."
2912 msgstr "Aider les utilisateurs à trouver le bon paquet."
2915 #: doc/guix.texi:274 doc/guix.texi:21730 doc/guix.texi:21956
2916 #: doc/guix.texi:21957
2918 msgid "Python Modules"
2919 msgstr "Modules python"
2922 #: doc/guix.texi:274 doc/guix.texi:21730
2923 msgid "A touch of British comedy."
2924 msgstr "Un peu de comédie anglaise."
2927 #: doc/guix.texi:274 doc/guix.texi:21730 doc/guix.texi:22031
2928 #: doc/guix.texi:22032
2930 msgid "Perl Modules"
2931 msgstr "Modules perl"
2934 #: doc/guix.texi:274 doc/guix.texi:21730
2935 msgid "Little pearls."
2936 msgstr "Petites perles."
2939 #: doc/guix.texi:274 doc/guix.texi:21730 doc/guix.texi:22047
2940 #: doc/guix.texi:22048
2942 msgid "Java Packages"
2943 msgstr "Paquets java"
2946 #: doc/guix.texi:274 doc/guix.texi:21730
2947 msgid "Coffee break."
2948 msgstr "Pause café."
2951 #: doc/guix.texi:274 doc/guix.texi:21730 doc/guix.texi:22067
2952 #: doc/guix.texi:22068
2955 msgstr "Polices de caractères"
2958 #: doc/guix.texi:274 doc/guix.texi:21730
2959 msgid "Fond of fonts."
2963 #: doc/guix.texi:297
2969 #: doc/guix.texi:304
2971 "GNU Guix@footnote{``Guix'' is pronounced like ``geeks'', or ``ɡiːks'' using "
2972 "the international phonetic alphabet (IPA).} is a package management tool for "
2973 "the GNU system. Guix makes it easy for unprivileged users to install, "
2974 "upgrade, or remove packages, to roll back to a previous package set, to "
2975 "build packages from source, and generally assists with the creation and "
2976 "maintenance of software environments."
2978 "GNU Guix@footnote{« Guix » se prononce comme « geeks » (en prononçant le "
2979 "« s »), ou « ɡiːks » dans l'alphabet phonétique international (API).} est un "
2980 "outil de gestion de paquets pour le système GNU. Guix facilite pour les "
2981 "utilisateurs non privilégiés l'installation, la mise à jour et la "
2982 "suppression de paquets, la restauration à un ensemble de paquets précédent, "
2983 "la construction de paquets depuis les sources et plus généralement aide à la "
2984 "création et à la maintenance d'environnements logiciels."
2987 #: doc/guix.texi:305
2989 msgid "user interfaces"
2990 msgstr "interfaces utilisateurs"
2993 #: doc/guix.texi:310
2995 "Guix provides a command-line package management interface (@pxref{Invoking "
2996 "guix package}), a set of command-line utilities (@pxref{Utilities}), as well "
2997 "as Scheme programming interfaces (@pxref{Programming Interface})."
2999 "Guix fournit une interface de gestion des paquets par la ligne de commande "
3000 "(@pxref{Invoquer guix package}), un ensemble d'utilitaires en ligne de "
3001 "commande (@pxref{Utilitaires}) ainsi que des interfaces de programmation "
3002 "Scheme (@pxref{Interface de programmation})."
3005 #: doc/guix.texi:310
3007 msgid "build daemon"
3008 msgstr "démon de construction"
3011 #: doc/guix.texi:314
3013 "Its @dfn{build daemon} is responsible for building packages on behalf of "
3014 "users (@pxref{Setting Up the Daemon}) and for downloading pre-built binaries "
3015 "from authorized sources (@pxref{Substitutes})."
3017 "Son @dfn{démon de construction} est responsable de la construction des "
3018 "paquets pour les utilisateurs (@pxref{Paramétrer le démon}) et du "
3019 "téléchargement des binaires pré-construits depuis les sources autorisées "
3020 "(@pxref{Substituts})."
3023 #: doc/guix.texi:315
3025 msgid "extensibility of the distribution"
3026 msgstr "extensibilité de la distribution"
3029 #: doc/guix.texi:316 doc/guix.texi:21623
3031 msgid "customization, of packages"
3032 msgstr "personnalisation, des paquets"
3035 #: doc/guix.texi:325
3037 "Guix includes package definitions for many GNU and non-GNU packages, all of "
3038 "which @uref{https://www.gnu.org/philosophy/free-sw.html, respect the user's "
3039 "computing freedom}. It is @emph{extensible}: users can write their own "
3040 "package definitions (@pxref{Defining Packages}) and make them available as "
3041 "independent package modules (@pxref{Package Modules}). It is also "
3042 "@emph{customizable}: users can @emph{derive} specialized package definitions "
3043 "from existing ones, including from the command line (@pxref{Package "
3044 "Transformation Options})."
3046 "Guix contient de nombreuses définitions de paquet GNU et non-GNU qui "
3047 "respectent tous les @uref{https://www.gnu.org/philosophy/free-sw.fr.html, "
3048 "libertés de l'utilisateur}. Il est @emph{extensible} : les utilisateurs "
3049 "peuvent écrire leurs propres définitions de paquets (@pxref{Defining "
3050 "Packages}) et les rendre disponibles dans des modules de paquets "
3051 "indépendants (@pxref{Package Modules}). Il est aussi "
3052 "@emph{personnalisable} : les utilisateurs peuvent @emph{dériver} des "
3053 "définitions de paquets spécialisées à partir de définitions existantes, même "
3054 "depuis la ligne de commande (@pxref{Package Transformation Options})."
3057 #: doc/guix.texi:326 doc/guix.texi:7984 doc/guix.texi:8062
3059 msgid "Guix System Distribution"
3060 msgstr "Distribution Système Guix"
3063 #: doc/guix.texi:327 doc/guix.texi:7985
3069 #: doc/guix.texi:336
3071 "You can install GNU@tie{}Guix on top of an existing GNU/Linux system where "
3072 "it complements the available tools without interference "
3073 "(@pxref{Installation}), or you can use it as part of the standalone "
3074 "@dfn{Guix System Distribution} or GuixSD (@pxref{GNU Distribution}). With "
3075 "GNU@tie{}GuixSD, you @emph{declare} all aspects of the operating system "
3076 "configuration and Guix takes care of instantiating the configuration in a "
3077 "transactional, reproducible, and stateless fashion (@pxref{System "
3080 "Vous pouvez installer GNU@tie{}Guix sur un système GNU/Linux existant pour "
3081 "compléter les outils disponibles sans interférence (@pxref{Installation}) ou "
3082 "vous pouvez l'utiliser à travers la @dfn{Distribution Système Guix} ou "
3083 "GuixSD (@pxref{Distribution GNU}) distincte. Avec GNU@tie{}GuixSD, vous "
3084 "@emph{déclarez} tous les aspects de la configuration du système "
3085 "d'exploitation et Guix s'occupe de créer la configuration d'une manière "
3086 "transactionnelle, reproductible et sans état (@pxref{Configuration système})."
3089 #: doc/guix.texi:337
3091 msgid "functional package management"
3092 msgstr "gestion de paquet fonctionnelle"
3095 #: doc/guix.texi:352
3097 "Under the hood, Guix implements the @dfn{functional package management} "
3098 "discipline pioneered by Nix (@pxref{Acknowledgments}). In Guix, the package "
3099 "build and installation process is seen as a @emph{function}, in the "
3100 "mathematical sense. That function takes inputs, such as build scripts, a "
3101 "compiler, and libraries, and returns an installed package. As a pure "
3102 "function, its result depends solely on its inputs---for instance, it cannot "
3103 "refer to software or scripts that were not explicitly passed as inputs. A "
3104 "build function always produces the same result when passed a given set of "
3105 "inputs. It cannot alter the environment of the running system in any way; "
3106 "for instance, it cannot create, modify, or delete files outside of its build "
3107 "and installation directories. This is achieved by running build processes "
3108 "in isolated environments (or @dfn{containers}), where only their explicit "
3109 "inputs are visible."
3111 "Sous le capot, Guix implémente la discipline de @dfn{gestion de paquet "
3112 "fonctionnel} inventé par Nix (@pxref{Remerciements}). Dans Guix le processus "
3113 "de construction et d'installation des paquets est vu comme une "
3114 "@emph{fonction} dans le sens mathématique du terme. Cette fonction a des "
3115 "entrées (comme des scripts de construction, un compilateur et des "
3116 "bibliothèques) et renvoie un paquet installé. En tant que fonction pure, son "
3117 "résultat ne dépend que de ses entrées. Par exemple, il ne peut pas faire "
3118 "référence à des logiciels ou des scripts qui n'ont pas été explicitement "
3119 "passés en entrée. Une fonction de construction produit toujours le même "
3120 "résultat quand on lui donne le même ensemble d'entrée. Elle ne peut pas "
3121 "modifier l'environnement du système en cours d'exécution d'aucune manière ; "
3122 "par exemple elle ne peut pas créer, modifier ou supprimer des fichiers en "
3123 "dehors de ses répertoires de construction et d'installation. Ce résultat "
3124 "s'obtient en lançant les processus de construction dans des environnements "
3125 "isolés (ou des @dfn{conteneurs}) où seules les entrées explicites sont "
3129 #: doc/guix.texi:353 doc/guix.texi:4186
3135 #: doc/guix.texi:360
3137 "The result of package build functions is @dfn{cached} in the file system, in "
3138 "a special directory called @dfn{the store} (@pxref{The Store}). Each "
3139 "package is installed in a directory of its own in the store---by default "
3140 "under @file{/gnu/store}. The directory name contains a hash of all the "
3141 "inputs used to build that package; thus, changing an input yields a "
3142 "different directory name."
3144 "Le résultat des fonctions de construction de paquets est mis en @dfn{cache} "
3145 "dans le système de fichier, dans répertoire spécial appelé le @dfn{dépôt} "
3146 "(@pxref{The Store}). Chaque paquet est installé dans son répertoire propre "
3147 "dans le dépôt — par défaut dans @file{/gnu/store}. Le nom du répertoire "
3148 "contient un hash de toutes les entrées utilisées pour construire le paquet ; "
3149 "ainsi, changer une entrée donnera un nom de répertoire différent."
3152 #: doc/guix.texi:364
3154 "This approach is the foundation for the salient features of Guix: support "
3155 "for transactional package upgrade and rollback, per-user installation, and "
3156 "garbage collection of packages (@pxref{Features})."
3158 "Cette approche est le fondement des fonctionnalités les plus importante de "
3159 "Guix : le support des mises à jour des paquets et des retours en arrière "
3160 "transactionnels, l'installation différenciée par utilisateur et le ramassage "
3161 "de miettes pour les paquets (@pxref{Fonctionnalités})."
3164 #: doc/guix.texi:370
3166 msgid "installing Guix"
3167 msgstr "installer Guix"
3170 #: doc/guix.texi:375
3172 "GNU Guix is available for download from its website at @url{http://www.gnu."
3173 "org/software/guix/}. This section describes the software requirements of "
3174 "Guix, as well as how to install it and get ready to use it."
3176 "GNU Guix est disponible au téléchargement depuis son site web sur "
3177 "@url{http://www.gnu.org/software/guix/}. Cette section décrit les pré-requis "
3178 "logiciels de Guix ainsi que la manière de l'installer et de se préparer à "
3182 #: doc/guix.texi:380
3184 "Note that this section is concerned with the installation of the package "
3185 "manager, which can be done on top of a running GNU/Linux system. If, "
3186 "instead, you want to install the complete GNU operating system, "
3187 "@pxref{System Installation}."
3189 "Remarquez que cette section concerne l'installation du gestionnaire de "
3190 "paquet, ce qui se fait sur un système GNU/Linux en cours d'exécution. Si "
3191 "vous souhaitez plutôt installer le système d'exploitation GNU complet, "
3192 "@pxref{System Installation}."
3195 #: doc/guix.texi:381 doc/guix.texi:1444
3197 msgid "foreign distro"
3198 msgstr "distro extérieure"
3201 #: doc/guix.texi:387
3203 "When installed on a running GNU/Linux system---thereafter called a "
3204 "@dfn{foreign distro}---GNU@tie{}Guix complements the available tools without "
3205 "interference. Its data lives exclusively in two directories, usually @file{/"
3206 "gnu/store} and @file{/var/guix}; other files on your system, such as @file{/"
3207 "etc}, are left untouched."
3209 "Lorsqu'il est installé sur an système GNU/Linux existant — ci-après nommé "
3210 "@dfn{distro extérieure} — GNU@tie{}Guix complète les outils disponibles sans "
3211 "interférence. Ses données se trouvent exclusivement dans deux répertoires, "
3212 "typiquement @file{/gnu/store} et @file{/var/guix} ; les autres fichiers de "
3213 "votre système comme @file{/etc} sont laissés intacts."
3216 #: doc/guix.texi:390
3218 "Once installed, Guix can be updated by running @command{guix pull} "
3219 "(@pxref{Invoking guix pull})."
3221 "Une fois installé, Guix peut être mis à jour en lançant @command{guix pull} "
3222 "(@pxref{Invoking guix pull})."
3225 #: doc/guix.texi:403
3227 msgid "installing Guix from binaries"
3231 #: doc/guix.texi:409
3233 "This section describes how to install Guix on an arbitrary system from a "
3234 "self-contained tarball providing binaries for Guix and for all its "
3235 "dependencies. This is often quicker than installing from source, which is "
3236 "described in the next sections. The only requirement is to have GNU@tie{}"
3241 #: doc/guix.texi:414
3243 "We provide a @uref{https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-"
3244 "install.sh, shell installer script}, which automates the download, "
3245 "installation, and initial configuration of Guix. It should be run as the "
3250 #: doc/guix.texi:416
3251 msgid "Installing goes along these lines:"
3255 #: doc/guix.texi:419
3257 msgid "downloading Guix binary"
3261 #: doc/guix.texi:424
3263 "Download the binary tarball from @indicateurl{ftp://alpha.gnu.org/gnu/guix/"
3264 "guix-binary-@value{VERSION}.@var{system}.tar.xz}, where @var{system} is "
3265 "@code{x86_64-linux} for an @code{x86_64} machine already running the kernel "
3270 #: doc/guix.texi:428
3272 "Make sure to download the associated @file{.sig} file and to verify the "
3273 "authenticity of the tarball against it, along these lines:"
3277 #: doc/guix.texi:432
3280 "$ wget ftp://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz.sig\n"
3281 "$ gpg --verify guix-binary-@value{VERSION}.@var{system}.tar.xz.sig\n"
3285 #: doc/guix.texi:436 doc/guix.texi:8198
3287 "If that command fails because you do not have the required public key, then "
3288 "run this command to import it:"
3292 #: doc/guix.texi:439 doc/guix.texi:8201
3294 msgid "$ gpg --keyserver pgp.mit.edu --recv-keys @value{OPENPGP-SIGNING-KEY-ID}\n"
3298 #: doc/guix.texi:444 doc/guix.texi:8206
3299 msgid "and rerun the @code{gpg --verify} command."
3303 #: doc/guix.texi:448
3305 "Now, you need to become the @code{root} user. Depending on your "
3306 "distribution, you may have to run @code{su -} or @code{sudo -i}. As "
3311 #: doc/guix.texi:454
3315 "# tar --warning=no-timestamp -xf \\\n"
3316 " guix-binary-@value{VERSION}.@var{system}.tar.xz\n"
3317 "# mv var/guix /var/ && mv gnu /\n"
3321 #: doc/guix.texi:459
3323 "This creates @file{/gnu/store} (@pxref{The Store}) and @file{/var/guix}. "
3324 "The latter contains a ready-to-use profile for @code{root} (see next step.)"
3328 #: doc/guix.texi:462
3330 "Do @emph{not} unpack the tarball on a working Guix system since that would "
3331 "overwrite its own essential files."
3335 #: doc/guix.texi:472
3337 "The @code{--warning=no-timestamp} option makes sure GNU@tie{}tar does not "
3338 "emit warnings about ``implausibly old time stamps'' (such warnings were "
3339 "triggered by GNU@tie{}tar 1.26 and older; recent versions are fine.) They "
3340 "stem from the fact that all the files in the archive have their modification "
3341 "time set to zero (which means January 1st, 1970.) This is done on purpose "
3342 "to make sure the archive content is independent of its creation time, thus "
3343 "making it reproducible."
3347 #: doc/guix.texi:475
3348 msgid "Make @code{root}'s profile available under @file{~root/.guix-profile}:"
3352 #: doc/guix.texi:479
3355 "# ln -sf /var/guix/profiles/per-user/root/guix-profile \\\n"
3356 " ~root/.guix-profile\n"
3360 #: doc/guix.texi:483
3362 "Source @file{etc/profile} to augment @code{PATH} and other relevant "
3363 "environment variables:"
3367 #: doc/guix.texi:487
3370 "# GUIX_PROFILE=\"`echo ~root`/.guix-profile\" ; \\\n"
3371 " source $GUIX_PROFILE/etc/profile\n"
3375 #: doc/guix.texi:492
3377 "Create the group and user accounts for build users as explained below "
3378 "(@pxref{Build Environment Setup})."
3382 #: doc/guix.texi:495
3383 msgid "Run the daemon, and set it to automatically start on boot."
3387 #: doc/guix.texi:498
3389 "If your host distro uses the systemd init system, this can be achieved with "
3394 #: doc/guix.texi:510
3397 "# cp ~root/.guix-profile/lib/systemd/system/guix-daemon.service \\\n"
3398 " /etc/systemd/system/\n"
3399 "# systemctl start guix-daemon && systemctl enable guix-daemon\n"
3403 #: doc/guix.texi:513 doc/guix.texi:7635
3404 msgid "If your host distro uses the Upstart init system:"
3408 #: doc/guix.texi:518
3411 "# initctl reload-configuration\n"
3412 "# cp ~root/.guix-profile/lib/upstart/system/guix-daemon.conf /etc/init/\n"
3413 "# start guix-daemon\n"
3417 #: doc/guix.texi:521
3418 msgid "Otherwise, you can still start the daemon manually with:"
3422 #: doc/guix.texi:524
3424 msgid "# ~root/.guix-profile/bin/guix-daemon --build-users-group=guixbuild\n"
3428 #: doc/guix.texi:529
3430 "Make the @command{guix} command available to other users on the machine, for "
3435 #: doc/guix.texi:534
3438 "# mkdir -p /usr/local/bin\n"
3439 "# cd /usr/local/bin\n"
3440 "# ln -s /var/guix/profiles/per-user/root/guix-profile/bin/guix\n"
3444 #: doc/guix.texi:538
3446 "It is also a good idea to make the Info version of this manual available "
3451 #: doc/guix.texi:544
3454 "# mkdir -p /usr/local/share/info\n"
3455 "# cd /usr/local/share/info\n"
3456 "# for i in /var/guix/profiles/per-user/root/guix-profile/share/info/* ;\n"
3457 " do ln -s $i ; done\n"
3461 #: doc/guix.texi:550
3463 "That way, assuming @file{/usr/local/share/info} is in the search path, "
3464 "running @command{info guix} will open this manual (@pxref{Other Info "
3465 "Directories,,, texinfo, GNU Texinfo}, for more details on changing the Info "
3470 #: doc/guix.texi:552 doc/guix.texi:2304 doc/guix.texi:10194
3472 msgid "substitutes, authorization thereof"
3476 #: doc/guix.texi:555
3478 "To use substitutes from @code{hydra.gnu.org} or one of its mirrors "
3479 "(@pxref{Substitutes}), authorize them:"
3481 "Pour utiliser les substituts de @code{hydra.gnu.org} ou l'un de ses mirroirs "
3482 "(@pxref{Substituts}), autorisez-les :"
3485 #: doc/guix.texi:558
3487 msgid "# guix archive --authorize < ~root/.guix-profile/share/guix/hydra.gnu.org.pub\n"
3491 #: doc/guix.texi:563
3493 "Each user may need to perform a few additional steps to make their Guix "
3494 "environment ready for use, @pxref{Application Setup}."
3498 #: doc/guix.texi:566
3499 msgid "Voilà, the installation is complete!"
3503 #: doc/guix.texi:569
3505 "You can confirm that Guix is working by installing a sample package into the "
3510 #: doc/guix.texi:572
3512 msgid "# guix package -i hello\n"
3516 #: doc/guix.texi:579
3518 "The @code{guix} package must remain available in @code{root}'s profile, or "
3519 "it would become subject to garbage collection---in which case you would find "
3520 "yourself badly handicapped by the lack of the @command{guix} command. In "
3521 "other words, do not remove @code{guix} by running @code{guix package -r "
3526 #: doc/guix.texi:582
3528 "The binary installation tarball can be (re)produced and verified simply by "
3529 "running the following command in the Guix source tree:"
3533 #: doc/guix.texi:585
3535 msgid "make guix-binary.@var{system}.tar.xz\n"
3539 #: doc/guix.texi:589
3540 msgid "... which, in turn, runs:"
3544 #: doc/guix.texi:592
3546 msgid "guix pack -s @var{system} --localstatedir guix\n"
3550 #: doc/guix.texi:595
3551 msgid "@xref{Invoking guix pack}, for more info on this handy tool."
3555 #: doc/guix.texi:603
3557 "This section lists requirements when building Guix from source. The build "
3558 "procedure for Guix is the same as for other GNU software, and is not covered "
3559 "here. Please see the files @file{README} and @file{INSTALL} in the Guix "
3560 "source tree for additional details."
3564 #: doc/guix.texi:605
3565 msgid "GNU Guix depends on the following packages:"
3569 #: doc/guix.texi:607
3571 msgid "@url{http://gnu.org/software/guile/, GNU Guile}, version 2.0.13 or"
3575 #: doc/guix.texi:609
3576 msgid "later, including 2.2.x;"
3580 #: doc/guix.texi:609
3582 msgid "@url{http://gnupg.org/, GNU libgcrypt};"
3586 #: doc/guix.texi:614
3588 "@uref{http://gnutls.org/, GnuTLS}, specifically its Guile bindings "
3589 "(@pxref{Guile Preparations, how to install the GnuTLS bindings for Guile,, "
3590 "gnutls-guile, GnuTLS-Guile});"
3594 #: doc/guix.texi:618
3596 "@uref{https://gitlab.com/guile-git/guile-git, Guile-Git}, from August 2017 "
3601 #: doc/guix.texi:618
3603 msgid "@url{http://zlib.net, zlib};"
3607 #: doc/guix.texi:619
3609 msgid "@url{http://www.gnu.org/software/make/, GNU Make}."
3613 #: doc/guix.texi:623
3614 msgid "The following dependencies are optional:"
3618 #: doc/guix.texi:631
3620 "Installing @url{http://savannah.nongnu.org/projects/guile-json/, Guile-JSON} "
3621 "will allow you to use the @command{guix import pypi} command "
3622 "(@pxref{Invoking guix import}). It is of interest primarily for developers "
3623 "and not for casual users."
3627 #: doc/guix.texi:638
3629 "Support for build offloading (@pxref{Daemon Offload Setup}) and "
3630 "@command{guix copy} (@pxref{Invoking guix copy}) depends on @uref{https://"
3631 "github.com/artyom-poptsov/guile-ssh, Guile-SSH}, version 0.10.2 or later."
3635 #: doc/guix.texi:642
3637 "When @url{http://www.bzip.org, libbz2} is available, @command{guix-daemon} "
3638 "can use it to compress build logs."
3642 #: doc/guix.texi:646
3644 "Unless @code{--disable-daemon} was passed to @command{configure}, the "
3645 "following packages are also needed:"
3649 #: doc/guix.texi:648
3651 msgid "@url{http://sqlite.org, SQLite 3};"
3655 #: doc/guix.texi:649
3657 msgid "@url{http://gcc.gnu.org, GCC's g++}, with support for the"
3661 #: doc/guix.texi:651
3662 msgid "C++11 standard."
3666 #: doc/guix.texi:653
3668 msgid "state directory"
3672 #: doc/guix.texi:661
3674 "When configuring Guix on a system that already has a Guix installation, be "
3675 "sure to specify the same state directory as the existing installation using "
3676 "the @code{--localstatedir} option of the @command{configure} script "
3677 "(@pxref{Directory Variables, @code{localstatedir},, standards, GNU Coding "
3678 "Standards}). The @command{configure} script protects against unintended "
3679 "misconfiguration of @var{localstatedir} so you do not inadvertently corrupt "
3680 "your store (@pxref{The Store})."
3684 #: doc/guix.texi:662
3686 msgid "Nix, compatibility"
3690 #: doc/guix.texi:667
3692 "When a working installation of @url{http://nixos.org/nix/, the Nix package "
3693 "manager} is available, you can instead configure Guix with @code{--disable-"
3694 "daemon}. In that case, Nix replaces the three dependencies above."
3698 #: doc/guix.texi:677
3700 "Guix is compatible with Nix, so it is possible to share the same store "
3701 "between both. To do so, you must pass @command{configure} not only the same "
3702 "@code{--with-store-dir} value, but also the same @code{--localstatedir} "
3703 "value. The latter is essential because it specifies where the database that "
3704 "stores metadata about the store is located, among other things. The default "
3705 "values for Nix are @code{--with-store-dir=/nix/store} and @code{--"
3706 "localstatedir=/nix/var}. Note that @code{--disable-daemon} is not required "
3707 "if your goal is to share the store with Nix."
3711 #: doc/guix.texi:681
3717 #: doc/guix.texi:687
3719 "After a successful @command{configure} and @code{make} run, it is a good "
3720 "idea to run the test suite. It can help catch issues with the setup or "
3721 "environment, or bugs in Guix itself---and really, reporting test failures is "
3722 "a good way to help improve the software. To run the test suite, type:"
3726 #: doc/guix.texi:690
3728 msgid "make check\n"
3732 #: doc/guix.texi:697
3734 "Test cases can run in parallel: you can use the @code{-j} option of GNU@tie{}"
3735 "make to speed things up. The first run may take a few minutes on a recent "
3736 "machine; subsequent runs will be faster because the store that is created "
3737 "for test purposes will already have various things in cache."
3741 #: doc/guix.texi:700
3743 "It is also possible to run a subset of the tests by defining the "
3744 "@code{TESTS} makefile variable as in this example:"
3748 #: doc/guix.texi:703
3750 msgid "make check TESTS=\"tests/store.scm tests/cpio.scm\"\n"
3754 #: doc/guix.texi:708
3756 "By default, tests results are displayed at a file level. In order to see "
3757 "the details of every individual test cases, it is possible to define the "
3758 "@code{SCM_LOG_DRIVER_FLAGS} makefile variable as in this example:"
3762 #: doc/guix.texi:711
3764 msgid "make check TESTS=\"tests/base64.scm\" SCM_LOG_DRIVER_FLAGS=\"--brief=no\"\n"
3768 #: doc/guix.texi:717
3770 "Upon failure, please email @email{bug-guix@@gnu.org} and attach the "
3771 "@file{test-suite.log} file. Please specify the Guix version being used as "
3772 "well as version numbers of the dependencies (@pxref{Requirements}) in your "
3777 #: doc/guix.texi:721
3779 "Guix also comes with a whole-system test suite that tests complete GuixSD "
3780 "operating system instances. It can only run on systems where Guix is "
3781 "already installed, using:"
3785 #: doc/guix.texi:724
3787 msgid "make check-system\n"
3791 #: doc/guix.texi:728
3792 msgid "or, again, by defining @code{TESTS} to select a subset of tests to run:"
3796 #: doc/guix.texi:731
3798 msgid "make check-system TESTS=\"basic mcron\"\n"
3802 #: doc/guix.texi:739
3804 "These system tests are defined in the @code{(gnu tests @dots{})} modules. "
3805 "They work by running the operating systems under test with lightweight "
3806 "instrumentation in a virtual machine (VM). They can be computationally "
3807 "intensive or rather cheap, depending on whether substitutes are available "
3808 "for their dependencies (@pxref{Substitutes}). Some of them require a lot of "
3809 "storage space to hold VM images."
3811 "Ces tests systèmes sont définis dans les modules @code{(gnu tests @dots{})}. "
3812 "Ils fonctionnent en lançant les systèmes d'exploitation sous test avec une "
3813 "instrumentation légère dans une machine virtuelle (VM). Ils peuvent être "
3814 "intenses en terme de calculs ou plutôt rapides en fonction de la "
3815 "disponibilité des substituts de leurs dépendances (@pxref{Substituts}). "
3816 "Certains requièrent beaucoup d'espace disque pour contenir les images des VM."
3819 #: doc/guix.texi:742
3821 "Again in case of test failures, please send @email{bug-guix@@gnu.org} all "
3826 #: doc/guix.texi:746
3832 #: doc/guix.texi:754
3834 "Operations such as building a package or running the garbage collector are "
3835 "all performed by a specialized process, the @dfn{build daemon}, on behalf of "
3836 "clients. Only the daemon may access the store and its associated database. "
3837 "Thus, any operation that manipulates the store goes through the daemon. For "
3838 "instance, command-line tools such as @command{guix package} and "
3839 "@command{guix build} communicate with the daemon (@i{via} remote procedure "
3840 "calls) to instruct it what to do."
3844 #: doc/guix.texi:758
3846 "The following sections explain how to prepare the build daemon's "
3847 "environment. See also @ref{Substitutes}, for information on how to allow "
3848 "the daemon to download pre-built binaries."
3850 "Les sections suivantes expliquent comment préparer l'environnement du démon "
3851 "de construction. Voir aussi @ref{Substituts} pour apprendre comment "
3852 "permettre le téléchargement de binaires pré-construits."
3855 #: doc/guix.texi:768 doc/guix.texi:1193
3857 msgid "build environment"
3861 #: doc/guix.texi:776
3863 "In a standard multi-user setup, Guix and its daemon---the @command{guix-"
3864 "daemon} program---are installed by the system administrator; @file{/gnu/"
3865 "store} is owned by @code{root} and @command{guix-daemon} runs as "
3866 "@code{root}. Unprivileged users may use Guix tools to build packages or "
3867 "otherwise access the store, and the daemon will do it on their behalf, "
3868 "ensuring that the store is kept in a consistent state, and allowing built "
3869 "packages to be shared among users."
3873 #: doc/guix.texi:777
3879 #: doc/guix.texi:788
3881 "When @command{guix-daemon} runs as @code{root}, you may not want package "
3882 "build processes themselves to run as @code{root} too, for obvious security "
3883 "reasons. To avoid that, a special pool of @dfn{build users} should be "
3884 "created for use by build processes started by the daemon. These build users "
3885 "need not have a shell and a home directory: they will just be used when the "
3886 "daemon drops @code{root} privileges in build processes. Having several such "
3887 "users allows the daemon to launch distinct build processes under separate "
3888 "UIDs, which guarantees that they do not interfere with each other---an "
3889 "essential feature since builds are regarded as pure functions "
3890 "(@pxref{Introduction})."
3894 #: doc/guix.texi:791
3896 "On a GNU/Linux system, a build user pool may be created like this (using "
3897 "Bash syntax and the @code{shadow} commands):"
3901 #: doc/guix.texi:803
3904 "# groupadd --system guixbuild\n"
3905 "# for i in `seq -w 1 10`;\n"
3907 " useradd -g guixbuild -G guixbuild \\\n"
3908 " -d /var/empty -s `which nologin` \\\n"
3909 " -c \"Guix build user $i\" --system \\\n"
3915 #: doc/guix.texi:813
3917 "The number of build users determines how many build jobs may run in "
3918 "parallel, as specified by the @option{--max-jobs} option (@pxref{Invoking "
3919 "guix-daemon, @option{--max-jobs}}). To use @command{guix system vm} and "
3920 "related commands, you may need to add the build users to the @code{kvm} "
3921 "group so they can access @file{/dev/kvm}, using @code{-G guixbuild,kvm} "
3922 "instead of @code{-G guixbuild} (@pxref{Invoking guix system})."
3926 #: doc/guix.texi:822
3928 "The @code{guix-daemon} program may then be run as @code{root} with the "
3929 "following command@footnote{If your machine uses the systemd init system, "
3930 "dropping the @file{@var{prefix}/lib/systemd/system/guix-daemon.service} file "
3931 "in @file{/etc/systemd/system} will ensure that @command{guix-daemon} is "
3932 "automatically started. Similarly, if your machine uses the Upstart init "
3933 "system, drop the @file{@var{prefix}/lib/upstart/system/guix-daemon.conf} "
3934 "file in @file{/etc/init}.}:"
3938 #: doc/guix.texi:825 doc/guix.texi:1186
3940 msgid "# guix-daemon --build-users-group=guixbuild\n"
3944 #: doc/guix.texi:827 doc/guix.texi:1191
3950 #: doc/guix.texi:832
3952 "This way, the daemon starts build processes in a chroot, under one of the "
3953 "@code{guixbuilder} users. On GNU/Linux, by default, the chroot environment "
3954 "contains nothing but:"
3958 #: doc/guix.texi:840
3960 "a minimal @code{/dev} directory, created mostly independently from the host "
3961 "@code{/dev}@footnote{``Mostly'', because while the set of files that appear "
3962 "in the chroot's @code{/dev} is fixed, most of these files can only be "
3963 "created if the host has them.};"
3967 #: doc/guix.texi:844
3969 "the @code{/proc} directory; it only shows the processes of the container "
3970 "since a separate PID name space is used;"
3974 #: doc/guix.texi:848
3976 "@file{/etc/passwd} with an entry for the current user and an entry for user "
3981 #: doc/guix.texi:851
3982 msgid "@file{/etc/group} with an entry for the user's group;"
3986 #: doc/guix.texi:855
3988 "@file{/etc/hosts} with an entry that maps @code{localhost} to "
3993 #: doc/guix.texi:858
3994 msgid "a writable @file{/tmp} directory."
3998 #: doc/guix.texi:867
4000 "You can influence the directory where the daemon stores build trees @i{via} "
4001 "the @code{TMPDIR} environment variable. However, the build tree within the "
4002 "chroot is always called @file{/tmp/guix-build-@var{name}.drv-0}, where "
4003 "@var{name} is the derivation name---e.g., @code{coreutils-8.24}. This way, "
4004 "the value of @code{TMPDIR} does not leak inside build environments, which "
4005 "avoids discrepancies in cases where build processes capture the name of "
4010 #: doc/guix.texi:868 doc/guix.texi:2411
4016 #: doc/guix.texi:872
4018 "The daemon also honors the @code{http_proxy} environment variable for HTTP "
4019 "downloads it performs, be it for fixed-output derivations "
4020 "(@pxref{Derivations}) or for substitutes (@pxref{Substitutes})."
4022 "Le démon tient aussi compte de la variable d'environnement @code{http_proxy} "
4023 "pour ses téléchargements HTTP, que ce soit pour les dérivations à sortie "
4024 "fixes (@pxref{Derivations}) ou pour les substituts (@pxref{Substituts})."
4027 #: doc/guix.texi:880
4029 "If you are installing Guix as an unprivileged user, it is still possible to "
4030 "run @command{guix-daemon} provided you pass @code{--disable-chroot}. "
4031 "However, build processes will not be isolated from one another, and not from "
4032 "the rest of the system. Thus, build processes may interfere with each "
4033 "other, and may access programs, libraries, and other files available on the "
4034 "system---making it much harder to view them as @emph{pure} functions."
4038 #: doc/guix.texi:883
4040 msgid "Using the Offload Facility"
4044 #: doc/guix.texi:885
4050 #: doc/guix.texi:886 doc/guix.texi:1247
4056 #: doc/guix.texi:900
4058 "When desired, the build daemon can @dfn{offload} derivation builds to other "
4059 "machines running Guix, using the @code{offload} @dfn{build hook}"
4060 "@footnote{This feature is available only when @uref{https://github.com/"
4061 "artyom-poptsov/guile-ssh, Guile-SSH} is present.}. When that feature is "
4062 "enabled, a list of user-specified build machines is read from @file{/etc/"
4063 "guix/machines.scm}; every time a build is requested, for instance via "
4064 "@code{guix build}, the daemon attempts to offload it to one of the machines "
4065 "that satisfy the constraints of the derivation, in particular its system "
4066 "type---e.g., @file{x86_64-linux}. Missing prerequisites for the build are "
4067 "copied over SSH to the target machine, which then proceeds with the build; "
4068 "upon success the output(s) of the build are copied back to the initial "
4073 #: doc/guix.texi:902
4074 msgid "The @file{/etc/guix/machines.scm} file typically looks like this:"
4078 #: doc/guix.texi:910
4081 "(list (build-machine\n"
4082 " (name \"eightysix.example.org\")\n"
4083 " (system \"x86_64-linux\")\n"
4084 " (host-key \"ssh-ed25519 AAAAC3Nza@dots{}\")\n"
4086 " (speed 2.)) ;incredibly fast!\n"
4091 #: doc/guix.texi:919
4095 " (name \"meeps.example.org\")\n"
4096 " (system \"mips64el-linux\")\n"
4097 " (host-key \"ssh-rsa AAAAB3Nza@dots{}\")\n"
4098 " (user \"alice\")\n"
4100 " (string-append (getenv \"HOME\")\n"
4101 " \"/.ssh/identity-for-guix\"))))\n"
4105 #: doc/guix.texi:925
4107 "In the example above we specify a list of two build machines, one for the "
4108 "@code{x86_64} architecture and one for the @code{mips64el} architecture."
4112 #: doc/guix.texi:934
4114 "In fact, this file is---not surprisingly!---a Scheme file that is evaluated "
4115 "when the @code{offload} hook is started. Its return value must be a list of "
4116 "@code{build-machine} objects. While this example shows a fixed list of "
4117 "build machines, one could imagine, say, using DNS-SD to return a list of "
4118 "potential build machines discovered in the local network "
4119 "(@pxref{Introduction, Guile-Avahi,, guile-avahi, Using Avahi in Guile Scheme "
4120 "Programs}). The @code{build-machine} data type is detailed below."
4124 #: doc/guix.texi:935
4126 msgid "{Data Type} build-machine"
4130 #: doc/guix.texi:938
4132 "This data type represents build machines to which the daemon may offload "
4133 "builds. The important fields are:"
4137 #: doc/guix.texi:941 doc/guix.texi:3402 doc/guix.texi:9406 doc/guix.texi:9470
4138 #: doc/guix.texi:9565 doc/guix.texi:11000 doc/guix.texi:15037
4139 #: doc/guix.texi:15270 doc/guix.texi:15403 doc/guix.texi:15677
4140 #: doc/guix.texi:15718 doc/guix.texi:19663 doc/guix.texi:19680
4141 #: doc/guix.texi:19946 doc/guix.texi:21154
4147 #: doc/guix.texi:943
4148 msgid "The host name of the remote machine."
4152 #: doc/guix.texi:944
4158 #: doc/guix.texi:946
4159 msgid "The system type of the remote machine---e.g., @code{\"x86_64-linux\"}."
4163 #: doc/guix.texi:947 doc/guix.texi:11010
4169 #: doc/guix.texi:951
4171 "The user account to use when connecting to the remote machine over SSH. "
4172 "Note that the SSH key pair must @emph{not} be passphrase-protected, to allow "
4173 "non-interactive logins."
4177 #: doc/guix.texi:952
4183 #: doc/guix.texi:956
4185 "This must be the machine's SSH @dfn{public host key} in OpenSSH format. "
4186 "This is used to authenticate the machine when we connect to it. It is a "
4187 "long string that looks like this:"
4191 #: doc/guix.texi:959
4193 msgid "ssh-ed25519 AAAAC3NzaC@dots{}mde+UhL hint@@example.org\n"
4197 #: doc/guix.texi:964
4199 "If the machine is running the OpenSSH daemon, @command{sshd}, the host key "
4200 "can be found in a file such as @file{/etc/ssh/ssh_host_ed25519_key.pub}."
4204 #: doc/guix.texi:969
4206 "If the machine is running the SSH daemon of GNU@tie{}lsh, @command{lshd}, "
4207 "the host key is in @file{/etc/lsh/host-key.pub} or a similar file. It can "
4208 "be converted to the OpenSSH format using @command{lsh-export-key} "
4209 "(@pxref{Converting keys,,, lsh, LSH Manual}):"
4213 #: doc/guix.texi:973
4216 "$ lsh-export-key --openssh < /etc/lsh/host-key.pub \n"
4217 "ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV@dots{}\n"
4221 #: doc/guix.texi:978
4222 msgid "A number of optional fields may be specified:"
4226 #: doc/guix.texi:981
4228 msgid "@code{port} (default: @code{22})"
4232 #: doc/guix.texi:983
4233 msgid "Port number of SSH server on the machine."
4237 #: doc/guix.texi:984
4239 msgid "@code{private-key} (default: @file{~root/.ssh/id_rsa})"
4243 #: doc/guix.texi:987
4245 "The SSH private key file to use when connecting to the machine, in OpenSSH "
4250 #: doc/guix.texi:990
4252 "Note that the default value is the private key @emph{of the root account}. "
4253 "Make sure it exists if you use the default."
4257 #: doc/guix.texi:991
4259 msgid "@code{compression} (default: @code{\"zlib@@openssh.com,zlib\"})"
4263 #: doc/guix.texi:992 doc/guix.texi:10422
4265 msgid "@code{compression-level} (default: @code{3})"
4269 #: doc/guix.texi:994
4270 msgid "The SSH-level compression methods and compression level requested."
4274 #: doc/guix.texi:997
4276 "Note that offloading relies on SSH compression to reduce bandwidth usage "
4277 "when transferring files to and from build machines."
4281 #: doc/guix.texi:998
4283 msgid "@code{daemon-socket} (default: @code{\"/var/guix/daemon-socket/socket\"})"
4287 #: doc/guix.texi:1001
4289 "File name of the Unix-domain socket @command{guix-daemon} is listening to on "
4294 #: doc/guix.texi:1002
4296 msgid "@code{parallel-builds} (default: @code{1})"
4300 #: doc/guix.texi:1004
4301 msgid "The number of builds that may run in parallel on the machine."
4305 #: doc/guix.texi:1005
4307 msgid "@code{speed} (default: @code{1.0})"
4311 #: doc/guix.texi:1008
4313 "A ``relative speed factor''. The offload scheduler will tend to prefer "
4314 "machines with a higher speed factor."
4318 #: doc/guix.texi:1009
4320 msgid "@code{features} (default: @code{'()})"
4324 #: doc/guix.texi:1014
4326 "A list of strings denoting specific features supported by the machine. An "
4327 "example is @code{\"kvm\"} for machines that have the KVM Linux modules and "
4328 "corresponding hardware support. Derivations can request features by name, "
4329 "and they will be scheduled on matching build machines."
4333 #: doc/guix.texi:1022
4335 "The @code{guile} command must be in the search path on the build machines. "
4336 "In addition, the Guix modules must be in @code{$GUILE_LOAD_PATH} on the "
4337 "build machine---you can check whether this is the case by running:"
4341 #: doc/guix.texi:1025
4343 msgid "ssh build-machine guile -c \"'(use-modules (guix config))'\"\n"
4347 #: doc/guix.texi:1032
4349 "There is one last thing to do once @file{machines.scm} is in place. As "
4350 "explained above, when offloading, files are transferred back and forth "
4351 "between the machine stores. For this to work, you first need to generate a "
4352 "key pair on each machine to allow the daemon to export signed archives of "
4353 "files from the store (@pxref{Invoking guix archive}):"
4357 #: doc/guix.texi:1035
4359 msgid "# guix archive --generate-key\n"
4363 #: doc/guix.texi:1040
4365 "Each build machine must authorize the key of the master machine so that it "
4366 "accepts store items it receives from the master:"
4370 #: doc/guix.texi:1043
4372 msgid "# guix archive --authorize < master-public-key.txt\n"
4376 #: doc/guix.texi:1047
4378 "Likewise, the master machine must authorize the key of each build machine."
4382 #: doc/guix.texi:1053
4384 "All the fuss with keys is here to express pairwise mutual trust relations "
4385 "between the master and the build machines. Concretely, when the master "
4386 "receives files from a build machine (and @i{vice versa}), its build daemon "
4387 "can make sure they are genuine, have not been tampered with, and that they "
4388 "are signed by an authorized key."
4392 #: doc/guix.texi:1054
4394 msgid "offload test"
4398 #: doc/guix.texi:1057
4400 "To test whether your setup is operational, run this command on the master "
4405 #: doc/guix.texi:1060
4407 msgid "# guix offload test\n"
4411 #: doc/guix.texi:1066
4413 "This will attempt to connect to each of the build machines specified in "
4414 "@file{/etc/guix/machines.scm}, make sure Guile and the Guix modules are "
4415 "available on each machine, attempt to export to the machine and import from "
4416 "it, and report any error in the process."
4420 #: doc/guix.texi:1069
4422 "If you want to test a different machine file, just specify it on the command "
4427 #: doc/guix.texi:1072
4429 msgid "# guix offload test machines-qualif.scm\n"
4433 #: doc/guix.texi:1076
4435 "Last, you can test the subset of the machines whose name matches a regular "
4436 "expression like this:"
4440 #: doc/guix.texi:1079
4442 msgid "# guix offload test machines.scm '\\.gnu\\.org$'\n"
4446 #: doc/guix.texi:1081
4448 msgid "offload status"
4452 #: doc/guix.texi:1084
4454 "To display the current load of all build hosts, run this command on the main "
4459 #: doc/guix.texi:1087
4461 msgid "# guix offload status\n"
4465 #: doc/guix.texi:1093
4467 msgid "SELinux, daemon policy"
4471 #: doc/guix.texi:1094
4473 msgid "mandatory access control, SELinux"
4477 #: doc/guix.texi:1095
4479 msgid "security, guix-daemon"
4483 #: doc/guix.texi:1101
4485 "Guix includes an SELinux policy file at @file{etc/guix-daemon.cil} that can "
4486 "be installed on a system where SELinux is enabled, in order to label Guix "
4487 "files and to specify the expected behavior of the daemon. Since GuixSD does "
4488 "not provide an SELinux base policy, the daemon policy cannot be used on "
4492 #. type: subsubsection
4493 #: doc/guix.texi:1102
4495 msgid "Installing the SELinux policy"
4499 #: doc/guix.texi:1103
4501 msgid "SELinux, policy installation"
4505 #: doc/guix.texi:1105
4506 msgid "To install the policy run this command as root:"
4510 #: doc/guix.texi:1108
4512 msgid "semodule -i etc/guix-daemon.cil\n"
4516 #: doc/guix.texi:1112
4518 "Then relabel the file system with @code{restorecon} or by a different "
4519 "mechanism provided by your system."
4523 #: doc/guix.texi:1117
4525 "Once the policy is installed, the file system has been relabeled, and the "
4526 "daemon has been restarted, it should be running in the @code{guix_daemon_t} "
4527 "context. You can confirm this with the following command:"
4531 #: doc/guix.texi:1120
4533 msgid "ps -Zax | grep guix-daemon\n"
4537 #: doc/guix.texi:1125
4539 "Monitor the SELinux log files as you run a command like @code{guix build "
4540 "hello} to convince yourself that SELinux permits all necessary operations."
4544 #: doc/guix.texi:1127
4546 msgid "SELinux, limitations"
4550 #: doc/guix.texi:1132
4552 "This policy is not perfect. Here is a list of limitations or quirks that "
4553 "should be considered when deploying the provided SELinux policy for the Guix "
4558 #: doc/guix.texi:1139
4560 "@code{guix_daemon_socket_t} isn’t actually used. None of the socket "
4561 "operations involve contexts that have anything to do with "
4562 "@code{guix_daemon_socket_t}. It doesn’t hurt to have this unused label, but "
4563 "it would be preferrable to define socket rules for only this label."
4567 #: doc/guix.texi:1150
4569 "@code{guix gc} cannot access arbitrary links to profiles. By design, the "
4570 "file label of the destination of a symlink is independent of the file label "
4571 "of the link itself. Although all profiles under $localstatedir are "
4572 "labelled, the links to these profiles inherit the label of the directory "
4573 "they are in. For links in the user’s home directory this will be "
4574 "@code{user_home_t}. But for links from the root user’s home directory, or "
4575 "@file{/tmp}, or the HTTP server’s working directory, etc, this won’t work. "
4576 "@code{guix gc} would be prevented from reading and following these links."
4580 #: doc/guix.texi:1155
4582 "The daemon’s feature to listen for TCP connections might no longer work. "
4583 "This might require extra rules, because SELinux treats network sockets "
4584 "differently from files."
4588 #: doc/guix.texi:1166
4590 "Currently all files with a name matching the regular expression @code{/gnu/"
4591 "store/.+-(guix-.+|profile)/bin/guix-daemon} are assigned the label "
4592 "@code{guix_daemon_exec_t}; this means that @emph{any} file with that name in "
4593 "any profile would be permitted to run in the @code{guix_daemon_t} domain. "
4594 "This is not ideal. An attacker could build a package that provides this "
4595 "executable and convince a user to install and run it, which lifts it into "
4596 "the @code{guix_daemon_t} domain. At that point SELinux could not prevent it "
4597 "from accessing files that are allowed for processes in that domain."
4601 #: doc/guix.texi:1174
4603 "We could generate a much more restrictive policy at installation time, so "
4604 "that only the @emph{exact} file name of the currently installed @code{guix-"
4605 "daemon} executable would be labelled with @code{guix_daemon_exec_t}, instead "
4606 "of using a broad regular expression. The downside is that root would have "
4607 "to install or upgrade the policy at installation time whenever the Guix "
4608 "package that provides the effectively running @code{guix-daemon} executable "
4613 #: doc/guix.texi:1177
4615 msgid "Invoking @command{guix-daemon}"
4619 #: doc/guix.texi:1183
4621 "The @command{guix-daemon} program implements all the functionality to access "
4622 "the store. This includes launching build processes, running the garbage "
4623 "collector, querying the availability of a build result, etc. It is normally "
4624 "run as @code{root} like this:"
4628 #: doc/guix.texi:1190
4629 msgid "For details on how to set it up, @pxref{Setting Up the Daemon}."
4630 msgstr "Pour des détails sur son paramétrage, @pxref{Paramétrer le démon}."
4633 #: doc/guix.texi:1192
4635 msgid "container, build environment"
4639 #: doc/guix.texi:1194 doc/guix.texi:1732 doc/guix.texi:2392 doc/guix.texi:7648
4641 msgid "reproducible builds"
4645 #: doc/guix.texi:1206
4647 "By default, @command{guix-daemon} launches build processes under different "
4648 "UIDs, taken from the build group specified with @code{--build-users-group}. "
4649 "In addition, each build process is run in a chroot environment that only "
4650 "contains the subset of the store that the build process depends on, as "
4651 "specified by its derivation (@pxref{Programming Interface, derivation}), "
4652 "plus a set of specific system directories. By default, the latter contains "
4653 "@file{/dev} and @file{/dev/pts}. Furthermore, on GNU/Linux, the build "
4654 "environment is a @dfn{container}: in addition to having its own file system "
4655 "tree, it has a separate mount name space, its own PID name space, network "
4656 "name space, etc. This helps achieve reproducible builds (@pxref{Features})."
4658 "Par défaut, @command{guix-daemon} lance les processus de construction sous "
4659 "différents UID récupérés depuis le groupe de construction spécifié avec "
4660 "@code{--build-users-group}. En plus, chaque processus de construction est "
4661 "lancé dans un environnement chroot qui ne contient que le sous-ensemble du "
4662 "dépôt dont le processus de construction dépend, tel que spécifié par sa "
4663 "dérivation (@pxref{Interface de programmation, dérivation}), plus un "
4664 "ensemble de répertoires systèmes spécifiques. Par défaut ce dernier contient "
4665 "@file{/dev} et @file{/dev/pts}. De plus, sous GNU/Linux, l'environnement de "
4666 "construction est un @dfn{conteneur} : en plus d'avoir sa propre arborescence "
4667 "du système de fichier, elle a un espace de montage séparé, son propre espace "
4668 "de PID, son espace de réseau, etc. Cela aide à obtenir des constructions "
4669 "reproductibles (@pxref{Fonctionnalités})."
4672 #: doc/guix.texi:1215
4674 "When the daemon performs a build on behalf of the user, it creates a build "
4675 "directory under @file{/tmp} or under the directory specified by its "
4676 "@code{TMPDIR} environment variable; this directory is shared with the "
4677 "container for the duration of the build. Be aware that using a directory "
4678 "other than @file{/tmp} can affect build results---for example, with a longer "
4679 "directory name, a build process that uses Unix-domain sockets might hit the "
4680 "name length limitation for @code{sun_path}, which it would otherwise not hit."
4684 #: doc/guix.texi:1219
4686 "The build directory is automatically deleted upon completion, unless the "
4687 "build failed and the client specified @option{--keep-failed} "
4688 "(@pxref{Invoking guix build, @option{--keep-failed}})."
4692 #: doc/guix.texi:1221
4693 msgid "The following command-line options are supported:"
4697 #: doc/guix.texi:1223
4699 msgid "--build-users-group=@var{group}"
4703 #: doc/guix.texi:1226
4705 "Take users from @var{group} to run build processes (@pxref{Setting Up the "
4706 "Daemon, build users})."
4708 "Prend les utilisateurs de @var{group} pour lancer les processus de "
4709 "construction (@pxref{Paramétrer le démon, utilisateurs de construction})."
4712 #: doc/guix.texi:1227 doc/guix.texi:5498
4714 msgid "--no-substitutes"
4718 #: doc/guix.texi:1228 doc/guix.texi:1744 doc/guix.texi:2248
4724 #: doc/guix.texi:1232 doc/guix.texi:5502
4726 "Do not use substitutes for build products. That is, always build things "
4727 "locally instead of allowing downloads of pre-built binaries "
4728 "(@pxref{Substitutes})."
4730 "Ne pas utiliser de substitut pour les résultats de la construction. C'est-à-"
4731 "dire, toujours construire localement plutôt que de permettre le "
4732 "téléchargement de binaires pré-construits (@pxref{Substituts})."
4735 #: doc/guix.texi:1236
4737 "When the daemon runs with @code{--no-substitutes}, clients can still "
4738 "explicitly enable substitution @i{via} the @code{set-build-options} remote "
4739 "procedure call (@pxref{The Store})."
4743 #: doc/guix.texi:1237 doc/guix.texi:5485 doc/guix.texi:6897 doc/guix.texi:7773
4744 #: doc/guix.texi:7961
4746 msgid "--substitute-urls=@var{urls}"
4750 #: doc/guix.texi:1243
4751 msgid "daemon-substitute-urls"
4755 #: doc/guix.texi:1243
4757 "Consider @var{urls} the default whitespace-separated list of substitute "
4758 "source URLs. When this option is omitted, @indicateurl{https://mirror.hydra."
4759 "gnu.org https://hydra.gnu.org} is used (@code{mirror.hydra.gnu.org} is a "
4760 "mirror of @code{hydra.gnu.org})."
4764 #: doc/guix.texi:1246
4766 "This means that substitutes may be downloaded from @var{urls}, as long as "
4767 "they are signed by a trusted signature (@pxref{Substitutes})."
4769 "Cela signifie que les substituts sont téléchargés depuis les @var{urls}, "
4770 "tant qu'ils sont signés par une signature de confiance (@pxref{Substituts})."
4773 #: doc/guix.texi:1248 doc/guix.texi:5523
4775 msgid "--no-build-hook"
4779 #: doc/guix.texi:1250
4780 msgid "Do not use the @dfn{build hook}."
4784 #: doc/guix.texi:1254
4786 "The build hook is a helper program that the daemon can start and to which it "
4787 "submits build requests. This mechanism is used to offload builds to other "
4788 "machines (@pxref{Daemon Offload Setup})."
4792 #: doc/guix.texi:1255
4794 msgid "--cache-failures"
4798 #: doc/guix.texi:1257
4799 msgid "Cache build failures. By default, only successful builds are cached."
4803 #: doc/guix.texi:1262
4805 "When this option is used, @command{guix gc --list-failures} can be used to "
4806 "query the set of store items marked as failed; @command{guix gc --clear-"
4807 "failures} removes store items from the set of cached failures. "
4808 "@xref{Invoking guix gc}."
4812 #: doc/guix.texi:1263 doc/guix.texi:5547
4814 msgid "--cores=@var{n}"
4818 #: doc/guix.texi:1264 doc/guix.texi:5548
4824 #: doc/guix.texi:1267
4826 "Use @var{n} CPU cores to build each derivation; @code{0} means as many as "
4831 #: doc/guix.texi:1271
4833 "The default value is @code{0}, but it may be overridden by clients, such as "
4834 "the @code{--cores} option of @command{guix build} (@pxref{Invoking guix "
4839 #: doc/guix.texi:1275
4841 "The effect is to define the @code{NIX_BUILD_CORES} environment variable in "
4842 "the build process, which can then use it to exploit internal parallelism---"
4843 "for instance, by running @code{make -j$NIX_BUILD_CORES}."
4847 #: doc/guix.texi:1276 doc/guix.texi:5552
4849 msgid "--max-jobs=@var{n}"
4853 #: doc/guix.texi:1277 doc/guix.texi:5553
4859 #: doc/guix.texi:1282
4861 "Allow at most @var{n} build jobs in parallel. The default value is "
4862 "@code{1}. Setting it to @code{0} means that no builds will be performed "
4863 "locally; instead, the daemon will offload builds (@pxref{Daemon Offload "
4864 "Setup}), or simply fail."
4868 #: doc/guix.texi:1283 doc/guix.texi:5528
4870 msgid "--max-silent-time=@var{seconds}"
4874 #: doc/guix.texi:1286 doc/guix.texi:5531
4876 "When the build or substitution process remains silent for more than "
4877 "@var{seconds}, terminate it and report a build failure."
4881 #: doc/guix.texi:1288 doc/guix.texi:1297
4882 msgid "The default value is @code{0}, which disables the timeout."
4886 #: doc/guix.texi:1291
4888 "The value specified here can be overridden by clients (@pxref{Common Build "
4889 "Options, @code{--max-silent-time}})."
4893 #: doc/guix.texi:1292 doc/guix.texi:5535
4895 msgid "--timeout=@var{seconds}"
4899 #: doc/guix.texi:1295 doc/guix.texi:5538
4901 "Likewise, when the build or substitution process lasts for more than "
4902 "@var{seconds}, terminate it and report a build failure."
4906 #: doc/guix.texi:1300
4908 "The value specified here can be overridden by clients (@pxref{Common Build "
4909 "Options, @code{--timeout}})."
4913 #: doc/guix.texi:1301
4915 msgid "--rounds=@var{N}"
4919 #: doc/guix.texi:1306
4921 "Build each derivation @var{n} times in a row, and raise an error if "
4922 "consecutive build results are not bit-for-bit identical. Note that this "
4923 "setting can be overridden by clients such as @command{guix build} "
4924 "(@pxref{Invoking guix build})."
4928 #: doc/guix.texi:1310 doc/guix.texi:5830
4930 "When used in conjunction with @option{--keep-failed}, the differing output "
4931 "is kept in the store, under @file{/gnu/store/@dots{}-check}. This makes it "
4932 "easy to look for differences between the two results."
4936 #: doc/guix.texi:1311
4942 #: doc/guix.texi:1313
4943 msgid "Produce debugging output."
4947 #: doc/guix.texi:1317
4949 "This is useful to debug daemon start-up issues, but then it may be "
4950 "overridden by clients, for example the @code{--verbosity} option of "
4951 "@command{guix build} (@pxref{Invoking guix build})."
4955 #: doc/guix.texi:1318
4957 msgid "--chroot-directory=@var{dir}"
4961 #: doc/guix.texi:1320
4962 msgid "Add @var{dir} to the build chroot."
4966 #: doc/guix.texi:1326
4968 "Doing this may change the result of build processes---for instance if they "
4969 "use optional dependencies found in @var{dir} when it is available, and not "
4970 "otherwise. For that reason, it is not recommended to do so. Instead, make "
4971 "sure that each derivation declares all the inputs that it needs."
4975 #: doc/guix.texi:1327
4977 msgid "--disable-chroot"
4981 #: doc/guix.texi:1329
4982 msgid "Disable chroot builds."
4986 #: doc/guix.texi:1334
4988 "Using this option is not recommended since, again, it would allow build "
4989 "processes to gain access to undeclared dependencies. It is necessary, "
4990 "though, when @command{guix-daemon} is running under an unprivileged user "
4995 #: doc/guix.texi:1335
4997 msgid "--log-compression=@var{type}"
5001 #: doc/guix.texi:1338
5003 "Compress build logs according to @var{type}, one of @code{gzip}, "
5004 "@code{bzip2}, or @code{none}."
5008 #: doc/guix.texi:1342
5010 "Unless @code{--lose-logs} is used, all the build logs are kept in the "
5011 "@var{localstatedir}. To save space, the daemon automatically compresses "
5012 "them with bzip2 by default."
5016 #: doc/guix.texi:1343
5018 msgid "--disable-deduplication"
5022 #: doc/guix.texi:1344 doc/guix.texi:2708
5024 msgid "deduplication"
5028 #: doc/guix.texi:1346
5029 msgid "Disable automatic file ``deduplication'' in the store."
5033 #: doc/guix.texi:1353
5035 "By default, files added to the store are automatically ``deduplicated'': if "
5036 "a newly added file is identical to another one found in the store, the "
5037 "daemon makes the new file a hard link to the other file. This can "
5038 "noticeably reduce disk usage, at the expense of slightly increased input/"
5039 "output load at the end of a build process. This option disables this "
5044 #: doc/guix.texi:1354
5046 msgid "--gc-keep-outputs[=yes|no]"
5050 #: doc/guix.texi:1357
5052 "Tell whether the garbage collector (GC) must keep outputs of live "
5057 #: doc/guix.texi:1358 doc/guix.texi:2543
5063 #: doc/guix.texi:1359 doc/guix.texi:2544
5065 msgid "garbage collector roots"
5069 #: doc/guix.texi:1364
5071 "When set to ``yes'', the GC will keep the outputs of any live derivation "
5072 "available in the store---the @code{.drv} files. The default is ``no'', "
5073 "meaning that derivation outputs are kept only if they are GC roots. "
5074 "@xref{Invoking guix gc}, for more on GC roots."
5078 #: doc/guix.texi:1365
5080 msgid "--gc-keep-derivations[=yes|no]"
5084 #: doc/guix.texi:1368
5086 "Tell whether the garbage collector (GC) must keep derivations corresponding "
5091 #: doc/guix.texi:1373
5093 "When set to ``yes'', as is the case by default, the GC keeps derivations---i."
5094 "e., @code{.drv} files---as long as at least one of their outputs is live. "
5095 "This allows users to keep track of the origins of items in their store. "
5096 "Setting it to ``no'' saves a bit of disk space."
5100 #: doc/guix.texi:1380
5102 "Note that when both @code{--gc-keep-derivations} and @code{--gc-keep-"
5103 "outputs} are used, the effect is to keep all the build prerequisites (the "
5104 "sources, compiler, libraries, and other build-time tools) of live objects in "
5105 "the store, regardless of whether these prerequisites are live. This is "
5106 "convenient for developers since it saves rebuilds or downloads."
5110 #: doc/guix.texi:1381
5112 msgid "--impersonate-linux-2.6"
5116 #: doc/guix.texi:1384
5118 "On Linux-based systems, impersonate Linux 2.6. This means that the kernel's "
5119 "@code{uname} system call will report 2.6 as the release number."
5123 #: doc/guix.texi:1387
5125 "This might be helpful to build programs that (usually wrongfully) depend on "
5126 "the kernel version number."
5130 #: doc/guix.texi:1388
5136 #: doc/guix.texi:1391
5138 "Do not keep build logs. By default they are kept under "
5139 "@code{@var{localstatedir}/guix/log}."
5143 #: doc/guix.texi:1392 doc/guix.texi:2890 doc/guix.texi:5783 doc/guix.texi:6924
5144 #: doc/guix.texi:7332 doc/guix.texi:7966 doc/guix.texi:20048
5145 #: doc/guix.texi:20592
5147 msgid "--system=@var{system}"
5151 #: doc/guix.texi:1396
5153 "Assume @var{system} as the current system type. By default it is the "
5154 "architecture/kernel pair found at configure time, such as @code{x86_64-"
5159 #: doc/guix.texi:1397
5161 msgid "--listen=@var{endpoint}"
5165 #: doc/guix.texi:1402
5167 "Listen for connections on @var{endpoint}. @var{endpoint} is interpreted as "
5168 "the file name of a Unix-domain socket if it starts with @code{/} (slash "
5169 "sign). Otherwise, @var{endpoint} is interpreted as a host name or host name "
5170 "and port to listen to. Here are a few examples:"
5174 #: doc/guix.texi:1404
5176 msgid "--listen=/gnu/var/daemon"
5180 #: doc/guix.texi:1407
5182 "Listen for connections on the @file{/gnu/var/daemon} Unix-domain socket, "
5183 "creating it if needed."
5187 #: doc/guix.texi:1408
5189 msgid "--listen=localhost"
5193 #: doc/guix.texi:1409 doc/guix.texi:4235
5195 msgid "daemon, remote access"
5199 #: doc/guix.texi:1410 doc/guix.texi:4236
5201 msgid "remote access to the daemon"
5205 #: doc/guix.texi:1411 doc/guix.texi:4237
5207 msgid "daemon, cluster setup"
5211 #: doc/guix.texi:1412 doc/guix.texi:4238
5213 msgid "clusters, daemon setup"
5217 #: doc/guix.texi:1415
5219 "Listen for TCP connections on the network interface corresponding to "
5220 "@code{localhost}, on port 44146."
5224 #: doc/guix.texi:1416
5226 msgid "--listen=128.0.0.42:1234"
5230 #: doc/guix.texi:1419
5232 "Listen for TCP connections on the network interface corresponding to "
5233 "@code{128.0.0.42}, on port 1234."
5237 #: doc/guix.texi:1426
5239 "This option can be repeated multiple times, in which case @command{guix-"
5240 "daemon} accepts connections on all the specified endpoints. Users can tell "
5241 "client commands what endpoint to connect to by setting the "
5242 "@code{GUIX_DAEMON_SOCKET} environment variable (@pxref{The Store, "
5243 "@code{GUIX_DAEMON_SOCKET}})."
5247 #: doc/guix.texi:1427 doc/guix.texi:2325 doc/guix.texi:2789 doc/guix.texi:2952
5248 #: doc/guix.texi:4205 doc/guix.texi:4273 doc/guix.texi:5788 doc/guix.texi:7224
5249 #: doc/guix.texi:7851 doc/guix.texi:8069 doc/guix.texi:8280 doc/guix.texi:11491
5250 #: doc/guix.texi:20375 doc/guix.texi:20573 doc/guix.texi:20660
5251 #: doc/guix.texi:21504
5257 #: doc/guix.texi:1433
5259 "The daemon protocol is @emph{unauthenticated and unencrypted}. Using "
5260 "@code{--listen=@var{host}} is suitable on local networks, such as clusters, "
5261 "where only trusted nodes may connect to the build daemon. In other cases "
5262 "where remote access to the daemon is needed, we recommend using Unix-domain "
5263 "sockets along with SSH."
5267 #: doc/guix.texi:1438
5269 "When @code{--listen} is omitted, @command{guix-daemon} listens for "
5270 "connections on the Unix-domain socket located at @file{@var{localstatedir}/"
5271 "guix/daemon-socket/socket}."
5275 #: doc/guix.texi:1448
5277 "When using Guix on top of GNU/Linux distribution other than GuixSD---a so-"
5278 "called @dfn{foreign distro}---a few additional steps are needed to get "
5279 "everything in place. Here are some of them."
5283 #: doc/guix.texi:1452
5284 msgid "locales-and-locpath"
5288 #: doc/guix.texi:1452
5290 msgid "locales, when not on GuixSD"
5294 #: doc/guix.texi:1453 doc/guix.texi:9549
5300 #: doc/guix.texi:1454
5302 msgid "GUIX_LOCPATH"
5306 #: doc/guix.texi:1459
5308 "Packages installed @i{via} Guix will not use the locale data of the host "
5309 "system. Instead, you must first install one of the locale packages "
5310 "available with Guix and then define the @code{GUIX_LOCPATH} environment "
5315 #: doc/guix.texi:1463
5318 "$ guix package -i glibc-locales\n"
5319 "$ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale\n"
5323 #: doc/guix.texi:1469
5325 "Note that the @code{glibc-locales} package contains data for all the locales "
5326 "supported by the GNU@tie{}libc and weighs in at around 110@tie{}MiB. "
5327 "Alternatively, the @code{glibc-utf8-locales} is smaller but limited to a few "
5332 #: doc/guix.texi:1473
5334 "The @code{GUIX_LOCPATH} variable plays a role similar to @code{LOCPATH} "
5335 "(@pxref{Locale Names, @code{LOCPATH},, libc, The GNU C Library Reference "
5336 "Manual}). There are two important differences though:"
5340 #: doc/guix.texi:1480
5342 "@code{GUIX_LOCPATH} is honored only by the libc in Guix, and not by the libc "
5343 "provided by foreign distros. Thus, using @code{GUIX_LOCPATH} allows you to "
5344 "make sure the programs of the foreign distro will not end up loading "
5345 "incompatible locale data."
5349 #: doc/guix.texi:1487
5351 "libc suffixes each entry of @code{GUIX_LOCPATH} with @code{/X.Y}, where "
5352 "@code{X.Y} is the libc version---e.g., @code{2.22}. This means that, should "
5353 "your Guix profile contain a mixture of programs linked against different "
5354 "libc version, each libc version will only try to load locale data in the "
5359 #: doc/guix.texi:1491
5361 "This is important because the locale data format used by different libc "
5362 "versions may be incompatible."
5366 #: doc/guix.texi:1494
5368 msgid "name service switch, glibc"
5372 #: doc/guix.texi:1495
5374 msgid "NSS (name service switch), glibc"
5378 #: doc/guix.texi:1496
5380 msgid "nscd (name service caching daemon)"
5384 #: doc/guix.texi:1497
5386 msgid "name service caching daemon (nscd)"
5390 #: doc/guix.texi:1504
5392 "When using Guix on a foreign distro, we @emph{strongly recommend} that the "
5393 "system run the GNU C library's @dfn{name service cache daemon}, "
5394 "@command{nscd}, which should be listening on the @file{/var/run/nscd/socket} "
5395 "socket. Failing to do that, applications installed with Guix may fail to "
5396 "look up host names or user accounts, or may even crash. The next paragraphs "
5401 #: doc/guix.texi:1505
5403 msgid "nsswitch.conf"
5407 #: doc/guix.texi:1510
5409 "The GNU C library implements a @dfn{name service switch} (NSS), which is an "
5410 "extensible mechanism for ``name lookups'' in general: host name resolution, "
5411 "user accounts, and more (@pxref{Name Service Switch,,, libc, The GNU C "
5412 "Library Reference Manual})."
5416 #: doc/guix.texi:1511
5418 msgid "Network information service (NIS)"
5422 #: doc/guix.texi:1512
5424 msgid "NIS (Network information service)"
5428 #: doc/guix.texi:1521
5430 "Being extensible, the NSS supports @dfn{plugins}, which provide new name "
5431 "lookup implementations: for example, the @code{nss-mdns} plugin allow "
5432 "resolution of @code{.local} host names, the @code{nis} plugin allows user "
5433 "account lookup using the Network information service (NIS), and so on. "
5434 "These extra ``lookup services'' are configured system-wide in @file{/etc/"
5435 "nsswitch.conf}, and all the programs running on the system honor those "
5436 "settings (@pxref{NSS Configuration File,,, libc, The GNU C Reference "
5441 #: doc/guix.texi:1531
5443 "When they perform a name lookup---for instance by calling the "
5444 "@code{getaddrinfo} function in C---applications first try to connect to the "
5445 "nscd; on success, nscd performs name lookups on their behalf. If the nscd "
5446 "is not running, then they perform the name lookup by themselves, by loading "
5447 "the name lookup services into their own address space and running it. These "
5448 "name lookup services---the @file{libnss_*.so} files---are @code{dlopen}'d, "
5449 "but they may come from the host system's C library, rather than from the C "
5450 "library the application is linked against (the C library coming from Guix)."
5454 #: doc/guix.texi:1536
5456 "And this is where the problem is: if your application is linked against "
5457 "Guix's C library (say, glibc 2.24) and tries to load NSS plugins from "
5458 "another C library (say, @code{libnss_mdns.so} for glibc 2.22), it will "
5459 "likely crash or have its name lookups fail unexpectedly."
5463 #: doc/guix.texi:1541
5465 "Running @command{nscd} on the system, among other advantages, eliminates "
5466 "this binary incompatibility problem because those @code{libnss_*.so} files "
5467 "are loaded in the @command{nscd} process, not in applications themselves."
5471 #: doc/guix.texi:1542
5477 #: doc/guix.texi:1544 doc/guix.texi:22070
5483 #: doc/guix.texi:1552
5485 "The majority of graphical applications use Fontconfig to locate and load "
5486 "fonts and perform X11-client-side rendering. The @code{fontconfig} package "
5487 "in Guix looks for fonts in @file{$HOME/.guix-profile} by default. Thus, to "
5488 "allow graphical applications installed with Guix to display fonts, you have "
5489 "to install fonts with Guix as well. Essential font packages include "
5490 "@code{gs-fonts}, @code{font-dejavu}, and @code{font-gnu-freefont-ttf}."
5494 #: doc/guix.texi:1559
5496 "To display text written in Chinese languages, Japanese, or Korean in "
5497 "graphical applications, consider installing @code{font-adobe-source-han-"
5498 "sans} or @code{font-wqy-zenhei}. The former has multiple outputs, one per "
5499 "language family (@pxref{Packages with Multiple Outputs}). For instance, the "
5500 "following command installs fonts for Chinese languages:"
5504 #: doc/guix.texi:1562
5506 msgid "guix package -i font-adobe-source-han-sans:cn\n"
5510 #: doc/guix.texi:1564
5516 #: doc/guix.texi:1568
5518 "Older programs such as @command{xterm} do not use Fontconfig and instead "
5519 "rely on server-side font rendering. Such programs require to specify a full "
5520 "name of a font using XLFD (X Logical Font Description), like this:"
5524 #: doc/guix.texi:1571
5526 msgid "-*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1\n"
5530 #: doc/guix.texi:1575
5532 "To be able to use such full names for the TrueType fonts installed in your "
5533 "Guix profile, you need to extend the font path of the X server:"
5537 #: doc/guix.texi:1580
5539 msgid "xset +fp $(dirname $(readlink -f ~/.guix-profile/share/fonts/truetype/fonts.dir))\n"
5543 #: doc/guix.texi:1582
5549 #: doc/guix.texi:1585
5551 "After that, you can run @code{xlsfonts} (from @code{xlsfonts} package) to "
5552 "make sure your TrueType fonts are listed there."
5556 #: doc/guix.texi:1586
5562 #: doc/guix.texi:1587
5568 #: doc/guix.texi:1593
5570 "After installing fonts you may have to refresh the font cache to use them in "
5571 "applications. The same applies when applications installed via Guix do not "
5572 "seem to find fonts. To force rebuilding of the font cache run @code{fc-"
5573 "cache -f}. The @code{fc-cache} command is provided by the @code{fontconfig} "
5578 #: doc/guix.texi:1596 doc/guix.texi:19787
5584 #: doc/guix.texi:1599
5586 "The @code{nss-certs} package provides X.509 certificates, which allow "
5587 "programs to authenticate Web servers accessed over HTTPS."
5591 #: doc/guix.texi:1604
5593 "When using Guix on a foreign distro, you can install this package and define "
5594 "the relevant environment variables so that packages know where to look for "
5595 "certificates. @xref{X.509 Certificates}, for detailed information."
5599 #: doc/guix.texi:1605
5601 msgid "Emacs Packages"
5605 #: doc/guix.texi:1607
5611 #: doc/guix.texi:1618
5613 "When you install Emacs packages with Guix, the elisp files may be placed "
5614 "either in @file{$HOME/.guix-profile/share/emacs/site-lisp/} or in sub-"
5615 "directories of @file{$HOME/.guix-profile/share/emacs/site-lisp/guix.d/}. "
5616 "The latter directory exists because potentially there may exist thousands of "
5617 "Emacs packages and storing all their files in a single directory may not be "
5618 "reliable (because of name conflicts). So we think using a separate "
5619 "directory for each package is a good idea. It is very similar to how the "
5620 "Emacs package system organizes the file structure (@pxref{Package Files,,, "
5621 "emacs, The GNU Emacs Manual})."
5625 #: doc/guix.texi:1624
5627 "By default, Emacs (installed with Guix) ``knows'' where these packages are "
5628 "placed, so you do not need to perform any configuration. If, for some "
5629 "reason, you want to avoid auto-loading Emacs packages installed with Guix, "
5630 "you can do so by running Emacs with @code{--no-site-file} option "
5631 "(@pxref{Init File,,, emacs, The GNU Emacs Manual})."
5635 #: doc/guix.texi:1625
5637 msgid "The GCC toolchain"
5641 #: doc/guix.texi:1627
5647 #: doc/guix.texi:1628
5653 #: doc/guix.texi:1637
5655 "Guix offers individual compiler packages such as @code{gcc} but if you are "
5656 "in need of a complete toolchain for compiling and linking source code what "
5657 "you really want is the @code{gcc-toolchain} package. This package provides "
5658 "a complete GCC toolchain for C/C++ development, including GCC itself, the "
5659 "GNU C Library (headers and binaries, plus debugging symbols in the "
5660 "@code{debug} output), Binutils, and a linker wrapper."
5664 #: doc/guix.texi:1638
5666 msgid "attempt to use impure library, error message"
5670 #: doc/guix.texi:1648
5672 "The wrapper's purpose is to inspect the @code{-L} and @code{-l} switches "
5673 "passed to the linker, add corresponding @code{-rpath} arguments, and invoke "
5674 "the actual linker with this new set of arguments. By default, the linker "
5675 "wrapper refuses to link to libraries outside the store to ensure "
5676 "``purity''. This can be annoying when using the toolchain to link with "
5677 "local libraries. To allow references to libraries outside the store you "
5678 "need to define the environment variable "
5679 "@code{GUIX_LD_WRAPPER_ALLOW_IMPURITIES}."
5683 #: doc/guix.texi:1655
5689 #: doc/guix.texi:1660
5691 "The purpose of GNU Guix is to allow users to easily install, upgrade, and "
5692 "remove software packages, without having to know about their build "
5693 "procedures or dependencies. Guix also goes beyond this obvious set of "
5698 #: doc/guix.texi:1668
5700 "This chapter describes the main features of Guix, as well as the package "
5701 "management tools it provides. Along with the command-line interface "
5702 "described below (@pxref{Invoking guix package, @code{guix package}}), you "
5703 "may also use the Emacs-Guix interface (@pxref{Top,,, emacs-guix, The Emacs-"
5704 "Guix Reference Manual}), after installing @code{emacs-guix} package (run "
5705 "@kbd{M-x guix-help} command to start with it):"
5707 "Ce chapitre décrit les principales fonctionnalités de Guix, ainsi que des "
5708 "outils de gestion des paquets qu'il fournit. En plus de l'interface en ligne "
5709 "de commande décrite en dessous de (@pxref{Invoquer guix package, @code{guix "
5710 "package}}), vous pouvez aussi utiliser l'interface Emacs-Guix (@pxref{Top,,, "
5711 "emacs-guix, Le manuel de référence de emacs-guix}), après avoir installé le "
5712 "paquet @code{emacs-guix} (lancez la commande @kbd{M-x guix-help} pour le "
5716 #: doc/guix.texi:1671
5718 msgid "guix package -i emacs-guix\n"
5719 msgstr "guix package -i emacs-guix\n"
5722 #: doc/guix.texi:1690
5724 "When using Guix, each package ends up in the @dfn{package store}, in its own "
5725 "directory---something that resembles @file{/gnu/store/xxx-package-1.2}, "
5726 "where @code{xxx} is a base32 string."
5730 #: doc/guix.texi:1695
5732 "Instead of referring to these directories, users have their own "
5733 "@dfn{profile}, which points to the packages that they actually want to use. "
5734 "These profiles are stored within each user's home directory, at @code{$HOME/."
5739 #: doc/guix.texi:1703
5741 "For example, @code{alice} installs GCC 4.7.2. As a result, @file{/home/"
5742 "alice/.guix-profile/bin/gcc} points to @file{/gnu/store/@dots{}-gcc-4.7.2/"
5743 "bin/gcc}. Now, on the same machine, @code{bob} had already installed GCC "
5744 "4.8.0. The profile of @code{bob} simply continues to point to @file{/gnu/"
5745 "store/@dots{}-gcc-4.8.0/bin/gcc}---i.e., both versions of GCC coexist on the "
5746 "same system without any interference."
5750 #: doc/guix.texi:1707
5752 "The @command{guix package} command is the central tool to manage packages "
5753 "(@pxref{Invoking guix package}). It operates on the per-user profiles, and "
5754 "can be used @emph{with normal user privileges}."
5758 #: doc/guix.texi:1708 doc/guix.texi:1777
5760 msgid "transactions"
5764 #: doc/guix.texi:1715
5766 "The command provides the obvious install, remove, and upgrade operations. "
5767 "Each invocation is actually a @emph{transaction}: either the specified "
5768 "operation succeeds, or nothing happens. Thus, if the @command{guix package} "
5769 "process is terminated during the transaction, or if a power outage occurs "
5770 "during the transaction, then the user's profile remains in its previous "
5771 "state, and remains usable."
5775 #: doc/guix.texi:1723
5777 "In addition, any package transaction may be @emph{rolled back}. So, if, for "
5778 "example, an upgrade installs a new version of a package that turns out to "
5779 "have a serious bug, users may roll back to the previous instance of their "
5780 "profile, which was known to work well. Similarly, the global system "
5781 "configuration on GuixSD is subject to transactional upgrades and roll-back "
5782 "(@pxref{Using the Configuration System})."
5786 #: doc/guix.texi:1730
5788 "All packages in the package store may be @emph{garbage-collected}. Guix can "
5789 "determine which packages are still referenced by user profiles, and remove "
5790 "those that are provably no longer referenced (@pxref{Invoking guix gc}). "
5791 "Users may also explicitly remove old generations of their profile so that "
5792 "the packages they refer to can be collected."
5796 #: doc/guix.texi:1731
5798 msgid "reproducibility"
5802 #: doc/guix.texi:1743
5804 "Finally, Guix takes a @dfn{purely functional} approach to package "
5805 "management, as described in the introduction (@pxref{Introduction}). Each "
5806 "@file{/gnu/store} package directory name contains a hash of all the inputs "
5807 "that were used to build that package---compiler, libraries, build scripts, "
5808 "etc. This direct correspondence allows users to make sure a given package "
5809 "installation matches the current state of their distribution. It also helps "
5810 "maximize @dfn{build reproducibility}: thanks to the isolated build "
5811 "environments that are used, a given build is likely to yield bit-identical "
5812 "files when performed on different machines (@pxref{Invoking guix-daemon, "
5817 #: doc/guix.texi:1754
5819 "This foundation allows Guix to support @dfn{transparent binary/source "
5820 "deployment}. When a pre-built binary for a @file{/gnu/store} item is "
5821 "available from an external source---a @dfn{substitute}, Guix just downloads "
5822 "it and unpacks it; otherwise, it builds the package from source, locally "
5823 "(@pxref{Substitutes}). Because build results are usually bit-for-bit "
5824 "reproducible, users do not have to trust servers that provide substitutes: "
5825 "they can force a local build and @emph{challenge} providers (@pxref{Invoking "
5828 "Ce fondement permet à Guix de supporter le @dfn{déploiement transparent de "
5829 "binaire ou source}. Lorsqu'une binaire pré-construit pour une entrée de "
5830 "@file{/gnu/store} est disponible depuis une source externe (un "
5831 "@dfn{substitut}), Guix le télécharge simplement et le décompresse ; sinon, "
5832 "il construit le paquet depuis les sources localement (@pxref{Substituts}). "
5833 "Comme les résultats des constructions sont généralement reproductibles au "
5834 "bit près, si vous n'avez pas besoin de faire confiance aux serveurs qui "
5835 "fournissent les substituts : vous pouvez forcer une construction locale et "
5836 "@emph{défier} les fournisseurs (@pxref{Invoking guix challenge})."
5839 #: doc/guix.texi:1760
5841 "Control over the build environment is a feature that is also useful for "
5842 "developers. The @command{guix environment} command allows developers of a "
5843 "package to quickly set up the right development environment for their "
5844 "package, without having to manually install the dependencies of the package "
5845 "into their profile (@pxref{Invoking guix environment})."
5849 #: doc/guix.texi:1762
5851 msgid "Invoking @command{guix package}"
5855 #: doc/guix.texi:1764
5857 msgid "installing packages"
5861 #: doc/guix.texi:1765
5863 msgid "removing packages"
5867 #: doc/guix.texi:1766
5869 msgid "package installation"
5873 #: doc/guix.texi:1767
5875 msgid "package removal"
5879 #: doc/guix.texi:1773
5881 "The @command{guix package} command is the tool that allows users to install, "
5882 "upgrade, and remove packages, as well as rolling back to previous "
5883 "configurations. It operates only on the user's own profile, and works with "
5884 "normal user privileges (@pxref{Features}). Its syntax is:"
5886 "La commande @command{guix package} est l'outil qui permet d'installer, "
5887 "mettre à jour et supprimer les paquets ainsi que de revenir à une "
5888 "configuration précédente. Elle n'opère que dans le profil de l'utilisateur "
5889 "et fonctionne avec les privilèges utilisateurs normaux "
5890 "(@pxref{Fonctionnalités}). Sa syntaxe est :"
5893 #: doc/guix.texi:1776
5895 msgid "guix package @var{options}\n"
5899 #: doc/guix.texi:1782
5901 "Primarily, @var{options} specifies the operations to be performed during the "
5902 "transaction. Upon completion, a new profile is created, but previous "
5903 "@dfn{generations} of the profile remain available, should the user want to "
5908 #: doc/guix.texi:1785
5910 "For example, to remove @code{lua} and install @code{guile} and @code{guile-"
5911 "cairo} in a single transaction:"
5915 #: doc/guix.texi:1788
5917 msgid "guix package -r lua -i guile guile-cairo\n"
5921 #: doc/guix.texi:1794
5923 "@command{guix package} also supports a @dfn{declarative approach} whereby "
5924 "the user specifies the exact set of packages to be available and passes it "
5925 "@i{via} the @option{--manifest} option (@pxref{profile-manifest, @option{--"
5930 #: doc/guix.texi:1795
5936 #: doc/guix.texi:1801
5938 "For each user, a symlink to the user's default profile is automatically "
5939 "created in @file{$HOME/.guix-profile}. This symlink always points to the "
5940 "current generation of the user's default profile. Thus, users can add "
5941 "@file{$HOME/.guix-profile/bin} to their @code{PATH} environment variable, "
5946 #: doc/guix.texi:1801 doc/guix.texi:1998
5948 msgid "search paths"
5952 #: doc/guix.texi:1806
5954 "If you are not using the Guix System Distribution, consider adding the "
5955 "following lines to your @file{~/.bash_profile} (@pxref{Bash Startup Files,,, "
5956 "bash, The GNU Bash Reference Manual}) so that newly-spawned shells get all "
5957 "the right environment variable definitions:"
5961 #: doc/guix.texi:1810
5964 "GUIX_PROFILE=\"$HOME/.guix-profile\" ; \\\n"
5965 "source \"$HOME/.guix-profile/etc/profile\"\n"
5969 #: doc/guix.texi:1821
5971 "In a multi-user setup, user profiles are stored in a place registered as a "
5972 "@dfn{garbage-collector root}, which @file{$HOME/.guix-profile} points to "
5973 "(@pxref{Invoking guix gc}). That directory is normally "
5974 "@code{@var{localstatedir}/guix/profiles/per-user/@var{user}}, where "
5975 "@var{localstatedir} is the value passed to @code{configure} as @code{--"
5976 "localstatedir}, and @var{user} is the user name. The @file{per-user} "
5977 "directory is created when @command{guix-daemon} is started, and the "
5978 "@var{user} sub-directory is created by @command{guix package}."
5982 #: doc/guix.texi:1823
5983 msgid "The @var{options} can be among the following:"
5987 #: doc/guix.texi:1826
5989 msgid "--install=@var{package} @dots{}"
5993 #: doc/guix.texi:1827
5995 msgid "-i @var{package} @dots{}"
5999 #: doc/guix.texi:1829
6000 msgid "Install the specified @var{package}s."
6004 #: doc/guix.texi:1834
6006 "Each @var{package} may specify either a simple package name, such as "
6007 "@code{guile}, or a package name followed by an at-sign and version number, "
6008 "such as @code{guile@@1.8.8} or simply @code{guile@@1.8} (in the latter case, "
6009 "the newest version prefixed by @code{1.8} is selected.)"
6013 #: doc/guix.texi:1842
6015 "If no version number is specified, the newest available version will be "
6016 "selected. In addition, @var{package} may contain a colon, followed by the "
6017 "name of one of the outputs of the package, as in @code{gcc:doc} or "
6018 "@code{binutils@@2.22:lib} (@pxref{Packages with Multiple Outputs}). "
6019 "Packages with a corresponding name (and optionally version) are searched for "
6020 "among the GNU distribution modules (@pxref{Package Modules})."
6024 #: doc/guix.texi:1843
6026 msgid "propagated inputs"
6030 #: doc/guix.texi:1849
6032 "Sometimes packages have @dfn{propagated inputs}: these are dependencies that "
6033 "automatically get installed along with the required package (@pxref{package-"
6034 "propagated-inputs, @code{propagated-inputs} in @code{package} objects}, for "
6035 "information about propagated inputs in package definitions)."
6039 #: doc/guix.texi:1856
6040 msgid "package-cmd-propagated-inputs"
6044 #: doc/guix.texi:1856
6046 "An example is the GNU MPC library: its C header files refer to those of the "
6047 "GNU MPFR library, which in turn refer to those of the GMP library. Thus, "
6048 "when installing MPC, the MPFR and GMP libraries also get installed in the "
6049 "profile; removing MPC also removes MPFR and GMP---unless they had also been "
6050 "explicitly installed by the user."
6054 #: doc/guix.texi:1861
6056 "Besides, packages sometimes rely on the definition of environment variables "
6057 "for their search paths (see explanation of @code{--search-paths} below). "
6058 "Any missing or possibly incorrect environment variable definitions are "
6063 #: doc/guix.texi:1862
6065 msgid "--install-from-expression=@var{exp}"
6069 #: doc/guix.texi:1863
6071 msgid "-e @var{exp}"
6075 #: doc/guix.texi:1865
6076 msgid "Install the package @var{exp} evaluates to."
6080 #: doc/guix.texi:1870
6082 "@var{exp} must be a Scheme expression that evaluates to a @code{<package>} "
6083 "object. This option is notably useful to disambiguate between same-named "
6084 "variants of a package, with expressions such as @code{(@@ (gnu packages "
6085 "base) guile-final)}."
6089 #: doc/guix.texi:1874
6091 "Note that this option installs the first output of the specified package, "
6092 "which may be insufficient when needing a specific output of a multiple-"
6097 #: doc/guix.texi:1875
6099 msgid "--install-from-file=@var{file}"
6103 #: doc/guix.texi:1876 doc/guix.texi:5699
6105 msgid "-f @var{file}"
6109 #: doc/guix.texi:1878
6110 msgid "Install the package that the code within @var{file} evaluates to."
6114 #: doc/guix.texi:1881 doc/guix.texi:7283
6116 "As an example, @var{file} might contain a definition like this "
6117 "(@pxref{Defining Packages}):"
6121 #: doc/guix.texi:1884 doc/guix.texi:5709
6123 msgid "@verbatiminclude package-hello.scm\n"
6127 #: doc/guix.texi:1890
6129 "Developers may find it useful to include such a @file{guix.scm} file in the "
6130 "root of their project source tree that can be used to test development "
6131 "snapshots and create reproducible development environments (@pxref{Invoking "
6132 "guix environment})."
6136 #: doc/guix.texi:1891
6138 msgid "--remove=@var{package} @dots{}"
6142 #: doc/guix.texi:1892
6144 msgid "-r @var{package} @dots{}"
6148 #: doc/guix.texi:1894
6149 msgid "Remove the specified @var{package}s."
6153 #: doc/guix.texi:1899
6155 "As for @code{--install}, each @var{package} may specify a version number and/"
6156 "or output name in addition to the package name. For instance, @code{-r "
6157 "glibc:debug} would remove the @code{debug} output of @code{glibc}."
6161 #: doc/guix.texi:1900
6163 msgid "--upgrade[=@var{regexp} @dots{}]"
6167 #: doc/guix.texi:1901
6169 msgid "-u [@var{regexp} @dots{}]"
6173 #: doc/guix.texi:1902
6175 msgid "upgrading packages"
6179 #: doc/guix.texi:1906
6181 "Upgrade all the installed packages. If one or more @var{regexp}s are "
6182 "specified, upgrade only installed packages whose name matches a "
6183 "@var{regexp}. Also see the @code{--do-not-upgrade} option below."
6187 #: doc/guix.texi:1911
6189 "Note that this upgrades package to the latest version of packages found in "
6190 "the distribution currently installed. To update your distribution, you "
6191 "should regularly run @command{guix pull} (@pxref{Invoking guix pull})."
6195 #: doc/guix.texi:1912
6197 msgid "--do-not-upgrade[=@var{regexp} @dots{}]"
6201 #: doc/guix.texi:1917
6203 "When used together with the @code{--upgrade} option, do @emph{not} upgrade "
6204 "any packages whose name matches a @var{regexp}. For example, to upgrade all "
6205 "packages in the current profile except those containing the substring "
6210 #: doc/guix.texi:1920
6212 msgid "$ guix package --upgrade . --do-not-upgrade emacs\n"
6216 #: doc/guix.texi:1922
6218 msgid "profile-manifest"
6222 #: doc/guix.texi:1922 doc/guix.texi:2877 doc/guix.texi:6577 doc/guix.texi:7288
6223 #: doc/guix.texi:7972
6225 msgid "--manifest=@var{file}"
6229 #: doc/guix.texi:1923 doc/guix.texi:2878 doc/guix.texi:6578 doc/guix.texi:7289
6231 msgid "-m @var{file}"
6235 #: doc/guix.texi:1924
6237 msgid "profile declaration"
6241 #: doc/guix.texi:1925
6243 msgid "profile manifest"
6247 #: doc/guix.texi:1928
6249 "Create a new generation of the profile from the manifest object returned by "
6250 "the Scheme code in @var{file}."
6254 #: doc/guix.texi:1934
6256 "This allows you to @emph{declare} the profile's contents rather than "
6257 "constructing it through a sequence of @code{--install} and similar "
6258 "commands. The advantage is that @var{file} can be put under version "
6259 "control, copied to different machines to reproduce the same profile, and so "
6264 #: doc/guix.texi:1938
6266 "@var{file} must return a @dfn{manifest} object, which is roughly a list of "
6271 #: doc/guix.texi:1939
6273 msgid "packages->manifest"
6277 #: doc/guix.texi:1942
6280 "(use-package-modules guile emacs)\n"
6285 #: doc/guix.texi:1948
6288 "(packages->manifest\n"
6291 " ;; Use a specific package output.\n"
6292 " (list guile-2.0 \"debug\")))\n"
6296 #: doc/guix.texi:1950
6298 msgid "specifications->manifest"
6302 #: doc/guix.texi:1957
6304 "In this example we have to know which modules define the @code{emacs} and "
6305 "@code{guile-2.0} variables to provide the right @code{use-package-modules} "
6306 "line, which can be cumbersome. We can instead provide regular package "
6307 "specifications and let @code{specifications->manifest} look up the "
6308 "corresponding package objects, like this:"
6312 #: doc/guix.texi:1961
6315 "(specifications->manifest\n"
6316 " '(\"emacs\" \"guile@@2.2\" \"guile@@2.2:debug\"))\n"
6320 #: doc/guix.texi:1963
6326 #: doc/guix.texi:1964 doc/guix.texi:20427
6328 msgid "rolling back"
6332 #: doc/guix.texi:1965
6334 msgid "undoing transactions"
6338 #: doc/guix.texi:1966
6340 msgid "transactions, undoing"
6344 #: doc/guix.texi:1969
6346 "Roll back to the previous @dfn{generation} of the profile---i.e., undo the "
6351 #: doc/guix.texi:1972
6353 "When combined with options such as @code{--install}, roll back occurs before "
6354 "any other actions."
6358 #: doc/guix.texi:1976
6360 "When rolling back from the first generation that actually contains installed "
6361 "packages, the profile is made to point to the @dfn{zeroth generation}, which "
6362 "contains no files apart from its own metadata."
6366 #: doc/guix.texi:1980
6368 "After having rolled back, installing, removing, or upgrading packages "
6369 "overwrites previous future generations. Thus, the history of the "
6370 "generations in a profile is always linear."
6374 #: doc/guix.texi:1981
6376 msgid "--switch-generation=@var{pattern}"
6380 #: doc/guix.texi:1982
6382 msgid "-S @var{pattern}"
6386 #: doc/guix.texi:1983 doc/guix.texi:2181 doc/guix.texi:20385
6392 #: doc/guix.texi:1985
6393 msgid "Switch to a particular generation defined by @var{pattern}."
6397 #: doc/guix.texi:1991
6399 "@var{pattern} may be either a generation number or a number prefixed with ``"
6400 "+'' or ``-''. The latter means: move forward/backward by a specified number "
6401 "of generations. For example, if you want to return to the latest generation "
6402 "after @code{--roll-back}, use @code{--switch-generation=+1}."
6406 #: doc/guix.texi:1996
6408 "The difference between @code{--roll-back} and @code{--switch-generation=-1} "
6409 "is that @code{--switch-generation} will not make a zeroth generation, so if "
6410 "a specified generation does not exist, the current generation will not be "
6415 #: doc/guix.texi:1997
6417 msgid "--search-paths[=@var{kind}]"
6421 #: doc/guix.texi:2003
6423 "Report environment variable definitions, in Bash syntax, that may be needed "
6424 "in order to use the set of installed packages. These environment variables "
6425 "are used to specify @dfn{search paths} for files used by some of the "
6426 "installed packages."
6430 #: doc/guix.texi:2011
6432 "For example, GCC needs the @code{CPATH} and @code{LIBRARY_PATH} environment "
6433 "variables to be defined so it can look for headers and libraries in the "
6434 "user's profile (@pxref{Environment Variables,,, gcc, Using the GNU Compiler "
6435 "Collection (GCC)}). If GCC and, say, the C library are installed in the "
6436 "profile, then @code{--search-paths} will suggest setting these variables to "
6437 "@code{@var{profile}/include} and @code{@var{profile}/lib}, respectively."
6441 #: doc/guix.texi:2014
6443 "The typical use case is to define these environment variables in the shell:"
6447 #: doc/guix.texi:2017
6449 msgid "$ eval `guix package --search-paths`\n"
6453 #: doc/guix.texi:2023
6455 "@var{kind} may be one of @code{exact}, @code{prefix}, or @code{suffix}, "
6456 "meaning that the returned environment variable definitions will either be "
6457 "exact settings, or prefixes or suffixes of the current value of these "
6458 "variables. When omitted, @var{kind} defaults to @code{exact}."
6462 #: doc/guix.texi:2026
6464 "This option can also be used to compute the @emph{combined} search paths of "
6465 "several profiles. Consider this example:"
6469 #: doc/guix.texi:2031
6472 "$ guix package -p foo -i guile\n"
6473 "$ guix package -p bar -i guile-json\n"
6474 "$ guix package -p foo -p bar --search-paths\n"
6478 #: doc/guix.texi:2036
6480 "The last command above reports about the @code{GUILE_LOAD_PATH} variable, "
6481 "even though, taken individually, neither @file{foo} nor @file{bar} would "
6482 "lead to that recommendation."
6486 #: doc/guix.texi:2038
6488 msgid "--profile=@var{profile}"
6492 #: doc/guix.texi:2039
6494 msgid "-p @var{profile}"
6498 #: doc/guix.texi:2041
6499 msgid "Use @var{profile} instead of the user's default profile."
6503 #: doc/guix.texi:2042
6505 msgid "collisions, in a profile"
6509 #: doc/guix.texi:2043
6511 msgid "colliding packages in profiles"
6515 #: doc/guix.texi:2044
6517 msgid "profile collisions"
6521 #: doc/guix.texi:2045
6523 msgid "--allow-collisions"
6527 #: doc/guix.texi:2047
6528 msgid "Allow colliding packages in the new profile. Use at your own risk!"
6532 #: doc/guix.texi:2051
6534 "By default, @command{guix package} reports as an error @dfn{collisions} in "
6535 "the profile. Collisions happen when two or more different versions or "
6536 "variants of a given package end up in the profile."
6540 #: doc/guix.texi:2052 doc/guix.texi:2754 doc/guix.texi:7777
6546 #: doc/guix.texi:2055
6548 "Produce verbose output. In particular, emit the build log of the "
6549 "environment on the standard error port."
6553 #: doc/guix.texi:2056 doc/guix.texi:2773 doc/guix.texi:2931
6559 #: doc/guix.texi:2059
6561 "Use the bootstrap Guile to build the profile. This option is only useful to "
6562 "distribution developers."
6566 #: doc/guix.texi:2065
6568 "In addition to these actions, @command{guix package} supports the following "
6569 "options to query the current state of a profile, or the availability of "
6574 #: doc/guix.texi:2068
6576 msgid "--search=@var{regexp}"
6580 #: doc/guix.texi:2069
6582 msgid "-s @var{regexp}"
6586 #: doc/guix.texi:2070
6588 msgid "searching for packages"
6592 #: doc/guix.texi:2075
6594 "List the available packages whose name, synopsis, or description matches "
6595 "@var{regexp}, sorted by relevance. Print all the metadata of matching "
6596 "packages in @code{recutils} format (@pxref{Top, GNU recutils databases,, "
6597 "recutils, GNU recutils manual})."
6601 #: doc/guix.texi:2078
6603 "This allows specific fields to be extracted using the @command{recsel} "
6604 "command, for instance:"
6608 #: doc/guix.texi:2084
6611 "$ guix package -s malloc | recsel -p name,version,relevance\n"
6619 #: doc/guix.texi:2088
6629 #: doc/guix.texi:2092
6638 #: doc/guix.texi:2096
6640 "Similarly, to show the name of all the packages available under the terms of "
6641 "the GNU@tie{}LGPL version 3:"
6645 #: doc/guix.texi:2100
6648 "$ guix package -s \"\" | recsel -p name -e 'license ~ \"LGPL 3\"'\n"
6654 #: doc/guix.texi:2103
6662 #: doc/guix.texi:2108
6664 "It is also possible to refine search results using several @code{-s} flags. "
6665 "For example, the following command returns a list of board games:"
6669 #: doc/guix.texi:2113
6672 "$ guix package -s '\\<board\\>' -s game | recsel -p name\n"
6678 #: doc/guix.texi:2119
6680 "If we were to omit @code{-s game}, we would also get software packages that "
6681 "deal with printed circuit boards; removing the angle brackets around "
6682 "@code{board} would further add packages that have to do with keyboards."
6686 #: doc/guix.texi:2123
6688 "And now for a more elaborate example. The following command searches for "
6689 "cryptographic libraries, filters out Haskell, Perl, Python, and Ruby "
6690 "libraries, and prints the name and synopsis of the matching packages:"
6694 #: doc/guix.texi:2127
6697 "$ guix package -s crypto -s library | \\\n"
6698 " recsel -e '! (name ~ \"^(ghc|perl|python|ruby)\")' -p name,synopsis\n"
6702 #: doc/guix.texi:2132
6704 "@xref{Selection Expressions,,, recutils, GNU recutils manual}, for more "
6705 "information on @dfn{selection expressions} for @code{recsel -e}."
6709 #: doc/guix.texi:2133
6711 msgid "--show=@var{package}"
6715 #: doc/guix.texi:2137
6717 "Show details about @var{package}, taken from the list of available packages, "
6718 "in @code{recutils} format (@pxref{Top, GNU recutils databases,, recutils, "
6719 "GNU recutils manual})."
6723 #: doc/guix.texi:2142
6726 "$ guix package --show=python | recsel -p name,version\n"
6733 #: doc/guix.texi:2145
6741 #: doc/guix.texi:2149
6743 "You may also specify the full name of a package to only get details about a "
6744 "specific version of it:"
6748 #: doc/guix.texi:2153
6751 "$ guix package --show=python@@3.4 | recsel -p name,version\n"
6757 #: doc/guix.texi:2157
6759 msgid "--list-installed[=@var{regexp}]"
6763 #: doc/guix.texi:2158
6765 msgid "-I [@var{regexp}]"
6769 #: doc/guix.texi:2162
6771 "List the currently installed packages in the specified profile, with the "
6772 "most recently installed packages shown last. When @var{regexp} is "
6773 "specified, list only installed packages whose name matches @var{regexp}."
6777 #: doc/guix.texi:2168
6779 "For each installed package, print the following items, separated by tabs: "
6780 "the package name, its version string, the part of the package that is "
6781 "installed (for instance, @code{out} for the default output, @code{include} "
6782 "for its headers, etc.), and the path of this package in the store."
6786 #: doc/guix.texi:2169
6788 msgid "--list-available[=@var{regexp}]"
6792 #: doc/guix.texi:2170
6794 msgid "-A [@var{regexp}]"
6798 #: doc/guix.texi:2174
6800 "List packages currently available in the distribution for this system "
6801 "(@pxref{GNU Distribution}). When @var{regexp} is specified, list only "
6802 "installed packages whose name matches @var{regexp}."
6804 "Liste les paquets actuellement disponibles dans la distribution pour ce "
6805 "système (@pxref{Distribution GNU}). Lorsque @var{regexp} est spécifié, liste "
6806 "uniquement les paquets dont le nom correspond à @var{regexp}."
6809 #: doc/guix.texi:2178
6811 "For each package, print the following items separated by tabs: its name, its "
6812 "version string, the parts of the package (@pxref{Packages with Multiple "
6813 "Outputs}), and the source location of its definition."
6817 #: doc/guix.texi:2179
6819 msgid "--list-generations[=@var{pattern}]"
6823 #: doc/guix.texi:2180
6825 msgid "-l [@var{pattern}]"
6829 #: doc/guix.texi:2186
6831 "Return a list of generations along with their creation dates; for each "
6832 "generation, show the installed packages, with the most recently installed "
6833 "packages shown last. Note that the zeroth generation is never shown."
6837 #: doc/guix.texi:2191
6839 "For each installed package, print the following items, separated by tabs: "
6840 "the name of a package, its version string, the part of the package that is "
6841 "installed (@pxref{Packages with Multiple Outputs}), and the location of this "
6842 "package in the store."
6846 #: doc/guix.texi:2194
6848 "When @var{pattern} is used, the command returns only matching generations. "
6849 "Valid patterns include:"
6853 #: doc/guix.texi:2196
6855 msgid "@emph{Integers and comma-separated integers}. Both patterns denote"
6859 #: doc/guix.texi:2199
6861 "generation numbers. For instance, @code{--list-generations=1} returns the "
6866 #: doc/guix.texi:2202
6868 "And @code{--list-generations=1,8,2} outputs three generations in the "
6869 "specified order. Neither spaces nor trailing commas are allowed."
6873 #: doc/guix.texi:2203
6875 msgid "@emph{Ranges}. @code{--list-generations=2..9} prints the"
6879 #: doc/guix.texi:2206
6881 "specified generations and everything in between. Note that the start of a "
6882 "range must be smaller than its end."
6886 #: doc/guix.texi:2210
6888 "It is also possible to omit the endpoint. For example, @code{--list-"
6889 "generations=2..}, returns all generations starting from the second one."
6893 #: doc/guix.texi:2211
6895 msgid "@emph{Durations}. You can also get the last @emph{N}@tie{}days, weeks,"
6899 #: doc/guix.texi:2215
6901 "or months by passing an integer along with the first letter of the "
6902 "duration. For example, @code{--list-generations=20d} lists generations that "
6903 "are up to 20 days old."
6907 #: doc/guix.texi:2217
6909 msgid "--delete-generations[=@var{pattern}]"
6913 #: doc/guix.texi:2218
6915 msgid "-d [@var{pattern}]"
6919 #: doc/guix.texi:2221
6921 "When @var{pattern} is omitted, delete all generations except the current one."
6925 #: doc/guix.texi:2227
6927 "This command accepts the same patterns as @option{--list-generations}. When "
6928 "@var{pattern} is specified, delete the matching generations. When "
6929 "@var{pattern} specifies a duration, generations @emph{older} than the "
6930 "specified duration match. For instance, @code{--delete-generations=1m} "
6931 "deletes generations that are more than one month old."
6935 #: doc/guix.texi:2230
6937 "If the current generation matches, it is @emph{not} deleted. Also, the "
6938 "zeroth generation is never deleted."
6942 #: doc/guix.texi:2233
6944 "Note that deleting generations prevents rolling back to them. Consequently, "
6945 "this command must be used with care."
6949 #: doc/guix.texi:2244
6951 "Finally, since @command{guix package} may actually start build processes, it "
6952 "supports all the common build options (@pxref{Common Build Options}). It "
6953 "also supports package transformation options, such as @option{--with-source} "
6954 "(@pxref{Package Transformation Options}). However, note that package "
6955 "transformations are lost when upgrading; to preserve transformations across "
6956 "upgrades, you should define your own package variant in a Guile module and "
6957 "add it to @code{GUIX_PACKAGE_PATH} (@pxref{Defining Packages})."
6961 #: doc/guix.texi:2249
6963 msgid "pre-built binaries"
6967 #: doc/guix.texi:2255
6969 "Guix supports transparent source/binary deployment, which means that it can "
6970 "either build things locally, or download pre-built items from a server, or "
6971 "both. We call these pre-built items @dfn{substitutes}---they are "
6972 "substitutes for local build results. In many cases, downloading a "
6973 "substitute is much faster than building things locally."
6977 #: doc/guix.texi:2260
6979 "Substitutes can be anything resulting from a derivation build "
6980 "(@pxref{Derivations}). Of course, in the common case, they are pre-built "
6981 "package binaries, but source tarballs, for instance, which also result from "
6982 "derivation builds, can be available as substitutes."
6986 #: doc/guix.texi:2273
6992 #: doc/guix.texi:2274
6998 #: doc/guix.texi:2284
7000 "The @code{mirror.hydra.gnu.org} server is a front-end to an official build "
7001 "farm that builds packages from Guix continuously for some architectures, and "
7002 "makes them available as substitutes. This is the default source of "
7003 "substitutes; it can be overridden by passing the @option{--substitute-urls} "
7004 "option either to @command{guix-daemon} (@pxref{daemon-substitute-urls,, "
7005 "@code{guix-daemon --substitute-urls}}) or to client tools such as "
7006 "@command{guix package} (@pxref{client-substitute-urls,, client @option{--"
7007 "substitute-urls} option})."
7011 #: doc/guix.texi:2290
7013 "Substitute URLs can be either HTTP or HTTPS. HTTPS is recommended because "
7014 "communications are encrypted; conversely, using HTTP makes all "
7015 "communications visible to an eavesdropper, who could use the information "
7016 "gathered to determine, for instance, whether your system has unpatched "
7017 "security vulnerabilities."
7021 #: doc/guix.texi:2299
7023 "Substitutes from the official build farm are enabled by default when using "
7024 "the Guix System Distribution (@pxref{GNU Distribution}). However, they are "
7025 "disabled by default when using Guix on a foreign distribution, unless you "
7026 "have explicitly enabled them via one of the recommended installation steps "
7027 "(@pxref{Installation}). The following paragraphs describe how to enable or "
7028 "disable substitutes for the official build farm; the same procedure can also "
7029 "be used to enable substitutes for any other substitute server."
7033 #: doc/guix.texi:2303
7039 #: doc/guix.texi:2305
7041 msgid "access control list (ACL), for substitutes"
7045 #: doc/guix.texi:2306
7047 msgid "ACL (access control list), for substitutes"
7051 #: doc/guix.texi:2313
7053 "To allow Guix to download substitutes from @code{hydra.gnu.org} or a mirror "
7054 "thereof, you must add its public key to the access control list (ACL) of "
7055 "archive imports, using the @command{guix archive} command (@pxref{Invoking "
7056 "guix archive}). Doing so implies that you trust @code{hydra.gnu.org} to not "
7057 "be compromised and to serve genuine substitutes."
7061 #: doc/guix.texi:2320
7063 "The public key for @code{hydra.gnu.org} is installed along with Guix, in "
7064 "@code{@var{prefix}/share/guix/hydra.gnu.org.pub}, where @var{prefix} is the "
7065 "installation prefix of Guix. If you installed Guix from source, make sure "
7066 "you checked the GPG signature of @file{guix-@value{VERSION}.tar.gz}, which "
7067 "contains this public key file. Then, you can run something like this:"
7071 #: doc/guix.texi:2323
7073 msgid "# guix archive --authorize < @var{prefix}/share/guix/hydra.gnu.org.pub\n"
7077 #: doc/guix.texi:2329
7079 "Similarly, the @file{berlin.guixsd.org.pub} file contains the public key for "
7080 "the project's new build farm, reachable at @indicateurl{https://berlin."
7085 #: doc/guix.texi:2334
7087 "As of this writing @code{berlin.guixsd.org} is being upgraded so it can "
7088 "better scale up, but you might want to give it a try. It is backed by 20 "
7089 "x86_64/i686 build nodes and may be able to provide substitutes more quickly "
7090 "than @code{mirror.hydra.gnu.org}."
7094 #: doc/guix.texi:2338
7096 "Once this is in place, the output of a command like @code{guix build} should "
7097 "change from something like:"
7101 #: doc/guix.texi:2347
7104 "$ guix build emacs --dry-run\n"
7105 "The following derivations would be built:\n"
7106 " /gnu/store/yr7bnx8xwcayd6j95r2clmkdl1qh688w-emacs-24.3.drv\n"
7107 " /gnu/store/x8qsh1hlhgjx6cwsjyvybnfv2i37z23w-dbus-1.6.4.tar.gz.drv\n"
7108 " /gnu/store/1ixwp12fl950d15h2cj11c73733jay0z-alsa-lib-1.0.27.1.tar.bz2.drv\n"
7109 " /gnu/store/nlma1pw0p603fpfiqy7kn4zm105r5dmw-util-linux-2.21.drv\n"
7114 #: doc/guix.texi:2351
7115 msgid "to something like:"
7119 #: doc/guix.texi:2360
7122 "$ guix build emacs --dry-run\n"
7123 "112.3 MB would be downloaded:\n"
7124 " /gnu/store/pk3n22lbq6ydamyymqkkz7i69wiwjiwi-emacs-24.3\n"
7125 " /gnu/store/2ygn4ncnhrpr61rssa6z0d9x22si0va3-libjpeg-8d\n"
7126 " /gnu/store/71yz6lgx4dazma9dwn2mcjxaah9w77jq-cairo-1.12.16\n"
7127 " /gnu/store/7zdhgp0n1518lvfn8mb96sxqfmvqrl7v-libxrender-0.9.7\n"
7132 #: doc/guix.texi:2365
7134 "This indicates that substitutes from @code{hydra.gnu.org} are usable and "
7135 "will be downloaded, when possible, for future builds."
7139 #: doc/guix.texi:2366
7141 msgid "substitutes, how to disable"
7145 #: doc/guix.texi:2372
7147 "The substitute mechanism can be disabled globally by running @code{guix-"
7148 "daemon} with @code{--no-substitutes} (@pxref{Invoking guix-daemon}). It can "
7149 "also be disabled temporarily by passing the @code{--no-substitutes} option "
7150 "to @command{guix package}, @command{guix build}, and other command-line "
7155 #: doc/guix.texi:2376
7157 msgid "digital signatures"
7161 #: doc/guix.texi:2380
7163 "Guix detects and raises an error when attempting to use a substitute that "
7164 "has been tampered with. Likewise, it ignores substitutes that are not "
7165 "signed, or that are not signed by one of the keys listed in the ACL."
7169 #: doc/guix.texi:2386
7171 "There is one exception though: if an unauthorized server provides "
7172 "substitutes that are @emph{bit-for-bit identical} to those provided by an "
7173 "authorized server, then the unauthorized server becomes eligible for "
7174 "downloads. For example, assume we have chosen two substitute servers with "
7179 #: doc/guix.texi:2389
7181 msgid "--substitute-urls=\"https://a.example.org https://b.example.org\"\n"
7185 #: doc/guix.texi:2400
7187 "If the ACL contains only the key for @code{b.example.org}, and if @code{a."
7188 "example.org} happens to serve the @emph{exact same} substitutes, then Guix "
7189 "will download substitutes from @code{a.example.org} because it comes first "
7190 "in the list and can be considered a mirror of @code{b.example.org}. In "
7191 "practice, independent build machines usually produce the same binaries, "
7192 "thanks to bit-reproducible builds (see below)."
7196 #: doc/guix.texi:2407
7198 "When using HTTPS, the server's X.509 certificate is @emph{not} validated (in "
7199 "other words, the server is not authenticated), contrary to what HTTPS "
7200 "clients such as Web browsers usually do. This is because Guix authenticates "
7201 "substitute information itself, as explained above, which is what we care "
7202 "about (whereas X.509 certificates are about authenticating bindings between "
7203 "domain names and public keys.)"
7207 #: doc/guix.texi:2419
7209 "Substitutes are downloaded over HTTP or HTTPS. The @code{http_proxy} "
7210 "environment variable can be set in the environment of @command{guix-daemon} "
7211 "and is honored for downloads of substitutes. Note that the value of "
7212 "@code{http_proxy} in the environment where @command{guix build}, "
7213 "@command{guix package}, and other client commands are run has "
7214 "@emph{absolutely no effect}."
7218 #: doc/guix.texi:2428
7220 "Even when a substitute for a derivation is available, sometimes the "
7221 "substitution attempt will fail. This can happen for a variety of reasons: "
7222 "the substitute server might be offline, the substitute may recently have "
7223 "been deleted, the connection might have been interrupted, etc."
7227 #: doc/guix.texi:2442
7229 "When substitutes are enabled and a substitute for a derivation is available, "
7230 "but the substitution attempt fails, Guix will attempt to build the "
7231 "derivation locally depending on whether or not @code{--fallback} was given "
7232 "(@pxref{fallback-option,, common build option @code{--fallback}}). "
7233 "Specifically, if @code{--fallback} was omitted, then no local build will be "
7234 "performed, and the derivation is considered to have failed. However, if "
7235 "@code{--fallback} was given, then Guix will attempt to build the derivation "
7236 "locally, and the success or failure of the derivation depends on the success "
7237 "or failure of the local build. Note that when substitutes are disabled or "
7238 "no substitute is available for the derivation in question, a local build "
7239 "will @emph{always} be performed, regardless of whether or not @code{--"
7240 "fallback} was given."
7244 #: doc/guix.texi:2447
7246 "To get an idea of how many substitutes are available right now, you can try "
7247 "running the @command{guix weather} command (@pxref{Invoking guix weather}). "
7248 "This command provides statistics on the substitutes provided by a server."
7252 #: doc/guix.texi:2451
7254 msgid "trust, of pre-built binaries"
7258 #: doc/guix.texi:2461
7260 "Today, each individual's control over their own computing is at the mercy of "
7261 "institutions, corporations, and groups with enough power and determination "
7262 "to subvert the computing infrastructure and exploit its weaknesses. While "
7263 "using @code{hydra.gnu.org} substitutes can be convenient, we encourage users "
7264 "to also build on their own, or even run their own build farm, such that "
7265 "@code{hydra.gnu.org} is less of an interesting target. One way to help is "
7266 "by publishing the software you build using @command{guix publish} so that "
7267 "others have one more choice of server to download substitutes from "
7268 "(@pxref{Invoking guix publish})."
7272 #: doc/guix.texi:2473
7274 "Guix has the foundations to maximize build reproducibility "
7275 "(@pxref{Features}). In most cases, independent builds of a given package or "
7276 "derivation should yield bit-identical results. Thus, through a diverse set "
7277 "of independent package builds, we can strengthen the integrity of our "
7278 "systems. The @command{guix challenge} command aims to help users assess "
7279 "substitute servers, and to assist developers in finding out about non-"
7280 "deterministic package builds (@pxref{Invoking guix challenge}). Similarly, "
7281 "the @option{--check} option of @command{guix build} allows users to check "
7282 "whether previously-installed substitutes are genuine by rebuilding them "
7283 "locally (@pxref{build-check, @command{guix build --check}})."
7287 #: doc/guix.texi:2477
7289 "In the future, we want Guix to have support to publish and retrieve binaries "
7290 "to/from other users, in a peer-to-peer fashion. If you would like to "
7291 "discuss this project, join us on @email{guix-devel@@gnu.org}."
7295 #: doc/guix.texi:2481
7297 msgid "multiple-output packages"
7301 #: doc/guix.texi:2482
7303 msgid "package outputs"
7307 #: doc/guix.texi:2483
7313 #: doc/guix.texi:2493
7315 "Often, packages defined in Guix have a single @dfn{output}---i.e., the "
7316 "source package leads to exactly one directory in the store. When running "
7317 "@command{guix package -i glibc}, one installs the default output of the GNU "
7318 "libc package; the default output is called @code{out}, but its name can be "
7319 "omitted as shown in this command. In this particular case, the default "
7320 "output of @code{glibc} contains all the C header files, shared libraries, "
7321 "static libraries, Info documentation, and other supporting files."
7325 #: doc/guix.texi:2501
7327 "Sometimes it is more appropriate to separate the various types of files "
7328 "produced from a single source package into separate outputs. For instance, "
7329 "the GLib C library (used by GTK+ and related packages) installs more than "
7330 "20 MiB of reference documentation as HTML pages. To save space for users "
7331 "who do not need it, the documentation goes to a separate output, called "
7332 "@code{doc}. To install the main GLib output, which contains everything but "
7333 "the documentation, one would run:"
7337 #: doc/guix.texi:2504
7339 msgid "guix package -i glib\n"
7343 #: doc/guix.texi:2506 doc/guix.texi:21321
7345 msgid "documentation"
7349 #: doc/guix.texi:2508
7350 msgid "The command to install its documentation is:"
7354 #: doc/guix.texi:2511
7356 msgid "guix package -i glib:doc\n"
7360 #: doc/guix.texi:2522
7362 "Some packages install programs with different ``dependency footprints''. "
7363 "For instance, the WordNet package installs both command-line tools and "
7364 "graphical user interfaces (GUIs). The former depend solely on the C "
7365 "library, whereas the latter depend on Tcl/Tk and the underlying X "
7366 "libraries. In this case, we leave the command-line tools in the default "
7367 "output, whereas the GUIs are in a separate output. This allows users who do "
7368 "not need the GUIs to save space. The @command{guix size} command can help "
7369 "find out about such situations (@pxref{Invoking guix size}). @command{guix "
7370 "graph} can also be helpful (@pxref{Invoking guix graph})."
7374 #: doc/guix.texi:2530
7376 "There are several such multiple-output packages in the GNU distribution. "
7377 "Other conventional output names include @code{lib} for libraries and "
7378 "possibly header files, @code{bin} for stand-alone programs, and @code{debug} "
7379 "for debugging information (@pxref{Installing Debugging Files}). The outputs "
7380 "of a packages are listed in the third column of the output of @command{guix "
7381 "package --list-available} (@pxref{Invoking guix package})."
7385 #: doc/guix.texi:2533
7387 msgid "Invoking @command{guix gc}"
7391 #: doc/guix.texi:2535
7393 msgid "garbage collector"
7397 #: doc/guix.texi:2536
7403 #: doc/guix.texi:2542
7405 "Packages that are installed, but not used, may be @dfn{garbage-collected}. "
7406 "The @command{guix gc} command allows users to explicitly run the garbage "
7407 "collector to reclaim space from the @file{/gnu/store} directory. It is the "
7408 "@emph{only} way to remove files from @file{/gnu/store}---removing files or "
7409 "directories manually may break it beyond repair!"
7413 #: doc/guix.texi:2553
7415 "The garbage collector has a set of known @dfn{roots}: any file under @file{/"
7416 "gnu/store} reachable from a root is considered @dfn{live} and cannot be "
7417 "deleted; any other file is considered @dfn{dead} and may be deleted. The "
7418 "set of garbage collector roots (``GC roots'' for short) includes default "
7419 "user profiles; by default, the symlinks under @file{/var/guix/gcroots} "
7420 "represent these GC roots. New GC roots can be added with @command{guix "
7421 "build --root}, for example (@pxref{Invoking guix build})."
7425 #: doc/guix.texi:2559
7427 "Prior to running @code{guix gc --collect-garbage} to make space, it is often "
7428 "useful to remove old generations from user profiles; that way, old package "
7429 "builds referenced by those generations can be reclaimed. This is achieved "
7430 "by running @code{guix package --delete-generations} (@pxref{Invoking guix "
7435 #: doc/guix.texi:2563
7437 "Our recommendation is to run a garbage collection periodically, or when you "
7438 "are short on disk space. For instance, to guarantee that at least 5@tie{}GB "
7439 "are available on your disk, simply run:"
7443 #: doc/guix.texi:2566
7445 msgid "guix gc -F 5G\n"
7449 #: doc/guix.texi:2575
7451 "It is perfectly safe to run as a non-interactive periodic job "
7452 "(@pxref{Scheduled Job Execution}, for how to set up such a job on GuixSD). "
7453 "Running @command{guix gc} with no arguments will collect as much garbage as "
7454 "it can, but that is often inconvenient: you may find yourself having to "
7455 "rebuild or re-download software that is ``dead'' from the GC viewpoint but "
7456 "that is necessary to build other pieces of software---e.g., the compiler "
7461 #: doc/guix.texi:2581
7463 "The @command{guix gc} command has three modes of operation: it can be used "
7464 "to garbage-collect any dead files (the default), to delete specific files "
7465 "(the @code{--delete} option), to print garbage-collector information, or for "
7466 "more advanced queries. The garbage collection options are as follows:"
7470 #: doc/guix.texi:2583
7472 msgid "--collect-garbage[=@var{min}]"
7476 #: doc/guix.texi:2584
7478 msgid "-C [@var{min}]"
7482 #: doc/guix.texi:2588
7484 "Collect garbage---i.e., unreachable @file{/gnu/store} files and sub-"
7485 "directories. This is the default operation when no option is specified."
7489 #: doc/guix.texi:2593
7491 "When @var{min} is given, stop once @var{min} bytes have been collected. "
7492 "@var{min} may be a number of bytes, or it may include a unit as a suffix, "
7493 "such as @code{MiB} for mebibytes and @code{GB} for gigabytes (@pxref{Block "
7494 "size, size specifications,, coreutils, GNU Coreutils})."
7498 #: doc/guix.texi:2595
7499 msgid "When @var{min} is omitted, collect all the garbage."
7503 #: doc/guix.texi:2596
7505 msgid "--free-space=@var{free}"
7509 #: doc/guix.texi:2597
7511 msgid "-F @var{free}"
7515 #: doc/guix.texi:2601
7517 "Collect garbage until @var{free} space is available under @file{/gnu/store}, "
7518 "if possible; @var{free} denotes storage space, such as @code{500MiB}, as "
7523 #: doc/guix.texi:2604
7525 "When @var{free} or more is already available in @file{/gnu/store}, do "
7526 "nothing and exit immediately."
7530 #: doc/guix.texi:2605
7536 #: doc/guix.texi:2606 doc/guix.texi:5840 doc/guix.texi:20598
7542 #: doc/guix.texi:2610
7544 "Attempt to delete all the store files and directories specified as "
7545 "arguments. This fails if some of the files are not in the store, or if they "
7550 #: doc/guix.texi:2611
7552 msgid "--list-failures"
7556 #: doc/guix.texi:2613
7557 msgid "List store items corresponding to cached build failures."
7561 #: doc/guix.texi:2617
7563 "This prints nothing unless the daemon was started with @option{--cache-"
7564 "failures} (@pxref{Invoking guix-daemon, @option{--cache-failures}})."
7568 #: doc/guix.texi:2618
7570 msgid "--clear-failures"
7574 #: doc/guix.texi:2620
7575 msgid "Remove the specified store items from the failed-build cache."
7579 #: doc/guix.texi:2623
7581 "Again, this option only makes sense when the daemon is started with "
7582 "@option{--cache-failures}. Otherwise, it does nothing."
7586 #: doc/guix.texi:2624
7592 #: doc/guix.texi:2627
7594 "Show the list of dead files and directories still present in the store---i."
7595 "e., files and directories no longer reachable from any root."
7599 #: doc/guix.texi:2628
7605 #: doc/guix.texi:2630
7606 msgid "Show the list of live store files and directories."
7610 #: doc/guix.texi:2634
7611 msgid "In addition, the references among existing store files can be queried:"
7615 #: doc/guix.texi:2637
7617 msgid "--references"
7621 #: doc/guix.texi:2638
7627 #: doc/guix.texi:2639 doc/guix.texi:6935
7629 msgid "package dependencies"
7633 #: doc/guix.texi:2642
7635 "List the references (respectively, the referrers) of store files given as "
7640 #: doc/guix.texi:2643
7642 msgid "--requisites"
7646 #: doc/guix.texi:2644
7652 #: doc/guix.texi:2645 doc/guix.texi:6819 doc/guix.texi:6843 doc/guix.texi:6907
7658 #: doc/guix.texi:2650
7660 "List the requisites of the store files passed as arguments. Requisites "
7661 "include the store files themselves, their references, and the references of "
7662 "these, recursively. In other words, the returned list is the "
7663 "@dfn{transitive closure} of the store files."
7667 #: doc/guix.texi:2654
7669 "@xref{Invoking guix size}, for a tool to profile the size of the closure of "
7670 "an element. @xref{Invoking guix graph}, for a tool to visualize the graph "
7675 #: doc/guix.texi:2655
7681 #: doc/guix.texi:2656 doc/guix.texi:3122 doc/guix.texi:7020
7687 #: doc/guix.texi:2659
7689 "Return the derivation(s) leading to the given store items "
7690 "(@pxref{Derivations})."
7694 #: doc/guix.texi:2661
7695 msgid "For example, this command:"
7699 #: doc/guix.texi:2664
7701 msgid "guix gc --derivers `guix package -I ^emacs$ | cut -f4`\n"
7705 #: doc/guix.texi:2669
7707 "returns the @file{.drv} file(s) leading to the @code{emacs} package "
7708 "installed in your profile."
7712 #: doc/guix.texi:2673
7714 "Note that there may be zero matching @file{.drv} files, for instance because "
7715 "these files have been garbage-collected. There can also be more than one "
7716 "matching @file{.drv} due to fixed-output derivations."
7720 #: doc/guix.texi:2677
7722 "Lastly, the following options allow you to check the integrity of the store "
7723 "and to control disk usage."
7727 #: doc/guix.texi:2680
7729 msgid "--verify[=@var{options}]"
7733 #: doc/guix.texi:2681
7735 msgid "integrity, of the store"
7739 #: doc/guix.texi:2682
7741 msgid "integrity checking"
7745 #: doc/guix.texi:2684
7746 msgid "Verify the integrity of the store."
7750 #: doc/guix.texi:2687
7752 "By default, make sure that all the store items marked as valid in the "
7753 "database of the daemon actually exist in @file{/gnu/store}."
7757 #: doc/guix.texi:2690
7759 "When provided, @var{options} must be a comma-separated list containing one "
7760 "or more of @code{contents} and @code{repair}."
7764 #: doc/guix.texi:2696
7766 "When passing @option{--verify=contents}, the daemon computes the content "
7767 "hash of each store item and compares it against its hash in the database. "
7768 "Hash mismatches are reported as data corruptions. Because it traverses "
7769 "@emph{all the files in the store}, this command can take a long time, "
7770 "especially on systems with a slow disk drive."
7774 #: doc/guix.texi:2697
7776 msgid "repairing the store"
7780 #: doc/guix.texi:2698 doc/guix.texi:5833
7782 msgid "corruption, recovering from"
7786 #: doc/guix.texi:2706
7788 "Using @option{--verify=repair} or @option{--verify=contents,repair} causes "
7789 "the daemon to try to repair corrupt store items by fetching substitutes for "
7790 "them (@pxref{Substitutes}). Because repairing is not atomic, and thus "
7791 "potentially dangerous, it is available only to the system administrator. A "
7792 "lightweight alternative, when you know exactly which items in the store are "
7793 "corrupt, is @command{guix build --repair} (@pxref{Invoking guix build})."
7795 "Utiliser @option{--verify=repair} ou @option{--verify=contents,repair} fait "
7796 "que le démon essaie de réparer les objets du dépôt corrompus en récupérant "
7797 "leurs substituts (@pxref{Substituts}). Comme la réparation n'est pas "
7798 "atomique et donc potentiellement dangereuse, elle n'est disponible que pour "
7799 "l'administrateur système. Une alternative plus légère lorsque vous "
7800 "connaissez exactement quelle entrée est corrompue consiste à lancer "
7801 "@command{guix build --repair} (@pxref{Invoking guix build})."
7804 #: doc/guix.texi:2707
7810 #: doc/guix.texi:2711
7812 "Optimize the store by hard-linking identical files---this is "
7813 "@dfn{deduplication}."
7817 #: doc/guix.texi:2717
7819 "The daemon performs deduplication after each successful build or archive "
7820 "import, unless it was started with @code{--disable-deduplication} "
7821 "(@pxref{Invoking guix-daemon, @code{--disable-deduplication}}). Thus, this "
7822 "option is primarily useful when the daemon was running with @code{--disable-"
7827 #: doc/guix.texi:2721
7829 msgid "Invoking @command{guix pull}"
7833 #: doc/guix.texi:2723
7835 msgid "upgrading Guix"
7839 #: doc/guix.texi:2724
7841 msgid "updating Guix"
7844 #. type: command{#1}
7845 #: doc/guix.texi:2725
7851 #: doc/guix.texi:2726
7857 #: doc/guix.texi:2733
7859 "Packages are installed or upgraded to the latest version available in the "
7860 "distribution currently available on your local machine. To update that "
7861 "distribution, along with the Guix tools, you must run @command{guix pull}: "
7862 "the command downloads the latest Guix source code and package descriptions, "
7863 "and deploys it. Source code is downloaded from a @uref{https://git-scm.com, "
7868 #: doc/guix.texi:2739
7870 "On completion, @command{guix package} will use packages and package versions "
7871 "from this just-retrieved copy of Guix. Not only that, but all the Guix "
7872 "commands and Scheme modules will also be taken from that latest version. "
7873 "New @command{guix} sub-commands added by the update also become available."
7877 #: doc/guix.texi:2749
7879 "Any user can update their Guix copy using @command{guix pull}, and the "
7880 "effect is limited to the user who run @command{guix pull}. For instance, "
7881 "when user @code{root} runs @command{guix pull}, this has no effect on the "
7882 "version of Guix that user @code{alice} sees, and vice versa@footnote{Under "
7883 "the hood, @command{guix pull} updates the @file{~/.config/guix/latest} "
7884 "symbolic link to point to the latest Guix, and the @command{guix} command "
7885 "loads code from there. Currently, the only way to roll back an invocation "
7886 "of @command{guix pull} is to manually update this symlink to point to the "
7891 #: doc/guix.texi:2752
7893 "The @command{guix pull} command is usually invoked with no arguments, but it "
7894 "supports the following options:"
7898 #: doc/guix.texi:2756
7900 "Produce verbose output, writing build logs to the standard error output."
7904 #: doc/guix.texi:2757
7906 msgid "--url=@var{url}"
7910 #: doc/guix.texi:2759
7911 msgid "Download Guix from the Git repository at @var{url}."
7915 #: doc/guix.texi:2760
7917 msgid "GUIX_PULL_URL"
7921 #: doc/guix.texi:2764
7923 "By default, the source is taken from its canonical Git repository at "
7924 "@code{gnu.org}, for the stable branch of Guix. To use a different source, "
7925 "set the @code{GUIX_PULL_URL} environment variable."
7929 #: doc/guix.texi:2765
7931 msgid "--commit=@var{commit}"
7935 #: doc/guix.texi:2768
7937 "Deploy @var{commit}, a valid Git commit ID represented as a hexadecimal "
7942 #: doc/guix.texi:2769
7944 msgid "--branch=@var{branch}"
7948 #: doc/guix.texi:2772
7950 "Deploy the tip of @var{branch}, the name of a Git branch available on the "
7951 "repository at @var{url}."
7955 #: doc/guix.texi:2776
7957 "Use the bootstrap Guile to build the latest Guix. This option is only "
7958 "useful to Guix developers."
7962 #: doc/guix.texi:2780
7964 "In addition, @command{guix pull} supports all the common build options "
7965 "(@pxref{Common Build Options})."
7969 #: doc/guix.texi:2782
7971 msgid "Invoking @command{guix pack}"
7975 #: doc/guix.texi:2788
7977 "Occasionally you want to pass software to people who are not (yet!) lucky "
7978 "enough to be using Guix. You'd tell them to run @command{guix package -i "
7979 "@var{something}}, but that's not possible in this case. This is where "
7980 "@command{guix pack} comes in."
7984 #: doc/guix.texi:2793
7986 "If you are looking for ways to exchange binaries among machines that already "
7987 "run Guix, @pxref{Invoking guix copy}, @ref{Invoking guix publish}, and "
7988 "@ref{Invoking guix archive}."
7992 #: doc/guix.texi:2795
7998 #: doc/guix.texi:2796
8004 #: doc/guix.texi:2797
8006 msgid "application bundle"
8010 #: doc/guix.texi:2798
8012 msgid "software bundle"
8016 #: doc/guix.texi:2807
8018 "The @command{guix pack} command creates a shrink-wrapped @dfn{pack} or "
8019 "@dfn{software bundle}: it creates a tarball or some other archive containing "
8020 "the binaries of the software you're interested in, and all its "
8021 "dependencies. The resulting archive can be used on any machine that does "
8022 "not have Guix, and people can run the exact same binaries as those you have "
8023 "with Guix. The pack itself is created in a bit-reproducible fashion, so "
8024 "anyone can verify that it really contains the build results that you pretend "
8029 #: doc/guix.texi:2810
8031 "For example, to create a bundle containing Guile, Emacs, Geiser, and all "
8032 "their dependencies, you can run:"
8036 #: doc/guix.texi:2815
8039 "$ guix pack guile emacs geiser\n"
8041 "/gnu/store/@dots{}-pack.tar.gz\n"
8045 #: doc/guix.texi:2823
8047 "The result here is a tarball containing a @file{/gnu/store} directory with "
8048 "all the relevant packages. The resulting tarball contains a @dfn{profile} "
8049 "with the three packages of interest; the profile is the same as would be "
8050 "created by @command{guix package -i}. It is this mechanism that is used to "
8051 "create Guix's own standalone binary tarball (@pxref{Binary Installation})."
8055 #: doc/guix.texi:2828
8057 "Users of this pack would have to run @file{/gnu/store/@dots{}-profile/bin/"
8058 "guile} to run Guile, which you may find inconvenient. To work around it, "
8059 "you can create, say, a @file{/opt/gnu/bin} symlink to the profile:"
8063 #: doc/guix.texi:2831
8065 msgid "guix pack -S /opt/gnu/bin=bin guile emacs geiser\n"
8069 #: doc/guix.texi:2835
8070 msgid "That way, users can happily type @file{/opt/gnu/bin/guile} and enjoy."
8074 #: doc/guix.texi:2838
8076 "Alternatively, you can produce a pack in the Docker image format using the "
8077 "following command:"
8081 #: doc/guix.texi:2841
8083 msgid "guix pack -f docker guile emacs geiser\n"
8087 #: doc/guix.texi:2848
8089 "The result is a tarball that can be passed to the @command{docker load} "
8090 "command. See the @uref{https://docs.docker.com/engine/reference/commandline/"
8091 "load/, Docker documentation} for more information."
8095 #: doc/guix.texi:2850
8096 msgid "Several command-line options allow you to customize your pack:"
8100 #: doc/guix.texi:2852
8102 msgid "--format=@var{format}"
8106 #: doc/guix.texi:2853
8108 msgid "-f @var{format}"
8112 #: doc/guix.texi:2855
8113 msgid "Produce a pack in the given @var{format}."
8117 #: doc/guix.texi:2857
8118 msgid "The available formats are:"
8122 #: doc/guix.texi:2859
8128 #: doc/guix.texi:2862
8130 "This is the default format. It produces a tarball containing all the "
8131 "specified binaries and symlinks."
8135 #: doc/guix.texi:2863
8141 #: doc/guix.texi:2867
8143 "This produces a tarball that follows the @uref{https://github.com/docker/"
8144 "docker/blob/master/image/spec/v1.2.md, Docker Image Specification}."
8148 #: doc/guix.texi:2869 doc/guix.texi:5711 doc/guix.texi:6536 doc/guix.texi:7097
8149 #: doc/guix.texi:7247 doc/guix.texi:20584
8151 msgid "--expression=@var{expr}"
8155 #: doc/guix.texi:2870 doc/guix.texi:5712 doc/guix.texi:6537 doc/guix.texi:7098
8156 #: doc/guix.texi:7248 doc/guix.texi:20585
8158 msgid "-e @var{expr}"
8162 #: doc/guix.texi:2872 doc/guix.texi:6539 doc/guix.texi:7100
8163 msgid "Consider the package @var{expr} evaluates to."
8167 #: doc/guix.texi:2876
8169 "This has the same purpose as the same-named option in @command{guix build} "
8170 "(@pxref{Additional Build Options, @code{--expression} in @command{guix "
8175 #: doc/guix.texi:2881
8177 "Use the packages contained in the manifest object returned by the Scheme "
8178 "code in @var{file}."
8182 #: doc/guix.texi:2889
8184 "This has a similar purpose as the same-named option in @command{guix "
8185 "package} (@pxref{profile-manifest, @option{--manifest}}) and uses the same "
8186 "manifest files. It allows you to define a collection of packages once and "
8187 "use it both for creating profiles and for creating archives for use on "
8188 "machines that do not have Guix installed. Note that you can specify "
8189 "@emph{either} a manifest file @emph{or} a list of packages, but not both."
8193 #: doc/guix.texi:2891 doc/guix.texi:5784 doc/guix.texi:6925 doc/guix.texi:7333
8194 #: doc/guix.texi:7967 doc/guix.texi:20593
8196 msgid "-s @var{system}"
8200 #: doc/guix.texi:2894 doc/guix.texi:5787
8202 "Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of the "
8203 "system type of the build host."
8207 #: doc/guix.texi:2895 doc/guix.texi:5808
8209 msgid "--target=@var{triplet}"
8213 #: doc/guix.texi:2896 doc/guix.texi:3322 doc/guix.texi:5809
8215 msgid "cross-compilation"
8219 #: doc/guix.texi:2900 doc/guix.texi:5813
8221 "Cross-build for @var{triplet}, which must be a valid GNU triplet, such as "
8222 "@code{\"mips64el-linux-gnu\"} (@pxref{Specifying target triplets, GNU "
8223 "configuration triplets,, autoconf, Autoconf})."
8227 #: doc/guix.texi:2901
8229 msgid "--compression=@var{tool}"
8233 #: doc/guix.texi:2902
8235 msgid "-C @var{tool}"
8239 #: doc/guix.texi:2905
8241 "Compress the resulting tarball using @var{tool}---one of @code{gzip}, "
8242 "@code{bzip2}, @code{xz}, @code{lzip}, or @code{none} for no compression."
8246 #: doc/guix.texi:2906
8248 msgid "--symlink=@var{spec}"
8252 #: doc/guix.texi:2907
8254 msgid "-S @var{spec}"
8258 #: doc/guix.texi:2910
8260 "Add the symlinks specified by @var{spec} to the pack. This option can "
8261 "appear several times."
8265 #: doc/guix.texi:2914
8267 "@var{spec} has the form @code{@var{source}=@var{target}}, where @var{source} "
8268 "is the symlink that will be created and @var{target} is the symlink target."
8272 #: doc/guix.texi:2917
8274 "For instance, @code{-S /opt/gnu/bin=bin} creates a @file{/opt/gnu/bin} "
8275 "symlink pointing to the @file{bin} sub-directory of the profile."
8279 #: doc/guix.texi:2918
8281 msgid "--localstatedir"
8285 #: doc/guix.texi:2921
8287 "Include the ``local state directory'', @file{/var/guix}, in the resulting "
8292 #: doc/guix.texi:2927
8294 "@file{/var/guix} contains the store database (@pxref{The Store}) as well as "
8295 "garbage-collector roots (@pxref{Invoking guix gc}). Providing it in the "
8296 "pack means that the store is ``complete'' and manageable by Guix; not "
8297 "providing it pack means that the store is ``dead'': items cannot be added to "
8298 "it or removed from it after extraction of the pack."
8302 #: doc/guix.texi:2930
8304 "One use case for this is the Guix self-contained binary tarball "
8305 "(@pxref{Binary Installation})."
8309 #: doc/guix.texi:2934
8311 "Use the bootstrap binaries to build the pack. This option is only useful to "
8316 #: doc/guix.texi:2939
8318 "In addition, @command{guix pack} supports all the common build options "
8319 "(@pxref{Common Build Options}) and all the package transformation options "
8320 "(@pxref{Package Transformation Options})."
8324 #: doc/guix.texi:2942
8326 msgid "Invoking @command{guix archive}"
8329 #. type: command{#1}
8330 #: doc/guix.texi:2944
8332 msgid "guix archive"
8336 #: doc/guix.texi:2945
8342 #: doc/guix.texi:2951
8344 "The @command{guix archive} command allows users to @dfn{export} files from "
8345 "the store into a single archive, and to later @dfn{import} them on a machine "
8346 "that runs Guix. In particular, it allows store files to be transferred from "
8347 "one machine to the store on another machine."
8351 #: doc/guix.texi:2955
8353 "If you're looking for a way to produce archives in a format suitable for "
8354 "tools other than Guix, @pxref{Invoking guix pack}."
8358 #: doc/guix.texi:2957
8360 msgid "exporting store items"
8364 #: doc/guix.texi:2959
8365 msgid "To export store files as an archive to standard output, run:"
8369 #: doc/guix.texi:2962
8371 msgid "guix archive --export @var{options} @var{specifications}...\n"
8375 #: doc/guix.texi:2969
8377 "@var{specifications} may be either store file names or package "
8378 "specifications, as for @command{guix package} (@pxref{Invoking guix "
8379 "package}). For instance, the following command creates an archive "
8380 "containing the @code{gui} output of the @code{git} package and the main "
8381 "output of @code{emacs}:"
8385 #: doc/guix.texi:2972
8387 msgid "guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar\n"
8391 #: doc/guix.texi:2977
8393 "If the specified packages are not built yet, @command{guix archive} "
8394 "automatically builds them. The build process may be controlled with the "
8395 "common build options (@pxref{Common Build Options})."
8399 #: doc/guix.texi:2980
8401 "To transfer the @code{emacs} package to a machine connected over SSH, one "
8406 #: doc/guix.texi:2983
8408 msgid "guix archive --export -r emacs | ssh the-machine guix archive --import\n"
8412 #: doc/guix.texi:2988
8414 "Similarly, a complete user profile may be transferred from one machine to "
8415 "another like this:"
8419 #: doc/guix.texi:2992
8422 "guix archive --export -r $(readlink -f ~/.guix-profile) | \\\n"
8423 " ssh the-machine guix-archive --import\n"
8427 #: doc/guix.texi:3002
8429 "However, note that, in both examples, all of @code{emacs} and the profile as "
8430 "well as all of their dependencies are transferred (due to @code{-r}), "
8431 "regardless of what is already available in the store on the target machine. "
8432 "The @code{--missing} option can help figure out which items are missing from "
8433 "the target store. The @command{guix copy} command simplifies and optimizes "
8434 "this whole process, so this is probably what you should use in this case "
8435 "(@pxref{Invoking guix copy})."
8439 #: doc/guix.texi:3003
8441 msgid "nar, archive format"
8445 #: doc/guix.texi:3004
8447 msgid "normalized archive (nar)"
8451 #: doc/guix.texi:3014
8453 "Archives are stored in the ``normalized archive'' or ``nar'' format, which "
8454 "is comparable in spirit to `tar', but with differences that make it more "
8455 "appropriate for our purposes. First, rather than recording all Unix "
8456 "metadata for each file, the nar format only mentions the file type (regular, "
8457 "directory, or symbolic link); Unix permissions and owner/group are "
8458 "dismissed. Second, the order in which directory entries are stored always "
8459 "follows the order of file names according to the C locale collation order. "
8460 "This makes archive production fully deterministic."
8464 #: doc/guix.texi:3020
8466 "When exporting, the daemon digitally signs the contents of the archive, and "
8467 "that digital signature is appended. When importing, the daemon verifies the "
8468 "signature and rejects the import in case of an invalid signature or if the "
8469 "signing key is not authorized."
8473 #: doc/guix.texi:3022
8474 msgid "The main options are:"
8478 #: doc/guix.texi:3024
8484 #: doc/guix.texi:3027
8486 "Export the specified store files or packages (see below.) Write the "
8487 "resulting archive to the standard output."
8491 #: doc/guix.texi:3030
8493 "Dependencies are @emph{not} included in the output, unless @code{--"
8494 "recursive} is passed."
8498 #: doc/guix.texi:3031 doc/guix.texi:6080
8504 #: doc/guix.texi:3032 doc/guix.texi:6079
8510 #: doc/guix.texi:3037
8512 "When combined with @code{--export}, this instructs @command{guix archive} to "
8513 "include dependencies of the given items in the archive. Thus, the resulting "
8514 "archive is self-contained: it contains the closure of the exported store "
8519 #: doc/guix.texi:3038
8525 #: doc/guix.texi:3043
8527 "Read an archive from the standard input, and import the files listed therein "
8528 "into the store. Abort if the archive has an invalid digital signature, or "
8529 "if it is signed by a public key not among the authorized keys (see @code{--"
8530 "authorize} below.)"
8534 #: doc/guix.texi:3044
8540 #: doc/guix.texi:3048
8542 "Read a list of store file names from the standard input, one per line, and "
8543 "write on the standard output the subset of these files missing from the "
8548 #: doc/guix.texi:3049
8550 msgid "--generate-key[=@var{parameters}]"
8554 #: doc/guix.texi:3050
8556 msgid "signing, archives"
8560 #: doc/guix.texi:3055
8562 "Generate a new key pair for the daemon. This is a prerequisite before "
8563 "archives can be exported with @code{--export}. Note that this operation "
8564 "usually takes time, because it needs to gather enough entropy to generate "
8569 #: doc/guix.texi:3065
8571 "The generated key pair is typically stored under @file{/etc/guix}, in "
8572 "@file{signing-key.pub} (public key) and @file{signing-key.sec} (private key, "
8573 "which must be kept secret.) When @var{parameters} is omitted, an ECDSA key "
8574 "using the Ed25519 curve is generated, or, for Libgcrypt versions before "
8575 "1.6.0, it is a 4096-bit RSA key. Alternatively, @var{parameters} can "
8576 "specify @code{genkey} parameters suitable for Libgcrypt (@pxref{General "
8577 "public-key related Functions, @code{gcry_pk_genkey},, gcrypt, The Libgcrypt "
8578 "Reference Manual})."
8582 #: doc/guix.texi:3066
8588 #: doc/guix.texi:3067
8590 msgid "authorizing, archives"
8594 #: doc/guix.texi:3071
8596 "Authorize imports signed by the public key passed on standard input. The "
8597 "public key must be in ``s-expression advanced format''---i.e., the same "
8598 "format as the @file{signing-key.pub} file."
8602 #: doc/guix.texi:3078
8604 "The list of authorized keys is kept in the human-editable file @file{/etc/"
8605 "guix/acl}. The file contains @url{http://people.csail.mit.edu/rivest/Sexp."
8606 "txt, ``advanced-format s-expressions''} and is structured as an access-"
8607 "control list in the @url{http://theworld.com/~cme/spki.txt, Simple Public-"
8608 "Key Infrastructure (SPKI)}."
8612 #: doc/guix.texi:3079
8614 msgid "--extract=@var{directory}"
8618 #: doc/guix.texi:3080
8620 msgid "-x @var{directory}"
8624 #: doc/guix.texi:3084
8626 "Read a single-item archive as served by substitute servers "
8627 "(@pxref{Substitutes}) and extract it to @var{directory}. This is a low-"
8628 "level operation needed in only very narrow use cases; see below."
8630 "Lit une archive à un seul élément telle que servie par un serveur de "
8631 "substituts (@pxref{Substituts}) et l'extrait dans @var{directory}. C'est une "
8632 "opération de bas niveau requise seulement dans de rares cas d'usage ; voir "
8636 #: doc/guix.texi:3087
8638 "For example, the following command extracts the substitute for Emacs served "
8639 "by @code{hydra.gnu.org} to @file{/tmp/emacs}:"
8643 #: doc/guix.texi:3092
8647 " https://hydra.gnu.org/nar/@dots{}-emacs-24.5 \\\n"
8648 " | bunzip2 | guix archive -x /tmp/emacs\n"
8652 #: doc/guix.texi:3099
8654 "Single-item archives are different from multiple-item archives produced by "
8655 "@command{guix archive --export}; they contain a single store item, and they "
8656 "do @emph{not} embed a signature. Thus this operation does @emph{no} "
8657 "signature verification and its output should be considered unsafe."
8661 #: doc/guix.texi:3102
8663 "The primary purpose of this operation is to facilitate inspection of archive "
8664 "contents coming from possibly untrusted substitute servers."
8668 #: doc/guix.texi:3115
8670 "GNU Guix provides several Scheme programming interfaces (APIs) to define, "
8671 "build, and query packages. The first interface allows users to write high-"
8672 "level package definitions. These definitions refer to familiar packaging "
8673 "concepts, such as the name and version of a package, its build system, and "
8674 "its dependencies. These definitions can then be turned into concrete build "
8679 #: doc/guix.texi:3121
8681 "Build actions are performed by the Guix daemon, on behalf of users. In a "
8682 "standard setup, the daemon has write access to the store---the @file{/gnu/"
8683 "store} directory---whereas users do not. The recommended setup also has the "
8684 "daemon perform builds in chroots, under a specific build users, to minimize "
8685 "interference with the rest of the system."
8689 #: doc/guix.texi:3130
8691 "Lower-level APIs are available to interact with the daemon and the store. "
8692 "To instruct the daemon to perform a build action, users actually provide it "
8693 "with a @dfn{derivation}. A derivation is a low-level representation of the "
8694 "build actions to be taken, and the environment in which they should occur---"
8695 "derivations are to package definitions what assembly is to C programs. The "
8696 "term ``derivation'' comes from the fact that build results @emph{derive} "
8701 #: doc/guix.texi:3133
8703 "This chapter describes all these APIs in turn, starting from high-level "
8704 "package definitions."
8708 #: doc/guix.texi:3150
8710 "The high-level interface to package definitions is implemented in the "
8711 "@code{(guix packages)} and @code{(guix build-system)} modules. As an "
8712 "example, the package definition, or @dfn{recipe}, for the GNU Hello package "
8717 #: doc/guix.texi:3158
8720 "(define-module (gnu packages hello)\n"
8721 " #:use-module (guix packages)\n"
8722 " #:use-module (guix download)\n"
8723 " #:use-module (guix build-system gnu)\n"
8724 " #:use-module (guix licenses)\n"
8725 " #:use-module (gnu packages gawk))\n"
8730 #: doc/guix.texi:3177
8733 "(define-public hello\n"
8735 " (name \"hello\")\n"
8736 " (version \"2.10\")\n"
8737 " (source (origin\n"
8738 " (method url-fetch)\n"
8739 " (uri (string-append \"mirror://gnu/hello/hello-\" version\n"
8743 " \"0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i\"))))\n"
8744 " (build-system gnu-build-system)\n"
8745 " (arguments '(#:configure-flags '(\"--enable-silent-rules\")))\n"
8746 " (inputs `((\"gawk\" ,gawk)))\n"
8747 " (synopsis \"Hello, GNU world: An example GNU package\")\n"
8748 " (description \"Guess what GNU Hello prints!\")\n"
8749 " (home-page \"http://www.gnu.org/software/hello/\")\n"
8750 " (license gpl3+)))\n"
8754 #: doc/guix.texi:3187
8756 "Without being a Scheme expert, the reader may have guessed the meaning of "
8757 "the various fields here. This expression binds the variable @code{hello} to "
8758 "a @code{<package>} object, which is essentially a record (@pxref{SRFI-9, "
8759 "Scheme records,, guile, GNU Guile Reference Manual}). This package object "
8760 "can be inspected using procedures found in the @code{(guix packages)} "
8761 "module; for instance, @code{(package-name hello)} returns---surprise!---"
8766 #: doc/guix.texi:3191
8768 "With luck, you may be able to import part or all of the definition of the "
8769 "package you are interested in from another repository, using the @code{guix "
8770 "import} command (@pxref{Invoking guix import})."
8774 #: doc/guix.texi:3197
8776 "In the example above, @var{hello} is defined in a module of its own, "
8777 "@code{(gnu packages hello)}. Technically, this is not strictly necessary, "
8778 "but it is convenient to do so: all the packages defined in modules under "
8779 "@code{(gnu packages @dots{})} are automatically known to the command-line "
8780 "tools (@pxref{Package Modules})."
8784 #: doc/guix.texi:3199
8785 msgid "There are a few points worth noting in the above package definition:"
8789 #: doc/guix.texi:3206
8791 "The @code{source} field of the package is an @code{<origin>} object "
8792 "(@pxref{origin Reference}, for the complete reference). Here, the @code{url-"
8793 "fetch} method from @code{(guix download)} is used, meaning that the source "
8794 "is a file to be downloaded over FTP or HTTP."
8798 #: doc/guix.texi:3209
8800 "The @code{mirror://gnu} prefix instructs @code{url-fetch} to use one of the "
8801 "GNU mirrors defined in @code{(guix download)}."
8805 #: doc/guix.texi:3216
8807 "The @code{sha256} field specifies the expected SHA256 hash of the file being "
8808 "downloaded. It is mandatory, and allows Guix to check the integrity of the "
8809 "file. The @code{(base32 @dots{})} form introduces the base32 representation "
8810 "of the hash. You can obtain this information with @code{guix download} "
8811 "(@pxref{Invoking guix download}) and @code{guix hash} (@pxref{Invoking guix "
8816 #: doc/guix.texi:3217
8822 #: doc/guix.texi:3221
8824 "When needed, the @code{origin} form can also have a @code{patches} field "
8825 "listing patches to be applied, and a @code{snippet} field giving a Scheme "
8826 "expression to modify the source code."
8830 #: doc/guix.texi:3223
8832 msgid "GNU Build System"
8836 #: doc/guix.texi:3229
8838 "The @code{build-system} field specifies the procedure to build the package "
8839 "(@pxref{Build Systems}). Here, @var{gnu-build-system} represents the "
8840 "familiar GNU Build System, where packages may be configured, built, and "
8841 "installed with the usual @code{./configure && make && make check && make "
8842 "install} command sequence."
8846 #: doc/guix.texi:3235
8848 "The @code{arguments} field specifies options for the build system "
8849 "(@pxref{Build Systems}). Here it is interpreted by @var{gnu-build-system} "
8850 "as a request run @file{configure} with the @code{--enable-silent-rules} flag."
8854 #: doc/guix.texi:3236 doc/guix.texi:3239
8860 #: doc/guix.texi:3237
8866 #: doc/guix.texi:3238
8872 #: doc/guix.texi:3247
8874 "What about these quote (@code{'}) characters? They are Scheme syntax to "
8875 "introduce a literal list; @code{'} is synonymous with @code{quote}. "
8876 "@xref{Expression Syntax, quoting,, guile, GNU Guile Reference Manual}, for "
8877 "details. Here the value of the @code{arguments} field is a list of "
8878 "arguments passed to the build system down the road, as with @code{apply} "
8879 "(@pxref{Fly Evaluation, @code{apply},, guile, GNU Guile Reference Manual})."
8883 #: doc/guix.texi:3253
8885 "The hash-colon (@code{#:}) sequence defines a Scheme @dfn{keyword} "
8886 "(@pxref{Keywords,,, guile, GNU Guile Reference Manual}), and @code{#:"
8887 "configure-flags} is a keyword used to pass a keyword argument to the build "
8888 "system (@pxref{Coding With Keywords,,, guile, GNU Guile Reference Manual})."
8892 #: doc/guix.texi:3259
8894 "The @code{inputs} field specifies inputs to the build process---i.e., build-"
8895 "time or run-time dependencies of the package. Here, we define an input "
8896 "called @code{\"gawk\"} whose value is that of the @var{gawk} variable; "
8897 "@var{gawk} is itself bound to a @code{<package>} object."
8901 #: doc/guix.texi:3260
8903 msgid "backquote (quasiquote)"
8907 #: doc/guix.texi:3261
8913 #: doc/guix.texi:3262
8919 #: doc/guix.texi:3263
8921 msgid "comma (unquote)"
8925 #: doc/guix.texi:3264
8931 #: doc/guix.texi:3265
8937 #: doc/guix.texi:3266
8943 #: doc/guix.texi:3267
8945 msgid "unquote-splicing"
8949 #: doc/guix.texi:3273
8951 "Again, @code{`} (a backquote, synonymous with @code{quasiquote}) allows us "
8952 "to introduce a literal list in the @code{inputs} field, while @code{,} (a "
8953 "comma, synonymous with @code{unquote}) allows us to insert a value in that "
8954 "list (@pxref{Expression Syntax, unquote,, guile, GNU Guile Reference "
8959 #: doc/guix.texi:3277
8961 "Note that GCC, Coreutils, Bash, and other essential tools do not need to be "
8962 "specified as inputs here. Instead, @var{gnu-build-system} takes care of "
8963 "ensuring that they are present (@pxref{Build Systems})."
8967 #: doc/guix.texi:3281
8969 "However, any other dependencies need to be specified in the @code{inputs} "
8970 "field. Any dependency not specified here will simply be unavailable to the "
8971 "build process, possibly leading to a build failure."
8975 #: doc/guix.texi:3284
8976 msgid "@xref{package Reference}, for a full description of possible fields."
8980 #: doc/guix.texi:3295
8982 "Once a package definition is in place, the package may actually be built "
8983 "using the @code{guix build} command-line tool (@pxref{Invoking guix build}), "
8984 "troubleshooting any build failures you encounter (@pxref{Debugging Build "
8985 "Failures}). You can easily jump back to the package definition using the "
8986 "@command{guix edit} command (@pxref{Invoking guix edit}). @xref{Packaging "
8987 "Guidelines}, for more information on how to test package definitions, and "
8988 "@ref{Invoking guix lint}, for information on how to check a definition for "
8989 "style conformance."
8993 #: doc/guix.texi:3295
8995 msgid "GUIX_PACKAGE_PATH"
8999 #: doc/guix.texi:3299
9001 "Lastly, @pxref{Package Modules}, for information on how to extend the "
9002 "distribution by adding your own package definitions to "
9003 "@code{GUIX_PACKAGE_PATH}."
9007 #: doc/guix.texi:3303
9009 "Finally, updating the package definition to a new upstream version can be "
9010 "partly automated by the @command{guix refresh} command (@pxref{Invoking guix "
9015 #: doc/guix.texi:3309
9017 "Behind the scenes, a derivation corresponding to the @code{<package>} object "
9018 "is first computed by the @code{package-derivation} procedure. That "
9019 "derivation is stored in a @code{.drv} file under @file{/gnu/store}. The "
9020 "build actions it prescribes may then be realized by using the @code{build-"
9021 "derivations} procedure (@pxref{The Store})."
9025 #: doc/guix.texi:3310
9027 msgid "{Scheme Procedure} package-derivation @var{store} @var{package} [@var{system}]"
9031 #: doc/guix.texi:3313
9033 "Return the @code{<derivation>} object of @var{package} for @var{system} "
9034 "(@pxref{Derivations})."
9038 #: doc/guix.texi:3319
9040 "@var{package} must be a valid @code{<package>} object, and @var{system} must "
9041 "be a string denoting the target system type---e.g., @code{\"x86_64-linux\"} "
9042 "for an x86_64 Linux-based GNU system. @var{store} must be a connection to "
9043 "the daemon, which operates on the store (@pxref{The Store})."
9047 #: doc/guix.texi:3325
9049 "Similarly, it is possible to compute a derivation that cross-builds a "
9050 "package for some other system:"
9054 #: doc/guix.texi:3326
9056 msgid "{Scheme Procedure} package-cross-derivation @var{store} @"
9060 #: doc/guix.texi:3330
9062 "@var{package} @var{target} [@var{system}] Return the @code{<derivation>} "
9063 "object of @var{package} cross-built from @var{system} to @var{target}."
9067 #: doc/guix.texi:3335
9069 "@var{target} must be a valid GNU triplet denoting the target hardware and "
9070 "operating system, such as @code{\"mips64el-linux-gnu\"} "
9071 "(@pxref{Configuration Names, GNU configuration triplets,, configure, GNU "
9072 "Configure and Build System})."
9076 #: doc/guix.texi:3337
9078 msgid "package transformations"
9082 #: doc/guix.texi:3338
9084 msgid "input rewriting"
9088 #: doc/guix.texi:3339
9090 msgid "dependency tree rewriting"
9094 #: doc/guix.texi:3343
9096 "Packages can be manipulated in arbitrary ways. An example of a useful "
9097 "transformation is @dfn{input rewriting}, whereby the dependency tree of a "
9098 "package is rewritten by replacing specific inputs by others:"
9102 #: doc/guix.texi:3344
9104 msgid "{Scheme Procedure} package-input-rewriting @var{replacements} @"
9108 #: doc/guix.texi:3351
9110 "[@var{rewrite-name}] Return a procedure that, when passed a package, "
9111 "replaces its direct and indirect dependencies (but not its implicit inputs) "
9112 "according to @var{replacements}. @var{replacements} is a list of package "
9113 "pairs; the first element of each pair is the package to replace, and the "
9114 "second one is the replacement."
9118 #: doc/guix.texi:3354
9120 "Optionally, @var{rewrite-name} is a one-argument procedure that takes the "
9121 "name of a package and returns its new name after rewrite."
9125 #: doc/guix.texi:3358
9126 msgid "Consider this example:"
9130 #: doc/guix.texi:3364
9133 "(define libressl-instead-of-openssl\n"
9134 " ;; This is a procedure to replace OPENSSL by LIBRESSL,\n"
9135 " ;; recursively.\n"
9136 " (package-input-rewriting `((,openssl . ,libressl))))\n"
9141 #: doc/guix.texi:3367
9144 "(define git-with-libressl\n"
9145 " (libressl-instead-of-openssl git))\n"
9149 #: doc/guix.texi:3375
9151 "Here we first define a rewriting procedure that replaces @var{openssl} with "
9152 "@var{libressl}. Then we use it to define a @dfn{variant} of the @var{git} "
9153 "package that uses @var{libressl} instead of @var{openssl}. This is exactly "
9154 "what the @option{--with-input} command-line option does (@pxref{Package "
9155 "Transformation Options, @option{--with-input}})."
9159 #: doc/guix.texi:3379
9161 "A more generic procedure to rewrite a package dependency graph is "
9162 "@code{package-mapping}: it supports arbitrary changes to nodes in the graph."
9166 #: doc/guix.texi:3380
9168 msgid "{Scheme Procedure} package-mapping @var{proc} [@var{cut?}]"
9172 #: doc/guix.texi:3384
9174 "Return a procedure that, given a package, applies @var{proc} to all the "
9175 "packages depended on and returns the resulting package. The procedure stops "
9176 "recursion when @var{cut?} returns true for a given package."
9180 #: doc/guix.texi:3393
9182 msgid "@code{package} Reference"
9186 #: doc/guix.texi:3397
9188 "This section summarizes all the options available in @code{package} "
9189 "declarations (@pxref{Defining Packages})."
9193 #: doc/guix.texi:3398
9195 msgid "{Data Type} package"
9199 #: doc/guix.texi:3400
9200 msgid "This is the data type representing a package recipe."
9204 #: doc/guix.texi:3404
9205 msgid "The name of the package, as a string."
9209 #: doc/guix.texi:3405
9215 #: doc/guix.texi:3407
9216 msgid "The version of the package, as a string."
9220 #: doc/guix.texi:3408 doc/guix.texi:6743 doc/guix.texi:9281 doc/guix.texi:9569
9226 #: doc/guix.texi:3415
9228 "An object telling how the source code for the package should be acquired. "
9229 "Most of the time, this is an @code{origin} object, which denotes a file "
9230 "fetched from the Internet (@pxref{origin Reference}). It can also be any "
9231 "other ``file-like'' object such as a @code{local-file}, which denotes a file "
9232 "from the local file system (@pxref{G-Expressions, @code{local-file}})."
9236 #: doc/guix.texi:3416
9238 msgid "build-system"
9242 #: doc/guix.texi:3419
9244 "The build system that should be used to build the package (@pxref{Build "
9249 #: doc/guix.texi:3420 doc/guix.texi:11018
9251 msgid "@code{arguments} (default: @code{'()})"
9255 #: doc/guix.texi:3423
9257 "The arguments that should be passed to the build system. This is a list, "
9258 "typically containing sequential keyword-value pairs."
9262 #: doc/guix.texi:3424
9264 msgid "@code{inputs} (default: @code{'()})"
9268 #: doc/guix.texi:3425
9270 msgid "@code{native-inputs} (default: @code{'()})"
9274 #: doc/guix.texi:3426
9276 msgid "@code{propagated-inputs} (default: @code{'()})"
9280 #: doc/guix.texi:3427
9282 msgid "inputs, of packages"
9286 #: doc/guix.texi:3435
9288 "These fields list dependencies of the package. Each one is a list of "
9289 "tuples, where each tuple has a label for the input (a string) as its first "
9290 "element, a package, origin, or derivation as its second element, and "
9291 "optionally the name of the output thereof that should be used, which "
9292 "defaults to @code{\"out\"} (@pxref{Packages with Multiple Outputs}, for more "
9293 "on package outputs). For example, the list below specifies three inputs:"
9297 #: doc/guix.texi:3440
9300 "`((\"libffi\" ,libffi)\n"
9301 " (\"libunistring\" ,libunistring)\n"
9302 " (\"glib:bin\" ,glib \"bin\")) ;the \"bin\" output of Glib\n"
9306 #: doc/guix.texi:3442
9308 msgid "cross compilation, package dependencies"
9312 #: doc/guix.texi:3448
9314 "The distinction between @code{native-inputs} and @code{inputs} is necessary "
9315 "when considering cross-compilation. When cross-compiling, dependencies "
9316 "listed in @code{inputs} are built for the @emph{target} architecture; "
9317 "conversely, dependencies listed in @code{native-inputs} are built for the "
9318 "architecture of the @emph{build} machine."
9322 #: doc/guix.texi:3453
9324 "@code{native-inputs} is typically used to list tools needed at build time, "
9325 "but not at run time, such as Autoconf, Automake, pkg-config, Gettext, or "
9326 "Bison. @command{guix lint} can report likely mistakes in this area "
9327 "(@pxref{Invoking guix lint})."
9331 #: doc/guix.texi:3460
9332 msgid "package-propagated-inputs"
9336 #: doc/guix.texi:3460
9338 "Lastly, @code{propagated-inputs} is similar to @code{inputs}, but the "
9339 "specified packages will be automatically installed alongside the package "
9340 "they belong to (@pxref{package-cmd-propagated-inputs, @command{guix "
9341 "package}}, for information on how @command{guix package} deals with "
9342 "propagated inputs.)"
9346 #: doc/guix.texi:3464
9348 "For example this is necessary when a C/C++ library needs headers of another "
9349 "library to compile, or when a pkg-config file refers to another one @i{via} "
9350 "its @code{Requires} field."
9354 #: doc/guix.texi:3471
9356 "Another example where @code{propagated-inputs} is useful is for languages "
9357 "that lack a facility to record the run-time search path akin to the "
9358 "@code{RUNPATH} of ELF files; this includes Guile, Python, Perl, and more. "
9359 "To ensure that libraries written in those languages can find library code "
9360 "they depend on at run time, run-time dependencies must be listed in "
9361 "@code{propagated-inputs} rather than @code{inputs}."
9365 #: doc/guix.texi:3472
9367 msgid "@code{self-native-input?} (default: @code{#f})"
9371 #: doc/guix.texi:3475
9373 "This is a Boolean field telling whether the package should use itself as a "
9374 "native input when cross-compiling."
9378 #: doc/guix.texi:3476
9380 msgid "@code{outputs} (default: @code{'(\"out\")})"
9384 #: doc/guix.texi:3479
9386 "The list of output names of the package. @xref{Packages with Multiple "
9387 "Outputs}, for typical uses of additional outputs."
9391 #: doc/guix.texi:3480
9393 msgid "@code{native-search-paths} (default: @code{'()})"
9397 #: doc/guix.texi:3481
9399 msgid "@code{search-paths} (default: @code{'()})"
9403 #: doc/guix.texi:3484
9405 "A list of @code{search-path-specification} objects describing search-path "
9406 "environment variables honored by the package."
9410 #: doc/guix.texi:3485
9412 msgid "@code{replacement} (default: @code{#f})"
9416 #: doc/guix.texi:3489
9418 "This must be either @code{#f} or a package object that will be used as a "
9419 "@dfn{replacement} for this package. @xref{Security Updates, grafts}, for "
9424 #: doc/guix.texi:3490 doc/guix.texi:6735
9430 #: doc/guix.texi:3492
9431 msgid "A one-line description of the package."
9435 #: doc/guix.texi:3493 doc/guix.texi:6736 doc/guix.texi:21027
9441 #: doc/guix.texi:3495
9442 msgid "A more elaborate description of the package."
9446 #: doc/guix.texi:3496
9452 #: doc/guix.texi:3497
9454 msgid "license, of packages"
9458 #: doc/guix.texi:3500
9460 "The license of the package; a value from @code{(guix licenses)}, or a list "
9465 #: doc/guix.texi:3501 doc/guix.texi:6744
9471 #: doc/guix.texi:3503
9472 msgid "The URL to the home-page of the package, as a string."
9476 #: doc/guix.texi:3504
9478 msgid "@code{supported-systems} (default: @var{%supported-systems})"
9482 #: doc/guix.texi:3507
9484 "The list of systems supported by the package, as strings of the form "
9485 "@code{architecture-kernel}, for example @code{\"x86_64-linux\"}."
9489 #: doc/guix.texi:3508
9491 msgid "@code{maintainers} (default: @code{'()})"
9495 #: doc/guix.texi:3510
9496 msgid "The list of maintainers of the package, as @code{maintainer} objects."
9500 #: doc/guix.texi:3511
9502 msgid "@code{location} (default: source location of the @code{package} form)"
9506 #: doc/guix.texi:3515
9508 "The source location of the package. It is useful to override this when "
9509 "inheriting from another package, in which case this field is not "
9510 "automatically corrected."
9514 #: doc/guix.texi:3520
9516 msgid "@code{origin} Reference"
9520 #: doc/guix.texi:3524
9522 "This section summarizes all the options available in @code{origin} "
9523 "declarations (@pxref{Defining Packages})."
9527 #: doc/guix.texi:3525
9529 msgid "{Data Type} origin"
9533 #: doc/guix.texi:3527
9534 msgid "This is the data type representing a source code origin."
9538 #: doc/guix.texi:3529 doc/guix.texi:15696
9544 #: doc/guix.texi:3534
9546 "An object containing the URI of the source. The object type depends on the "
9547 "@code{method} (see below). For example, when using the @var{url-fetch} "
9548 "method of @code{(guix download)}, the valid @code{uri} values are: a URL "
9549 "represented as a string, or a list thereof."
9553 #: doc/guix.texi:3535
9559 #: doc/guix.texi:3537
9560 msgid "A procedure that handles the URI."
9564 #: doc/guix.texi:3539
9565 msgid "Examples include:"
9569 #: doc/guix.texi:3541
9571 msgid "@var{url-fetch} from @code{(guix download)}"
9575 #: doc/guix.texi:3544
9577 "download a file from the HTTP, HTTPS, or FTP URL specified in the @code{uri} "
9582 #: doc/guix.texi:3545 doc/guix.texi:6097
9588 #: doc/guix.texi:3546
9590 msgid "@var{git-fetch} from @code{(guix git-download)}"
9594 #: doc/guix.texi:3550
9596 "clone the Git version control repository, and check out the revision "
9597 "specified in the @code{uri} field as a @code{git-reference} object; a "
9598 "@code{git-reference} looks like this:"
9602 #: doc/guix.texi:3555
9606 " (url \"git://git.debian.org/git/pkg-shadow/shadow\")\n"
9607 " (commit \"v4.1.5.1\"))\n"
9611 #: doc/guix.texi:3558
9617 #: doc/guix.texi:3562
9619 "A bytevector containing the SHA-256 hash of the source. Typically the "
9620 "@code{base32} form is used here to generate the bytevector from a base-32 "
9625 #: doc/guix.texi:3566
9627 "You can obtain this information using @code{guix download} (@pxref{Invoking "
9628 "guix download}) or @code{guix hash} (@pxref{Invoking guix hash})."
9632 #: doc/guix.texi:3567
9634 msgid "@code{file-name} (default: @code{#f})"
9638 #: doc/guix.texi:3573
9640 "The file name under which the source code should be saved. When this is "
9641 "@code{#f}, a sensible default value will be used in most cases. In case the "
9642 "source is fetched from a URL, the file name from the URL will be used. For "
9643 "version control checkouts, it is recommended to provide the file name "
9644 "explicitly because the default is not very descriptive."
9648 #: doc/guix.texi:3574
9650 msgid "@code{patches} (default: @code{'()})"
9654 #: doc/guix.texi:3577
9656 "A list of file names, origins, or file-like objects (@pxref{G-Expressions, "
9657 "file-like objects}) pointing to patches to be applied to the source."
9661 #: doc/guix.texi:3581
9663 "This list of patches must be unconditional. In particular, it cannot depend "
9664 "on the value of @code{%current-system} or @code{%current-target-system}."
9668 #: doc/guix.texi:3582
9670 msgid "@code{snippet} (default: @code{#f})"
9674 #: doc/guix.texi:3586
9676 "A G-expression (@pxref{G-Expressions}) or S-expression that will be run in "
9677 "the source directory. This is a convenient way to modify the source, "
9678 "sometimes more convenient than a patch."
9682 #: doc/guix.texi:3587
9684 msgid "@code{patch-flags} (default: @code{'(\"-p1\")})"
9688 #: doc/guix.texi:3590
9690 "A list of command-line flags that should be passed to the @code{patch} "
9695 #: doc/guix.texi:3591
9697 msgid "@code{patch-inputs} (default: @code{#f})"
9701 #: doc/guix.texi:3595
9703 "Input packages or derivations to the patching process. When this is "
9704 "@code{#f}, the usual set of inputs necessary for patching are provided, such "
9705 "as GNU@tie{}Patch."
9709 #: doc/guix.texi:3596
9711 msgid "@code{modules} (default: @code{'()})"
9715 #: doc/guix.texi:3599
9717 "A list of Guile modules that should be loaded during the patching process "
9718 "and while running the code in the @code{snippet} field."
9722 #: doc/guix.texi:3600
9724 msgid "@code{patch-guile} (default: @code{#f})"
9728 #: doc/guix.texi:3603
9730 "The Guile package that should be used in the patching process. When this is "
9731 "@code{#f}, a sensible default is used."
9735 #: doc/guix.texi:3610
9737 msgid "build system"
9741 #: doc/guix.texi:3615
9743 "Each package definition specifies a @dfn{build system} and arguments for "
9744 "that build system (@pxref{Defining Packages}). This @code{build-system} "
9745 "field represents the build procedure of the package, as well as implicit "
9746 "dependencies of that build procedure."
9750 #: doc/guix.texi:3619
9752 "Build systems are @code{<build-system>} objects. The interface to create "
9753 "and manipulate them is provided by the @code{(guix build-system)} module, "
9754 "and actual build systems are exported by specific modules."
9758 #: doc/guix.texi:3620
9760 msgid "bag (low-level package representation)"
9764 #: doc/guix.texi:3627
9766 "Under the hood, build systems first compile package objects to @dfn{bags}. "
9767 "A @dfn{bag} is like a package, but with less ornamentation---in other words, "
9768 "a bag is a lower-level representation of a package, which includes all the "
9769 "inputs of that package, including some that were implicitly added by the "
9770 "build system. This intermediate representation is then compiled to a "
9771 "derivation (@pxref{Derivations})."
9775 #: doc/guix.texi:3635
9777 "Build systems accept an optional list of @dfn{arguments}. In package "
9778 "definitions, these are passed @i{via} the @code{arguments} field "
9779 "(@pxref{Defining Packages}). They are typically keyword arguments "
9780 "(@pxref{Optional Arguments, keyword arguments in Guile,, guile, GNU Guile "
9781 "Reference Manual}). The value of these arguments is usually evaluated in "
9782 "the @dfn{build stratum}---i.e., by a Guile process launched by the daemon "
9783 "(@pxref{Derivations})."
9787 #: doc/guix.texi:3639
9789 "The main build system is @var{gnu-build-system}, which implements the "
9790 "standard build procedure for GNU and many other packages. It is provided by "
9791 "the @code{(guix build-system gnu)} module."
9795 #: doc/guix.texi:3640
9797 msgid "{Scheme Variable} gnu-build-system"
9801 #: doc/guix.texi:3644
9803 "@var{gnu-build-system} represents the GNU Build System, and variants thereof "
9804 "(@pxref{Configuration, configuration and makefile conventions,, standards, "
9805 "GNU Coding Standards})."
9809 #: doc/guix.texi:3645
9811 msgid "build phases"
9815 #: doc/guix.texi:3652
9817 "In a nutshell, packages using it are configured, built, and installed with "
9818 "the usual @code{./configure && make && make check && make install} command "
9819 "sequence. In practice, a few additional steps are often needed. All these "
9820 "steps are split up in separate @dfn{phases}, notably@footnote{Please see the "
9821 "@code{(guix build gnu-build-system)} modules for more details about the "
9826 #: doc/guix.texi:3654
9832 #: doc/guix.texi:3658
9834 "Unpack the source tarball, and change the current directory to the extracted "
9835 "source tree. If the source is actually a directory, copy it to the build "
9836 "tree, and enter that directory."
9840 #: doc/guix.texi:3659
9842 msgid "patch-source-shebangs"
9846 #: doc/guix.texi:3663
9848 "Patch shebangs encountered in source files so they refer to the right store "
9849 "file names. For instance, this changes @code{#!/bin/sh} to @code{#!/gnu/"
9850 "store/@dots{}-bash-4.3/bin/sh}."
9854 #: doc/guix.texi:3664 doc/guix.texi:4130
9860 #: doc/guix.texi:3668
9862 "Run the @file{configure} script with a number of default options, such as "
9863 "@code{--prefix=/gnu/store/@dots{}}, as well as the options specified by the "
9864 "@code{#:configure-flags} argument."
9868 #: doc/guix.texi:3669 doc/guix.texi:4135 doc/guix.texi:20437
9874 #: doc/guix.texi:3673
9876 "Run @code{make} with the list of flags specified with @code{#:make-flags}. "
9877 "If the @code{#:parallel-build?} argument is true (the default), build with "
9882 #: doc/guix.texi:3674 doc/guix.texi:4139
9888 #: doc/guix.texi:3679
9890 "Run @code{make check}, or some other target specified with @code{#:test-"
9891 "target}, unless @code{#:tests? #f} is passed. If the @code{#:parallel-"
9892 "tests?} argument is true (the default), run @code{make check -j}."
9896 #: doc/guix.texi:3680 doc/guix.texi:4143
9902 #: doc/guix.texi:3682
9903 msgid "Run @code{make install} with the flags listed in @code{#:make-flags}."
9907 #: doc/guix.texi:3683
9909 msgid "patch-shebangs"
9913 #: doc/guix.texi:3685
9914 msgid "Patch shebangs on the installed executable files."
9918 #: doc/guix.texi:3686
9924 #: doc/guix.texi:3690
9926 "Strip debugging symbols from ELF files (unless @code{#:strip-binaries?} is "
9927 "false), copying them to the @code{debug} output when available "
9928 "(@pxref{Installing Debugging Files})."
9932 #: doc/guix.texi:3692
9934 msgid "%standard-phases"
9938 #: doc/guix.texi:3697
9940 "The build-side module @code{(guix build gnu-build-system)} defines "
9941 "@var{%standard-phases} as the default list of build phases. @var{%standard-"
9942 "phases} is a list of symbol/procedure pairs, where the procedure implements "
9947 #: doc/guix.texi:3700
9949 "The list of phases used for a particular package can be changed with the "
9950 "@code{#:phases} parameter. For instance, passing:"
9954 #: doc/guix.texi:3703
9956 msgid "#:phases (modify-phases %standard-phases (delete 'configure))\n"
9960 #: doc/guix.texi:3707
9962 "means that all the phases described above will be used, except the "
9963 "@code{configure} phase."
9967 #: doc/guix.texi:3714
9969 "In addition, this build system ensures that the ``standard'' environment for "
9970 "GNU packages is available. This includes tools such as GCC, libc, "
9971 "Coreutils, Bash, Make, Diffutils, grep, and sed (see the @code{(guix build-"
9972 "system gnu)} module for a complete list). We call these the @dfn{implicit "
9973 "inputs} of a package, because package definitions do not have to mention "
9978 #: doc/guix.texi:3721
9980 "Other @code{<build-system>} objects are defined to support other conventions "
9981 "and tools used by free software packages. They inherit most of @var{gnu-"
9982 "build-system}, and differ mainly in the set of inputs implicitly added to "
9983 "the build process, and in the list of phases executed. Some of these build "
9984 "systems are listed below."
9988 #: doc/guix.texi:3722
9990 msgid "{Scheme Variable} ant-build-system"
9994 #: doc/guix.texi:3726
9996 "This variable is exported by @code{(guix build-system ant)}. It implements "
9997 "the build procedure for Java packages that can be built with @url{http://ant."
9998 "apache.org/, Ant build tool}."
10002 #: doc/guix.texi:3731
10004 "It adds both @code{ant} and the @dfn{Java Development Kit} (JDK) as provided "
10005 "by the @code{icedtea} package to the set of inputs. Different packages can "
10006 "be specified with the @code{#:ant} and @code{#:jdk} parameters, respectively."
10010 #: doc/guix.texi:3737
10012 "When the original package does not provide a suitable Ant build file, the "
10013 "parameter @code{#:jar-name} can be used to generate a minimal Ant build file "
10014 "@file{build.xml} with tasks to build the specified jar archive. In this "
10015 "case the parameter @code{#:source-dir} can be used to specify the source sub-"
10016 "directory, defaulting to ``src''."
10020 #: doc/guix.texi:3745
10022 "The @code{#:main-class} parameter can be used with the minimal ant buildfile "
10023 "to specify the main class of the resulting jar. This makes the jar file "
10024 "executable. The @code{#:test-include} parameter can be used to specify the "
10025 "list of junit tests to run. It defaults to @code{(list \"**/*Test.java\")}. "
10026 "The @code{#:test-exclude} can be used to disable some tests. It defaults to "
10027 "@code{(list \"**/Abstract*.java\")}, because abstract classes cannot be run "
10032 #: doc/guix.texi:3749
10034 "The parameter @code{#:build-target} can be used to specify the Ant task that "
10035 "should be run during the @code{build} phase. By default the ``jar'' task "
10040 #: doc/guix.texi:3752
10042 msgid "{Scheme Variable} asdf-build-system/source"
10046 #: doc/guix.texi:3753
10048 msgid "{Scheme Variable} asdf-build-system/sbcl"
10052 #: doc/guix.texi:3754
10054 msgid "{Scheme Variable} asdf-build-system/ecl"
10058 #: doc/guix.texi:3760
10060 "These variables, exported by @code{(guix build-system asdf)}, implement "
10061 "build procedures for Common Lisp packages using @url{https://common-lisp.net/"
10062 "project/asdf/, ``ASDF''}. ASDF is a system definition facility for Common "
10063 "Lisp programs and libraries."
10067 #: doc/guix.texi:3767
10069 "The @code{asdf-build-system/source} system installs the packages in source "
10070 "form, and can be loaded using any common lisp implementation, via ASDF. The "
10071 "others, such as @code{asdf-build-system/sbcl}, install binary systems in the "
10072 "format which a particular implementation understands. These build systems "
10073 "can also be used to produce executable programs, or lisp images which "
10074 "contain a set of packages pre-loaded."
10078 #: doc/guix.texi:3771
10080 "The build system uses naming conventions. For binary packages, the package "
10081 "name should be prefixed with the lisp implementation, such as @code{sbcl-} "
10082 "for @code{asdf-build-system/sbcl}."
10086 #: doc/guix.texi:3775
10088 "Additionally, the corresponding source package should be labeled using the "
10089 "same convention as python packages (see @ref{Python Modules}), using the "
10090 "@code{cl-} prefix."
10094 #: doc/guix.texi:3780
10096 "For binary packages, each system should be defined as a Guix package. If "
10097 "one package @code{origin} contains several systems, package variants can be "
10098 "created in order to build all the systems. Source packages, which use "
10099 "@code{asdf-build-system/source}, may contain several systems."
10103 #: doc/guix.texi:3787
10105 "In order to create executable programs and images, the build-side procedures "
10106 "@code{build-program} and @code{build-image} can be used. They should be "
10107 "called in a build phase after the @code{create-symlinks} phase, so that the "
10108 "system which was just built can be used within the resulting image. "
10109 "@code{build-program} requires a list of Common Lisp expressions to be passed "
10110 "as the @code{#:entry-program} argument."
10114 #: doc/guix.texi:3796
10116 "If the system is not defined within its own @code{.asd} file of the same "
10117 "name, then the @code{#:asd-file} parameter should be used to specify which "
10118 "file the system is defined in. Furthermore, if the package defines a system "
10119 "for its tests in a separate file, it will be loaded before the tests are run "
10120 "if it is specified by the @code{#:test-asd-file} parameter. If it is not "
10121 "set, the files @code{<system>-tests.asd}, @code{<system>-test.asd}, "
10122 "@code{tests.asd}, and @code{test.asd} will be tried if they exist."
10126 #: doc/guix.texi:3800
10128 "If for some reason the package must be named in a different way than the "
10129 "naming conventions suggest, the @code{#:asd-system-name} parameter can be "
10130 "used to specify the name of the system."
10134 #: doc/guix.texi:3803
10136 msgid "{Scheme Variable} cargo-build-system"
10140 #: doc/guix.texi:3804
10142 msgid "Rust programming language"
10146 #: doc/guix.texi:3805
10148 msgid "Cargo (Rust build system)"
10152 #: doc/guix.texi:3809
10154 "This variable is exported by @code{(guix build-system cargo)}. It supports "
10155 "builds of packages using Cargo, the build tool of the @uref{https://www.rust-"
10156 "lang.org, Rust programming language}."
10160 #: doc/guix.texi:3814
10162 "In its @code{configure} phase, this build system replaces dependencies "
10163 "specified in the @file{Carto.toml} file with inputs to the Guix package. "
10164 "The @code{install} phase installs the binaries, and it also installs the "
10165 "source code and @file{Cargo.toml} file."
10169 #: doc/guix.texi:3816
10171 msgid "{Scheme Variable} cmake-build-system"
10175 #: doc/guix.texi:3820
10177 "This variable is exported by @code{(guix build-system cmake)}. It "
10178 "implements the build procedure for packages using the @url{http://www.cmake."
10179 "org, CMake build tool}."
10183 #: doc/guix.texi:3824
10185 "It automatically adds the @code{cmake} package to the set of inputs. Which "
10186 "package is used can be specified with the @code{#:cmake} parameter."
10190 #: doc/guix.texi:3831
10192 "The @code{#:configure-flags} parameter is taken as a list of flags passed to "
10193 "the @command{cmake} command. The @code{#:build-type} parameter specifies in "
10194 "abstract terms the flags passed to the compiler; it defaults to "
10195 "@code{\"RelWithDebInfo\"} (short for ``release mode with debugging "
10196 "information''), which roughly means that code is compiled with @code{-O2 -"
10197 "g}, as is the case for Autoconf-based packages by default."
10201 #: doc/guix.texi:3833
10203 msgid "{Scheme Variable} go-build-system"
10207 #: doc/guix.texi:3838
10209 "This variable is exported by @code{(guix build-system go)}. It implements a "
10210 "build procedure for Go packages using the standard @url{https://golang.org/"
10211 "cmd/go/#hdr-Compile_packages_and_dependencies, Go build mechanisms}."
10215 #: doc/guix.texi:3849
10217 "The user is expected to provide a value for the key @code{#:import-path} "
10218 "and, in some cases, @code{#:unpack-path}. The @url{https://golang.org/doc/"
10219 "code.html#ImportPaths, import path} corresponds to the file system path "
10220 "expected by the package's build scripts and any referring packages, and "
10221 "provides a unique way to refer to a Go package. It is typically based on a "
10222 "combination of the package source code's remote URI and file system "
10223 "hierarchy structure. In some cases, you will need to unpack the package's "
10224 "source code to a different directory structure than the one indicated by the "
10225 "import path, and @code{#:unpack-path} should be used in such cases."
10229 #: doc/guix.texi:3854
10231 "Packages that provide Go libraries should be installed along with their "
10232 "source code. The key @code{#:install-source?}, which defaults to @code{#t}, "
10233 "controls whether or not the source code is installed. It can be set to "
10234 "@code{#f} for packages that only provide executable files."
10238 #: doc/guix.texi:3856
10240 msgid "{Scheme Variable} glib-or-gtk-build-system"
10244 #: doc/guix.texi:3859
10246 "This variable is exported by @code{(guix build-system glib-or-gtk)}. It is "
10247 "intended for use with packages making use of GLib or GTK+."
10251 #: doc/guix.texi:3862
10253 "This build system adds the following two phases to the ones defined by "
10254 "@var{gnu-build-system}:"
10258 #: doc/guix.texi:3864 doc/guix.texi:4159
10260 msgid "glib-or-gtk-wrap"
10264 #: doc/guix.texi:3871
10266 "The phase @code{glib-or-gtk-wrap} ensures that programs in @file{bin/} are "
10267 "able to find GLib ``schemas'' and @uref{https://developer.gnome.org/gtk3/"
10268 "stable/gtk-running.html, GTK+ modules}. This is achieved by wrapping the "
10269 "programs in launch scripts that appropriately set the @code{XDG_DATA_DIRS} "
10270 "and @code{GTK_PATH} environment variables."
10274 #: doc/guix.texi:3878
10276 "It is possible to exclude specific package outputs from that wrapping "
10277 "process by listing their names in the @code{#:glib-or-gtk-wrap-excluded-"
10278 "outputs} parameter. This is useful when an output is known not to contain "
10279 "any GLib or GTK+ binaries, and where wrapping would gratuitously add a "
10280 "dependency of that output on GLib and GTK+."
10284 #: doc/guix.texi:3879 doc/guix.texi:4163
10286 msgid "glib-or-gtk-compile-schemas"
10290 #: doc/guix.texi:3887
10292 "The phase @code{glib-or-gtk-compile-schemas} makes sure that all "
10293 "@uref{https://developer.gnome.org/gio/stable/glib-compile-schemas.html, "
10294 "GSettings schemas} of GLib are compiled. Compilation is performed by the "
10295 "@command{glib-compile-schemas} program. It is provided by the package "
10296 "@code{glib:bin} which is automatically imported by the build system. The "
10297 "@code{glib} package providing @command{glib-compile-schemas} can be "
10298 "specified with the @code{#:glib} parameter."
10302 #: doc/guix.texi:3890
10303 msgid "Both phases are executed after the @code{install} phase."
10307 #: doc/guix.texi:3892
10309 msgid "{Scheme Variable} minify-build-system"
10313 #: doc/guix.texi:3895
10315 "This variable is exported by @code{(guix build-system minify)}. It "
10316 "implements a minification procedure for simple JavaScript packages."
10320 #: doc/guix.texi:3901
10322 "It adds @code{uglify-js} to the set of inputs and uses it to compress all "
10323 "JavaScript files in the @file{src} directory. A different minifier package "
10324 "can be specified with the @code{#:uglify-js} parameter, but it is expected "
10325 "that the package writes the minified code to the standard output."
10329 #: doc/guix.texi:3905
10331 "When the input JavaScript files are not all located in the @file{src} "
10332 "directory, the parameter @code{#:javascript-files} can be used to specify a "
10333 "list of file names to feed to the minifier."
10337 #: doc/guix.texi:3907
10339 msgid "{Scheme Variable} ocaml-build-system"
10343 #: doc/guix.texi:3913
10345 "This variable is exported by @code{(guix build-system ocaml)}. It "
10346 "implements a build procedure for @uref{https://ocaml.org, OCaml} packages, "
10347 "which consists of choosing the correct set of commands to run for each "
10348 "package. OCaml packages can expect many different commands to be run. This "
10349 "build system will try some of them."
10353 #: doc/guix.texi:3923
10355 "When the package has a @file{setup.ml} file present at the top-level, it "
10356 "will run @code{ocaml setup.ml -configure}, @code{ocaml setup.ml -build} and "
10357 "@code{ocaml setup.ml -install}. The build system will assume that this file "
10358 "was generated by @uref{http://oasis.forge.ocamlcore.org/, OASIS} and will "
10359 "take care of setting the prefix and enabling tests if they are not "
10360 "disabled. You can pass configure and build flags with the @code{#:configure-"
10361 "flags} and @code{#:build-flags}. The @code{#:test-flags} key can be passed "
10362 "to change the set of flags used to enable tests. The @code{#:use-make?} key "
10363 "can be used to bypass this system in the build and install phases."
10367 #: doc/guix.texi:3928
10369 "When the package has a @file{configure} file, it is assumed that it is a "
10370 "hand-made configure script that requires a different argument format than in "
10371 "the @code{gnu-build-system}. You can add more flags with the @code{#:"
10372 "configure-flags} key."
10376 #: doc/guix.texi:3932
10378 "When the package has a @file{Makefile} file (or @code{#:use-make?} is "
10379 "@code{#t}), it will be used and more flags can be passed to the build and "
10380 "install phases with the @code{#:make-flags} key."
10384 #: doc/guix.texi:3940
10386 "Finally, some packages do not have these files and use a somewhat standard "
10387 "location for its build system. In that case, the build system will run "
10388 "@code{ocaml pkg/pkg.ml} or @code{ocaml pkg/build.ml} and take care of "
10389 "providing the path to the required findlib module. Additional flags can be "
10390 "passed via the @code{#:build-flags} key. Install is taken care of by "
10391 "@command{opam-installer}. In this case, the @code{opam} package must be "
10392 "added to the @code{native-inputs} field of the package definition."
10396 #: doc/guix.texi:3948
10398 "Note that most OCaml packages assume they will be installed in the same "
10399 "directory as OCaml, which is not what we want in guix. In particular, they "
10400 "will install @file{.so} files in their module's directory, which is usually "
10401 "fine because it is in the OCaml compiler directory. In guix though, these "
10402 "libraries cannot be found and we use @code{CAML_LD_LIBRARY_PATH}. This "
10403 "variable points to @file{lib/ocaml/site-lib/stubslibs} and this is where "
10404 "@file{.so} libraries should be installed."
10408 #: doc/guix.texi:3950
10410 msgid "{Scheme Variable} python-build-system"
10414 #: doc/guix.texi:3955
10416 "This variable is exported by @code{(guix build-system python)}. It "
10417 "implements the more or less standard build procedure used by Python "
10418 "packages, which consists in running @code{python setup.py build} and then "
10419 "@code{python setup.py install --prefix=/gnu/store/@dots{}}."
10423 #: doc/guix.texi:3959
10425 "For packages that install stand-alone Python programs under @code{bin/}, it "
10426 "takes care of wrapping these programs so that their @code{PYTHONPATH} "
10427 "environment variable points to all the Python libraries they depend on."
10431 #: doc/guix.texi:3965
10433 "Which Python package is used to perform the build can be specified with the "
10434 "@code{#:python} parameter. This is a useful way to force a package to be "
10435 "built for a specific version of the Python interpreter, which might be "
10436 "necessary if the package is only compatible with a single interpreter "
10441 #: doc/guix.texi:3970
10443 "By default guix calls @code{setup.py} under control of @code{setuptools}, "
10444 "much like @command{pip} does. Some packages are not compatible with "
10445 "setuptools (and pip), thus you can disable this by setting the @code{#:use-"
10446 "setuptools} parameter to @code{#f}."
10450 #: doc/guix.texi:3972
10452 msgid "{Scheme Variable} perl-build-system"
10456 #: doc/guix.texi:3984
10458 "This variable is exported by @code{(guix build-system perl)}. It implements "
10459 "the standard build procedure for Perl packages, which either consists in "
10460 "running @code{perl Build.PL --prefix=/gnu/store/@dots{}}, followed by "
10461 "@code{Build} and @code{Build install}; or in running @code{perl Makefile.PL "
10462 "PREFIX=/gnu/store/@dots{}}, followed by @code{make} and @code{make install}, "
10463 "depending on which of @code{Build.PL} or @code{Makefile.PL} is present in "
10464 "the package distribution. Preference is given to the former if both "
10465 "@code{Build.PL} and @code{Makefile.PL} exist in the package distribution. "
10466 "This preference can be reversed by specifying @code{#t} for the @code{#:make-"
10467 "maker?} parameter."
10471 #: doc/guix.texi:3988
10473 "The initial @code{perl Makefile.PL} or @code{perl Build.PL} invocation "
10474 "passes flags specified by the @code{#:make-maker-flags} or @code{#:module-"
10475 "build-flags} parameter, respectively."
10479 #: doc/guix.texi:3990
10480 msgid "Which Perl package is used can be specified with @code{#:perl}."
10484 #: doc/guix.texi:3992
10486 msgid "{Scheme Variable} r-build-system"
10490 #: doc/guix.texi:4000
10492 "This variable is exported by @code{(guix build-system r)}. It implements "
10493 "the build procedure used by @uref{http://r-project.org, R} packages, which "
10494 "essentially is little more than running @code{R CMD INSTALL --library=/gnu/"
10495 "store/@dots{}} in an environment where @code{R_LIBS_SITE} contains the paths "
10496 "to all R package inputs. Tests are run after installation using the R "
10497 "function @code{tools::testInstalledPackage}."
10501 #: doc/guix.texi:4002
10503 msgid "{Scheme Variable} texlive-build-system"
10507 #: doc/guix.texi:4007
10509 "This variable is exported by @code{(guix build-system texlive)}. It is used "
10510 "to build TeX packages in batch mode with a specified engine. The build "
10511 "system sets the @code{TEXINPUTS} variable to find all TeX source files in "
10516 #: doc/guix.texi:4016
10518 "By default it runs @code{luatex} on all files ending on @code{ins}. A "
10519 "different engine and format can be specified with the @code{#:tex-format} "
10520 "argument. Different build targets can be specified with the @code{#:build-"
10521 "targets} argument, which expects a list of file names. The build system "
10522 "adds only @code{texlive-bin} and @code{texlive-latex-base} (both from "
10523 "@code{(gnu packages tex}) to the inputs. Both can be overridden with the "
10524 "arguments @code{#:texlive-bin} and @code{#:texlive-latex-base}, respectively."
10528 #: doc/guix.texi:4019
10530 "The @code{#:tex-directory} parameter tells the build system where to install "
10531 "the built files under the texmf tree."
10535 #: doc/guix.texi:4021
10537 msgid "{Scheme Variable} ruby-build-system"
10541 #: doc/guix.texi:4025
10543 "This variable is exported by @code{(guix build-system ruby)}. It implements "
10544 "the RubyGems build procedure used by Ruby packages, which involves running "
10545 "@code{gem build} followed by @code{gem install}."
10549 #: doc/guix.texi:4033
10551 "The @code{source} field of a package that uses this build system typically "
10552 "references a gem archive, since this is the format that Ruby developers use "
10553 "when releasing their software. The build system unpacks the gem archive, "
10554 "potentially patches the source, runs the test suite, repackages the gem, and "
10555 "installs it. Additionally, directories and tarballs may be referenced to "
10556 "allow building unreleased gems from Git or a traditional source release "
10561 #: doc/guix.texi:4037
10563 "Which Ruby package is used can be specified with the @code{#:ruby} "
10564 "parameter. A list of additional flags to be passed to the @command{gem} "
10565 "command can be specified with the @code{#:gem-flags} parameter."
10569 #: doc/guix.texi:4039
10571 msgid "{Scheme Variable} waf-build-system"
10575 #: doc/guix.texi:4045
10577 "This variable is exported by @code{(guix build-system waf)}. It implements "
10578 "a build procedure around the @code{waf} script. The common phases---"
10579 "@code{configure}, @code{build}, and @code{install}---are implemented by "
10580 "passing their names as arguments to the @code{waf} script."
10584 #: doc/guix.texi:4049
10586 "The @code{waf} script is executed by the Python interpreter. Which Python "
10587 "package is used to run the script can be specified with the @code{#:python} "
10592 #: doc/guix.texi:4051
10594 msgid "{Scheme Variable} scons-build-system"
10598 #: doc/guix.texi:4057
10600 "This variable is exported by @code{(guix build-system scons)}. It "
10601 "implements the build procedure used by the SCons software construction "
10602 "tool. This build system runs @code{scons} to build the package, @code{scons "
10603 "test} to run tests, and then @code{scons install} to install the package."
10607 #: doc/guix.texi:4062
10609 "Additional flags to be passed to @code{scons} can be specified with the "
10610 "@code{#:scons-flags} parameter. The version of Python used to run SCons can "
10611 "be specified by selecting the appropriate SCons package with the @code{#:"
10612 "scons} parameter."
10616 #: doc/guix.texi:4064
10618 msgid "{Scheme Variable} haskell-build-system"
10622 #: doc/guix.texi:4078
10624 "This variable is exported by @code{(guix build-system haskell)}. It "
10625 "implements the Cabal build procedure used by Haskell packages, which "
10626 "involves running @code{runhaskell Setup.hs configure --prefix=/gnu/store/"
10627 "@dots{}} and @code{runhaskell Setup.hs build}. Instead of installing the "
10628 "package by running @code{runhaskell Setup.hs install}, to avoid trying to "
10629 "register libraries in the read-only compiler store directory, the build "
10630 "system uses @code{runhaskell Setup.hs copy}, followed by @code{runhaskell "
10631 "Setup.hs register}. In addition, the build system generates the package "
10632 "documentation by running @code{runhaskell Setup.hs haddock}, unless @code{#:"
10633 "haddock? #f} is passed. Optional Haddock parameters can be passed with the "
10634 "help of the @code{#:haddock-flags} parameter. If the file @code{Setup.hs} "
10635 "is not found, the build system looks for @code{Setup.lhs} instead."
10639 #: doc/guix.texi:4081
10641 "Which Haskell compiler is used can be specified with the @code{#:haskell} "
10642 "parameter which defaults to @code{ghc}."
10646 #: doc/guix.texi:4083
10648 msgid "{Scheme Variable} dub-build-system"
10652 #: doc/guix.texi:4088
10654 "This variable is exported by @code{(guix build-system dub)}. It implements "
10655 "the Dub build procedure used by D packages, which involves running @code{dub "
10656 "build} and @code{dub run}. Installation is done by copying the files "
10661 #: doc/guix.texi:4091
10663 "Which D compiler is used can be specified with the @code{#:ldc} parameter "
10664 "which defaults to @code{ldc}."
10668 #: doc/guix.texi:4093
10670 msgid "{Scheme Variable} emacs-build-system"
10674 #: doc/guix.texi:4097
10676 "This variable is exported by @code{(guix build-system emacs)}. It "
10677 "implements an installation procedure similar to the packaging system of "
10678 "Emacs itself (@pxref{Packages,,, emacs, The GNU Emacs Manual})."
10682 #: doc/guix.texi:4104
10684 "It first creates the @code{@var{package}-autoloads.el} file, then it byte "
10685 "compiles all Emacs Lisp files. Differently from the Emacs packaging system, "
10686 "the Info documentation files are moved to the standard documentation "
10687 "directory and the @file{dir} file is deleted. Each package is installed in "
10688 "its own directory under @file{share/emacs/site-lisp/guix.d}."
10692 #: doc/guix.texi:4106
10694 msgid "{Scheme Variable} font-build-system"
10698 #: doc/guix.texi:4112
10700 "This variable is exported by @code{(guix build-system font)}. It implements "
10701 "an installation procedure for font packages where upstream provides pre-"
10702 "compiled TrueType, OpenType, etc. font files that merely need to be copied "
10703 "into place. It copies font files to standard locations in the output "
10708 #: doc/guix.texi:4114
10710 msgid "{Scheme Variable} meson-build-system"
10714 #: doc/guix.texi:4118
10716 "This variable is exported by @code{(guix build-system meson)}. It "
10717 "implements the build procedure for packages that use @url{http://mesonbuild."
10718 "com, Meson} as their build system."
10722 #: doc/guix.texi:4124
10724 "It adds both Meson and @uref{https://ninja-build.org/, Ninja} to the set of "
10725 "inputs, and they can be changed with the parameters @code{#:meson} and "
10726 "@code{#:ninja} if needed. The default Meson is @code{meson-for-build}, "
10727 "which is special because it doesn't clear the @code{RUNPATH} of binaries and "
10728 "libraries when they are installed."
10732 #: doc/guix.texi:4127
10734 "This build system is an extension of @var{gnu-build-system}, but with the "
10735 "following phases changed to some specific for Meson:"
10739 #: doc/guix.texi:4134
10741 "The phase runs @code{meson} with the flags specified in @code{#:configure-"
10742 "flags}. The flag @code{--build-type} is always set to @code{plain} unless "
10743 "something else is specified in @code{#:build-type}."
10747 #: doc/guix.texi:4138
10749 "The phase runs @code{ninja} to build the package in parallel by default, but "
10750 "this can be changed with @code{#:parallel-build?}."
10754 #: doc/guix.texi:4142
10756 "The phase runs @code{ninja} with the target specified in @code{#:test-"
10757 "target}, which is @code{\"test\"} by default."
10761 #: doc/guix.texi:4145
10762 msgid "The phase runs @code{ninja install} and can not be changed."
10766 #: doc/guix.texi:4148
10767 msgid "Apart from that, the build system also adds the following phases:"
10771 #: doc/guix.texi:4151
10773 msgid "fix-runpath"
10777 #: doc/guix.texi:4158
10779 "This phase ensures that all binaries can find the libraries they need. It "
10780 "searches for required libraries in subdirectories of the package being "
10781 "built, and adds those to @code{RUNPATH} where needed. It also removes "
10782 "references to libraries left over from the build phase by @code{meson-for-"
10783 "build}, such as test dependencies, that aren't actually required for the "
10788 #: doc/guix.texi:4162 doc/guix.texi:4166
10790 "This phase is the phase provided by @code{glib-or-gtk-build-system}, and it "
10791 "is not enabled by default. It can be enabled with @code{#:glib-or-gtk?}."
10794 #. type: Plain text
10795 #: doc/guix.texi:4173
10797 "Lastly, for packages that do not need anything as sophisticated, a "
10798 "``trivial'' build system is provided. It is trivial in the sense that it "
10799 "provides basically no support: it does not pull any implicit inputs, and "
10800 "does not have a notion of build phases."
10804 #: doc/guix.texi:4174
10806 msgid "{Scheme Variable} trivial-build-system"
10810 #: doc/guix.texi:4176
10811 msgid "This variable is exported by @code{(guix build-system trivial)}."
10815 #: doc/guix.texi:4181
10817 "This build system requires a @code{#:builder} argument. This argument must "
10818 "be a Scheme expression that builds the package output(s)---as with "
10819 "@code{build-expression->derivation} (@pxref{Derivations, @code{build-"
10820 "expression->derivation}})."
10824 #: doc/guix.texi:4187
10826 msgid "store items"
10830 #: doc/guix.texi:4188
10832 msgid "store paths"
10835 #. type: Plain text
10836 #: doc/guix.texi:4199
10838 "Conceptually, the @dfn{store} is the place where derivations that have been "
10839 "built successfully are stored---by default, @file{/gnu/store}. Sub-"
10840 "directories in the store are referred to as @dfn{store items} or sometimes "
10841 "@dfn{store paths}. The store has an associated database that contains "
10842 "information such as the store paths referred to by each store path, and the "
10843 "list of @emph{valid} store items---results of successful builds. This "
10844 "database resides in @file{@var{localstatedir}/guix/db}, where "
10845 "@var{localstatedir} is the state directory specified @i{via} @option{--"
10846 "localstatedir} at configure time, usually @file{/var}."
10849 #. type: Plain text
10850 #: doc/guix.texi:4204
10852 "The store is @emph{always} accessed by the daemon on behalf of its clients "
10853 "(@pxref{Invoking guix-daemon}). To manipulate the store, clients connect to "
10854 "the daemon over a Unix-domain socket, send requests to it, and read the "
10855 "result---these are remote procedure calls, or RPCs."
10859 #: doc/guix.texi:4209
10861 "Users must @emph{never} modify files under @file{/gnu/store} directly. This "
10862 "would lead to inconsistencies and break the immutability assumptions of "
10863 "Guix's functional model (@pxref{Introduction})."
10867 #: doc/guix.texi:4213
10869 "@xref{Invoking guix gc, @command{guix gc --verify}}, for information on how "
10870 "to check the integrity of the store and attempt recovery from accidental "
10874 #. type: Plain text
10875 #: doc/guix.texi:4220
10877 "The @code{(guix store)} module provides procedures to connect to the daemon, "
10878 "and to perform RPCs. These are described below. By default, @code{open-"
10879 "connection}, and thus all the @command{guix} commands, connect to the local "
10880 "daemon or to the URI specified by the @code{GUIX_DAEMON_SOCKET} environment "
10885 #: doc/guix.texi:4221
10887 msgid "{Environment Variable} GUIX_DAEMON_SOCKET"
10891 #: doc/guix.texi:4226
10893 "When set, the value of this variable should be a file name or a URI "
10894 "designating the daemon endpoint. When it is a file name, it denotes a Unix-"
10895 "domain socket to connect to. In addition to file names, the supported URI "
10900 #: doc/guix.texi:4228 doc/guix.texi:15406
10906 #: doc/guix.texi:4229
10912 #: doc/guix.texi:4233
10914 "These are for Unix-domain sockets. @code{file:///var/guix/daemon-socket/"
10915 "socket} is equivalent to @file{/var/guix/daemon-socket/socket}."
10919 #: doc/guix.texi:4234
10925 #: doc/guix.texi:4242
10927 "These URIs denote connections over TCP/IP, without encryption nor "
10928 "authentication of the remote host. The URI must specify the host name and "
10929 "optionally a port number (by default port 44146 is used):"
10933 #: doc/guix.texi:4245
10935 msgid "guix://master.guix.example.org:1234\n"
10939 #: doc/guix.texi:4250
10941 "This setup is suitable on local networks, such as clusters, where only "
10942 "trusted nodes may connect to the build daemon at @code{master.guix.example."
10947 #: doc/guix.texi:4254
10949 "The @code{--listen} option of @command{guix-daemon} can be used to instruct "
10950 "it to listen for TCP connections (@pxref{Invoking guix-daemon, @code{--"
10955 #: doc/guix.texi:4255
10961 #: doc/guix.texi:4256
10963 msgid "SSH access to build daemons"
10967 #: doc/guix.texi:4260
10969 "These URIs allow you to connect to a remote daemon over SSH@footnote{This "
10970 "feature requires Guile-SSH (@pxref{Requirements}).}. A typical URL might "
10975 #: doc/guix.texi:4263
10977 msgid "ssh://charlie@@guix.example.org:22\n"
10981 #: doc/guix.texi:4267
10983 "As for @command{guix copy}, the usual OpenSSH client configuration files are "
10984 "honored (@pxref{Invoking guix copy})."
10988 #: doc/guix.texi:4270
10989 msgid "Additional URI schemes may be supported in the future."
10993 #: doc/guix.texi:4277
10995 "The ability to connect to remote build daemons is considered experimental as "
10996 "of @value{VERSION}. Please get in touch with us to share any problems or "
10997 "suggestions you may have (@pxref{Contributing})."
11001 #: doc/guix.texi:4280
11003 msgid "{Scheme Procedure} open-connection [@var{uri}] [#:reserve-space? #t]"
11007 #: doc/guix.texi:4285
11009 "Connect to the daemon over the Unix-domain socket at @var{uri} (a string). "
11010 "When @var{reserve-space?} is true, instruct it to reserve a little bit of "
11011 "extra space on the file system so that the garbage collector can still "
11012 "operate should the disk become full. Return a server object."
11016 #: doc/guix.texi:4288
11018 "@var{file} defaults to @var{%default-socket-path}, which is the normal "
11019 "location given the options that were passed to @command{configure}."
11023 #: doc/guix.texi:4290
11025 msgid "{Scheme Procedure} close-connection @var{server}"
11029 #: doc/guix.texi:4292
11030 msgid "Close the connection to @var{server}."
11034 #: doc/guix.texi:4294
11036 msgid "{Scheme Variable} current-build-output-port"
11040 #: doc/guix.texi:4297
11042 "This variable is bound to a SRFI-39 parameter, which refers to the port "
11043 "where build and error logs sent by the daemon should be written."
11046 #. type: Plain text
11047 #: doc/guix.texi:4301
11049 "Procedures that make RPCs all take a server object as their first argument."
11053 #: doc/guix.texi:4302
11055 msgid "{Scheme Procedure} valid-path? @var{server} @var{path}"
11059 #: doc/guix.texi:4303
11061 msgid "invalid store items"
11065 #: doc/guix.texi:4308
11067 "Return @code{#t} when @var{path} designates a valid store item and @code{#f} "
11068 "otherwise (an invalid item may exist on disk but still be invalid, for "
11069 "instance because it is the result of an aborted or failed build.)"
11073 #: doc/guix.texi:4311
11075 "A @code{&nix-protocol-error} condition is raised if @var{path} is not "
11076 "prefixed by the store directory (@file{/gnu/store})."
11080 #: doc/guix.texi:4313
11082 msgid "{Scheme Procedure} add-text-to-store @var{server} @var{name} @var{text} [@var{references}]"
11086 #: doc/guix.texi:4317
11088 "Add @var{text} under file @var{name} in the store, and return its store "
11089 "path. @var{references} is the list of store paths referred to by the "
11090 "resulting store path."
11094 #: doc/guix.texi:4319
11096 msgid "{Scheme Procedure} build-derivations @var{server} @var{derivations}"
11100 #: doc/guix.texi:4323
11102 "Build @var{derivations} (a list of @code{<derivation>} objects or derivation "
11103 "paths), and return when the worker is done building them. Return @code{#t} "
11107 #. type: Plain text
11108 #: doc/guix.texi:4329
11110 "Note that the @code{(guix monads)} module provides a monad as well as "
11111 "monadic versions of the above procedures, with the goal of making it more "
11112 "convenient to work with code that accesses the store (@pxref{The Store "
11117 #: doc/guix.texi:4332
11118 msgid "This section is currently incomplete."
11122 #: doc/guix.texi:4336
11124 msgid "derivations"
11127 #. type: Plain text
11128 #: doc/guix.texi:4340
11130 "Low-level build actions and the environment in which they are performed are "
11131 "represented by @dfn{derivations}. A derivation contains the following "
11132 "pieces of information:"
11136 #: doc/guix.texi:4345
11138 "The outputs of the derivation---derivations produce at least one file or "
11139 "directory in the store, but may produce more."
11143 #: doc/guix.texi:4349
11145 "The inputs of the derivations, which may be other derivations or plain files "
11146 "in the store (patches, build scripts, etc.)"
11150 #: doc/guix.texi:4352
11151 msgid "The system type targeted by the derivation---e.g., @code{x86_64-linux}."
11155 #: doc/guix.texi:4356
11157 "The file name of a build script in the store, along with the arguments to be "
11162 #: doc/guix.texi:4359
11163 msgid "A list of environment variables to be defined."
11167 #: doc/guix.texi:4362
11169 msgid "derivation path"
11172 #. type: Plain text
11173 #: doc/guix.texi:4370
11175 "Derivations allow clients of the daemon to communicate build actions to the "
11176 "store. They exist in two forms: as an in-memory representation, both on the "
11177 "client- and daemon-side, and as files in the store whose name end in @code{."
11178 "drv}---these files are referred to as @dfn{derivation paths}. Derivations "
11179 "paths can be passed to the @code{build-derivations} procedure to perform the "
11180 "build actions they prescribe (@pxref{The Store})."
11184 #: doc/guix.texi:4371
11186 msgid "fixed-output derivations"
11189 #. type: Plain text
11190 #: doc/guix.texi:4378
11192 "Operations such as file downloads and version-control checkouts for which "
11193 "the expected content hash is known in advance are modeled as @dfn{fixed-"
11194 "output derivations}. Unlike regular derivations, the outputs of a fixed-"
11195 "output derivation are independent of its inputs---e.g., a source code "
11196 "download produces the same result regardless of the download method and "
11197 "tools being used."
11200 #. type: Plain text
11201 #: doc/guix.texi:4383
11203 "The @code{(guix derivations)} module provides a representation of "
11204 "derivations as Scheme objects, along with procedures to create and otherwise "
11205 "manipulate derivations. The lowest-level primitive to create a derivation "
11206 "is the @code{derivation} procedure:"
11210 #: doc/guix.texi:4384
11212 msgid "{Scheme Procedure} derivation @var{store} @var{name} @var{builder} @"
11213 msgstr "{Scheme Procedure} derivation @var{store} @var{name} @var{builder} @"
11216 #: doc/guix.texi:4393
11218 "@var{args} [#:outputs '(\"out\")] [#:hash #f] [#:hash-algo #f] @ [#:"
11219 "recursive? #f] [#:inputs '()] [#:env-vars '()] @ [#:system (%current-"
11220 "system)] [#:references-graphs #f] @ [#:allowed-references #f] [#:disallowed-"
11221 "references #f] @ [#:leaked-env-vars #f] [#:local-build? #f] @ [#:"
11222 "substitutable? #t] Build a derivation with the given arguments, and return "
11223 "the resulting @code{<derivation>} object."
11225 "@var{args} [#:outputs '(\"out\")] [#:hash #f] [#:hash-algo #f] @ [#:"
11226 "recursive? #f] [#:inputs '()] [#:env-vars '()] @ [#:system (%current-"
11227 "system)] [#:references-graphs #f] @ [#:allowed-references #f] [#:disallowed-"
11228 "references #f] @ [#:leaked-env-vars #f] [#:local-build? #f] @ [#:"
11229 "substitutable? #t] Construit une dérivation avec les arguments donnés et "
11230 "renvie l'objet @code{<derivation>} obtenu."
11233 #: doc/guix.texi:4400
11235 "When @var{hash} and @var{hash-algo} are given, a @dfn{fixed-output "
11236 "derivation} is created---i.e., one whose result is known in advance, such as "
11237 "a file download. If, in addition, @var{recursive?} is true, then that fixed "
11238 "output may be an executable file or a directory and @var{hash} must be the "
11239 "hash of an archive containing this output."
11243 #: doc/guix.texi:4405
11245 "When @var{references-graphs} is true, it must be a list of file name/store "
11246 "path pairs. In that case, the reference graph of each store path is "
11247 "exported in the build environment in the corresponding file, in a simple "
11252 #: doc/guix.texi:4410
11254 "When @var{allowed-references} is true, it must be a list of store items or "
11255 "outputs that the derivation's output may refer to. Likewise, "
11256 "@var{disallowed-references}, if true, must be a list of things the outputs "
11257 "may @emph{not} refer to."
11261 #: doc/guix.texi:4417
11263 "When @var{leaked-env-vars} is true, it must be a list of strings denoting "
11264 "environment variables that are allowed to ``leak'' from the daemon's "
11265 "environment to the build environment. This is only applicable to fixed-"
11266 "output derivations---i.e., when @var{hash} is true. The main use is to "
11267 "allow variables such as @code{http_proxy} to be passed to derivations that "
11272 #: doc/guix.texi:4422
11274 "When @var{local-build?} is true, declare that the derivation is not a good "
11275 "candidate for offloading and should rather be built locally (@pxref{Daemon "
11276 "Offload Setup}). This is the case for small derivations where the costs of "
11277 "data transfers would outweigh the benefits."
11281 #: doc/guix.texi:4427
11283 "When @var{substitutable?} is false, declare that substitutes of the "
11284 "derivation's output should not be used (@pxref{Substitutes}). This is "
11285 "useful, for instance, when building packages that capture details of the "
11286 "host CPU instruction set."
11288 "Lorsque que @var{substitutable?} est faux, déclare que les substituts de la "
11289 "sortie de la dérivation ne devraient pas être utilisés (@pxref{Substituts}). "
11290 "Cela est utile par exemple pour construire des paquets qui utilisent des "
11291 "détails du jeu d'instruction du CPU hôte."
11293 #. type: Plain text
11294 #: doc/guix.texi:4433
11296 "Here's an example with a shell script as its builder, assuming @var{store} "
11297 "is an open connection to the daemon, and @var{bash} points to a Bash "
11298 "executable in the store:"
11302 #: doc/guix.texi:4438
11305 "(use-modules (guix utils)\n"
11307 " (guix derivations))\n"
11312 #: doc/guix.texi:4447
11315 "(let ((builder ; add the Bash script to the store\n"
11316 " (add-text-to-store store \"my-builder.sh\"\n"
11317 " \"echo hello world > $out\\n\" '())))\n"
11318 " (derivation store \"foo\"\n"
11319 " bash `(\"-e\" ,builder)\n"
11320 " #:inputs `((,bash) (,builder))\n"
11321 " #:env-vars '((\"HOME\" . \"/homeless\"))))\n"
11322 "@result{} #<derivation /gnu/store/@dots{}-foo.drv => /gnu/store/@dots{}-foo>\n"
11325 #. type: Plain text
11326 #: doc/guix.texi:4454
11328 "As can be guessed, this primitive is cumbersome to use directly. A better "
11329 "approach is to write build scripts in Scheme, of course! The best course of "
11330 "action for that is to write the build code as a ``G-expression'', and to "
11331 "pass it to @code{gexp->derivation}. For more information, @pxref{G-"
11335 #. type: Plain text
11336 #: doc/guix.texi:4459
11338 "Once upon a time, @code{gexp->derivation} did not exist and constructing "
11339 "derivations with build code written in Scheme was achieved with @code{build-"
11340 "expression->derivation}, documented below. This procedure is now deprecated "
11341 "in favor of the much nicer @code{gexp->derivation}."
11345 #: doc/guix.texi:4460
11347 msgid "{Scheme Procedure} build-expression->derivation @var{store} @"
11351 #: doc/guix.texi:4476
11353 "@var{name} @var{exp} @ [#:system (%current-system)] [#:inputs '()] @ [#:"
11354 "outputs '(\"out\")] [#:hash #f] [#:hash-algo #f] @ [#:recursive? #f] [#:env-"
11355 "vars '()] [#:modules '()] @ [#:references-graphs #f] [#:allowed-references "
11356 "#f] @ [#:disallowed-references #f] @ [#:local-build? #f] [#:substitutable? "
11357 "#t] [#:guile-for-build #f] Return a derivation that executes Scheme "
11358 "expression @var{exp} as a builder for derivation @var{name}. @var{inputs} "
11359 "must be a list of @code{(name drv-path sub-drv)} tuples; when @var{sub-drv} "
11360 "is omitted, @code{\"out\"} is assumed. @var{modules} is a list of names of "
11361 "Guile modules from the current search path to be copied in the store, "
11362 "compiled, and made available in the load path during the execution of "
11363 "@var{exp}---e.g., @code{((guix build utils) (guix build gnu-build-system))}."
11367 #: doc/guix.texi:4484
11369 "@var{exp} is evaluated in an environment where @code{%outputs} is bound to a "
11370 "list of output/path pairs, and where @code{%build-inputs} is bound to a list "
11371 "of string/output-path pairs made from @var{inputs}. Optionally, @var{env-"
11372 "vars} is a list of string pairs specifying the name and value of environment "
11373 "variables visible to the builder. The builder terminates by passing the "
11374 "result of @var{exp} to @code{exit}; thus, when @var{exp} returns @code{#f}, "
11375 "the build is considered to have failed."
11379 #: doc/guix.texi:4488
11381 "@var{exp} is built using @var{guile-for-build} (a derivation). When "
11382 "@var{guile-for-build} is omitted or is @code{#f}, the value of the "
11383 "@code{%guile-for-build} fluid is used instead."
11387 #: doc/guix.texi:4493
11389 "See the @code{derivation} procedure for the meaning of @var{references-"
11390 "graphs}, @var{allowed-references}, @var{disallowed-references}, @var{local-"
11391 "build?}, and @var{substitutable?}."
11394 #. type: Plain text
11395 #: doc/guix.texi:4498
11397 "Here's an example of a single-output derivation that creates a directory "
11398 "containing one file:"
11402 #: doc/guix.texi:4506
11405 "(let ((builder '(let ((out (assoc-ref %outputs \"out\")))\n"
11406 " (mkdir out) ; create /gnu/store/@dots{}-goo\n"
11407 " (call-with-output-file (string-append out \"/test\")\n"
11409 " (display '(hello guix) p))))))\n"
11410 " (build-expression->derivation store \"goo\" builder))\n"
11415 #: doc/guix.texi:4508
11417 msgid "@result{} #<derivation /gnu/store/@dots{}-goo.drv => @dots{}>\n"
11421 #: doc/guix.texi:4514
11426 #. type: Plain text
11427 #: doc/guix.texi:4520
11429 "The procedures that operate on the store described in the previous sections "
11430 "all take an open connection to the build daemon as their first argument. "
11431 "Although the underlying model is functional, they either have side effects "
11432 "or depend on the current state of the store."
11435 #. type: Plain text
11436 #: doc/guix.texi:4526
11438 "The former is inconvenient: the connection to the build daemon has to be "
11439 "carried around in all those functions, making it impossible to compose "
11440 "functions that do not take that parameter with functions that do. The "
11441 "latter can be problematic: since store operations have side effects and/or "
11442 "depend on external state, they have to be properly sequenced."
11446 #: doc/guix.texi:4527
11448 msgid "monadic values"
11452 #: doc/guix.texi:4528
11454 msgid "monadic functions"
11457 #. type: Plain text
11458 #: doc/guix.texi:4538
11460 "This is where the @code{(guix monads)} module comes in. This module "
11461 "provides a framework for working with @dfn{monads}, and a particularly "
11462 "useful monad for our uses, the @dfn{store monad}. Monads are a construct "
11463 "that allows two things: associating ``context'' with values (in our case, "
11464 "the context is the store), and building sequences of computations (here "
11465 "computations include accesses to the store). Values in a monad---values "
11466 "that carry this additional context---are called @dfn{monadic values}; "
11467 "procedures that return such values are called @dfn{monadic procedures}."
11470 #. type: Plain text
11471 #: doc/guix.texi:4540
11472 msgid "Consider this ``normal'' procedure:"
11476 #: doc/guix.texi:4549
11479 "(define (sh-symlink store)\n"
11480 " ;; Return a derivation that symlinks the 'bash' executable.\n"
11481 " (let* ((drv (package-derivation store bash))\n"
11482 " (out (derivation->output-path drv))\n"
11483 " (sh (string-append out \"/bin/bash\")))\n"
11484 " (build-expression->derivation store \"sh\"\n"
11485 " `(symlink ,sh %output))))\n"
11488 #. type: Plain text
11489 #: doc/guix.texi:4553
11491 "Using @code{(guix monads)} and @code{(guix gexp)}, it may be rewritten as a "
11492 "monadic function:"
11496 #: doc/guix.texi:4561
11499 "(define (sh-symlink)\n"
11500 " ;; Same, but return a monadic value.\n"
11501 " (mlet %store-monad ((drv (package->derivation bash)))\n"
11502 " (gexp->derivation \"sh\"\n"
11503 " #~(symlink (string-append #$drv \"/bin/bash\")\n"
11507 #. type: Plain text
11508 #: doc/guix.texi:4568
11510 "There are several things to note in the second version: the @code{store} "
11511 "parameter is now implicit and is ``threaded'' in the calls to the "
11512 "@code{package->derivation} and @code{gexp->derivation} monadic procedures, "
11513 "and the monadic value returned by @code{package->derivation} is @dfn{bound} "
11514 "using @code{mlet} instead of plain @code{let}."
11517 #. type: Plain text
11518 #: doc/guix.texi:4572
11520 "As it turns out, the call to @code{package->derivation} can even be omitted "
11521 "since it will take place implicitly, as we will see later (@pxref{G-"
11526 #: doc/guix.texi:4578
11529 "(define (sh-symlink)\n"
11530 " (gexp->derivation \"sh\"\n"
11531 " #~(symlink (string-append #$bash \"/bin/bash\")\n"
11535 #. type: Plain text
11536 #: doc/guix.texi:4587
11538 "Calling the monadic @code{sh-symlink} has no effect. As someone once said, "
11539 "``you exit a monad like you exit a building on fire: by running''. So, to "
11540 "exit the monad and get the desired effect, one must use @code{run-with-"
11545 #: doc/guix.texi:4591
11548 "(run-with-store (open-connection) (sh-symlink))\n"
11549 "@result{} /gnu/store/...-sh-symlink\n"
11552 #. type: Plain text
11553 #: doc/guix.texi:4597
11555 "Note that the @code{(guix monad-repl)} module extends the Guile REPL with "
11556 "new ``meta-commands'' to make it easier to deal with monadic procedures: "
11557 "@code{run-in-store}, and @code{enter-store-monad}. The former is used to "
11558 "``run'' a single monadic value through the store:"
11562 #: doc/guix.texi:4601
11565 "scheme@@(guile-user)> ,run-in-store (package->derivation hello)\n"
11566 "$1 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}>\n"
11569 #. type: Plain text
11570 #: doc/guix.texi:4605
11572 "The latter enters a recursive REPL, where all the return values are "
11573 "automatically run through the store:"
11577 #: doc/guix.texi:4614
11580 "scheme@@(guile-user)> ,enter-store-monad\n"
11581 "store-monad@@(guile-user) [1]> (package->derivation hello)\n"
11582 "$2 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}>\n"
11583 "store-monad@@(guile-user) [1]> (text-file \"foo\" \"Hello!\")\n"
11584 "$3 = \"/gnu/store/@dots{}-foo\"\n"
11585 "store-monad@@(guile-user) [1]> ,q\n"
11586 "scheme@@(guile-user)>\n"
11589 #. type: Plain text
11590 #: doc/guix.texi:4619
11592 "Note that non-monadic values cannot be returned in the @code{store-monad} "
11596 #. type: Plain text
11597 #: doc/guix.texi:4622
11599 "The main syntactic forms to deal with monads in general are provided by the "
11600 "@code{(guix monads)} module and are described below."
11604 #: doc/guix.texi:4623
11606 msgid "{Scheme Syntax} with-monad @var{monad} @var{body} ..."
11610 #: doc/guix.texi:4626
11612 "Evaluate any @code{>>=} or @code{return} forms in @var{body} as being in "
11617 #: doc/guix.texi:4628
11619 msgid "{Scheme Syntax} return @var{val}"
11623 #: doc/guix.texi:4630
11624 msgid "Return a monadic value that encapsulates @var{val}."
11628 #: doc/guix.texi:4632
11630 msgid "{Scheme Syntax} >>= @var{mval} @var{mproc} ..."
11634 #: doc/guix.texi:4639
11636 "@dfn{Bind} monadic value @var{mval}, passing its ``contents'' to monadic "
11637 "procedures @var{mproc}@dots{}@footnote{This operation is commonly referred "
11638 "to as ``bind'', but that name denotes an unrelated procedure in Guile. Thus "
11639 "we use this somewhat cryptic symbol inherited from the Haskell language.}. "
11640 "There can be one @var{mproc} or several of them, as in this example:"
11644 #: doc/guix.texi:4647
11647 "(run-with-state\n"
11648 " (with-monad %state-monad\n"
11649 " (>>= (return 1)\n"
11650 " (lambda (x) (return (+ 1 x)))\n"
11651 " (lambda (x) (return (* 2 x)))))\n"
11657 #: doc/guix.texi:4650
11661 "@result{} some-state\n"
11665 #: doc/guix.texi:4653
11667 msgid "{Scheme Syntax} mlet @var{monad} ((@var{var} @var{mval}) ...) @"
11671 #: doc/guix.texi:4655
11672 msgid "@var{body} ..."
11676 #: doc/guix.texi:4655
11678 msgid "{Scheme Syntax} mlet* @var{monad} ((@var{var} @var{mval}) ...) @"
11682 #: doc/guix.texi:4667
11684 "@var{body} ... Bind the variables @var{var} to the monadic values "
11685 "@var{mval} in @var{body}, which is a sequence of expressions. As with the "
11686 "bind operator, this can be thought of as ``unpacking'' the raw, non-monadic "
11687 "value ``contained'' in @var{mval} and making @var{var} refer to that raw, "
11688 "non-monadic value within the scope of the @var{body}. The form (@var{var} -"
11689 "> @var{val}) binds @var{var} to the ``normal'' value @var{val}, as per "
11690 "@code{let}. The binding operations occur in sequence from left to right. "
11691 "The last expression of @var{body} must be a monadic expression, and its "
11692 "result will become the result of the @code{mlet} or @code{mlet*} when run in "
11697 #: doc/guix.texi:4670
11699 "@code{mlet*} is to @code{mlet} what @code{let*} is to @code{let} "
11700 "(@pxref{Local Bindings,,, guile, GNU Guile Reference Manual})."
11704 #: doc/guix.texi:4672
11706 msgid "{Scheme System} mbegin @var{monad} @var{mexp} ..."
11710 #: doc/guix.texi:4676
11712 "Bind @var{mexp} and the following monadic expressions in sequence, returning "
11713 "the result of the last expression. Every expression in the sequence must be "
11714 "a monadic expression."
11718 #: doc/guix.texi:4680
11720 "This is akin to @code{mlet}, except that the return values of the monadic "
11721 "expressions are ignored. In that sense, it is analogous to @code{begin}, "
11722 "but applied to monadic expressions."
11726 #: doc/guix.texi:4682
11728 msgid "{Scheme System} mwhen @var{condition} @var{mexp0} @var{mexp*} ..."
11732 #: doc/guix.texi:4687
11734 "When @var{condition} is true, evaluate the sequence of monadic expressions "
11735 "@var{mexp0}..@var{mexp*} as in an @code{mbegin}. When @var{condition} is "
11736 "false, return @code{*unspecified*} in the current monad. Every expression "
11737 "in the sequence must be a monadic expression."
11741 #: doc/guix.texi:4689
11743 msgid "{Scheme System} munless @var{condition} @var{mexp0} @var{mexp*} ..."
11747 #: doc/guix.texi:4694
11749 "When @var{condition} is false, evaluate the sequence of monadic expressions "
11750 "@var{mexp0}..@var{mexp*} as in an @code{mbegin}. When @var{condition} is "
11751 "true, return @code{*unspecified*} in the current monad. Every expression in "
11752 "the sequence must be a monadic expression."
11756 #: doc/guix.texi:4696
11758 msgid "state monad"
11761 #. type: Plain text
11762 #: doc/guix.texi:4700
11764 "The @code{(guix monads)} module provides the @dfn{state monad}, which allows "
11765 "an additional value---the state---to be @emph{threaded} through monadic "
11770 #: doc/guix.texi:4701
11772 msgid "{Scheme Variable} %state-monad"
11776 #: doc/guix.texi:4704
11778 "The state monad. Procedures in the state monad can access and change the "
11779 "state that is threaded."
11783 #: doc/guix.texi:4708
11785 "Consider the example below. The @code{square} procedure returns a value in "
11786 "the state monad. It returns the square of its argument, but also increments "
11787 "the current state value:"
11791 #: doc/guix.texi:4715
11794 "(define (square x)\n"
11795 " (mlet %state-monad ((count (current-state)))\n"
11796 " (mbegin %state-monad\n"
11797 " (set-current-state (+ 1 count))\n"
11798 " (return (* x x)))))\n"
11803 #: doc/guix.texi:4719
11806 "(run-with-state (sequence %state-monad (map square (iota 3))) 0)\n"
11807 "@result{} (0 1 4)\n"
11812 #: doc/guix.texi:4723
11814 "When ``run'' through @var{%state-monad}, we obtain that additional state "
11815 "value, which is the number of @code{square} calls."
11819 #: doc/guix.texi:4725
11821 msgid "{Monadic Procedure} current-state"
11825 #: doc/guix.texi:4727
11826 msgid "Return the current state as a monadic value."
11830 #: doc/guix.texi:4729
11832 msgid "{Monadic Procedure} set-current-state @var{value}"
11836 #: doc/guix.texi:4732
11838 "Set the current state to @var{value} and return the previous state as a "
11843 #: doc/guix.texi:4734
11845 msgid "{Monadic Procedure} state-push @var{value}"
11849 #: doc/guix.texi:4737
11851 "Push @var{value} to the current state, which is assumed to be a list, and "
11852 "return the previous state as a monadic value."
11856 #: doc/guix.texi:4739
11858 msgid "{Monadic Procedure} state-pop"
11862 #: doc/guix.texi:4742
11864 "Pop a value from the current state and return it as a monadic value. The "
11865 "state is assumed to be a list."
11869 #: doc/guix.texi:4744
11871 msgid "{Scheme Procedure} run-with-state @var{mval} [@var{state}]"
11875 #: doc/guix.texi:4747
11877 "Run monadic value @var{mval} starting with @var{state} as the initial "
11878 "state. Return two values: the resulting value, and the resulting state."
11881 #. type: Plain text
11882 #: doc/guix.texi:4751
11884 "The main interface to the store monad, provided by the @code{(guix store)} "
11885 "module, is as follows."
11889 #: doc/guix.texi:4752
11891 msgid "{Scheme Variable} %store-monad"
11895 #: doc/guix.texi:4754
11896 msgid "The store monad---an alias for @var{%state-monad}."
11900 #: doc/guix.texi:4758
11902 "Values in the store monad encapsulate accesses to the store. When its "
11903 "effect is needed, a value of the store monad must be ``evaluated'' by "
11904 "passing it to the @code{run-with-store} procedure (see below.)"
11908 #: doc/guix.texi:4760
11910 msgid "{Scheme Procedure} run-with-store @var{store} @var{mval} [#:guile-for-build] [#:system (%current-system)]"
11914 #: doc/guix.texi:4763
11916 "Run @var{mval}, a monadic value in the store monad, in @var{store}, an open "
11917 "store connection."
11921 #: doc/guix.texi:4765
11923 msgid "{Monadic Procedure} text-file @var{name} @var{text} [@var{references}]"
11927 #: doc/guix.texi:4769
11929 "Return as a monadic value the absolute file name in the store of the file "
11930 "containing @var{text}, a string. @var{references} is a list of store items "
11931 "that the resulting text file refers to; it defaults to the empty list."
11935 #: doc/guix.texi:4771
11937 msgid "{Monadic Procedure} interned-file @var{file} [@var{name}] @"
11941 #: doc/guix.texi:4776
11943 "[#:recursive? #t] [#:select? (const #t)] Return the name of @var{file} once "
11944 "interned in the store. Use @var{name} as its store name, or the basename of "
11945 "@var{file} if @var{name} is omitted."
11949 #: doc/guix.texi:4780 doc/guix.texi:5159
11951 "When @var{recursive?} is true, the contents of @var{file} are added "
11952 "recursively; if @var{file} designates a flat file and @var{recursive?} is "
11953 "true, its contents are added, and its permission bits are kept."
11957 #: doc/guix.texi:4785 doc/guix.texi:5164
11959 "When @var{recursive?} is true, call @code{(@var{select?} @var{file} "
11960 "@var{stat})} for each directory entry, where @var{file} is the entry's "
11961 "absolute file name and @var{stat} is the result of @code{lstat}; exclude "
11962 "entries for which @var{select?} does not return true."
11966 #: doc/guix.texi:4787
11967 msgid "The example below adds a file to the store, under two different names:"
11971 #: doc/guix.texi:4793
11974 "(run-with-store (open-connection)\n"
11975 " (mlet %store-monad ((a (interned-file \"README\"))\n"
11976 " (b (interned-file \"README\" \"LEGU-MIN\")))\n"
11977 " (return (list a b))))\n"
11982 #: doc/guix.texi:4795
11984 msgid "@result{} (\"/gnu/store/rwm@dots{}-README\" \"/gnu/store/44i@dots{}-LEGU-MIN\")\n"
11987 #. type: Plain text
11988 #: doc/guix.texi:4801
11990 "The @code{(guix packages)} module exports the following package-related "
11991 "monadic procedures:"
11995 #: doc/guix.texi:4802
11997 msgid "{Monadic Procedure} package-file @var{package} [@var{file}] @"
12001 #: doc/guix.texi:4810
12003 "[#:system (%current-system)] [#:target #f] @ [#:output \"out\"] Return as a "
12004 "monadic value in the absolute file name of @var{file} within the "
12005 "@var{output} directory of @var{package}. When @var{file} is omitted, return "
12006 "the name of the @var{output} directory of @var{package}. When @var{target} "
12007 "is true, use it as a cross-compilation target triplet."
12011 #: doc/guix.texi:4812
12013 msgid "{Monadic Procedure} package->derivation @var{package} [@var{system}]"
12017 #: doc/guix.texi:4813
12019 msgid "{Monadic Procedure} package->cross-derivation @var{package} @"
12023 #: doc/guix.texi:4817
12025 "@var{target} [@var{system}] Monadic version of @code{package-derivation} and "
12026 "@code{package-cross-derivation} (@pxref{Defining Packages})."
12030 #: doc/guix.texi:4823
12032 msgid "G-expression"
12036 #: doc/guix.texi:4824
12038 msgid "build code quoting"
12041 #. type: Plain text
12042 #: doc/guix.texi:4830
12044 "So we have ``derivations'', which represent a sequence of build actions to "
12045 "be performed to produce an item in the store (@pxref{Derivations}). These "
12046 "build actions are performed when asking the daemon to actually build the "
12047 "derivations; they are run by the daemon in a container (@pxref{Invoking guix-"
12052 #: doc/guix.texi:4831
12054 msgid "strata of code"
12057 #. type: Plain text
12058 #: doc/guix.texi:4843
12060 "It should come as no surprise that we like to write these build actions in "
12061 "Scheme. When we do that, we end up with two @dfn{strata} of Scheme "
12062 "code@footnote{The term @dfn{stratum} in this context was coined by Manuel "
12063 "Serrano et al.@: in the context of their work on Hop. Oleg Kiselyov, who "
12064 "has written insightful @url{http://okmij.org/ftp/meta-programming/#meta-"
12065 "scheme, essays and code on this topic}, refers to this kind of code "
12066 "generation as @dfn{staging}.}: the ``host code''---code that defines "
12067 "packages, talks to the daemon, etc.---and the ``build code''---code that "
12068 "actually performs build actions, such as making directories, invoking "
12069 "@command{make}, etc."
12072 #. type: Plain text
12073 #: doc/guix.texi:4850
12075 "To describe a derivation and its build actions, one typically needs to embed "
12076 "build code inside host code. It boils down to manipulating build code as "
12077 "data, and the homoiconicity of Scheme---code has a direct representation as "
12078 "data---comes in handy for that. But we need more than the normal "
12079 "@code{quasiquote} mechanism in Scheme to construct build expressions."
12082 #. type: Plain text
12083 #: doc/guix.texi:4859
12085 "The @code{(guix gexp)} module implements @dfn{G-expressions}, a form of S-"
12086 "expressions adapted to build expressions. G-expressions, or @dfn{gexps}, "
12087 "consist essentially of three syntactic forms: @code{gexp}, @code{ungexp}, "
12088 "and @code{ungexp-splicing} (or simply: @code{#~}, @code{#$}, and @code{#"
12089 "$@@}), which are comparable to @code{quasiquote}, @code{unquote}, and "
12090 "@code{unquote-splicing}, respectively (@pxref{Expression Syntax, "
12091 "@code{quasiquote},, guile, GNU Guile Reference Manual}). However, there are "
12092 "major differences:"
12096 #: doc/guix.texi:4864
12098 "Gexps are meant to be written to a file and run or manipulated by other "
12103 #: doc/guix.texi:4869
12105 "When a high-level object such as a package or derivation is unquoted inside "
12106 "a gexp, the result is as if its output file name had been introduced."
12110 #: doc/guix.texi:4874
12112 "Gexps carry information about the packages or derivations they refer to, and "
12113 "these dependencies are automatically added as inputs to the build processes "
12118 #: doc/guix.texi:4876 doc/guix.texi:5346
12120 msgid "lowering, of high-level objects in gexps"
12123 #. type: Plain text
12124 #: doc/guix.texi:4886
12126 "This mechanism is not limited to package and derivation objects: "
12127 "@dfn{compilers} able to ``lower'' other high-level objects to derivations or "
12128 "files in the store can be defined, such that these objects can also be "
12129 "inserted into gexps. For example, a useful type of high-level objects that "
12130 "can be inserted in a gexp is ``file-like objects'', which make it easy to "
12131 "add files to the store and to refer to them in derivations and such (see "
12132 "@code{local-file} and @code{plain-file} below.)"
12135 #. type: Plain text
12136 #: doc/guix.texi:4888
12137 msgid "To illustrate the idea, here is an example of a gexp:"
12141 #: doc/guix.texi:4896
12144 "(define build-exp\n"
12146 " (mkdir #$output)\n"
12147 " (chdir #$output)\n"
12148 " (symlink (string-append #$coreutils \"/bin/ls\")\n"
12149 " \"list-files\")))\n"
12152 #. type: Plain text
12153 #: doc/guix.texi:4901
12155 "This gexp can be passed to @code{gexp->derivation}; we obtain a derivation "
12156 "that builds a directory containing exactly one symlink to @file{/gnu/store/"
12157 "@dots{}-coreutils-8.22/bin/ls}:"
12161 #: doc/guix.texi:4904
12163 msgid "(gexp->derivation \"the-thing\" build-exp)\n"
12166 #. type: Plain text
12167 #: doc/guix.texi:4912
12169 "As one would expect, the @code{\"/gnu/store/@dots{}-coreutils-8.22\"} string "
12170 "is substituted to the reference to the @var{coreutils} package in the actual "
12171 "build code, and @var{coreutils} is automatically made an input to the "
12172 "derivation. Likewise, @code{#$output} (equivalent to @code{(ungexp "
12173 "output)}) is replaced by a string containing the directory name of the "
12174 "output of the derivation."
12178 #: doc/guix.texi:4913
12180 msgid "cross compilation"
12183 #. type: Plain text
12184 #: doc/guix.texi:4919
12186 "In a cross-compilation context, it is useful to distinguish between "
12187 "references to the @emph{native} build of a package---that can run on the "
12188 "host---versus references to cross builds of a package. To that end, the "
12189 "@code{#+} plays the same role as @code{#$}, but is a reference to a native "
12194 #: doc/guix.texi:4929
12197 "(gexp->derivation \"vi\"\n"
12199 " (mkdir #$output)\n"
12200 " (system* (string-append #+coreutils \"/bin/ln\")\n"
12202 " (string-append #$emacs \"/bin/emacs\")\n"
12203 " (string-append #$output \"/bin/vi\")))\n"
12204 " #:target \"mips64el-linux-gnu\")\n"
12207 #. type: Plain text
12208 #: doc/guix.texi:4935
12210 "In the example above, the native build of @var{coreutils} is used, so that "
12211 "@command{ln} can actually run on the host; but then the cross-compiled build "
12212 "of @var{emacs} is referenced."
12216 #: doc/guix.texi:4936
12218 msgid "imported modules, for gexps"
12222 #: doc/guix.texi:4937
12224 msgid "with-imported-modules"
12227 #. type: Plain text
12228 #: doc/guix.texi:4942
12230 "Another gexp feature is @dfn{imported modules}: sometimes you want to be "
12231 "able to use certain Guile modules from the ``host environment'' in the gexp, "
12232 "so those modules should be imported in the ``build environment''. The "
12233 "@code{with-imported-modules} form allows you to express that:"
12237 #: doc/guix.texi:4953
12240 "(let ((build (with-imported-modules '((guix build utils))\n"
12242 " (use-modules (guix build utils))\n"
12243 " (mkdir-p (string-append #$output \"/bin\"))))))\n"
12244 " (gexp->derivation \"empty-dir\"\n"
12247 " (display \"success!\\n\")\n"
12251 #. type: Plain text
12252 #: doc/guix.texi:4959
12254 "In this example, the @code{(guix build utils)} module is automatically "
12255 "pulled into the isolated build environment of our gexp, such that @code{(use-"
12256 "modules (guix build utils))} works as expected."
12260 #: doc/guix.texi:4960
12262 msgid "module closure"
12266 #: doc/guix.texi:4961
12268 msgid "source-module-closure"
12271 #. type: Plain text
12272 #: doc/guix.texi:4968
12274 "Usually you want the @emph{closure} of the module to be imported---i.e., the "
12275 "module itself and all the modules it depends on---rather than just the "
12276 "module; failing to do that, attempts to use the module will fail because of "
12277 "missing dependent modules. The @code{source-module-closure} procedure "
12278 "computes the closure of a module by looking at its source file headers, "
12279 "which comes in handy in this case:"
12283 #: doc/guix.texi:4971
12286 "(use-modules (guix modules)) ;for 'source-module-closure'\n"
12291 #: doc/guix.texi:4980
12294 "(with-imported-modules (source-module-closure\n"
12295 " '((guix build utils)\n"
12296 " (gnu build vm)))\n"
12297 " (gexp->derivation \"something-with-vms\"\n"
12299 " (use-modules (guix build utils)\n"
12300 " (gnu build vm))\n"
12304 #. type: Plain text
12305 #: doc/guix.texi:4983
12306 msgid "The syntactic form to construct gexps is summarized below."
12310 #: doc/guix.texi:4984
12312 msgid "{Scheme Syntax} #~@var{exp}"
12316 #: doc/guix.texi:4985
12318 msgid "{Scheme Syntax} (gexp @var{exp})"
12322 #: doc/guix.texi:4988
12324 "Return a G-expression containing @var{exp}. @var{exp} may contain one or "
12325 "more of the following forms:"
12329 #: doc/guix.texi:4990
12331 msgid "#$@var{obj}"
12335 #: doc/guix.texi:4991
12337 msgid "(ungexp @var{obj})"
12341 #: doc/guix.texi:4996
12343 "Introduce a reference to @var{obj}. @var{obj} may have one of the supported "
12344 "types, for example a package or a derivation, in which case the "
12345 "@code{ungexp} form is replaced by its output file name---e.g., @code{\"/gnu/"
12346 "store/@dots{}-coreutils-8.22}."
12350 #: doc/guix.texi:4999
12352 "If @var{obj} is a list, it is traversed and references to supported objects "
12353 "are substituted similarly."
12357 #: doc/guix.texi:5002
12359 "If @var{obj} is another gexp, its contents are inserted and its dependencies "
12360 "are added to those of the containing gexp."
12364 #: doc/guix.texi:5004
12365 msgid "If @var{obj} is another kind of object, it is inserted as is."
12369 #: doc/guix.texi:5005
12371 msgid "#$@var{obj}:@var{output}"
12375 #: doc/guix.texi:5006
12377 msgid "(ungexp @var{obj} @var{output})"
12381 #: doc/guix.texi:5010
12383 "This is like the form above, but referring explicitly to the @var{output} of "
12384 "@var{obj}---this is useful when @var{obj} produces multiple outputs "
12385 "(@pxref{Packages with Multiple Outputs})."
12389 #: doc/guix.texi:5011
12391 msgid "#+@var{obj}"
12395 #: doc/guix.texi:5012
12397 msgid "#+@var{obj}:output"
12401 #: doc/guix.texi:5013
12403 msgid "(ungexp-native @var{obj})"
12407 #: doc/guix.texi:5014
12409 msgid "(ungexp-native @var{obj} @var{output})"
12413 #: doc/guix.texi:5017
12415 "Same as @code{ungexp}, but produces a reference to the @emph{native} build "
12416 "of @var{obj} when used in a cross compilation context."
12420 #: doc/guix.texi:5018
12422 msgid "#$output[:@var{output}]"
12426 #: doc/guix.texi:5019
12428 msgid "(ungexp output [@var{output}])"
12432 #: doc/guix.texi:5022
12434 "Insert a reference to derivation output @var{output}, or to the main output "
12435 "when @var{output} is omitted."
12439 #: doc/guix.texi:5024
12440 msgid "This only makes sense for gexps passed to @code{gexp->derivation}."
12444 #: doc/guix.texi:5025
12446 msgid "#$@@@var{lst}"
12450 #: doc/guix.texi:5026
12452 msgid "(ungexp-splicing @var{lst})"
12456 #: doc/guix.texi:5029
12458 "Like the above, but splices the contents of @var{lst} inside the containing "
12463 #: doc/guix.texi:5030
12465 msgid "#+@@@var{lst}"
12469 #: doc/guix.texi:5031
12471 msgid "(ungexp-native-splicing @var{lst})"
12475 #: doc/guix.texi:5034
12477 "Like the above, but refers to native builds of the objects listed in "
12482 #: doc/guix.texi:5039
12484 "G-expressions created by @code{gexp} or @code{#~} are run-time objects of "
12485 "the @code{gexp?} type (see below.)"
12489 #: doc/guix.texi:5041
12491 msgid "{Scheme Syntax} with-imported-modules @var{modules} @var{body}@dots{}"
12495 #: doc/guix.texi:5044
12497 "Mark the gexps defined in @var{body}@dots{} as requiring @var{modules} in "
12498 "their execution environment."
12502 #: doc/guix.texi:5048
12504 "Each item in @var{modules} can be the name of a module, such as @code{(guix "
12505 "build utils)}, or it can be a module name, followed by an arrow, followed by "
12506 "a file-like object:"
12510 #: doc/guix.texi:5054
12513 "`((guix build utils)\n"
12515 " ((guix config) => ,(scheme-file \"config.scm\"\n"
12516 " #~(define-module @dots{}))))\n"
12520 #: doc/guix.texi:5059
12522 "In the example above, the first two modules are taken from the search path, "
12523 "and the last one is created from the given file-like object."
12527 #: doc/guix.texi:5063
12529 "This form has @emph{lexical} scope: it has an effect on the gexps directly "
12530 "defined in @var{body}@dots{}, but not on those defined, say, in procedures "
12531 "called from @var{body}@dots{}."
12535 #: doc/guix.texi:5065
12537 msgid "{Scheme Procedure} gexp? @var{obj}"
12541 #: doc/guix.texi:5067
12542 msgid "Return @code{#t} if @var{obj} is a G-expression."
12545 #. type: Plain text
12546 #: doc/guix.texi:5073
12548 "G-expressions are meant to be written to disk, either as code building some "
12549 "derivation, or as plain files in the store. The monadic procedures below "
12550 "allow you to do that (@pxref{The Store Monad}, for more information about "
12555 #: doc/guix.texi:5074
12557 msgid "{Monadic Procedure} gexp->derivation @var{name} @var{exp} @"
12561 #: doc/guix.texi:5090
12563 "[#:system (%current-system)] [#:target #f] [#:graft? #t] @ [#:hash #f] [#:"
12564 "hash-algo #f] @ [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ [#:"
12565 "module-path @var{%load-path}] @ [#:references-graphs #f] [#:allowed-"
12566 "references #f] @ [#:disallowed-references #f] @ [#:leaked-env-vars #f] @ [#:"
12567 "script-name (string-append @var{name} \"-builder\")] @ [#:deprecation-"
12568 "warnings #f] @ [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build "
12569 "#f] Return a derivation @var{name} that runs @var{exp} (a gexp) with "
12570 "@var{guile-for-build} (a derivation) on @var{system}; @var{exp} is stored in "
12571 "a file called @var{script-name}. When @var{target} is true, it is used as "
12572 "the cross-compilation target triplet for packages referred to by @var{exp}."
12576 #: doc/guix.texi:5098
12578 "@var{modules} is deprecated in favor of @code{with-imported-modules}. Its "
12579 "meaning is to make @var{modules} available in the evaluation context of "
12580 "@var{exp}; @var{modules} is a list of names of Guile modules searched in "
12581 "@var{module-path} to be copied in the store, compiled, and made available in "
12582 "the load path during the execution of @var{exp}---e.g., @code{((guix build "
12583 "utils) (guix build gnu-build-system))}."
12587 #: doc/guix.texi:5101
12589 "@var{graft?} determines whether packages referred to by @var{exp} should be "
12590 "grafted when applicable."
12594 #: doc/guix.texi:5104
12596 "When @var{references-graphs} is true, it must be a list of tuples of one of "
12597 "the following forms:"
12601 #: doc/guix.texi:5111
12604 "(@var{file-name} @var{package})\n"
12605 "(@var{file-name} @var{package} @var{output})\n"
12606 "(@var{file-name} @var{derivation})\n"
12607 "(@var{file-name} @var{derivation} @var{output})\n"
12608 "(@var{file-name} @var{store-item})\n"
12612 #: doc/guix.texi:5117
12614 "The right-hand-side of each element of @var{references-graphs} is "
12615 "automatically made an input of the build process of @var{exp}. In the build "
12616 "environment, each @var{file-name} contains the reference graph of the "
12617 "corresponding item, in a simple text format."
12621 #: doc/guix.texi:5123
12623 "@var{allowed-references} must be either @code{#f} or a list of output names "
12624 "and packages. In the latter case, the list denotes store items that the "
12625 "result is allowed to refer to. Any reference to another store item will "
12626 "lead to a build error. Similarly for @var{disallowed-references}, which can "
12627 "list items that must not be referenced by the outputs."
12631 #: doc/guix.texi:5126
12633 "@var{deprecation-warnings} determines whether to show deprecation warnings "
12634 "while compiling modules. It can be @code{#f}, @code{#t}, or "
12635 "@code{'detailed}."
12639 #: doc/guix.texi:5128
12640 msgid "The other arguments are as for @code{derivation} (@pxref{Derivations})."
12644 #: doc/guix.texi:5130
12646 msgid "file-like objects"
12649 #. type: Plain text
12650 #: doc/guix.texi:5135
12652 "The @code{local-file}, @code{plain-file}, @code{computed-file}, "
12653 "@code{program-file}, and @code{scheme-file} procedures below return "
12654 "@dfn{file-like objects}. That is, when unquoted in a G-expression, these "
12655 "objects lead to a file in the store. Consider this G-expression:"
12659 #: doc/guix.texi:5139
12662 "#~(system* #$(file-append glibc \"/sbin/nscd\") \"-f\"\n"
12663 " #$(local-file \"/tmp/my-nscd.conf\"))\n"
12666 #. type: Plain text
12667 #: doc/guix.texi:5148
12669 "The effect here is to ``intern'' @file{/tmp/my-nscd.conf} by copying it to "
12670 "the store. Once expanded, for instance @i{via} @code{gexp->derivation}, the "
12671 "G-expression refers to that copy under @file{/gnu/store}; thus, modifying or "
12672 "removing the file in @file{/tmp} does not have any effect on what the G-"
12673 "expression does. @code{plain-file} can be used similarly; it differs in "
12674 "that the file content is directly passed as a string."
12678 #: doc/guix.texi:5149
12680 msgid "{Scheme Procedure} local-file @var{file} [@var{name}] @"
12684 #: doc/guix.texi:5155
12686 "[#:recursive? #f] [#:select? (const #t)] Return an object representing local "
12687 "file @var{file} to add to the store; this object can be used in a gexp. If "
12688 "@var{file} is a relative file name, it is looked up relative to the source "
12689 "file where this form appears. @var{file} will be added to the store under "
12690 "@var{name}--by default the base name of @var{file}."
12694 #: doc/guix.texi:5167
12696 "This is the declarative counterpart of the @code{interned-file} monadic "
12697 "procedure (@pxref{The Store Monad, @code{interned-file}})."
12701 #: doc/guix.texi:5169
12703 msgid "{Scheme Procedure} plain-file @var{name} @var{content}"
12707 #: doc/guix.texi:5172
12709 "Return an object representing a text file called @var{name} with the given "
12710 "@var{content} (a string) to be added to the store."
12714 #: doc/guix.texi:5174
12715 msgid "This is the declarative counterpart of @code{text-file}."
12719 #: doc/guix.texi:5176
12721 msgid "{Scheme Procedure} computed-file @var{name} @var{gexp} @"
12725 #: doc/guix.texi:5181
12727 "[#:options '(#:local-build? #t)] Return an object representing the store "
12728 "item @var{name}, a file or directory computed by @var{gexp}. @var{options} "
12729 "is a list of additional arguments to pass to @code{gexp->derivation}."
12733 #: doc/guix.texi:5183
12734 msgid "This is the declarative counterpart of @code{gexp->derivation}."
12738 #: doc/guix.texi:5185
12740 msgid "{Monadic Procedure} gexp->script @var{name} @var{exp} @"
12744 #: doc/guix.texi:5190
12746 "[#:guile (default-guile)] [#:module-path %load-path] Return an executable "
12747 "script @var{name} that runs @var{exp} using @var{guile}, with @var{exp}'s "
12748 "imported modules in its search path. Look up @var{exp}'s modules in "
12749 "@var{module-path}."
12753 #: doc/guix.texi:5193
12755 "The example below builds a script that simply invokes the @command{ls} "
12760 #: doc/guix.texi:5196
12763 "(use-modules (guix gexp) (gnu packages base))\n"
12768 #: doc/guix.texi:5200
12771 "(gexp->script \"list-files\"\n"
12772 " #~(execl #$(file-append coreutils \"/bin/ls\")\n"
12777 #: doc/guix.texi:5205
12779 "When ``running'' it through the store (@pxref{The Store Monad, @code{run-"
12780 "with-store}}), we obtain a derivation that produces an executable file "
12781 "@file{/gnu/store/@dots{}-list-files} along these lines:"
12785 #: doc/guix.texi:5210
12788 "#!/gnu/store/@dots{}-guile-2.0.11/bin/guile -ds\n"
12790 "(execl \"/gnu/store/@dots{}-coreutils-8.22\"/bin/ls\" \"ls\")\n"
12794 #: doc/guix.texi:5213
12796 msgid "{Scheme Procedure} program-file @var{name} @var{exp} @"
12800 #: doc/guix.texi:5218
12802 "[#:guile #f] [#:module-path %load-path] Return an object representing the "
12803 "executable store item @var{name} that runs @var{gexp}. @var{guile} is the "
12804 "Guile package used to execute that script. Imported modules of @var{gexp} "
12805 "are looked up in @var{module-path}."
12809 #: doc/guix.texi:5220
12810 msgid "This is the declarative counterpart of @code{gexp->script}."
12814 #: doc/guix.texi:5222
12816 msgid "{Monadic Procedure} gexp->file @var{name} @var{exp} @"
12820 #: doc/guix.texi:5229
12822 "[#:set-load-path? #t] [#:module-path %load-path] @ [#:splice? #f] @ [#:guile "
12823 "(default-guile)] Return a derivation that builds a file @var{name} "
12824 "containing @var{exp}. When @var{splice?} is true, @var{exp} is considered "
12825 "to be a list of expressions that will be spliced in the resulting file."
12829 #: doc/guix.texi:5234
12831 "When @var{set-load-path?} is true, emit code in the resulting file to set "
12832 "@code{%load-path} and @code{%load-compiled-path} to honor @var{exp}'s "
12833 "imported modules. Look up @var{exp}'s modules in @var{module-path}."
12837 #: doc/guix.texi:5237
12839 "The resulting file holds references to all the dependencies of @var{exp} or "
12840 "a subset thereof."
12844 #: doc/guix.texi:5239
12846 msgid "{Scheme Procedure} scheme-file @var{name} @var{exp} [#:splice? #f]"
12847 msgstr "{Scheme Procedure} derivation @var{store} @var{name} @var{builder} @"
12850 #: doc/guix.texi:5242
12852 "Return an object representing the Scheme file @var{name} that contains "
12857 #: doc/guix.texi:5244
12858 msgid "This is the declarative counterpart of @code{gexp->file}."
12862 #: doc/guix.texi:5246
12864 msgid "{Monadic Procedure} text-file* @var{name} @var{text} @dots{}"
12868 #: doc/guix.texi:5252
12870 "Return as a monadic value a derivation that builds a text file containing "
12871 "all of @var{text}. @var{text} may list, in addition to strings, objects of "
12872 "any type that can be used in a gexp: packages, derivations, local file "
12873 "objects, etc. The resulting store file holds references to all these."
12877 #: doc/guix.texi:5257
12879 "This variant should be preferred over @code{text-file} anytime the file to "
12880 "create will reference items from the store. This is typically the case when "
12881 "building a configuration file that embeds store file names, like this:"
12885 #: doc/guix.texi:5265
12888 "(define (profile.sh)\n"
12889 " ;; Return the name of a shell script in the store that\n"
12890 " ;; initializes the 'PATH' environment variable.\n"
12891 " (text-file* \"profile.sh\"\n"
12892 " \"export PATH=\" coreutils \"/bin:\"\n"
12893 " grep \"/bin:\" sed \"/bin\\n\"))\n"
12897 #: doc/guix.texi:5270
12899 "In this example, the resulting @file{/gnu/store/@dots{}-profile.sh} file "
12900 "will reference @var{coreutils}, @var{grep}, and @var{sed}, thereby "
12901 "preventing them from being garbage-collected during its lifetime."
12905 #: doc/guix.texi:5272
12907 msgid "{Scheme Procedure} mixed-text-file @var{name} @var{text} @dots{}"
12911 #: doc/guix.texi:5276
12913 "Return an object representing store file @var{name} containing @var{text}. "
12914 "@var{text} is a sequence of strings and file-like objects, as in:"
12918 #: doc/guix.texi:5280
12921 "(mixed-text-file \"profile\"\n"
12922 " \"export PATH=\" coreutils \"/bin:\" grep \"/bin\")\n"
12926 #: doc/guix.texi:5283
12927 msgid "This is the declarative counterpart of @code{text-file*}."
12931 #: doc/guix.texi:5285
12933 msgid "{Scheme Procedure} file-union @var{name} @var{files}"
12937 #: doc/guix.texi:5290
12939 "Return a @code{<computed-file>} that builds a directory containing all of "
12940 "@var{files}. Each item in @var{files} must be a two-element list where the "
12941 "first element is the file name to use in the new directory, and the second "
12942 "element is a gexp denoting the target file. Here's an example:"
12946 #: doc/guix.texi:5297
12949 "(file-union \"etc\"\n"
12950 " `((\"hosts\" ,(plain-file \"hosts\"\n"
12951 " \"127.0.0.1 localhost\"))\n"
12952 " (\"bashrc\" ,(plain-file \"bashrc\"\n"
12953 " \"alias ls='ls --color'\"))))\n"
12957 #: doc/guix.texi:5300
12958 msgid "This yields an @code{etc} directory containing these two files."
12962 #: doc/guix.texi:5302
12964 msgid "{Scheme Procedure} directory-union @var{name} @var{things}"
12968 #: doc/guix.texi:5305
12970 "Return a directory that is the union of @var{things}, where @var{things} is "
12971 "a list of file-like objects denoting directories. For example:"
12975 #: doc/guix.texi:5308
12977 msgid "(directory-union \"guile+emacs\" (list guile emacs))\n"
12981 #: doc/guix.texi:5311
12983 "yields a directory that is the union of the @code{guile} and @code{emacs} "
12988 #: doc/guix.texi:5313
12990 msgid "{Scheme Procedure} file-append @var{obj} @var{suffix} @dots{}"
12994 #: doc/guix.texi:5317
12996 "Return a file-like object that expands to the concatenation of @var{obj} and "
12997 "@var{suffix}, where @var{obj} is a lowerable object and each @var{suffix} is "
13002 #: doc/guix.texi:5319
13003 msgid "As an example, consider this gexp:"
13007 #: doc/guix.texi:5324
13010 "(gexp->script \"run-uname\"\n"
13011 " #~(system* #$(file-append coreutils\n"
13012 " \"/bin/uname\")))\n"
13016 #: doc/guix.texi:5327
13017 msgid "The same effect could be achieved with:"
13021 #: doc/guix.texi:5332
13024 "(gexp->script \"run-uname\"\n"
13025 " #~(system* (string-append #$coreutils\n"
13026 " \"/bin/uname\")))\n"
13030 #: doc/guix.texi:5338
13032 "There is one difference though: in the @code{file-append} case, the "
13033 "resulting script contains the absolute file name as a string, whereas in the "
13034 "second case, the resulting script contains a @code{(string-append @dots{})} "
13035 "expression to construct the file name @emph{at run time}."
13038 #. type: Plain text
13039 #: doc/guix.texi:5345
13041 "Of course, in addition to gexps embedded in ``host'' code, there are also "
13042 "modules containing build tools. To make it clear that they are meant to be "
13043 "used in the build stratum, these modules are kept in the @code{(guix build "
13044 "@dots{})} name space."
13047 #. type: Plain text
13048 #: doc/guix.texi:5351
13050 "Internally, high-level objects are @dfn{lowered}, using their compiler, to "
13051 "either derivations or store items. For instance, lowering a package yields "
13052 "a derivation, and lowering a @code{plain-file} yields a store item. This is "
13053 "achieved using the @code{lower-object} monadic procedure."
13057 #: doc/guix.texi:5352
13059 msgid "{Monadic Procedure} lower-object @var{obj} [@var{system}] @"
13063 #: doc/guix.texi:5358
13065 "[#:target #f] Return as a value in @var{%store-monad} the derivation or "
13066 "store item corresponding to @var{obj} for @var{system}, cross-compiling for "
13067 "@var{target} if @var{target} is true. @var{obj} must be an object that has "
13068 "an associated gexp compiler, such as a @code{<package>}."
13071 #. type: Plain text
13072 #: doc/guix.texi:5369
13074 "This section describes Guix command-line utilities. Some of them are "
13075 "primarily targeted at developers and users who write new package "
13076 "definitions, while others are more generally useful. They complement the "
13077 "Scheme programming interface of Guix in a convenient way."
13081 #: doc/guix.texi:5391
13083 msgid "package building"
13086 #. type: command{#1}
13087 #: doc/guix.texi:5392
13092 #. type: Plain text
13093 #: doc/guix.texi:5398
13095 "The @command{guix build} command builds packages or derivations and their "
13096 "dependencies, and prints the resulting store paths. Note that it does not "
13097 "modify the user's profile---this is the job of the @command{guix package} "
13098 "command (@pxref{Invoking guix package}). Thus, it is mainly useful for "
13099 "distribution developers."
13102 #. type: Plain text
13103 #: doc/guix.texi:5400 doc/guix.texi:6057 doc/guix.texi:6124 doc/guix.texi:6793
13104 #: doc/guix.texi:7123 doc/guix.texi:7453 doc/guix.texi:7758 doc/guix.texi:7824
13105 #: doc/guix.texi:7863
13106 msgid "The general syntax is:"
13110 #: doc/guix.texi:5403
13112 msgid "guix build @var{options} @var{package-or-derivation}@dots{}\n"
13115 #. type: Plain text
13116 #: doc/guix.texi:5408
13118 "As an example, the following command builds the latest versions of Emacs and "
13119 "of Guile, displays their build logs, and finally displays the resulting "
13124 #: doc/guix.texi:5411
13126 msgid "guix build emacs guile\n"
13129 #. type: Plain text
13130 #: doc/guix.texi:5414
13131 msgid "Similarly, the following command builds all the available packages:"
13135 #: doc/guix.texi:5418
13138 "guix build --quiet --keep-going \\\n"
13139 " `guix package -A | cut -f1,2 --output-delimiter=@@`\n"
13142 #. type: Plain text
13143 #: doc/guix.texi:5426
13145 "@var{package-or-derivation} may be either the name of a package found in the "
13146 "software distribution such as @code{coreutils} or @code{coreutils@@8.20}, or "
13147 "a derivation such as @file{/gnu/store/@dots{}-coreutils-8.19.drv}. In the "
13148 "former case, a package with the corresponding name (and optionally version) "
13149 "is searched for among the GNU distribution modules (@pxref{Package Modules})."
13152 #. type: Plain text
13153 #: doc/guix.texi:5431
13155 "Alternatively, the @code{--expression} option may be used to specify a "
13156 "Scheme expression that evaluates to a package; this is useful when "
13157 "disambiguating among several same-named packages or package variants is "
13161 #. type: Plain text
13162 #: doc/guix.texi:5434
13164 "There may be zero or more @var{options}. The available options are "
13165 "described in the subsections below."
13168 #. type: Plain text
13169 #: doc/guix.texi:5449
13171 "A number of options that control the build process are common to "
13172 "@command{guix build} and other commands that can spawn builds, such as "
13173 "@command{guix package} or @command{guix archive}. These are the following:"
13177 #: doc/guix.texi:5452
13179 msgid "--load-path=@var{directory}"
13183 #: doc/guix.texi:5453
13185 msgid "-L @var{directory}"
13189 #: doc/guix.texi:5456
13191 "Add @var{directory} to the front of the package module search path "
13192 "(@pxref{Package Modules})."
13196 #: doc/guix.texi:5459
13198 "This allows users to define their own packages and make them visible to the "
13199 "command-line tools."
13203 #: doc/guix.texi:5460
13205 msgid "--keep-failed"
13209 #: doc/guix.texi:5461
13215 #: doc/guix.texi:5467
13217 "Keep the build tree of failed builds. Thus, if a build fails, its build "
13218 "tree is kept under @file{/tmp}, in a directory whose name is shown at the "
13219 "end of the build log. This is useful when debugging build issues. "
13220 "@xref{Debugging Build Failures}, for tips and tricks on how to debug build "
13225 #: doc/guix.texi:5468
13227 msgid "--keep-going"
13231 #: doc/guix.texi:5469
13237 #: doc/guix.texi:5472
13239 "Keep going when some of the derivations fail to build; return only once all "
13240 "the builds have either completed or failed."
13244 #: doc/guix.texi:5475
13246 "The default behavior is to stop as soon as one of the specified derivations "
13251 #: doc/guix.texi:5476
13257 #: doc/guix.texi:5477
13263 #: doc/guix.texi:5479
13264 msgid "Do not build the derivations."
13267 #. type: anchor{#1}
13268 #: doc/guix.texi:5481
13269 msgid "fallback-option"
13273 #: doc/guix.texi:5481
13279 #: doc/guix.texi:5484
13281 "When substituting a pre-built binary fails, fall back to building packages "
13282 "locally (@pxref{Substitution Failure})."
13285 #. type: anchor{#1}
13286 #: doc/guix.texi:5490
13287 msgid "client-substitute-urls"
13291 #: doc/guix.texi:5490
13293 "Consider @var{urls} the whitespace-separated list of substitute source URLs, "
13294 "overriding the default list of URLs of @command{guix-daemon} (@pxref{daemon-"
13295 "substitute-urls,, @command{guix-daemon} URLs})."
13299 #: doc/guix.texi:5494
13301 "This means that substitutes may be downloaded from @var{urls}, provided they "
13302 "are signed by a key authorized by the system administrator "
13303 "(@pxref{Substitutes})."
13305 "Cela signifie que les substituts peuvent être téléchargés depuis @var{urls}, "
13306 "tant qu'ils sont signés par une clef autorisée par l'administrateur système "
13307 "(@pxref{Substituts})."
13310 #: doc/guix.texi:5497
13312 "When @var{urls} is the empty string, substitutes are effectively disabled."
13316 #: doc/guix.texi:5503
13318 msgid "--no-grafts"
13322 #: doc/guix.texi:5507
13324 "Do not ``graft'' packages. In practice, this means that package updates "
13325 "available as grafts are not applied. @xref{Security Updates}, for more "
13326 "information on grafts."
13330 #: doc/guix.texi:5508
13332 msgid "--rounds=@var{n}"
13336 #: doc/guix.texi:5511
13338 "Build each derivation @var{n} times in a row, and raise an error if "
13339 "consecutive build results are not bit-for-bit identical."
13343 #: doc/guix.texi:5516
13345 "This is a useful way to detect non-deterministic builds processes. Non-"
13346 "deterministic build processes are a problem because they make it practically "
13347 "impossible for users to @emph{verify} whether third-party binaries are "
13348 "genuine. @xref{Invoking guix challenge}, for more."
13352 #: doc/guix.texi:5522
13354 "Note that, currently, the differing build results are not kept around, so "
13355 "you will have to manually investigate in case of an error---e.g., by "
13356 "stashing one of the build results with @code{guix archive --export} "
13357 "(@pxref{Invoking guix archive}), then rebuilding, and finally comparing the "
13362 #: doc/guix.texi:5527
13364 "Do not attempt to offload builds @i{via} the ``build hook'' of the daemon "
13365 "(@pxref{Daemon Offload Setup}). That is, always build things locally "
13366 "instead of offloading builds to remote machines."
13370 #: doc/guix.texi:5534
13372 "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, "
13373 "@code{--max-silent-time}})."
13377 #: doc/guix.texi:5541
13379 "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, "
13380 "@code{--timeout}})."
13384 #: doc/guix.texi:5542
13386 msgid "--verbosity=@var{level}"
13390 #: doc/guix.texi:5546
13392 "Use the given verbosity level. @var{level} must be an integer between 0 and "
13393 "5; higher means more verbose output. Setting a level of 4 or more may be "
13394 "helpful when debugging setup issues with the build daemon."
13398 #: doc/guix.texi:5551
13400 "Allow the use of up to @var{n} CPU cores for the build. The special value "
13401 "@code{0} means to use as many CPU cores as available."
13405 #: doc/guix.texi:5557
13407 "Allow at most @var{n} build jobs in parallel. @xref{Invoking guix-daemon, "
13408 "@code{--max-jobs}}, for details about this option and the equivalent "
13409 "@command{guix-daemon} option."
13412 #. type: Plain text
13413 #: doc/guix.texi:5564
13415 "Behind the scenes, @command{guix build} is essentially an interface to the "
13416 "@code{package-derivation} procedure of the @code{(guix packages)} module, "
13417 "and to the @code{build-derivations} procedure of the @code{(guix "
13418 "derivations)} module."
13421 #. type: Plain text
13422 #: doc/guix.texi:5568
13424 "In addition to options explicitly passed on the command line, @command{guix "
13425 "build} and other @command{guix} commands that support building honor the "
13426 "@code{GUIX_BUILD_OPTIONS} environment variable."
13430 #: doc/guix.texi:5569
13432 msgid "{Environment Variable} GUIX_BUILD_OPTIONS"
13436 #: doc/guix.texi:5574
13438 "Users can define this variable to a list of command line options that will "
13439 "automatically be used by @command{guix build} and other @command{guix} "
13440 "commands that can perform builds, as in the example below:"
13444 #: doc/guix.texi:5577
13446 msgid "$ export GUIX_BUILD_OPTIONS=\"--no-substitutes -c 2 -L /foo/bar\"\n"
13450 #: doc/guix.texi:5581
13452 "These options are parsed independently, and the result is appended to the "
13453 "parsed command-line options."
13457 #: doc/guix.texi:5587
13459 msgid "package variants"
13462 #. type: Plain text
13463 #: doc/guix.texi:5595
13465 "Another set of command-line options supported by @command{guix build} and "
13466 "also @command{guix package} are @dfn{package transformation options}. These "
13467 "are options that make it possible to define @dfn{package variants}---for "
13468 "instance, packages built from different source code. This is a convenient "
13469 "way to create customized packages on the fly without having to type in the "
13470 "definitions of package variants (@pxref{Defining Packages})."
13474 #: doc/guix.texi:5598
13476 msgid "--with-source=@var{source}"
13480 #: doc/guix.texi:5599
13482 msgid "--with-source=@var{package}=@var{source}"
13486 #: doc/guix.texi:5600
13488 msgid "--with-source=@var{package}@@@var{version}=@var{source}"
13492 #: doc/guix.texi:5605
13494 "Use @var{source} as the source of @var{package}, and @var{version} as its "
13495 "version number. @var{source} must be a file name or a URL, as for "
13496 "@command{guix download} (@pxref{Invoking guix download})."
13500 #: doc/guix.texi:5611
13502 "When @var{package} is omitted, it is taken to be the package name specified "
13503 "on the command line that matches the base of @var{source}---e.g., if "
13504 "@var{source} is @code{/src/guile-2.0.10.tar.gz}, the corresponding package "
13509 #: doc/guix.texi:5614
13511 "Likewise, when @var{version} is omitted, the version string is inferred from "
13512 "@var{source}; in the previous example, it is @code{2.0.10}."
13516 #: doc/guix.texi:5619
13518 "This option allows users to try out versions of packages other than the one "
13519 "provided by the distribution. The example below downloads @file{ed-1.7.tar."
13520 "gz} from a GNU mirror and uses that as the source for the @code{ed} package:"
13524 #: doc/guix.texi:5622
13526 msgid "guix build ed --with-source=mirror://gnu/ed/ed-1.7.tar.gz\n"
13530 #: doc/guix.texi:5626
13532 "As a developer, @code{--with-source} makes it easy to test release "
13537 #: doc/guix.texi:5629
13539 msgid "guix build guile --with-source=../guile-2.0.9.219-e1bb7.tar.xz\n"
13543 #: doc/guix.texi:5632
13544 msgid "@dots{} or to build from a checkout in a pristine environment:"
13548 #: doc/guix.texi:5636
13551 "$ git clone git://git.sv.gnu.org/guix.git\n"
13552 "$ guix build guix --with-source=guix@@1.0=./guix\n"
13556 #: doc/guix.texi:5638
13558 msgid "--with-input=@var{package}=@var{replacement}"
13562 #: doc/guix.texi:5643
13564 "Replace dependency on @var{package} by a dependency on @var{replacement}. "
13565 "@var{package} must be a package name, and @var{replacement} must be a "
13566 "package specification such as @code{guile} or @code{guile@@1.8}."
13570 #: doc/guix.texi:5647
13572 "For instance, the following command builds Guix, but replaces its dependency "
13573 "on the current stable version of Guile with a dependency on the legacy "
13574 "version of Guile, @code{guile@@2.0}:"
13578 #: doc/guix.texi:5650
13580 msgid "guix build --with-input=guile=guile@@2.0 guix\n"
13584 #: doc/guix.texi:5655
13586 "This is a recursive, deep replacement. So in this example, both @code{guix} "
13587 "and its dependency @code{guile-json} (which also depends on @code{guile}) "
13588 "get rebuilt against @code{guile@@2.0}."
13592 #: doc/guix.texi:5658
13594 "This is implemented using the @code{package-input-rewriting} Scheme "
13595 "procedure (@pxref{Defining Packages, @code{package-input-rewriting}})."
13599 #: doc/guix.texi:5659
13601 msgid "--with-graft=@var{package}=@var{replacement}"
13605 #: doc/guix.texi:5665
13607 "This is similar to @code{--with-input} but with an important difference: "
13608 "instead of rebuilding the whole dependency chain, @var{replacement} is built "
13609 "and then @dfn{grafted} onto the binaries that were initially referring to "
13610 "@var{package}. @xref{Security Updates}, for more information on grafts."
13614 #: doc/guix.texi:5669
13616 "For example, the command below grafts version 3.5.4 of GnuTLS onto Wget and "
13617 "all its dependencies, replacing references to the version of GnuTLS they "
13618 "currently refer to:"
13622 #: doc/guix.texi:5672
13624 msgid "guix build --with-graft=gnutls=gnutls@@3.5.4 wget\n"
13628 #: doc/guix.texi:5681
13630 "This has the advantage of being much faster than rebuilding everything. But "
13631 "there is a caveat: it works if and only if @var{package} and "
13632 "@var{replacement} are strictly compatible---for example, if they provide a "
13633 "library, the application binary interface (ABI) of those libraries must be "
13634 "compatible. If @var{replacement} is somehow incompatible with "
13635 "@var{package}, then the resulting package may be unusable. Use with care!"
13638 #. type: Plain text
13639 #: doc/guix.texi:5689
13641 "The command-line options presented below are specific to @command{guix "
13646 #: doc/guix.texi:5692
13652 #: doc/guix.texi:5693
13658 #: doc/guix.texi:5697
13660 "Build quietly, without displaying the build log. Upon completion, the build "
13661 "log is kept in @file{/var} (or similar) and can always be retrieved using "
13662 "the @option{--log-file} option."
13666 #: doc/guix.texi:5698
13668 msgid "--file=@var{file}"
13672 #: doc/guix.texi:5703
13674 "Build the package or derivation that the code within @var{file} evaluates to."
13678 #: doc/guix.texi:5706
13680 "As an example, @var{file} might contain a package definition like this "
13681 "(@pxref{Defining Packages}):"
13685 #: doc/guix.texi:5714
13686 msgid "Build the package or derivation @var{expr} evaluates to."
13690 #: doc/guix.texi:5718
13692 "For example, @var{expr} may be @code{(@@ (gnu packages guile) guile-1.8)}, "
13693 "which unambiguously designates this specific variant of version 1.8 of Guile."
13697 #: doc/guix.texi:5722
13699 "Alternatively, @var{expr} may be a G-expression, in which case it is used as "
13700 "a build program passed to @code{gexp->derivation} (@pxref{G-Expressions})."
13704 #: doc/guix.texi:5726
13706 "Lastly, @var{expr} may refer to a zero-argument monadic procedure "
13707 "(@pxref{The Store Monad}). The procedure must return a derivation as a "
13708 "monadic value, which is then passed through @code{run-with-store}."
13712 #: doc/guix.texi:5727
13718 #: doc/guix.texi:5728
13724 #: doc/guix.texi:5731
13726 "Build the source derivations of the packages, rather than the packages "
13731 #: doc/guix.texi:5735
13733 "For instance, @code{guix build -S gcc} returns something like @file{/gnu/"
13734 "store/@dots{}-gcc-4.7.2.tar.bz2}, which is the GCC source tarball."
13738 #: doc/guix.texi:5739
13740 "The returned source tarball is the result of applying any patches and code "
13741 "snippets specified in the package @code{origin} (@pxref{Defining Packages})."
13745 #: doc/guix.texi:5740
13751 #: doc/guix.texi:5747
13753 "Fetch and return the source of @var{package-or-derivation} and all their "
13754 "dependencies, recursively. This is a handy way to obtain a local copy of "
13755 "all the source code needed to build @var{packages}, allowing you to "
13756 "eventually build them even without network access. It is an extension of "
13757 "the @code{--source} option and can accept one of the following optional "
13762 #: doc/guix.texi:5749 doc/guix.texi:6974
13768 #: doc/guix.texi:5752
13770 "This value causes the @code{--sources} option to behave in the same way as "
13771 "the @code{--source} option."
13775 #: doc/guix.texi:5753 doc/guix.texi:11798
13781 #: doc/guix.texi:5756
13783 "Build the source derivations of all packages, including any source that "
13784 "might be listed as @code{inputs}. This is the default value."
13788 #: doc/guix.texi:5762
13791 "$ guix build --sources tzdata\n"
13792 "The following derivations will be built:\n"
13793 " /gnu/store/@dots{}-tzdata2015b.tar.gz.drv\n"
13794 " /gnu/store/@dots{}-tzcode2015b.tar.gz.drv\n"
13798 #: doc/guix.texi:5764
13804 #: doc/guix.texi:5768
13806 "Build the source derivations of all packages, as well of all transitive "
13807 "inputs to the packages. This can be used e.g. to prefetch package source "
13808 "for later offline building."
13812 #: doc/guix.texi:5779
13815 "$ guix build --sources=transitive tzdata\n"
13816 "The following derivations will be built:\n"
13817 " /gnu/store/@dots{}-tzcode2015b.tar.gz.drv\n"
13818 " /gnu/store/@dots{}-findutils-4.4.2.tar.xz.drv\n"
13819 " /gnu/store/@dots{}-grep-2.21.tar.xz.drv\n"
13820 " /gnu/store/@dots{}-coreutils-8.23.tar.xz.drv\n"
13821 " /gnu/store/@dots{}-make-4.1.tar.xz.drv\n"
13822 " /gnu/store/@dots{}-bash-4.3.tar.xz.drv\n"
13827 #: doc/guix.texi:5792
13829 "The @code{--system} flag is for @emph{native} compilation and must not be "
13830 "confused with cross-compilation. See @code{--target} below for information "
13831 "on cross-compilation."
13835 #: doc/guix.texi:5798
13837 "An example use of this is on Linux-based systems, which can emulate "
13838 "different personalities. For instance, passing @code{--system=i686-linux} "
13839 "on an @code{x86_64-linux} system allows you to build packages in a complete "
13840 "32-bit environment."
13844 #: doc/guix.texi:5803
13846 "Similarly, when transparent emulation with QEMU and @code{binfmt_misc} is "
13847 "enabled (@pxref{Virtualization Services, @code{qemu-binfmt-service-type}}), "
13848 "you can build for any system for which a QEMU @code{binfmt_misc} handler is "
13853 #: doc/guix.texi:5807
13855 "Builds for a system other than that of the machine you are using can also be "
13856 "offloaded to a remote machine of the right architecture. @xref{Daemon "
13857 "Offload Setup}, for more information on offloading."
13860 #. type: anchor{#1}
13861 #: doc/guix.texi:5815
13862 msgid "build-check"
13866 #: doc/guix.texi:5815
13872 #: doc/guix.texi:5816
13874 msgid "determinism, checking"
13875 msgstr "déterminisme, vérification"
13878 #: doc/guix.texi:5817
13880 msgid "reproducibility, checking"
13881 msgstr "reproductibilité, vérification"
13884 #: doc/guix.texi:5821
13886 "Rebuild @var{package-or-derivation}, which are already available in the "
13887 "store, and raise an error if the build results are not bit-for-bit identical."
13891 #: doc/guix.texi:5826
13893 "This mechanism allows you to check whether previously installed substitutes "
13894 "are genuine (@pxref{Substitutes}), or whether the build result of a package "
13895 "is deterministic. @xref{Invoking guix challenge}, for more background "
13896 "information and tools."
13898 "Ce mécanisme vous permet de vérifier si les substituts précédemment "
13899 "installés sont authentiques (@pxref{Substituts}) ou si le résultat de la "
13900 "construction d'un paquet est déterministe. @xref{Invoking guix challenge} "
13901 "pour plus d'informations et pour les outils."
13904 #: doc/guix.texi:5831
13910 #: doc/guix.texi:5832
13912 msgid "repairing store items"
13916 #: doc/guix.texi:5836
13918 "Attempt to repair the specified store items, if they are corrupt, by re-"
13919 "downloading or rebuilding them."
13923 #: doc/guix.texi:5838
13924 msgid "This operation is not atomic and thus restricted to @code{root}."
13928 #: doc/guix.texi:5839
13930 msgid "--derivations"
13934 #: doc/guix.texi:5843
13936 "Return the derivation paths, not the output paths, of the given packages."
13940 #: doc/guix.texi:5844 doc/guix.texi:7231 doc/guix.texi:20625
13942 msgid "--root=@var{file}"
13946 #: doc/guix.texi:5845 doc/guix.texi:7232 doc/guix.texi:20626
13948 msgid "-r @var{file}"
13952 #: doc/guix.texi:5846
13954 msgid "GC roots, adding"
13958 #: doc/guix.texi:5847
13960 msgid "garbage collector roots, adding"
13964 #: doc/guix.texi:5850 doc/guix.texi:20629
13966 "Make @var{file} a symlink to the result, and register it as a garbage "
13971 #: doc/guix.texi:5856
13973 "Consequently, the results of this @command{guix build} invocation are "
13974 "protected from garbage collection until @var{file} is removed. When that "
13975 "option is omitted, build results are eligible for garbage collection as soon "
13976 "as the build completes. @xref{Invoking guix gc}, for more on GC roots."
13980 #: doc/guix.texi:5857
13986 #: doc/guix.texi:5858
13988 msgid "build logs, access"
13992 #: doc/guix.texi:5862
13994 "Return the build log file names or URLs for the given @var{package-or-"
13995 "derivation}, or raise an error if build logs are missing."
13999 #: doc/guix.texi:5865
14001 "This works regardless of how packages or derivations are specified. For "
14002 "instance, the following invocations are equivalent:"
14006 #: doc/guix.texi:5871
14009 "guix build --log-file `guix build -d guile`\n"
14010 "guix build --log-file `guix build guile`\n"
14011 "guix build --log-file guile\n"
14012 "guix build --log-file -e '(@@ (gnu packages guile) guile-2.0)'\n"
14016 #: doc/guix.texi:5876
14018 "If a log is unavailable locally, and unless @code{--no-substitutes} is "
14019 "passed, the command looks for a corresponding log on one of the substitute "
14020 "servers (as specified with @code{--substitute-urls}.)"
14024 #: doc/guix.texi:5879
14026 "So for instance, imagine you want to see the build log of GDB on MIPS, but "
14027 "you are actually on an @code{x86_64} machine:"
14031 #: doc/guix.texi:5883
14034 "$ guix build --log-file gdb -s mips64el-linux\n"
14035 "https://hydra.gnu.org/log/@dots{}-gdb-7.10\n"
14039 #: doc/guix.texi:5886
14040 msgid "You can freely access a huge library of build logs!"
14044 #: doc/guix.texi:5891
14046 msgid "build failures, debugging"
14049 #. type: Plain text
14050 #: doc/guix.texi:5897
14052 "When defining a new package (@pxref{Defining Packages}), you will probably "
14053 "find yourself spending some time debugging and tweaking the build until it "
14054 "succeeds. To do that, you need to operate the build commands yourself in an "
14055 "environment as close as possible to the one the build daemon uses."
14058 #. type: Plain text
14059 #: doc/guix.texi:5902
14061 "To that end, the first thing to do is to use the @option{--keep-failed} or "
14062 "@option{-K} option of @command{guix build}, which will keep the failed build "
14063 "tree in @file{/tmp} or whatever directory you specified as @code{TMPDIR} "
14064 "(@pxref{Invoking guix build, @code{--keep-failed}})."
14067 #. type: Plain text
14068 #: doc/guix.texi:5908
14070 "From there on, you can @command{cd} to the failed build tree and source the "
14071 "@file{environment-variables} file, which contains all the environment "
14072 "variable definitions that were in place when the build failed. So let's say "
14073 "you're debugging a build failure in package @code{foo}; a typical session "
14074 "would look like this:"
14078 #: doc/guix.texi:5915
14081 "$ guix build foo -K\n"
14082 "@dots{} @i{build fails}\n"
14083 "$ cd /tmp/guix-build-foo.drv-0\n"
14084 "$ source ./environment-variables\n"
14088 #. type: Plain text
14089 #: doc/guix.texi:5919
14091 "Now, you can invoke commands as if you were the daemon (almost) and "
14092 "troubleshoot your build process."
14095 #. type: Plain text
14096 #: doc/guix.texi:5925
14098 "Sometimes it happens that, for example, a package's tests pass when you run "
14099 "them manually but they fail when the daemon runs them. This can happen "
14100 "because the daemon runs builds in containers where, unlike in our "
14101 "environment above, network access is missing, @file{/bin/sh} does not exist, "
14102 "etc. (@pxref{Build Environment Setup})."
14105 #. type: Plain text
14106 #: doc/guix.texi:5928
14108 "In such cases, you may need to run inspect the build process from within a "
14109 "container similar to the one the build daemon creates:"
14113 #: doc/guix.texi:5936
14116 "$ guix build -K foo\n"
14118 "$ cd /tmp/guix-build-foo.drv-0\n"
14119 "$ guix environment --no-grafts -C foo --ad-hoc strace gdb\n"
14120 "[env]# source ./environment-variables\n"
14121 "[env]# cd foo-1.2\n"
14124 #. type: Plain text
14125 #: doc/guix.texi:5945
14127 "Here, @command{guix environment -C} creates a container and spawns a new "
14128 "shell in it (@pxref{Invoking guix environment}). The @command{--ad-hoc "
14129 "strace gdb} part adds the @command{strace} and @command{gdb} commands to the "
14130 "container, which would may find handy while debugging. The @option{--no-"
14131 "grafts} option makes sure we get the exact same environment, with ungrafted "
14132 "packages (@pxref{Security Updates}, for more info on grafts)."
14135 #. type: Plain text
14136 #: doc/guix.texi:5948
14138 "To get closer to a container like that used by the build daemon, we can "
14139 "remove @file{/bin/sh}:"
14143 #: doc/guix.texi:5951
14145 msgid "[env]# rm /bin/sh\n"
14148 #. type: Plain text
14149 #: doc/guix.texi:5955
14151 "(Don't worry, this is harmless: this is all happening in the throw-away "
14152 "container created by @command{guix environment}.)"
14155 #. type: Plain text
14156 #: doc/guix.texi:5958
14158 "The @command{strace} command is probably not in the search path, but we can "
14163 #: doc/guix.texi:5961
14165 msgid "[env]# $GUIX_ENVIRONMENT/bin/strace -f -o log make check\n"
14168 #. type: Plain text
14169 #: doc/guix.texi:5966
14171 "In this way, not only you will have reproduced the environment variables the "
14172 "daemon uses, you will also be running the build process in a container "
14173 "similar to the one the daemon uses."
14177 #: doc/guix.texi:5969
14179 msgid "Invoking @command{guix edit}"
14182 #. type: command{#1}
14183 #: doc/guix.texi:5971
14189 #: doc/guix.texi:5972
14191 msgid "package definition, editing"
14194 #. type: Plain text
14195 #: doc/guix.texi:5977
14197 "So many packages, so many source files! The @command{guix edit} command "
14198 "facilitates the life of users and packagers by pointing their editor at the "
14199 "source file containing the definition of the specified packages. For "
14204 #: doc/guix.texi:5980
14206 msgid "guix edit gcc@@4.9 vim\n"
14209 #. type: Plain text
14210 #: doc/guix.texi:5986
14212 "launches the program specified in the @code{VISUAL} or in the @code{EDITOR} "
14213 "environment variable to view the recipe of GCC@tie{}4.9.3 and that of Vim."
14216 #. type: Plain text
14217 #: doc/guix.texi:5992
14219 "If you are using a Guix Git checkout (@pxref{Building from Git}), or have "
14220 "created your own packages on @code{GUIX_PACKAGE_PATH} (@pxref{Defining "
14221 "Packages}), you will be able to edit the package recipes. Otherwise, you "
14222 "will be able to examine the read-only recipes for packages currently in the "
14227 #: doc/guix.texi:5995
14229 msgid "Invoking @command{guix download}"
14232 #. type: command{#1}
14233 #: doc/guix.texi:5997
14235 msgid "guix download"
14239 #: doc/guix.texi:5998
14241 msgid "downloading package sources"
14244 #. type: Plain text
14245 #: doc/guix.texi:6005
14247 "When writing a package definition, developers typically need to download a "
14248 "source tarball, compute its SHA256 hash, and write that hash in the package "
14249 "definition (@pxref{Defining Packages}). The @command{guix download} tool "
14250 "helps with this task: it downloads a file from the given URI, adds it to the "
14251 "store, and prints both its file name in the store and its SHA256 hash."
14254 #. type: Plain text
14255 #: doc/guix.texi:6012
14257 "The fact that the downloaded file is added to the store saves bandwidth: "
14258 "when the developer eventually tries to build the newly defined package with "
14259 "@command{guix build}, the source tarball will not have to be downloaded "
14260 "again because it is already in the store. It is also a convenient way to "
14261 "temporarily stash files, which may be deleted eventually (@pxref{Invoking "
14265 #. type: Plain text
14266 #: doc/guix.texi:6020
14268 "The @command{guix download} command supports the same URIs as used in "
14269 "package definitions. In particular, it supports @code{mirror://} URIs. "
14270 "@code{https} URIs (HTTP over TLS) are supported @emph{provided} the Guile "
14271 "bindings for GnuTLS are available in the user's environment; when they are "
14272 "not available, an error is raised. @xref{Guile Preparations, how to install "
14273 "the GnuTLS bindings for Guile,, gnutls-guile, GnuTLS-Guile}, for more "
14277 #. type: Plain text
14278 #: doc/guix.texi:6025
14280 "@command{guix download} verifies HTTPS server certificates by loading the "
14281 "certificates of X.509 authorities from the directory pointed to by the "
14282 "@code{SSL_CERT_DIR} environment variable (@pxref{X.509 Certificates}), "
14283 "unless @option{--no-check-certificate} is used."
14286 #. type: Plain text
14287 #: doc/guix.texi:6027 doc/guix.texi:7511
14288 msgid "The following options are available:"
14292 #: doc/guix.texi:6029 doc/guix.texi:6068
14294 msgid "--format=@var{fmt}"
14298 #: doc/guix.texi:6030 doc/guix.texi:6069
14300 msgid "-f @var{fmt}"
14304 #: doc/guix.texi:6033
14306 "Write the hash in the format specified by @var{fmt}. For more information "
14307 "on the valid values for @var{fmt}, @pxref{Invoking guix hash}."
14311 #: doc/guix.texi:6034
14313 msgid "--no-check-certificate"
14317 #: doc/guix.texi:6036
14318 msgid "Do not validate the X.509 certificates of HTTPS servers."
14322 #: doc/guix.texi:6040
14324 "When using this option, you have @emph{absolutely no guarantee} that you are "
14325 "communicating with the authentic server responsible for the given URL, which "
14326 "makes you vulnerable to ``man-in-the-middle'' attacks."
14330 #: doc/guix.texi:6041
14332 msgid "--output=@var{file}"
14336 #: doc/guix.texi:6042
14338 msgid "-o @var{file}"
14342 #: doc/guix.texi:6045
14344 "Save the downloaded file to @var{file} instead of adding it to the store."
14348 #: doc/guix.texi:6048
14350 msgid "Invoking @command{guix hash}"
14353 #. type: command{#1}
14354 #: doc/guix.texi:6050
14359 #. type: Plain text
14360 #: doc/guix.texi:6055
14362 "The @command{guix hash} command computes the SHA256 hash of a file. It is "
14363 "primarily a convenience tool for anyone contributing to the distribution: it "
14364 "computes the cryptographic hash of a file, which can be used in the "
14365 "definition of a package (@pxref{Defining Packages})."
14369 #: doc/guix.texi:6060
14371 msgid "guix hash @var{option} @var{file}\n"
14374 #. type: Plain text
14375 #: doc/guix.texi:6065
14377 "When @var{file} is @code{-} (a hyphen), @command{guix hash} computes the "
14378 "hash of data read from standard input. @command{guix hash} has the "
14379 "following options:"
14383 #: doc/guix.texi:6071
14384 msgid "Write the hash in the format specified by @var{fmt}."
14388 #: doc/guix.texi:6074
14390 "Supported formats: @code{nix-base32}, @code{base32}, @code{base16} "
14391 "(@code{hex} and @code{hexadecimal} can be used as well)."
14395 #: doc/guix.texi:6078
14397 "If the @option{--format} option is not specified, @command{guix hash} will "
14398 "output the hash in @code{nix-base32}. This representation is used in the "
14399 "definitions of packages."
14403 #: doc/guix.texi:6082
14404 msgid "Compute the hash on @var{file} recursively."
14408 #: doc/guix.texi:6091
14410 "In this case, the hash is computed on an archive containing @var{file}, "
14411 "including its children if it is a directory. Some of the metadata of "
14412 "@var{file} is part of the archive; for instance, when @var{file} is a "
14413 "regular file, the hash is different depending on whether @var{file} is "
14414 "executable or not. Metadata such as time stamps has no impact on the hash "
14415 "(@pxref{Invoking guix archive})."
14419 #: doc/guix.texi:6092
14421 msgid "--exclude-vcs"
14425 #: doc/guix.texi:6093
14431 #: doc/guix.texi:6096
14433 "When combined with @option{--recursive}, exclude version control system "
14434 "directories (@file{.bzr}, @file{.git}, @file{.hg}, etc.)"
14438 #: doc/guix.texi:6101
14440 "As an example, here is how you would compute the hash of a Git checkout, "
14441 "which is useful when using the @code{git-fetch} method (@pxref{origin "
14446 #: doc/guix.texi:6106
14449 "$ git clone http://example.org/foo.git\n"
14451 "$ guix hash -rx .\n"
14455 #: doc/guix.texi:6110 doc/guix.texi:6115
14457 msgid "Invoking @command{guix import}"
14461 #: doc/guix.texi:6112
14463 msgid "importing packages"
14467 #: doc/guix.texi:6113
14469 msgid "package import"
14473 #: doc/guix.texi:6114
14475 msgid "package conversion"
14478 #. type: Plain text
14479 #: doc/guix.texi:6122
14481 "The @command{guix import} command is useful for people who would like to add "
14482 "a package to the distribution with as little work as possible---a legitimate "
14483 "demand. The command knows of a few repositories from which it can "
14484 "``import'' package metadata. The result is a package definition, or a "
14485 "template thereof, in the format we know (@pxref{Defining Packages})."
14489 #: doc/guix.texi:6127
14491 msgid "guix import @var{importer} @var{options}@dots{}\n"
14494 #. type: Plain text
14495 #: doc/guix.texi:6133
14497 "@var{importer} specifies the source from which to import package metadata, "
14498 "and @var{options} specifies a package identifier and other options specific "
14499 "to @var{importer}. Currently, the available ``importers'' are:"
14503 #: doc/guix.texi:6135 doc/guix.texi:6588
14509 #: doc/guix.texi:6139
14511 "Import metadata for the given GNU package. This provides a template for the "
14512 "latest version of that GNU package, including the hash of its source "
14513 "tarball, and its canonical synopsis and description."
14517 #: doc/guix.texi:6142
14519 "Additional information such as the package dependencies and its license "
14520 "needs to be figured out manually."
14524 #: doc/guix.texi:6145
14526 "For example, the following command returns a package definition for GNU@tie{}"
14531 #: doc/guix.texi:6148
14533 msgid "guix import gnu hello\n"
14537 #: doc/guix.texi:6151 doc/guix.texi:6369 doc/guix.texi:6414 doc/guix.texi:6438
14538 msgid "Specific command-line options are:"
14542 #: doc/guix.texi:6153 doc/guix.texi:6689
14544 msgid "--key-download=@var{policy}"
14548 #: doc/guix.texi:6157
14550 "As for @code{guix refresh}, specify the policy to handle missing OpenPGP "
14551 "keys when verifying the package signature. @xref{Invoking guix refresh, "
14552 "@code{--key-download}}."
14556 #: doc/guix.texi:6159 doc/guix.texi:6160 doc/guix.texi:6606
14562 #: doc/guix.texi:6168
14564 "Import metadata from the @uref{https://pypi.python.org/, Python Package "
14565 "Index}@footnote{This functionality requires Guile-JSON to be installed. "
14566 "@xref{Requirements}.}. Information is taken from the JSON-formatted "
14567 "description available at @code{pypi.python.org} and usually includes all the "
14568 "relevant information, including package dependencies. For maximum "
14569 "efficiency, it is recommended to install the @command{unzip} utility, so "
14570 "that the importer can unzip Python wheels and gather data from them."
14574 #: doc/guix.texi:6171
14576 "The command below imports metadata for the @code{itsdangerous} Python "
14581 #: doc/guix.texi:6174
14583 msgid "guix import pypi itsdangerous\n"
14587 #: doc/guix.texi:6176 doc/guix.texi:6177 doc/guix.texi:6608
14593 #: doc/guix.texi:6188
14595 "Import metadata from @uref{https://rubygems.org/, RubyGems}@footnote{This "
14596 "functionality requires Guile-JSON to be installed. @xref{Requirements}.}. "
14597 "Information is taken from the JSON-formatted description available at "
14598 "@code{rubygems.org} and includes most relevant information, including "
14599 "runtime dependencies. There are some caveats, however. The metadata "
14600 "doesn't distinguish between synopses and descriptions, so the same string is "
14601 "used for both fields. Additionally, the details of non-Ruby dependencies "
14602 "required to build native extensions is unavailable and left as an exercise "
14607 #: doc/guix.texi:6190
14608 msgid "The command below imports metadata for the @code{rails} Ruby package:"
14612 #: doc/guix.texi:6193
14614 msgid "guix import gem rails\n"
14618 #: doc/guix.texi:6195 doc/guix.texi:6604
14624 #: doc/guix.texi:6196
14630 #: doc/guix.texi:6206
14632 "Import metadata from @uref{https://www.metacpan.org/, MetaCPAN}"
14633 "@footnote{This functionality requires Guile-JSON to be installed. "
14634 "@xref{Requirements}.}. Information is taken from the JSON-formatted "
14635 "metadata provided through @uref{https://fastapi.metacpan.org/, MetaCPAN's "
14636 "API} and includes most relevant information, such as module dependencies. "
14637 "License information should be checked closely. If Perl is available in the "
14638 "store, then the @code{corelist} utility will be used to filter core modules "
14639 "out of the list of dependencies."
14643 #: doc/guix.texi:6209
14645 "The command command below imports metadata for the @code{Acme::Boolean} Perl "
14650 #: doc/guix.texi:6212
14652 msgid "guix import cpan Acme::Boolean\n"
14656 #: doc/guix.texi:6214 doc/guix.texi:6600
14662 #: doc/guix.texi:6215
14668 #: doc/guix.texi:6216
14670 msgid "Bioconductor"
14674 #: doc/guix.texi:6220
14676 "Import metadata from @uref{https://cran.r-project.org/, CRAN}, the central "
14677 "repository for the @uref{http://r-project.org, GNU@tie{}R statistical and "
14678 "graphical environment}."
14682 #: doc/guix.texi:6222
14684 "Information is extracted from the @code{DESCRIPTION} file of the package."
14688 #: doc/guix.texi:6225
14690 "The command command below imports metadata for the @code{Cairo} R package:"
14694 #: doc/guix.texi:6228
14696 msgid "guix import cran Cairo\n"
14700 #: doc/guix.texi:6233
14702 "When @code{--recursive} is added, the importer will traverse the dependency "
14703 "graph of the given upstream package recursively and generate package "
14704 "expressions for all those packages that are not yet in Guix."
14708 #: doc/guix.texi:6238
14710 "When @code{--archive=bioconductor} is added, metadata is imported from "
14711 "@uref{https://www.bioconductor.org/, Bioconductor}, a repository of R "
14712 "packages for for the analysis and comprehension of high-throughput genomic "
14713 "data in bioinformatics."
14717 #: doc/guix.texi:6241
14719 "Information is extracted from the @code{DESCRIPTION} file of a package "
14720 "published on the web interface of the Bioconductor SVN repository."
14724 #: doc/guix.texi:6244
14726 "The command below imports metadata for the @code{GenomicRanges} R package:"
14730 #: doc/guix.texi:6247
14732 msgid "guix import cran --archive=bioconductor GenomicRanges\n"
14736 #: doc/guix.texi:6249
14742 #: doc/guix.texi:6250
14748 #: doc/guix.texi:6251
14754 #: doc/guix.texi:6255
14756 "Import metadata from @uref{http://www.ctan.org/, CTAN}, the comprehensive "
14757 "TeX archive network for TeX packages that are part of the @uref{https://www."
14758 "tug.org/texlive/, TeX Live distribution}."
14762 #: doc/guix.texi:6260
14764 "Information about the package is obtained through the XML API provided by "
14765 "CTAN, while the source code is downloaded from the SVN repository of the Tex "
14766 "Live project. This is done because the CTAN does not keep versioned "
14771 #: doc/guix.texi:6263
14773 "The command command below imports metadata for the @code{fontspec} TeX "
14778 #: doc/guix.texi:6266
14780 msgid "guix import texlive fontspec\n"
14784 #: doc/guix.texi:6272
14786 "When @code{--archive=DIRECTORY} is added, the source code is downloaded not "
14787 "from the @file{latex} sub-directory of the @file{texmf-dist/source} tree in "
14788 "the TeX Live SVN repository, but from the specified sibling directory under "
14793 #: doc/guix.texi:6276
14795 "The command below imports metadata for the @code{ifxetex} package from CTAN "
14796 "while fetching the sources from the directory @file{texmf/source/generic}:"
14800 #: doc/guix.texi:6279
14802 msgid "guix import texlive --archive=generic ifxetex\n"
14806 #: doc/guix.texi:6281
14812 #: doc/guix.texi:6282
14814 msgid "JSON, import"
14818 #: doc/guix.texi:6287
14820 "Import package metadata from a local JSON file@footnote{This functionality "
14821 "requires Guile-JSON to be installed. @xref{Requirements}.}. Consider the "
14822 "following example package definition in JSON format:"
14826 #: doc/guix.texi:6300
14830 " \"name\": \"hello\",\n"
14831 " \"version\": \"2.10\",\n"
14832 " \"source\": \"mirror://gnu/hello/hello-2.10.tar.gz\",\n"
14833 " \"build-system\": \"gnu\",\n"
14834 " \"home-page\": \"https://www.gnu.org/software/hello/\",\n"
14835 " \"synopsis\": \"Hello, GNU world: An example GNU package\",\n"
14836 " \"description\": \"GNU Hello prints a greeting.\",\n"
14837 " \"license\": \"GPL-3.0+\",\n"
14838 " \"native-inputs\": [\"gcc@@6\"]\n"
14843 #: doc/guix.texi:6306
14845 "The field names are the same as for the @code{<package>} record "
14846 "(@xref{Defining Packages}). References to other packages are provided as "
14847 "JSON lists of quoted package specification strings such as @code{guile} or "
14848 "@code{guile@@2.0}."
14852 #: doc/guix.texi:6309
14854 "The importer also supports a more explicit source definition using the "
14855 "common fields for @code{<origin>} records:"
14859 #: doc/guix.texi:6322
14864 " \"source\": @{\n"
14865 " \"method\": \"url-fetch\",\n"
14866 " \"uri\": \"mirror://gnu/hello/hello-2.10.tar.gz\",\n"
14867 " \"sha256\": @{\n"
14868 " \"base32\": \"0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i\"\n"
14876 #: doc/guix.texi:6326
14878 "The command below reads metadata from the JSON file @code{hello.json} and "
14879 "outputs a package expression:"
14883 #: doc/guix.texi:6329
14885 msgid "guix import json hello.json\n"
14889 #: doc/guix.texi:6331
14895 #: doc/guix.texi:6340
14897 "Import metadata from a local copy of the source of the @uref{http://nixos."
14898 "org/nixpkgs/, Nixpkgs distribution}@footnote{This relies on the @command{nix-"
14899 "instantiate} command of @uref{http://nixos.org/nix/, Nix}.}. Package "
14900 "definitions in Nixpkgs are typically written in a mixture of Nix-language "
14901 "and Bash code. This command only imports the high-level package structure "
14902 "that is written in the Nix language. It normally includes all the basic "
14903 "fields of a package definition."
14907 #: doc/guix.texi:6343
14909 "When importing a GNU package, the synopsis and descriptions are replaced by "
14910 "their canonical upstream variant."
14914 #: doc/guix.texi:6345
14915 msgid "Usually, you will first need to do:"
14919 #: doc/guix.texi:6348
14921 msgid "export NIX_REMOTE=daemon\n"
14925 #: doc/guix.texi:6352
14927 "so that @command{nix-instantiate} does not try to open the Nix database."
14931 #: doc/guix.texi:6356
14933 "As an example, the command below imports the package definition of "
14934 "LibreOffice (more precisely, it imports the definition of the package bound "
14935 "to the @code{libreoffice} top-level attribute):"
14939 #: doc/guix.texi:6359
14941 msgid "guix import nix ~/path/to/nixpkgs libreoffice\n"
14945 #: doc/guix.texi:6361 doc/guix.texi:6362 doc/guix.texi:6612
14951 #: doc/guix.texi:6367
14953 "Import metadata from the Haskell community's central package archive "
14954 "@uref{https://hackage.haskell.org/, Hackage}. Information is taken from "
14955 "Cabal files and includes all the relevant information, including package "
14960 #: doc/guix.texi:6371
14966 #: doc/guix.texi:6372
14972 #: doc/guix.texi:6374
14973 msgid "Read a Cabal file from standard input."
14977 #: doc/guix.texi:6374 doc/guix.texi:6416
14979 msgid "--no-test-dependencies"
14983 #: doc/guix.texi:6375 doc/guix.texi:6417
14989 #: doc/guix.texi:6377 doc/guix.texi:6419
14990 msgid "Do not include dependencies required only by the test suites."
14994 #: doc/guix.texi:6377
14996 msgid "--cabal-environment=@var{alist}"
15000 #: doc/guix.texi:6378
15002 msgid "-e @var{alist}"
15006 #: doc/guix.texi:6387
15008 "@var{alist} is a Scheme alist defining the environment in which the Cabal "
15009 "conditionals are evaluated. The accepted keys are: @code{os}, @code{arch}, "
15010 "@code{impl} and a string representing the name of a flag. The value "
15011 "associated with a flag has to be either the symbol @code{true} or "
15012 "@code{false}. The value associated with other keys has to conform to the "
15013 "Cabal file format definition. The default value associated with the keys "
15014 "@code{os}, @code{arch} and @code{impl} is @samp{linux}, @samp{x86_64} and "
15015 "@samp{ghc}, respectively."
15019 #: doc/guix.texi:6392
15021 "The command below imports metadata for the latest version of the @code{HTTP} "
15022 "Haskell package without including test dependencies and specifying the value "
15023 "of the flag @samp{network-uri} as @code{false}:"
15027 #: doc/guix.texi:6395
15029 msgid "guix import hackage -t -e \"'((\\\"network-uri\\\" . false))\" HTTP\n"
15033 #: doc/guix.texi:6399
15035 "A specific package version may optionally be specified by following the "
15036 "package name by an at-sign and a version number as in the following example:"
15040 #: doc/guix.texi:6402
15042 msgid "guix import hackage mtl@@2.1.3.1\n"
15046 #: doc/guix.texi:6404 doc/guix.texi:6405 doc/guix.texi:6614
15052 #: doc/guix.texi:6412
15054 "The @code{stackage} importer is a wrapper around the @code{hackage} one. It "
15055 "takes a package name, looks up the package version included in a long-term "
15056 "support (LTS) @uref{https://www.stackage.org, Stackage} release and uses the "
15057 "@code{hackage} importer to retrieve its metadata. Note that it is up to you "
15058 "to select an LTS release compatible with the GHC compiler used by Guix."
15062 #: doc/guix.texi:6419
15064 msgid "--lts-version=@var{version}"
15068 #: doc/guix.texi:6420
15070 msgid "-r @var{version}"
15074 #: doc/guix.texi:6423
15076 "@var{version} is the desired LTS release version. If omitted the latest "
15081 #: doc/guix.texi:6427
15083 "The command below imports metadata for the @code{HTTP} Haskell package "
15084 "included in the LTS Stackage release version 7.18:"
15088 #: doc/guix.texi:6430
15090 msgid "guix import stackage --lts-version=7.18 HTTP\n"
15094 #: doc/guix.texi:6432 doc/guix.texi:6433 doc/guix.texi:6598
15100 #: doc/guix.texi:6436
15102 "Import metadata from an Emacs Lisp Package Archive (ELPA) package repository "
15103 "(@pxref{Packages,,, emacs, The GNU Emacs Manual})."
15107 #: doc/guix.texi:6440
15109 msgid "--archive=@var{repo}"
15113 #: doc/guix.texi:6441
15115 msgid "-a @var{repo}"
15119 #: doc/guix.texi:6445
15121 "@var{repo} identifies the archive repository from which to retrieve the "
15122 "information. Currently the supported repositories and their identifiers are:"
15126 #: doc/guix.texi:6449
15128 "@uref{http://elpa.gnu.org/packages, GNU}, selected by the @code{gnu} "
15129 "identifier. This is the default."
15133 #: doc/guix.texi:6455
15135 "Packages from @code{elpa.gnu.org} are signed with one of the keys contained "
15136 "in the GnuPG keyring at @file{share/emacs/25.1/etc/package-keyring.gpg} (or "
15137 "similar) in the @code{emacs} package (@pxref{Package Installation, ELPA "
15138 "package signatures,, emacs, The GNU Emacs Manual})."
15142 #: doc/guix.texi:6459
15144 "@uref{http://stable.melpa.org/packages, MELPA-Stable}, selected by the "
15145 "@code{melpa-stable} identifier."
15149 #: doc/guix.texi:6463
15151 "@uref{http://melpa.org/packages, MELPA}, selected by the @code{melpa} "
15156 #: doc/guix.texi:6466 doc/guix.texi:6467 doc/guix.texi:6616
15162 #: doc/guix.texi:6470
15164 "Import metadata from the crates.io Rust package repository @uref{https://"
15165 "crates.io, crates.io}."
15168 #. type: Plain text
15169 #: doc/guix.texi:6475
15171 "The structure of the @command{guix import} code is modular. It would be "
15172 "useful to have more importers for other package formats, and your help is "
15173 "welcome here (@pxref{Contributing})."
15177 #: doc/guix.texi:6477
15179 msgid "Invoking @command{guix refresh}"
15182 #. type: command{#1}
15183 #: doc/guix.texi:6479
15185 msgid "guix refresh"
15188 #. type: Plain text
15189 #: doc/guix.texi:6484
15191 "The primary audience of the @command{guix refresh} command is developers of "
15192 "the GNU software distribution. By default, it reports any packages provided "
15193 "by the distribution that are outdated compared to the latest upstream "
15194 "version, like this:"
15198 #: doc/guix.texi:6489
15202 "gnu/packages/gettext.scm:29:13: gettext would be upgraded from 0.18.1.1 to 0.18.2.1\n"
15203 "gnu/packages/glib.scm:77:12: glib would be upgraded from 2.34.3 to 2.37.0\n"
15206 #. type: Plain text
15207 #: doc/guix.texi:6493
15209 "Alternately, one can specify packages to consider, in which case a warning "
15210 "is emitted for packages that lack an updater:"
15214 #: doc/guix.texi:6498
15217 "$ guix refresh coreutils guile guile-ssh\n"
15218 "gnu/packages/ssh.scm:205:2: warning: no updater for guile-ssh\n"
15219 "gnu/packages/guile.scm:136:12: guile would be upgraded from 2.0.12 to 2.0.13\n"
15222 #. type: Plain text
15223 #: doc/guix.texi:6507
15225 "@command{guix refresh} browses the upstream repository of each package and "
15226 "determines the highest version number of the releases therein. The command "
15227 "knows how to update specific types of packages: GNU packages, ELPA packages, "
15228 "etc.---see the documentation for @option{--type} below. There are many "
15229 "packages, though, for which it lacks a method to determine whether a new "
15230 "upstream release is available. However, the mechanism is extensible, so "
15231 "feel free to get in touch with us to add a new method!"
15234 #. type: Plain text
15235 #: doc/guix.texi:6512
15237 "Sometimes the upstream name differs from the package name used in Guix, and "
15238 "@command{guix refresh} needs a little help. Most updaters honor the "
15239 "@code{upstream-name} property in package definitions, which can be used to "
15244 #: doc/guix.texi:6519
15247 "(define-public network-manager\n"
15249 " (name \"network-manager\")\n"
15251 " (properties '((upstream-name . \"NetworkManager\")))))\n"
15254 #. type: Plain text
15255 #: doc/guix.texi:6531
15257 "When passed @code{--update}, it modifies distribution source files to update "
15258 "the version numbers and source tarball hashes of those package recipes "
15259 "(@pxref{Defining Packages}). This is achieved by downloading each package's "
15260 "latest source tarball and its associated OpenPGP signature, authenticating "
15261 "the downloaded tarball against its signature using @command{gpg}, and "
15262 "finally computing its hash. When the public key used to sign the tarball is "
15263 "missing from the user's keyring, an attempt is made to automatically "
15264 "retrieve it from a public key server; when this is successful, the key is "
15265 "added to the user's keyring; otherwise, @command{guix refresh} reports an "
15269 #. type: Plain text
15270 #: doc/guix.texi:6533
15271 msgid "The following options are supported:"
15275 #: doc/guix.texi:6541 doc/guix.texi:7102
15276 msgid "This is useful to precisely refer to a package, as in this example:"
15280 #: doc/guix.texi:6544
15282 msgid "guix refresh -l -e '(@@@@ (gnu packages commencement) glibc-final)'\n"
15286 #: doc/guix.texi:6548
15288 "This command lists the dependents of the ``final'' libc (essentially all the "
15293 #: doc/guix.texi:6549
15299 #: doc/guix.texi:6550
15305 #: doc/guix.texi:6554
15307 "Update distribution source files (package recipes) in place. This is "
15308 "usually run from a checkout of the Guix source tree (@pxref{Running Guix "
15309 "Before It Is Installed}):"
15313 #: doc/guix.texi:6557
15315 msgid "$ ./pre-inst-env guix refresh -s non-core -u\n"
15319 #: doc/guix.texi:6560
15320 msgid "@xref{Defining Packages}, for more information on package definitions."
15324 #: doc/guix.texi:6561
15326 msgid "--select=[@var{subset}]"
15330 #: doc/guix.texi:6562
15332 msgid "-s @var{subset}"
15336 #: doc/guix.texi:6565
15338 "Select all the packages in @var{subset}, one of @code{core} or @code{non-"
15343 #: doc/guix.texi:6572
15345 "The @code{core} subset refers to all the packages at the core of the "
15346 "distribution---i.e., packages that are used to build ``everything else''. "
15347 "This includes GCC, libc, Binutils, Bash, etc. Usually, changing one of "
15348 "these packages in the distribution entails a rebuild of all the others. "
15349 "Thus, such updates are an inconvenience to users in terms of build time or "
15350 "bandwidth used to achieve the upgrade."
15354 #: doc/guix.texi:6576
15356 "The @code{non-core} subset refers to the remaining packages. It is "
15357 "typically useful in cases where an update of the core packages would be "
15362 #: doc/guix.texi:6581
15364 "Select all the packages from the manifest in @var{file}. This is useful to "
15365 "check if any packages of the user manifest can be updated."
15369 #: doc/guix.texi:6582
15371 msgid "--type=@var{updater}"
15375 #: doc/guix.texi:6583
15377 msgid "-t @var{updater}"
15381 #: doc/guix.texi:6586
15383 "Select only packages handled by @var{updater} (may be a comma-separated list "
15384 "of updaters). Currently, @var{updater} may be one of:"
15388 #: doc/guix.texi:6590
15389 msgid "the updater for GNU packages;"
15393 #: doc/guix.texi:6590
15399 #: doc/guix.texi:6592
15400 msgid "the updater for GNOME packages;"
15404 #: doc/guix.texi:6592
15410 #: doc/guix.texi:6594
15411 msgid "the updater for KDE packages;"
15415 #: doc/guix.texi:6594
15421 #: doc/guix.texi:6596
15422 msgid "the updater for X.org packages;"
15426 #: doc/guix.texi:6596
15432 #: doc/guix.texi:6598
15433 msgid "the updater for packages hosted on kernel.org;"
15437 #: doc/guix.texi:6600
15438 msgid "the updater for @uref{http://elpa.gnu.org/, ELPA} packages;"
15442 #: doc/guix.texi:6602
15443 msgid "the updater for @uref{https://cran.r-project.org/, CRAN} packages;"
15447 #: doc/guix.texi:6602
15449 msgid "bioconductor"
15453 #: doc/guix.texi:6604
15455 "the updater for @uref{https://www.bioconductor.org/, Bioconductor} R "
15460 #: doc/guix.texi:6606
15461 msgid "the updater for @uref{http://www.cpan.org/, CPAN} packages;"
15465 #: doc/guix.texi:6608
15466 msgid "the updater for @uref{https://pypi.python.org, PyPI} packages."
15470 #: doc/guix.texi:6610
15471 msgid "the updater for @uref{https://rubygems.org, RubyGems} packages."
15475 #: doc/guix.texi:6610
15481 #: doc/guix.texi:6612
15482 msgid "the updater for @uref{https://github.com, GitHub} packages."
15486 #: doc/guix.texi:6614
15487 msgid "the updater for @uref{https://hackage.haskell.org, Hackage} packages."
15491 #: doc/guix.texi:6616
15492 msgid "the updater for @uref{https://www.stackage.org, Stackage} packages."
15496 #: doc/guix.texi:6618
15497 msgid "the updater for @uref{https://crates.io, Crates} packages."
15501 #: doc/guix.texi:6622
15503 "For instance, the following command only checks for updates of Emacs "
15504 "packages hosted at @code{elpa.gnu.org} and for updates of CRAN packages:"
15508 #: doc/guix.texi:6627
15511 "$ guix refresh --type=elpa,cran\n"
15512 "gnu/packages/statistics.scm:819:13: r-testthat would be upgraded from 0.10.0 to 0.11.0\n"
15513 "gnu/packages/emacs.scm:856:13: emacs-auctex would be upgraded from 11.88.6 to 11.88.9\n"
15516 #. type: Plain text
15517 #: doc/guix.texi:6633
15519 "In addition, @command{guix refresh} can be passed one or more package names, "
15520 "as in this example:"
15524 #: doc/guix.texi:6636
15526 msgid "$ ./pre-inst-env guix refresh -u emacs idutils gcc@@4.8\n"
15529 #. type: Plain text
15530 #: doc/guix.texi:6642
15532 "The command above specifically updates the @code{emacs} and @code{idutils} "
15533 "packages. The @code{--select} option would have no effect in this case."
15536 #. type: Plain text
15537 #: doc/guix.texi:6647
15539 "When considering whether to upgrade a package, it is sometimes convenient to "
15540 "know which packages would be affected by the upgrade and should be checked "
15541 "for compatibility. For this the following option may be used when passing "
15542 "@command{guix refresh} one or more package names:"
15546 #: doc/guix.texi:6650
15548 msgid "--list-updaters"
15552 #: doc/guix.texi:6651
15558 #: doc/guix.texi:6653
15559 msgid "List available updaters and exit (see @option{--type} above.)"
15563 #: doc/guix.texi:6656
15565 "For each updater, display the fraction of packages it covers; at the end, "
15566 "display the fraction of packages covered by all these updaters."
15570 #: doc/guix.texi:6657
15572 msgid "--list-dependent"
15576 #: doc/guix.texi:6658 doc/guix.texi:6803
15582 #: doc/guix.texi:6661
15584 "List top-level dependent packages that would need to be rebuilt as a result "
15585 "of upgrading one or more packages."
15589 #: doc/guix.texi:6665
15591 "@xref{Invoking guix graph, the @code{reverse-package} type of @command{guix "
15592 "graph}}, for information on how to visualize the list of dependents of a "
15596 #. type: Plain text
15597 #: doc/guix.texi:6671
15599 "Be aware that the @code{--list-dependent} option only @emph{approximates} "
15600 "the rebuilds that would be required as a result of an upgrade. More "
15601 "rebuilds might be required under some circumstances."
15605 #: doc/guix.texi:6676
15608 "$ guix refresh --list-dependent flex\n"
15609 "Building the following 120 packages would ensure 213 dependent packages are rebuilt:\n"
15610 "hop@@2.4.0 geiser@@0.4 notmuch@@0.18 mu@@0.9.9.5 cflow@@1.4 idutils@@4.6 @dots{}\n"
15613 #. type: Plain text
15614 #: doc/guix.texi:6680
15616 "The command above lists a set of packages that could be built to check for "
15617 "compatibility with an upgraded @code{flex} package."
15620 #. type: Plain text
15621 #: doc/guix.texi:6682
15622 msgid "The following options can be used to customize GnuPG operation:"
15626 #: doc/guix.texi:6685
15628 msgid "--gpg=@var{command}"
15632 #: doc/guix.texi:6688
15634 "Use @var{command} as the GnuPG 2.x command. @var{command} is searched for "
15639 #: doc/guix.texi:6692
15641 "Handle missing OpenPGP keys according to @var{policy}, which may be one of:"
15645 #: doc/guix.texi:6694 doc/guix.texi:13715
15651 #: doc/guix.texi:6697
15653 "Always download missing OpenPGP keys from the key server, and add them to "
15654 "the user's GnuPG keyring."
15658 #: doc/guix.texi:6698 doc/guix.texi:13717
15664 #: doc/guix.texi:6700
15665 msgid "Never try to download missing OpenPGP keys. Instead just bail out."
15669 #: doc/guix.texi:6701
15671 msgid "interactive"
15675 #: doc/guix.texi:6704
15677 "When a package signed with an unknown OpenPGP key is encountered, ask the "
15678 "user whether to download it or not. This is the default behavior."
15682 #: doc/guix.texi:6706
15684 msgid "--key-server=@var{host}"
15688 #: doc/guix.texi:6708
15689 msgid "Use @var{host} as the OpenPGP key server when importing a public key."
15692 #. type: Plain text
15693 #: doc/guix.texi:6721
15695 "The @code{github} updater uses the @uref{https://developer.github.com/v3/, "
15696 "GitHub API} to query for new releases. When used repeatedly e.g. when "
15697 "refreshing all packages, GitHub will eventually refuse to answer any further "
15698 "API requests. By default 60 API requests per hour are allowed, and a full "
15699 "refresh on all GitHub packages in Guix requires more than this. "
15700 "Authentication with GitHub through the use of an API token alleviates these "
15701 "limits. To use an API token, set the environment variable "
15702 "@code{GUIX_GITHUB_TOKEN} to a token procured from @uref{https://github.com/"
15703 "settings/tokens} or otherwise."
15707 #: doc/guix.texi:6724
15709 msgid "Invoking @command{guix lint}"
15712 #. type: command{#1}
15713 #: doc/guix.texi:6726
15719 #: doc/guix.texi:6727
15721 msgid "package, checking for errors"
15724 #. type: Plain text
15725 #: doc/guix.texi:6733
15727 "The @command{guix lint} command is meant to help package developers avoid "
15728 "common errors and use a consistent style. It runs a number of checks on a "
15729 "given set of packages in order to find common mistakes in their "
15730 "definitions. Available @dfn{checkers} include (see @code{--list-checkers} "
15731 "for a complete list):"
15735 #: doc/guix.texi:6739
15737 "Validate certain typographical and stylistic rules about package "
15738 "descriptions and synopses."
15742 #: doc/guix.texi:6740
15744 msgid "inputs-should-be-native"
15748 #: doc/guix.texi:6742
15749 msgid "Identify inputs that should most likely be native inputs."
15753 #: doc/guix.texi:6745
15759 #: doc/guix.texi:6746
15761 msgid "source-file-name"
15765 #: doc/guix.texi:6752
15767 "Probe @code{home-page} and @code{source} URLs and report those that are "
15768 "invalid. Suggest a @code{mirror://} URL when applicable. Check that the "
15769 "source file name is meaningful, e.g. is not just a version number or ``git-"
15770 "checkout'', without a declared @code{file-name} (@pxref{origin Reference})."
15774 #: doc/guix.texi:6753
15780 #: doc/guix.texi:6754 doc/guix.texi:21485
15782 msgid "security vulnerabilities"
15786 #: doc/guix.texi:6755
15788 msgid "CVE, Common Vulnerabilities and Exposures"
15792 #: doc/guix.texi:6760
15794 "Report known vulnerabilities found in the Common Vulnerabilities and "
15795 "Exposures (CVE) databases of the current and past year @uref{https://nvd."
15796 "nist.gov/download.cfm#CVE_FEED, published by the US NIST}."
15800 #: doc/guix.texi:6762
15802 "To view information about a particular vulnerability, visit pages such as:"
15805 #. type: indicateurl{#1}
15806 #: doc/guix.texi:6766
15807 msgid "https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-YYYY-ABCD"
15810 #. type: indicateurl{#1}
15811 #: doc/guix.texi:6768
15812 msgid "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-YYYY-ABCD"
15816 #: doc/guix.texi:6773
15818 "where @code{CVE-YYYY-ABCD} is the CVE identifier---e.g., "
15819 "@code{CVE-2015-7554}."
15823 #: doc/guix.texi:6778
15825 "Package developers can specify in package recipes the @uref{https://nvd.nist."
15826 "gov/cpe.cfm,Common Platform Enumeration (CPE)} name and version of the "
15827 "package when they differ from the name that Guix uses, as in this example:"
15831 #: doc/guix.texi:6785
15835 " (name \"grub\")\n"
15837 " ;; CPE calls this package \"grub2\".\n"
15838 " (properties '((cpe-name . \"grub2\"))))\n"
15842 #: doc/guix.texi:6787
15848 #: doc/guix.texi:6790
15850 "Warn about obvious source code formatting issues: trailing white space, use "
15851 "of tabulations, etc."
15855 #: doc/guix.texi:6796
15857 msgid "guix lint @var{options} @var{package}@dots{}\n"
15860 #. type: Plain text
15861 #: doc/guix.texi:6800
15863 "If no package is given on the command line, then all packages are checked. "
15864 "The @var{options} may be zero or more of the following:"
15868 #: doc/guix.texi:6802
15870 msgid "--list-checkers"
15874 #: doc/guix.texi:6806
15876 "List and describe all the available checkers that will be run on packages "
15881 #: doc/guix.texi:6807
15887 #: doc/guix.texi:6808
15893 #: doc/guix.texi:6811
15895 "Only enable the checkers specified in a comma-separated list using the names "
15896 "returned by @code{--list-checkers}."
15900 #: doc/guix.texi:6815
15902 msgid "Invoking @command{guix size}"
15906 #: doc/guix.texi:6817
15912 #: doc/guix.texi:6818
15914 msgid "package size"
15917 #. type: command{#1}
15918 #: doc/guix.texi:6820
15923 #. type: Plain text
15924 #: doc/guix.texi:6827
15926 "The @command{guix size} command helps package developers profile the disk "
15927 "usage of packages. It is easy to overlook the impact of an additional "
15928 "dependency added to a package, or the impact of using a single output for a "
15929 "package that could easily be split (@pxref{Packages with Multiple "
15930 "Outputs}). Such are the typical issues that @command{guix size} can "
15934 #. type: Plain text
15935 #: doc/guix.texi:6831
15937 "The command can be passed a package specification such as @code{gcc@@4.8} or "
15938 "@code{guile:debug}, or a file name in the store. Consider this example:"
15942 #: doc/guix.texi:6841
15945 "$ guix size coreutils\n"
15946 "store item total self\n"
15947 "/gnu/store/@dots{}-coreutils-8.23 70.0 13.9 19.8%\n"
15948 "/gnu/store/@dots{}-gmp-6.0.0a 55.3 2.5 3.6%\n"
15949 "/gnu/store/@dots{}-acl-2.2.52 53.7 0.5 0.7%\n"
15950 "/gnu/store/@dots{}-attr-2.4.46 53.2 0.3 0.5%\n"
15951 "/gnu/store/@dots{}-gcc-4.8.4-lib 52.9 15.7 22.4%\n"
15952 "/gnu/store/@dots{}-glibc-2.21 37.2 37.2 53.1%\n"
15955 #. type: Plain text
15956 #: doc/guix.texi:6847
15958 "The store items listed here constitute the @dfn{transitive closure} of "
15959 "Coreutils---i.e., Coreutils and all its dependencies, recursively---as would "
15964 #: doc/guix.texi:6850
15966 msgid "$ guix gc -R /gnu/store/@dots{}-coreutils-8.23\n"
15969 #. type: Plain text
15970 #: doc/guix.texi:6858
15972 "Here the output shows three columns next to store items. The first column, "
15973 "labeled ``total'', shows the size in mebibytes (MiB) of the closure of the "
15974 "store item---that is, its own size plus the size of all its dependencies. "
15975 "The next column, labeled ``self'', shows the size of the item itself. The "
15976 "last column shows the ratio of the size of the item itself to the space "
15977 "occupied by all the items listed here."
15980 #. type: Plain text
15981 #: doc/guix.texi:6863
15983 "In this example, we see that the closure of Coreutils weighs in at 70@tie{}"
15984 "MiB, half of which is taken by libc. (That libc represents a large fraction "
15985 "of the closure is not a problem @i{per se} because it is always available on "
15986 "the system anyway.)"
15989 #. type: Plain text
15990 #: doc/guix.texi:6869
15992 "When the package passed to @command{guix size} is available in the store, "
15993 "@command{guix size} queries the daemon to determine its dependencies, and "
15994 "measures its size in the store, similar to @command{du -ms --apparent-size} "
15995 "(@pxref{du invocation,,, coreutils, GNU Coreutils})."
15998 #. type: Plain text
15999 #: doc/guix.texi:6874
16001 "When the given package is @emph{not} in the store, @command{guix size} "
16002 "reports information based on the available substitutes "
16003 "(@pxref{Substitutes}). This makes it possible it to profile disk usage of "
16004 "store items that are not even on disk, only available remotely."
16006 "Lorsque le paquet donné n'est @emph{pas} dans le dépôt, @command{guix size} "
16007 "rapporte les informations en se basant sur les substituts disponibles "
16008 "(@pxref{Substituts}). Cela permet de profiler l'utilisation du disque des "
16009 "éléments du dépôt qui ne sont pas sur le disque, mais seulement disponibles "
16012 #. type: Plain text
16013 #: doc/guix.texi:6876
16014 msgid "You can also specify several package names:"
16018 #: doc/guix.texi:6886
16021 "$ guix size coreutils grep sed bash\n"
16022 "store item total self\n"
16023 "/gnu/store/@dots{}-coreutils-8.24 77.8 13.8 13.4%\n"
16024 "/gnu/store/@dots{}-grep-2.22 73.1 0.8 0.8%\n"
16025 "/gnu/store/@dots{}-bash-4.3.42 72.3 4.7 4.6%\n"
16026 "/gnu/store/@dots{}-readline-6.3 67.6 1.2 1.2%\n"
16028 "total: 102.3 MiB\n"
16031 #. type: Plain text
16032 #: doc/guix.texi:6892
16034 "In this example we see that the combination of the four packages takes "
16035 "102.3@tie{}MiB in total, which is much less than the sum of each closure "
16036 "since they have a lot of dependencies in common."
16039 #. type: Plain text
16040 #: doc/guix.texi:6894
16041 msgid "The available options are:"
16045 #: doc/guix.texi:6900
16047 "Use substitute information from @var{urls}. @xref{client-substitute-urls, "
16048 "the same option for @code{guix build}}."
16052 #: doc/guix.texi:6901
16054 msgid "--sort=@var{key}"
16058 #: doc/guix.texi:6903
16059 msgid "Sort lines according to @var{key}, one of the following options:"
16063 #: doc/guix.texi:6905
16069 #: doc/guix.texi:6907
16070 msgid "the size of each item (the default);"
16074 #: doc/guix.texi:6909
16075 msgid "the total size of the item's closure."
16079 #: doc/guix.texi:6911
16081 msgid "--map-file=@var{file}"
16085 #: doc/guix.texi:6913
16086 msgid "Write a graphical map of disk usage in PNG format to @var{file}."
16090 #: doc/guix.texi:6915
16091 msgid "For the example above, the map looks like this:"
16095 #: doc/guix.texi:6918
16097 "@image{images/coreutils-size-map,5in,, map of Coreutils disk usage produced "
16098 "by @command{guix size}}"
16102 #: doc/guix.texi:6923
16104 "This option requires that @uref{http://wingolog.org/software/guile-"
16105 "charting/, Guile-Charting} be installed and visible in Guile's module search "
16106 "path. When that is not the case, @command{guix size} fails as it tries to "
16111 #: doc/guix.texi:6927
16112 msgid "Consider packages for @var{system}---e.g., @code{x86_64-linux}."
16116 #: doc/guix.texi:6931
16118 msgid "Invoking @command{guix graph}"
16122 #: doc/guix.texi:6933
16127 #. type: command{#1}
16128 #: doc/guix.texi:6934
16133 #. type: Plain text
16134 #: doc/guix.texi:6948
16136 "Packages and their dependencies form a @dfn{graph}, specifically a directed "
16137 "acyclic graph (DAG). It can quickly become difficult to have a mental model "
16138 "of the package DAG, so the @command{guix graph} command provides a visual "
16139 "representation of the DAG. By default, @command{guix graph} emits a DAG "
16140 "representation in the input format of @uref{http://www.graphviz.org/, "
16141 "Graphviz}, so its output can be passed directly to the @command{dot} command "
16142 "of Graphviz. It can also emit an HTML page with embedded JavaScript code to "
16143 "display a ``chord diagram'' in a Web browser, using the @uref{https://d3js."
16144 "org/, d3.js} library, or emit Cypher queries to construct a graph in a graph "
16145 "database supporting the @uref{http://www.opencypher.org/, openCypher} query "
16146 "language. The general syntax is:"
16150 #: doc/guix.texi:6951
16152 msgid "guix graph @var{options} @var{package}@dots{}\n"
16155 #. type: Plain text
16156 #: doc/guix.texi:6956
16158 "For example, the following command generates a PDF file representing the "
16159 "package DAG for the GNU@tie{}Core Utilities, showing its build-time "
16164 #: doc/guix.texi:6959
16166 msgid "guix graph coreutils | dot -Tpdf > dag.pdf\n"
16169 #. type: Plain text
16170 #: doc/guix.texi:6962
16171 msgid "The output looks like this:"
16174 #. type: Plain text
16175 #: doc/guix.texi:6964
16177 "@image{images/coreutils-graph,2in,,Dependency graph of the GNU Coreutils}"
16180 #. type: Plain text
16181 #: doc/guix.texi:6966
16182 msgid "Nice little graph, no?"
16185 #. type: Plain text
16186 #: doc/guix.texi:6972
16188 "But there is more than one graph! The one above is concise: it is the graph "
16189 "of package objects, omitting implicit inputs such as GCC, libc, grep, etc. "
16190 "It is often useful to have such a concise graph, but sometimes one may want "
16191 "to see more details. @command{guix graph} supports several types of graphs, "
16192 "allowing you to choose the level of detail:"
16196 #: doc/guix.texi:6978
16198 "This is the default type used in the example above. It shows the DAG of "
16199 "package objects, excluding implicit dependencies. It is concise, but "
16200 "filters out many details."
16204 #: doc/guix.texi:6979
16206 msgid "reverse-package"
16210 #: doc/guix.texi:6981
16211 msgid "This shows the @emph{reverse} DAG of packages. For example:"
16215 #: doc/guix.texi:6984
16217 msgid "guix graph --type=reverse-package ocaml\n"
16221 #: doc/guix.texi:6987
16222 msgid "... yields the graph of packages that depend on OCaml."
16226 #: doc/guix.texi:6992
16228 "Note that for core packages this can yield huge graphs. If all you want is "
16229 "to know the number of packages that depend on a given package, use "
16230 "@command{guix refresh --list-dependent} (@pxref{Invoking guix refresh, "
16231 "@option{--list-dependent}})."
16235 #: doc/guix.texi:6993
16237 msgid "bag-emerged"
16241 #: doc/guix.texi:6995
16242 msgid "This is the package DAG, @emph{including} implicit inputs."
16246 #: doc/guix.texi:6997
16247 msgid "For instance, the following command:"
16251 #: doc/guix.texi:7000
16253 msgid "guix graph --type=bag-emerged coreutils | dot -Tpdf > dag.pdf\n"
16257 #: doc/guix.texi:7003
16258 msgid "... yields this bigger graph:"
16262 #: doc/guix.texi:7005
16264 "@image{images/coreutils-bag-graph,,5in,Detailed dependency graph of the GNU "
16269 #: doc/guix.texi:7008
16271 "At the bottom of the graph, we see all the implicit inputs of @var{gnu-build-"
16272 "system} (@pxref{Build Systems, @code{gnu-build-system}})."
16276 #: doc/guix.texi:7012
16278 "Now, note that the dependencies of these implicit inputs---that is, the "
16279 "@dfn{bootstrap dependencies} (@pxref{Bootstrapping})---are not shown here, "
16284 #: doc/guix.texi:7013
16290 #: doc/guix.texi:7016
16292 "Similar to @code{bag-emerged}, but this time including all the bootstrap "
16297 #: doc/guix.texi:7017
16299 msgid "bag-with-origins"
16303 #: doc/guix.texi:7019
16304 msgid "Similar to @code{bag}, but also showing origins and their dependencies."
16308 #: doc/guix.texi:7025
16310 "This is the most detailed representation: It shows the DAG of derivations "
16311 "(@pxref{Derivations}) and plain store items. Compared to the above "
16312 "representation, many additional nodes are visible, including build scripts, "
16313 "patches, Guile modules, etc."
16317 #: doc/guix.texi:7028
16319 "For this type of graph, it is also possible to pass a @file{.drv} file name "
16320 "instead of a package name, as in:"
16324 #: doc/guix.texi:7031
16326 msgid "guix graph -t derivation `guix system build -d my-config.scm`\n"
16330 #: doc/guix.texi:7033
16336 #: doc/guix.texi:7037
16338 "This is the graph of @dfn{package modules} (@pxref{Package Modules}). For "
16339 "example, the following command shows the graph for the package module that "
16340 "defines the @code{guile} package:"
16344 #: doc/guix.texi:7040
16346 msgid "guix graph -t module guile | dot -Tpdf > module-graph.pdf\n"
16349 #. type: Plain text
16350 #: doc/guix.texi:7045
16352 "All the types above correspond to @emph{build-time dependencies}. The "
16353 "following graph type represents the @emph{run-time dependencies}:"
16357 #: doc/guix.texi:7047
16363 #: doc/guix.texi:7050
16365 "This is the graph of @dfn{references} of a package output, as returned by "
16366 "@command{guix gc --references} (@pxref{Invoking guix gc})."
16370 #: doc/guix.texi:7053
16372 "If the given package output is not available in the store, @command{guix "
16373 "graph} attempts to obtain dependency information from substitutes."
16377 #: doc/guix.texi:7057
16379 "Here you can also pass a store file name instead of a package name. For "
16380 "example, the command below produces the reference graph of your profile "
16381 "(which can be big!):"
16385 #: doc/guix.texi:7060
16387 msgid "guix graph -t references `readlink -f ~/.guix-profile`\n"
16391 #: doc/guix.texi:7062
16397 #: doc/guix.texi:7065
16399 "This is the graph of the @dfn{referrers} of a store item, as returned by "
16400 "@command{guix gc --referrers} (@pxref{Invoking guix gc})."
16404 #: doc/guix.texi:7071
16406 "This relies exclusively on local information from your store. For instance, "
16407 "let us suppose that the current Inkscape is available in 10 profiles on your "
16408 "machine; @command{guix graph -t referrers inkscape} will show a graph rooted "
16409 "at Inkscape and with those 10 profiles linked to it."
16413 #: doc/guix.texi:7074
16415 "It can help determine what is preventing a store item from being garbage "
16419 #. type: Plain text
16420 #: doc/guix.texi:7078
16421 msgid "The available options are the following:"
16425 #: doc/guix.texi:7080
16427 msgid "--type=@var{type}"
16431 #: doc/guix.texi:7081 doc/guix.texi:20603
16433 msgid "-t @var{type}"
16437 #: doc/guix.texi:7084
16439 "Produce a graph output of @var{type}, where @var{type} must be one of the "
16440 "values listed above."
16444 #: doc/guix.texi:7085
16446 msgid "--list-types"
16450 #: doc/guix.texi:7087
16451 msgid "List the supported graph types."
16455 #: doc/guix.texi:7088
16457 msgid "--backend=@var{backend}"
16461 #: doc/guix.texi:7089
16463 msgid "-b @var{backend}"
16467 #: doc/guix.texi:7091
16468 msgid "Produce a graph using the selected @var{backend}."
16472 #: doc/guix.texi:7092
16474 msgid "--list-backends"
16478 #: doc/guix.texi:7094
16479 msgid "List the supported graph backends."
16483 #: doc/guix.texi:7096
16484 msgid "Currently, the available backends are Graphviz and d3.js."
16488 #: doc/guix.texi:7105
16490 msgid "guix graph -e '(@@@@ (gnu packages commencement) gnu-make-final)'\n"
16494 #: doc/guix.texi:7110
16496 msgid "Invoking @command{guix environment}"
16500 #: doc/guix.texi:7112
16502 msgid "reproducible build environments"
16506 #: doc/guix.texi:7113
16508 msgid "development environments"
16511 #. type: command{#1}
16512 #: doc/guix.texi:7114
16514 msgid "guix environment"
16518 #: doc/guix.texi:7115
16520 msgid "environment, package build environment"
16523 #. type: Plain text
16524 #: doc/guix.texi:7121
16526 "The purpose of @command{guix environment} is to assist hackers in creating "
16527 "reproducible development environments without polluting their package "
16528 "profile. The @command{guix environment} tool takes one or more packages, "
16529 "builds all of their inputs, and creates a shell environment to use them."
16533 #: doc/guix.texi:7126
16535 msgid "guix environment @var{options} @var{package}@dots{}\n"
16538 #. type: Plain text
16539 #: doc/guix.texi:7130
16541 "The following example spawns a new shell set up for the development of "
16546 #: doc/guix.texi:7133
16548 msgid "guix environment guile\n"
16551 #. type: Plain text
16552 #: doc/guix.texi:7150
16554 "If the needed dependencies are not built yet, @command{guix environment} "
16555 "automatically builds them. The environment of the new shell is an augmented "
16556 "version of the environment that @command{guix environment} was run in. It "
16557 "contains the necessary search paths for building the given package added to "
16558 "the existing environment variables. To create a ``pure'' environment, in "
16559 "which the original environment variables have been unset, use the @code{--"
16560 "pure} option@footnote{Users sometimes wrongfully augment environment "
16561 "variables such as @code{PATH} in their @file{~/.bashrc} file. As a "
16562 "consequence, when @code{guix environment} launches it, Bash may read "
16563 "@file{~/.bashrc}, thereby introducing ``impurities'' in these environment "
16564 "variables. It is an error to define such environment variables in @file{."
16565 "bashrc}; instead, they should be defined in @file{.bash_profile}, which is "
16566 "sourced only by log-in shells. @xref{Bash Startup Files,,, bash, The GNU "
16567 "Bash Reference Manual}, for details on Bash start-up files.}."
16571 #: doc/guix.texi:7151
16573 msgid "GUIX_ENVIRONMENT"
16576 #. type: Plain text
16577 #: doc/guix.texi:7157
16579 "@command{guix environment} defines the @code{GUIX_ENVIRONMENT} variable in "
16580 "the shell it spawns; its value is the file name of the profile of this "
16581 "environment. This allows users to, say, define a specific prompt for "
16582 "development environments in their @file{.bashrc} (@pxref{Bash Startup "
16583 "Files,,, bash, The GNU Bash Reference Manual}):"
16587 #: doc/guix.texi:7163
16590 "if [ -n \"$GUIX_ENVIRONMENT\" ]\n"
16592 " export PS1=\"\\u@@\\h \\w [dev]\\$ \"\n"
16596 #. type: Plain text
16597 #: doc/guix.texi:7167
16598 msgid "... or to browse the profile:"
16602 #: doc/guix.texi:7170
16604 msgid "$ ls \"$GUIX_ENVIRONMENT/bin\"\n"
16607 #. type: Plain text
16608 #: doc/guix.texi:7176
16610 "Additionally, more than one package may be specified, in which case the "
16611 "union of the inputs for the given packages are used. For example, the "
16612 "command below spawns a shell where all of the dependencies of both Guile and "
16613 "Emacs are available:"
16617 #: doc/guix.texi:7179
16619 msgid "guix environment guile emacs\n"
16622 #. type: Plain text
16623 #: doc/guix.texi:7184
16625 "Sometimes an interactive shell session is not desired. An arbitrary command "
16626 "may be invoked by placing the @code{--} token to separate the command from "
16627 "the rest of the arguments:"
16631 #: doc/guix.texi:7187
16633 msgid "guix environment guile -- make -j4\n"
16636 #. type: Plain text
16637 #: doc/guix.texi:7193
16639 "In other situations, it is more convenient to specify the list of packages "
16640 "needed in the environment. For example, the following command runs "
16641 "@command{python} from an environment containing Python@tie{}2.7 and NumPy:"
16645 #: doc/guix.texi:7196
16647 msgid "guix environment --ad-hoc python2-numpy python-2.7 -- python\n"
16650 #. type: Plain text
16651 #: doc/guix.texi:7207
16653 "Furthermore, one might want the dependencies of a package and also some "
16654 "additional packages that are not build-time or runtime dependencies, but are "
16655 "useful when developing nonetheless. Because of this, the @code{--ad-hoc} "
16656 "flag is positional. Packages appearing before @code{--ad-hoc} are "
16657 "interpreted as packages whose dependencies will be added to the "
16658 "environment. Packages appearing after are interpreted as packages that will "
16659 "be added to the environment directly. For example, the following command "
16660 "creates a Guix development environment that additionally includes Git and "
16665 #: doc/guix.texi:7210
16667 msgid "guix environment guix --ad-hoc git strace\n"
16670 #. type: Plain text
16671 #: doc/guix.texi:7219
16673 "Sometimes it is desirable to isolate the environment as much as possible, "
16674 "for maximal purity and reproducibility. In particular, when using Guix on a "
16675 "host distro that is not GuixSD, it is desirable to prevent access to @file{/"
16676 "usr/bin} and other system-wide resources from the development environment. "
16677 "For example, the following command spawns a Guile REPL in a ``container'' "
16678 "where only the store and the current working directory are mounted:"
16682 #: doc/guix.texi:7222
16684 msgid "guix environment --ad-hoc --container guile -- guile\n"
16688 #: doc/guix.texi:7226
16689 msgid "The @code{--container} option requires Linux-libre 3.19 or newer."
16692 #. type: Plain text
16693 #: doc/guix.texi:7229
16694 msgid "The available options are summarized below."
16698 #: doc/guix.texi:7233
16700 msgid "persistent environment"
16704 #: doc/guix.texi:7234
16706 msgid "garbage collector root, for environments"
16710 #: doc/guix.texi:7237
16712 "Make @var{file} a symlink to the profile for this environment, and register "
16713 "it as a garbage collector root."
16717 #: doc/guix.texi:7240
16719 "This is useful if you want to protect your environment from garbage "
16720 "collection, to make it ``persistent''."
16724 #: doc/guix.texi:7246
16726 "When this option is omitted, the environment is protected from garbage "
16727 "collection only for the duration of the @command{guix environment} session. "
16728 "This means that next time you recreate the same environment, you could have "
16729 "to rebuild or re-download packages. @xref{Invoking guix gc}, for more on GC "
16734 #: doc/guix.texi:7251
16736 "Create an environment for the package or list of packages that @var{expr} "
16741 #: doc/guix.texi:7253
16742 msgid "For example, running:"
16746 #: doc/guix.texi:7256
16748 msgid "guix environment -e '(@@ (gnu packages maths) petsc-openmpi)'\n"
16752 #: doc/guix.texi:7260
16754 "starts a shell with the environment for this specific variant of the PETSc "
16759 #: doc/guix.texi:7262
16764 #: doc/guix.texi:7265
16766 msgid "guix environment --ad-hoc -e '(@@ (gnu) %base-packages)'\n"
16770 #: doc/guix.texi:7268
16771 msgid "starts a shell with all the GuixSD base packages available."
16775 #: doc/guix.texi:7271
16777 "The above commands only use the default output of the given packages. To "
16778 "select other outputs, two element tuples can be specified:"
16782 #: doc/guix.texi:7274
16784 msgid "guix environment --ad-hoc -e '(list (@@ (gnu packages bash) bash) \"include\")'\n"
16788 #: doc/guix.texi:7276
16790 msgid "--load=@var{file}"
16794 #: doc/guix.texi:7277
16796 msgid "-l @var{file}"
16800 #: doc/guix.texi:7280
16802 "Create an environment for the package or list of packages that the code "
16803 "within @var{file} evaluates to."
16807 #: doc/guix.texi:7286
16809 msgid "@verbatiminclude environment-gdb.scm\n"
16813 #: doc/guix.texi:7292
16815 "Create an environment for the packages contained in the manifest object "
16816 "returned by the Scheme code in @var{file}."
16820 #: doc/guix.texi:7296
16822 "This is similar to the same-named option in @command{guix package} "
16823 "(@pxref{profile-manifest, @option{--manifest}}) and uses the same manifest "
16828 #: doc/guix.texi:7297
16834 #: doc/guix.texi:7302
16836 "Include all specified packages in the resulting environment, as if an @i{ad "
16837 "hoc} package were defined with them as inputs. This option is useful for "
16838 "quickly creating an environment without having to write a package expression "
16839 "to contain the desired inputs."
16843 #: doc/guix.texi:7304
16844 msgid "For instance, the command:"
16848 #: doc/guix.texi:7307
16850 msgid "guix environment --ad-hoc guile guile-sdl -- guile\n"
16854 #: doc/guix.texi:7311
16856 "runs @command{guile} in an environment where Guile and Guile-SDL are "
16861 #: doc/guix.texi:7316
16863 "Note that this example implicitly asks for the default output of "
16864 "@code{guile} and @code{guile-sdl}, but it is possible to ask for a specific "
16865 "output---e.g., @code{glib:bin} asks for the @code{bin} output of @code{glib} "
16866 "(@pxref{Packages with Multiple Outputs})."
16870 #: doc/guix.texi:7322
16872 "This option may be composed with the default behavior of @command{guix "
16873 "environment}. Packages appearing before @code{--ad-hoc} are interpreted as "
16874 "packages whose dependencies will be added to the environment, the default "
16875 "behavior. Packages appearing after are interpreted as packages that will be "
16876 "added to the environment directly."
16880 #: doc/guix.texi:7323
16886 #: doc/guix.texi:7327
16888 "Unset existing environment variables when building the new environment. "
16889 "This has the effect of creating an environment in which search paths only "
16890 "contain package inputs."
16894 #: doc/guix.texi:7328
16896 msgid "--search-paths"
16900 #: doc/guix.texi:7331
16902 "Display the environment variable definitions that make up the environment."
16906 #: doc/guix.texi:7335
16907 msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}."
16911 #: doc/guix.texi:7336
16913 msgid "--container"
16917 #: doc/guix.texi:7337
16923 #: doc/guix.texi:7338 doc/guix.texi:7849 doc/guix.texi:20552
16929 #: doc/guix.texi:7346
16931 "Run @var{command} within an isolated container. The current working "
16932 "directory outside the container is mapped inside the container. "
16933 "Additionally, unless overridden with @code{--user}, a dummy home directory "
16934 "is created that matches the current user's home directory, and @file{/etc/"
16935 "passwd} is configured accordingly. The spawned process runs as the current "
16936 "user outside the container, but has root privileges in the context of the "
16941 #: doc/guix.texi:7347
16947 #: doc/guix.texi:7348
16953 #: doc/guix.texi:7352
16955 "For containers, share the network namespace with the host system. "
16956 "Containers created without this flag only have access to the loopback device."
16960 #: doc/guix.texi:7353
16962 msgid "--link-profile"
16966 #: doc/guix.texi:7354
16972 #: doc/guix.texi:7361
16974 "For containers, link the environment profile to @file{~/.guix-profile} "
16975 "within the container. This is equivalent to running the command @command{ln "
16976 "-s $GUIX_ENVIRONMENT ~/.guix-profile} within the container. Linking will "
16977 "fail and abort the environment if the directory already exists, which will "
16978 "certainly be the case if @command{guix environment} was invoked in the "
16979 "user's home directory."
16983 #: doc/guix.texi:7368
16985 "Certain packages are configured to look in @code{~/.guix-profile} for "
16986 "configuration files and data;@footnote{For example, the @code{fontconfig} "
16987 "package inspects @file{~/.guix-profile/share/fonts} for additional fonts.} "
16988 "@code{--link-profile} allows these programs to behave as expected within the "
16993 #: doc/guix.texi:7369 doc/guix.texi:7521
16995 msgid "--user=@var{user}"
16999 #: doc/guix.texi:7370 doc/guix.texi:7522
17001 msgid "-u @var{user}"
17005 #: doc/guix.texi:7376
17007 "For containers, use the username @var{user} in place of the current user. "
17008 "The generated @file{/etc/passwd} entry within the container will contain the "
17009 "name @var{user}; the home directory will be @file{/home/USER}; and no user "
17010 "GECOS data will be copied. @var{user} need not exist on the system."
17014 #: doc/guix.texi:7381
17016 "Additionally, any shared or exposed path (see @code{--share} and @code{--"
17017 "expose} respectively) whose target is within the current user's home "
17018 "directory will be remapped relative to @file{/home/USER}; this includes the "
17019 "automatic mapping of the current working directory."
17023 #: doc/guix.texi:7388
17026 "# will expose paths as /home/foo/wd, /home/foo/test, and /home/foo/target\n"
17028 "guix environment --container --user=foo \\\n"
17029 " --expose=$HOME/test \\\n"
17030 " --expose=/tmp/target=$HOME/target\n"
17034 #: doc/guix.texi:7393
17036 "While this will limit the leaking of user identity through home paths and "
17037 "each of the user fields, this is only one useful component of a broader "
17038 "privacy/anonymity solution---not one in and of itself."
17042 #: doc/guix.texi:7394
17044 msgid "--expose=@var{source}[=@var{target}]"
17048 #: doc/guix.texi:7399
17050 "For containers, expose the file system @var{source} from the host system as "
17051 "the read-only file system @var{target} within the container. If "
17052 "@var{target} is not specified, @var{source} is used as the target mount "
17053 "point in the container."
17057 #: doc/guix.texi:7403
17059 "The example below spawns a Guile REPL in a container in which the user's "
17060 "home directory is accessible read-only via the @file{/exchange} directory:"
17064 #: doc/guix.texi:7406
17066 msgid "guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile\n"
17070 #: doc/guix.texi:7408
17072 msgid "--share=@var{source}[=@var{target}]"
17076 #: doc/guix.texi:7413
17078 "For containers, share the file system @var{source} from the host system as "
17079 "the writable file system @var{target} within the container. If @var{target} "
17080 "is not specified, @var{source} is used as the target mount point in the "
17085 #: doc/guix.texi:7417
17087 "The example below spawns a Guile REPL in a container in which the user's "
17088 "home directory is accessible for both reading and writing via the @file{/"
17089 "exchange} directory:"
17093 #: doc/guix.texi:7420
17095 msgid "guix environment --container --share=$HOME=/exchange --ad-hoc guile -- guile\n"
17098 #. type: Plain text
17099 #: doc/guix.texi:7426
17101 "@command{guix environment} also supports all of the common build options "
17102 "that @command{guix build} supports (@pxref{Common Build Options})."
17106 #: doc/guix.texi:7429
17108 msgid "Invoking @command{guix publish}"
17111 #. type: command{#1}
17112 #: doc/guix.texi:7431
17114 msgid "guix publish"
17117 #. type: Plain text
17118 #: doc/guix.texi:7435
17120 "The purpose of @command{guix publish} is to enable users to easily share "
17121 "their store with others, who can then use it as a substitute server "
17122 "(@pxref{Substitutes})."
17124 "Le but de @command{guix publish} est de vous permettre de partager "
17125 "facilement votre dépôt avec d'autres personnes qui peuvent ensuite "
17126 "l'utiliser comme serveur de substituts (@pxref{Substituts})."
17128 #. type: Plain text
17129 #: doc/guix.texi:7441
17131 "When @command{guix publish} runs, it spawns an HTTP server which allows "
17132 "anyone with network access to obtain substitutes from it. This means that "
17133 "any machine running Guix can also act as if it were a build farm, since the "
17134 "HTTP interface is compatible with Hydra, the software behind the @code{hydra."
17135 "gnu.org} build farm."
17138 #. type: Plain text
17139 #: doc/guix.texi:7447
17141 "For security, each substitute is signed, allowing recipients to check their "
17142 "authenticity and integrity (@pxref{Substitutes}). Because @command{guix "
17143 "publish} uses the signing key of the system, which is only readable by the "
17144 "system administrator, it must be started as root; the @code{--user} option "
17145 "makes it drop root privileges early on."
17147 "Pour des raisons de sécurité, chaque substitut est signé, ce qui permet aux "
17148 "destinataires de vérifier leur authenticité et leur intégrité "
17149 "(@pxref{Substituts}). Comme @command{guix publish} utilise la clef de "
17150 "signature du système, qui n'est lisible que par l'administrateur système, il "
17151 "doit être lancé en root ; l'option @code{--user} lui fait baisser ses "
17152 "privilèges le plus tôt possible."
17154 #. type: Plain text
17155 #: doc/guix.texi:7451
17157 "The signing key pair must be generated before @command{guix publish} is "
17158 "launched, using @command{guix archive --generate-key} (@pxref{Invoking guix "
17163 #: doc/guix.texi:7456
17165 msgid "guix publish @var{options}@dots{}\n"
17168 #. type: Plain text
17169 #: doc/guix.texi:7460
17171 "Running @command{guix publish} without any additional arguments will spawn "
17172 "an HTTP server on port 8080:"
17176 #: doc/guix.texi:7463
17178 msgid "guix publish\n"
17181 #. type: Plain text
17182 #: doc/guix.texi:7467
17184 "Once a publishing server has been authorized (@pxref{Invoking guix "
17185 "archive}), the daemon may download substitutes from it:"
17189 #: doc/guix.texi:7470
17191 msgid "guix-daemon --substitute-urls=http://example.org:8080\n"
17194 #. type: Plain text
17195 #: doc/guix.texi:7479
17197 "By default, @command{guix publish} compresses archives on the fly as it "
17198 "serves them. This ``on-the-fly'' mode is convenient in that it requires no "
17199 "setup and is immediately available. However, when serving lots of clients, "
17200 "we recommend using the @option{--cache} option, which enables caching of the "
17201 "archives before they are sent to clients---see below for details. The "
17202 "@command{guix weather} command provides a handy way to check what a server "
17203 "provides (@pxref{Invoking guix weather})."
17206 #. type: Plain text
17207 #: doc/guix.texi:7486
17209 "As a bonus, @command{guix publish} also serves as a content-addressed mirror "
17210 "for source files referenced in @code{origin} records (@pxref{origin "
17211 "Reference}). For instance, assuming @command{guix publish} is running on "
17212 "@code{example.org}, the following URL returns the raw @file{hello-2.10.tar."
17213 "gz} file with the given SHA256 hash (represented in @code{nix-base32} "
17214 "format, @pxref{Invoking guix hash}):"
17218 #: doc/guix.texi:7489
17220 msgid "http://example.org/file/hello-2.10.tar.gz/sha256/0ssi1@dots{}ndq1i\n"
17223 #. type: Plain text
17224 #: doc/guix.texi:7493
17226 "Obviously, these URLs only work for files that are in the store; in other "
17227 "cases, they return 404 (``Not Found'')."
17231 #: doc/guix.texi:7494
17233 msgid "build logs, publication"
17236 #. type: Plain text
17237 #: doc/guix.texi:7496
17238 msgid "Build logs are available from @code{/log} URLs like:"
17242 #: doc/guix.texi:7499
17244 msgid "http://example.org/log/gwspk@dots{}-guile-2.2.3\n"
17247 #. type: Plain text
17248 #: doc/guix.texi:7509
17250 "When @command{guix-daemon} is configured to save compressed build logs, as "
17251 "is the case by default (@pxref{Invoking guix-daemon}), @code{/log} URLs "
17252 "return the compressed log as-is, with an appropriate @code{Content-Type} and/"
17253 "or @code{Content-Encoding} header. We recommend running @command{guix-"
17254 "daemon} with @code{--log-compression=gzip} since Web browsers can "
17255 "automatically decompress it, which is not the case with bzip2 compression."
17259 #: doc/guix.texi:7513
17261 msgid "--port=@var{port}"
17265 #: doc/guix.texi:7514
17267 msgid "-p @var{port}"
17271 #: doc/guix.texi:7516
17272 msgid "Listen for HTTP requests on @var{port}."
17276 #: doc/guix.texi:7517 doc/guix.texi:17032
17278 msgid "--listen=@var{host}"
17282 #: doc/guix.texi:7520
17284 "Listen on the network interface for @var{host}. The default is to accept "
17285 "connections from any interface."
17289 #: doc/guix.texi:7525
17291 "Change privileges to @var{user} as soon as possible---i.e., once the server "
17292 "socket is open and the signing key has been read."
17296 #: doc/guix.texi:7526
17298 msgid "--compression[=@var{level}]"
17302 #: doc/guix.texi:7527
17304 msgid "-C [@var{level}]"
17308 #: doc/guix.texi:7532
17310 "Compress data using the given @var{level}. When @var{level} is zero, "
17311 "disable compression. The range 1 to 9 corresponds to different gzip "
17312 "compression levels: 1 is the fastest, and 9 is the best (CPU-intensive). "
17313 "The default is 3."
17317 #: doc/guix.texi:7541
17319 "Unless @option{--cache} is used, compression occurs on the fly and the "
17320 "compressed streams are not cached. Thus, to reduce load on the machine that "
17321 "runs @command{guix publish}, it may be a good idea to choose a low "
17322 "compression level, to run @command{guix publish} behind a caching proxy, or "
17323 "to use @option{--cache}. Using @option{--cache} has the advantage that it "
17324 "allows @command{guix publish} to add @code{Content-Length} HTTP header to "
17329 #: doc/guix.texi:7542
17331 msgid "--cache=@var{directory}"
17335 #: doc/guix.texi:7543
17337 msgid "-c @var{directory}"
17341 #: doc/guix.texi:7546
17343 "Cache archives and meta-data (@code{.narinfo} URLs) to @var{directory} and "
17344 "only serve archives that are in cache."
17348 #: doc/guix.texi:7554
17350 "When this option is omitted, archives and meta-data are created on-the-fly. "
17351 "This can reduce the available bandwidth, especially when compression is "
17352 "enabled, since this may become CPU-bound. Another drawback of the default "
17353 "mode is that the length of archives is not known in advance, so "
17354 "@command{guix publish} does not add a @code{Content-Length} HTTP header to "
17355 "its responses, which in turn prevents clients from knowing the amount of "
17356 "data being downloaded."
17360 #: doc/guix.texi:7562
17362 "Conversely, when @option{--cache} is used, the first request for a store "
17363 "item (@i{via} a @code{.narinfo} URL) returns 404 and triggers a background "
17364 "process to @dfn{bake} the archive---computing its @code{.narinfo} and "
17365 "compressing the archive, if needed. Once the archive is cached in "
17366 "@var{directory}, subsequent requests succeed and are served directly from "
17367 "the cache, which guarantees that clients get the best possible bandwidth."
17371 #: doc/guix.texi:7566
17373 "The ``baking'' process is performed by worker threads. By default, one "
17374 "thread per CPU core is created, but this can be customized. See @option{--"
17379 #: doc/guix.texi:7569
17381 "When @option{--ttl} is used, cached entries are automatically deleted when "
17382 "they have expired."
17386 #: doc/guix.texi:7570
17388 msgid "--workers=@var{N}"
17392 #: doc/guix.texi:7573
17394 "When @option{--cache} is used, request the allocation of @var{N} worker "
17395 "threads to ``bake'' archives."
17399 #: doc/guix.texi:7574
17401 msgid "--ttl=@var{ttl}"
17405 #: doc/guix.texi:7578
17407 "Produce @code{Cache-Control} HTTP headers that advertise a time-to-live "
17408 "(TTL) of @var{ttl}. @var{ttl} must denote a duration: @code{5d} means 5 "
17409 "days, @code{1m} means 1 month, and so on."
17413 #: doc/guix.texi:7583
17415 "This allows the user's Guix to keep substitute information in cache for "
17416 "@var{ttl}. However, note that @code{guix publish} does not itself guarantee "
17417 "that the store items it provides will indeed remain available for as long as "
17422 #: doc/guix.texi:7587
17424 "Additionally, when @option{--cache} is used, cached entries that have not "
17425 "been accessed for @var{ttl} and that no longer have a corresponding item in "
17426 "the store, may be deleted."
17430 #: doc/guix.texi:7588
17432 msgid "--nar-path=@var{path}"
17436 #: doc/guix.texi:7591
17438 "Use @var{path} as the prefix for the URLs of ``nar'' files (@pxref{Invoking "
17439 "guix archive, normalized archives})."
17443 #: doc/guix.texi:7595
17445 "By default, nars are served at a URL such as @code{/nar/gzip/@dots{}-"
17446 "coreutils-8.25}. This option allows you to change the @code{/nar} part to "
17451 #: doc/guix.texi:7596
17453 msgid "--public-key=@var{file}"
17457 #: doc/guix.texi:7597
17459 msgid "--private-key=@var{file}"
17463 #: doc/guix.texi:7600
17465 "Use the specific @var{file}s as the public/private key pair used to sign the "
17466 "store items being published."
17470 #: doc/guix.texi:7607
17472 "The files must correspond to the same key pair (the private key is used for "
17473 "signing and the public key is merely advertised in the signature metadata). "
17474 "They must contain keys in the canonical s-expression format as produced by "
17475 "@command{guix archive --generate-key} (@pxref{Invoking guix archive}). By "
17476 "default, @file{/etc/guix/signing-key.pub} and @file{/etc/guix/signing-key."
17481 #: doc/guix.texi:7608
17483 msgid "--repl[=@var{port}]"
17487 #: doc/guix.texi:7609
17489 msgid "-r [@var{port}]"
17493 #: doc/guix.texi:7613
17495 "Spawn a Guile REPL server (@pxref{REPL Servers,,, guile, GNU Guile Reference "
17496 "Manual}) on @var{port} (37146 by default). This is used primarily for "
17497 "debugging a running @command{guix publish} server."
17500 #. type: Plain text
17501 #: doc/guix.texi:7619
17503 "Enabling @command{guix publish} on a GuixSD system is a one-liner: just "
17504 "instantiate a @code{guix-publish-service-type} service in the "
17505 "@code{services} field of the @code{operating-system} declaration "
17506 "(@pxref{guix-publish-service-type, @code{guix-publish-service-type}})."
17509 #. type: Plain text
17510 #: doc/guix.texi:7622
17512 "If you are instead running Guix on a ``foreign distro'', follow these "
17517 #: doc/guix.texi:7626
17518 msgid "If your host distro uses the systemd init system:"
17522 #: doc/guix.texi:7631
17525 "# ln -s ~root/.guix-profile/lib/systemd/system/guix-publish.service \\\n"
17526 " /etc/systemd/system/\n"
17527 "# systemctl start guix-publish && systemctl enable guix-publish\n"
17531 #: doc/guix.texi:7639
17534 "# ln -s ~root/.guix-profile/lib/upstart/system/guix-publish.conf /etc/init/\n"
17535 "# start guix-publish\n"
17539 #: doc/guix.texi:7643
17540 msgid "Otherwise, proceed similarly with your distro's init system."
17544 #: doc/guix.texi:7646
17546 msgid "Invoking @command{guix challenge}"
17550 #: doc/guix.texi:7649
17552 msgid "verifiable builds"
17555 #. type: command{#1}
17556 #: doc/guix.texi:7650
17558 msgid "guix challenge"
17562 #: doc/guix.texi:7651
17567 #. type: Plain text
17568 #: doc/guix.texi:7656
17570 "Do the binaries provided by this server really correspond to the source code "
17571 "it claims to build? Is a package build process deterministic? These are the "
17572 "questions the @command{guix challenge} command attempts to answer."
17575 #. type: Plain text
17576 #: doc/guix.texi:7664
17578 "The former is obviously an important question: Before using a substitute "
17579 "server (@pxref{Substitutes}), one had better @emph{verify} that it provides "
17580 "the right binaries, and thus @emph{challenge} it. The latter is what "
17581 "enables the former: If package builds are deterministic, then independent "
17582 "builds of the package should yield the exact same result, bit for bit; if a "
17583 "server provides a binary different from the one obtained locally, it may be "
17584 "either corrupt or malicious."
17586 "La première question est évidemment importante : avant d'utiliser un serveur "
17587 "de substituts (@pxref{Substituts}), il vaut mieux @emph{vérifier} qu'il "
17588 "fournit les bons binaires et donc le @emph{défier}. La deuxième est ce qui "
17589 "permet la première : si les constructions des paquets sont déterministes "
17590 "alors des constructions indépendantes du paquet devraient donner le même "
17591 "résultat, bit à bit ; si un serveur fournit un binaire différent de celui "
17592 "obtenu localement, il peut être soit corrompu, soit malveillant."
17594 #. type: Plain text
17595 #: doc/guix.texi:7673
17597 "We know that the hash that shows up in @file{/gnu/store} file names is the "
17598 "hash of all the inputs of the process that built the file or directory---"
17599 "compilers, libraries, build scripts, etc. (@pxref{Introduction}). Assuming "
17600 "deterministic build processes, one store file name should map to exactly one "
17601 "build output. @command{guix challenge} checks whether there is, indeed, a "
17602 "single mapping by comparing the build outputs of several independent builds "
17603 "of any given store item."
17606 #. type: Plain text
17607 #: doc/guix.texi:7675
17608 msgid "The command output looks like this:"
17611 #. type: smallexample
17612 #: doc/guix.texi:7692
17615 "$ guix challenge --substitute-urls=\"https://hydra.gnu.org https://guix.example.org\"\n"
17616 "updating list of substitutes from 'https://hydra.gnu.org'... 100.0%\n"
17617 "updating list of substitutes from 'https://guix.example.org'... 100.0%\n"
17618 "/gnu/store/@dots{}-openssl-1.0.2d contents differ:\n"
17619 " local hash: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q\n"
17620 " https://hydra.gnu.org/nar/@dots{}-openssl-1.0.2d: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q\n"
17621 " https://guix.example.org/nar/@dots{}-openssl-1.0.2d: 1zy4fmaaqcnjrzzajkdn3f5gmjk754b43qkq47llbyak9z0qjyim\n"
17622 "/gnu/store/@dots{}-git-2.5.0 contents differ:\n"
17623 " local hash: 00p3bmryhjxrhpn2gxs2fy0a15lnip05l97205pgbk5ra395hyha\n"
17624 " https://hydra.gnu.org/nar/@dots{}-git-2.5.0: 069nb85bv4d4a6slrwjdy8v1cn4cwspm3kdbmyb81d6zckj3nq9f\n"
17625 " https://guix.example.org/nar/@dots{}-git-2.5.0: 0mdqa9w1p6cmli6976v4wi0sw9r4p5prkj7lzfd1877wk11c9c73\n"
17626 "/gnu/store/@dots{}-pius-2.1.1 contents differ:\n"
17627 " local hash: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax\n"
17628 " https://hydra.gnu.org/nar/@dots{}-pius-2.1.1: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax\n"
17629 " https://guix.example.org/nar/@dots{}-pius-2.1.1: 1cy25x1a4fzq5rk0pmvc8xhwyffnqz95h2bpvqsz2mpvlbccy0gs\n"
17633 #. type: smallexample
17634 #: doc/guix.texi:7694
17641 #. type: smallexample
17642 #: doc/guix.texi:7699
17645 "6,406 store items were analyzed:\n"
17646 " - 4,749 (74.1%) were identical\n"
17647 " - 525 (8.2%) differed\n"
17648 " - 1,132 (17.7%) were inconclusive\n"
17651 #. type: Plain text
17652 #: doc/guix.texi:7707
17654 "In this example, @command{guix challenge} first scans the store to determine "
17655 "the set of locally-built derivations---as opposed to store items that were "
17656 "downloaded from a substitute server---and then queries all the substitute "
17657 "servers. It then reports those store items for which the servers obtained a "
17658 "result different from the local build."
17662 #: doc/guix.texi:7708
17664 msgid "non-determinism, in package builds"
17667 #. type: Plain text
17668 #: doc/guix.texi:7719
17670 "As an example, @code{guix.example.org} always gets a different answer. "
17671 "Conversely, @code{hydra.gnu.org} agrees with local builds, except in the "
17672 "case of Git. This might indicate that the build process of Git is non-"
17673 "deterministic, meaning that its output varies as a function of various "
17674 "things that Guix does not fully control, in spite of building packages in "
17675 "isolated environments (@pxref{Features}). Most common sources of non-"
17676 "determinism include the addition of timestamps in build results, the "
17677 "inclusion of random numbers, and directory listings sorted by inode number. "
17678 "See @uref{https://reproducible-builds.org/docs/}, for more information."
17681 #. type: Plain text
17682 #: doc/guix.texi:7722
17684 "To find out what is wrong with this Git binary, we can do something along "
17685 "these lines (@pxref{Invoking guix archive}):"
17689 #: doc/guix.texi:7727
17692 "$ wget -q -O - https://hydra.gnu.org/nar/@dots{}-git-2.5.0 \\\n"
17693 " | guix archive -x /tmp/git\n"
17694 "$ diff -ur --no-dereference /gnu/store/@dots{}-git.2.5.0 /tmp/git\n"
17697 #. type: Plain text
17698 #: doc/guix.texi:7736
17700 "This command shows the difference between the files resulting from the local "
17701 "build, and the files resulting from the build on @code{hydra.gnu.org} "
17702 "(@pxref{Overview, Comparing and Merging Files,, diffutils, Comparing and "
17703 "Merging Files}). The @command{diff} command works great for text files. "
17704 "When binary files differ, a better option is @uref{https://diffoscope.org/, "
17705 "Diffoscope}, a tool that helps visualize differences for all kinds of files."
17708 #. type: Plain text
17709 #: doc/guix.texi:7744
17711 "Once you have done that work, you can tell whether the differences are due "
17712 "to a non-deterministic build process or to a malicious server. We try hard "
17713 "to remove sources of non-determinism in packages to make it easier to verify "
17714 "substitutes, but of course, this is a process that involves not just Guix, "
17715 "but a large part of the free software community. In the meantime, "
17716 "@command{guix challenge} is one tool to help address the problem."
17719 #. type: Plain text
17720 #: doc/guix.texi:7748
17722 "If you are writing packages for Guix, you are encouraged to check whether "
17723 "@code{hydra.gnu.org} and other substitute servers obtain the same build "
17724 "result as you did with:"
17728 #: doc/guix.texi:7751
17730 msgid "$ guix challenge @var{package}\n"
17733 #. type: Plain text
17734 #: doc/guix.texi:7756
17736 "where @var{package} is a package specification such as @code{guile@@2.0} or "
17737 "@code{glibc:debug}."
17741 #: doc/guix.texi:7761
17743 msgid "guix challenge @var{options} [@var{packages}@dots{}]\n"
17746 #. type: Plain text
17747 #: doc/guix.texi:7768
17749 "When a difference is found between the hash of a locally-built item and that "
17750 "of a server-provided substitute, or among substitutes provided by different "
17751 "servers, the command displays it as in the example above and its exit code "
17752 "is 2 (other non-zero exit codes denote other kinds of errors.)"
17755 #. type: Plain text
17756 #: doc/guix.texi:7770
17757 msgid "The one option that matters is:"
17761 #: doc/guix.texi:7776
17763 "Consider @var{urls} the whitespace-separated list of substitute source URLs "
17768 #: doc/guix.texi:7778
17774 #: doc/guix.texi:7781
17776 "Show details about matches (identical contents) in addition to information "
17777 "about mismatches."
17781 #: doc/guix.texi:7785
17783 msgid "Invoking @command{guix copy}"
17787 #: doc/guix.texi:7787
17789 msgid "copy, of store items, over SSH"
17793 #: doc/guix.texi:7788
17795 msgid "SSH, copy of store items"
17799 #: doc/guix.texi:7789
17801 msgid "sharing store items across machines"
17805 #: doc/guix.texi:7790
17807 msgid "transferring store items across machines"
17810 #. type: Plain text
17811 #: doc/guix.texi:7797
17813 "The @command{guix copy} command copies items from the store of one machine "
17814 "to that of another machine over a secure shell (SSH) "
17815 "connection@footnote{This command is available only when Guile-SSH was "
17816 "found. @xref{Requirements}, for details.}. For example, the following "
17817 "command copies the @code{coreutils} package, the user's profile, and all "
17818 "their dependencies over to @var{host}, logged in as @var{user}:"
17822 #: doc/guix.texi:7801
17825 "guix copy --to=@var{user}@@@var{host} \\\n"
17826 " coreutils `readlink -f ~/.guix-profile`\n"
17829 #. type: Plain text
17830 #: doc/guix.texi:7805
17832 "If some of the items to be copied are already present on @var{host}, they "
17833 "are not actually sent."
17836 #. type: Plain text
17837 #: doc/guix.texi:7808
17839 "The command below retrieves @code{libreoffice} and @code{gimp} from "
17840 "@var{host}, assuming they are available there:"
17844 #: doc/guix.texi:7811
17846 msgid "guix copy --from=@var{host} libreoffice gimp\n"
17849 #. type: Plain text
17850 #: doc/guix.texi:7816
17852 "The SSH connection is established using the Guile-SSH client, which is "
17853 "compatible with OpenSSH: it honors @file{~/.ssh/known_hosts} and @file{~/."
17854 "ssh/config}, and uses the SSH agent for authentication."
17857 #. type: Plain text
17858 #: doc/guix.texi:7822
17860 "The key used to sign items that are sent must be accepted by the remote "
17861 "machine. Likewise, the key used by the remote machine to sign items you are "
17862 "retrieving must be in @file{/etc/guix/acl} so it is accepted by your own "
17863 "daemon. @xref{Invoking guix archive}, for more information about store item "
17868 #: doc/guix.texi:7827
17870 msgid "guix copy [--to=@var{spec}|--from=@var{spec}] @var{items}@dots{}\n"
17873 #. type: Plain text
17874 #: doc/guix.texi:7830
17875 msgid "You must always specify one of the following options:"
17879 #: doc/guix.texi:7832
17881 msgid "--to=@var{spec}"
17885 #: doc/guix.texi:7833
17887 msgid "--from=@var{spec}"
17891 #: doc/guix.texi:7837
17893 "Specify the host to send to or receive from. @var{spec} must be an SSH spec "
17894 "such as @code{example.org}, @code{charlie@@example.org}, or "
17895 "@code{charlie@@example.org:2222}."
17898 #. type: Plain text
17899 #: doc/guix.texi:7841
17901 "The @var{items} can be either package names, such as @code{gimp}, or store "
17902 "items, such as @file{/gnu/store/@dots{}-idutils-4.6}."
17905 #. type: Plain text
17906 #: doc/guix.texi:7845
17908 "When specifying the name of a package to send, it is first built if needed, "
17909 "unless @option{--dry-run} was specified. Common build options are supported "
17910 "(@pxref{Common Build Options})."
17914 #: doc/guix.texi:7848
17916 msgid "Invoking @command{guix container}"
17919 #. type: command{#1}
17920 #: doc/guix.texi:7850
17922 msgid "guix container"
17926 #: doc/guix.texi:7854
17928 "As of version @value{VERSION}, this tool is experimental. The interface is "
17929 "subject to radical change in the future."
17932 #. type: Plain text
17933 #: doc/guix.texi:7861
17935 "The purpose of @command{guix container} is to manipulate processes running "
17936 "within an isolated environment, commonly known as a ``container'', typically "
17937 "created by the @command{guix environment} (@pxref{Invoking guix "
17938 "environment}) and @command{guix system container} (@pxref{Invoking guix "
17939 "system}) commands."
17943 #: doc/guix.texi:7866
17945 msgid "guix container @var{action} @var{options}@dots{}\n"
17948 #. type: Plain text
17949 #: doc/guix.texi:7870
17951 "@var{action} specifies the operation to perform with a container, and "
17952 "@var{options} specifies the context-specific arguments for the action."
17955 #. type: Plain text
17956 #: doc/guix.texi:7872
17957 msgid "The following actions are available:"
17961 #: doc/guix.texi:7874
17967 #: doc/guix.texi:7876
17968 msgid "Execute a command within the context of a running container."
17972 #: doc/guix.texi:7878
17973 msgid "The syntax is:"
17977 #: doc/guix.texi:7881
17979 msgid "guix container exec @var{pid} @var{program} @var{arguments}@dots{}\n"
17983 #: doc/guix.texi:7887
17985 "@var{pid} specifies the process ID of the running container. @var{program} "
17986 "specifies an executable file name within the root file system of the "
17987 "container. @var{arguments} are the additional options that will be passed "
17988 "to @var{program}."
17992 #: doc/guix.texi:7891
17994 "The following command launches an interactive login shell inside a GuixSD "
17995 "container, started by @command{guix system container}, and whose process ID "
18000 #: doc/guix.texi:7894
18002 msgid "guix container exec 9001 /run/current-system/profile/bin/bash --login\n"
18006 #: doc/guix.texi:7898
18008 "Note that the @var{pid} cannot be the parent process of a container. It "
18009 "must be PID 1 of the container or one of its child processes."
18013 #: doc/guix.texi:7902
18015 msgid "Invoking @command{guix weather}"
18018 #. type: Plain text
18019 #: doc/guix.texi:7911
18021 "Occasionally you're grumpy because substitutes are lacking and you end up "
18022 "building packages by yourself (@pxref{Substitutes}). The @command{guix "
18023 "weather} command reports on substitute availability on the specified servers "
18024 "so you can have an idea of whether you'll be grumpy today. It can sometimes "
18025 "be useful info as a user, but it is primarily useful to people running "
18026 "@command{guix publish} (@pxref{Invoking guix publish})."
18028 "Vous pouvez parfois grogner lorsque les substituts ne sont pas disponibles "
18029 "et que vous devez construire les paquets vous-même (@pxref{Substituts}). La "
18030 "commande @command{guix weather} rapporte la disponibilité des substituts sur "
18031 "les serveurs spécifiés pour que vous sachiez si vous allez raller "
18032 "aujourd'hui. Cela peut parfois être une information utile pour les "
18033 "utilisateurs, mais elle est surtout utile pour les personnes qui font "
18034 "tourner @command{guix publish} (@pxref{Invoking guix publish})."
18037 #: doc/guix.texi:7912
18039 msgid "statistics, for substitutes"
18043 #: doc/guix.texi:7913
18045 msgid "availability of substitutes"
18049 #: doc/guix.texi:7914
18051 msgid "substitute availability"
18055 #: doc/guix.texi:7915
18057 msgid "weather, substitute availability"
18060 #. type: Plain text
18061 #: doc/guix.texi:7917
18062 msgid "Here's a sample run:"
18066 #: doc/guix.texi:7929
18069 "$ guix weather --substitute-urls=https://guix.example.org\n"
18070 "computing 5,872 package derivations for x86_64-linux...\n"
18071 "looking for 6,128 store items on https://guix.example.org..\n"
18072 "updating list of substitutes from 'https://guix.example.org'... 100.0%\n"
18073 "https://guix.example.org\n"
18074 " 43.4% substitutes available (2,658 out of 6,128)\n"
18075 " 7,032.5 MiB of nars (compressed)\n"
18076 " 19,824.2 MiB on disk (uncompressed)\n"
18077 " 0.030 seconds per request (182.9 seconds in total)\n"
18078 " 33.5 requests per second\n"
18083 #: doc/guix.texi:7939
18086 " 9.8% (342 out of 3,470) of the missing items are queued\n"
18087 " 867 queued builds\n"
18088 " x86_64-linux: 518 (59.7%)\n"
18089 " i686-linux: 221 (25.5%)\n"
18090 " aarch64-linux: 128 (14.8%)\n"
18091 " build rate: 23.41 builds per hour\n"
18092 " x86_64-linux: 11.16 builds per hour\n"
18093 " i686-linux: 6.03 builds per hour\n"
18094 " aarch64-linux: 6.41 builds per hour\n"
18098 #: doc/guix.texi:7941
18100 msgid "continuous integration, statistics"
18103 #. type: Plain text
18104 #: doc/guix.texi:7950
18106 "As you can see, it reports the fraction of all the packages for which "
18107 "substitutes are available on the server---regardless of whether substitutes "
18108 "are enabled, and regardless of whether this server's signing key is "
18109 "authorized. It also reports the size of the compressed archives (``nars'') "
18110 "provided by the server, the size the corresponding store items occupy in the "
18111 "store (assuming deduplication is turned off), and the server's throughput. "
18112 "The second part gives continuous integration (CI) statistics, if the server "
18116 #. type: Plain text
18117 #: doc/guix.texi:7956
18119 "To achieve that, @command{guix weather} queries over HTTP(S) meta-data "
18120 "(@dfn{narinfos}) for all the relevant store items. Like @command{guix "
18121 "challenge}, it ignores signatures on those substitutes, which is innocuous "
18122 "since the command only gathers statistics and cannot install those "
18126 #. type: Plain text
18127 #: doc/guix.texi:7959
18129 "Among other things, it is possible to query specific system types and "
18130 "specific package sets. The available options are listed below."
18134 #: doc/guix.texi:7965
18136 "@var{urls} is the space-separated list of substitute server URLs to query. "
18137 "When this option is omitted, the default set of substitute servers is "
18142 #: doc/guix.texi:7971
18144 "Query substitutes for @var{system}---e.g., @code{aarch64-linux}. This "
18145 "option can be repeated, in which case @command{guix weather} will query "
18146 "substitutes for several system types."
18150 #: doc/guix.texi:7977
18152 "Instead of querying substitutes for all the packages, only ask for those "
18153 "specified in @var{file}. @var{file} must contain a @dfn{manifest}, as with "
18154 "the @code{-m} option of @command{guix package} (@pxref{Invoking guix "
18158 #. type: Plain text
18159 #: doc/guix.texi:7995
18161 "Guix comes with a distribution of the GNU system consisting entirely of free "
18162 "software@footnote{The term ``free'' here refers to the @url{http://www.gnu."
18163 "org/philosophy/free-sw.html,freedom provided to users of that software}.}. "
18164 "The distribution can be installed on its own (@pxref{System Installation}), "
18165 "but it is also possible to install Guix as a package manager on top of an "
18166 "installed GNU/Linux system (@pxref{Installation}). To distinguish between "
18167 "the two, we refer to the standalone distribution as the Guix System "
18168 "Distribution, or GuixSD."
18171 #. type: Plain text
18172 #: doc/guix.texi:8001
18174 "The distribution provides core GNU packages such as GNU libc, GCC, and "
18175 "Binutils, as well as many GNU and non-GNU applications. The complete list "
18176 "of available packages can be browsed @url{http://www.gnu.org/software/guix/"
18177 "packages,on-line} or by running @command{guix package} (@pxref{Invoking guix "
18182 #: doc/guix.texi:8004
18184 msgid "guix package --list-available\n"
18187 #. type: Plain text
18188 #: doc/guix.texi:8010
18190 "Our goal is to provide a practical 100% free software distribution of Linux-"
18191 "based and other variants of GNU, with a focus on the promotion and tight "
18192 "integration of GNU components, and an emphasis on programs and tools that "
18193 "help users exert that freedom."
18196 #. type: Plain text
18197 #: doc/guix.texi:8012
18198 msgid "Packages are currently available on the following platforms:"
18202 #: doc/guix.texi:8015 doc/guix.texi:8180
18204 msgid "x86_64-linux"
18208 #: doc/guix.texi:8017
18209 msgid "Intel/AMD @code{x86_64} architecture, Linux-Libre kernel;"
18213 #: doc/guix.texi:8018 doc/guix.texi:8183
18219 #: doc/guix.texi:8020
18220 msgid "Intel 32-bit architecture (IA32), Linux-Libre kernel;"
18224 #: doc/guix.texi:8021
18226 msgid "armhf-linux"
18230 #: doc/guix.texi:8025
18232 "ARMv7-A architecture with hard float, Thumb-2 and NEON, using the EABI hard-"
18233 "float application binary interface (ABI), and Linux-Libre kernel."
18237 #: doc/guix.texi:8026
18239 msgid "aarch64-linux"
18243 #: doc/guix.texi:8030
18245 "little-endian 64-bit ARMv8-A processors, Linux-Libre kernel. This is "
18246 "currently in an experimental stage, with limited support. "
18247 "@xref{Contributing}, for how to help!"
18251 #: doc/guix.texi:8031
18253 msgid "mips64el-linux"
18257 #: doc/guix.texi:8034
18259 "little-endian 64-bit MIPS processors, specifically the Loongson series, n32 "
18260 "ABI, and Linux-Libre kernel."
18263 #. type: Plain text
18264 #: doc/guix.texi:8038
18266 "GuixSD itself is currently only available on @code{i686} and @code{x86_64}."
18269 #. type: Plain text
18270 #: doc/guix.texi:8042
18272 "For information on porting to other architectures or kernels, "
18276 #. type: Plain text
18277 #: doc/guix.texi:8057
18279 "Building this distribution is a cooperative effort, and you are invited to "
18280 "join! @xref{Contributing}, for information about how you can help."
18284 #: doc/guix.texi:8061
18286 msgid "installing GuixSD"
18289 #. type: Plain text
18290 #: doc/guix.texi:8067
18292 "This section explains how to install the Guix System Distribution (GuixSD) "
18293 "on a machine. The Guix package manager can also be installed on top of a "
18294 "running GNU/Linux system, @pxref{Installation}."
18298 #: doc/guix.texi:8076
18300 "You are reading this documentation with an Info reader. For details on how "
18301 "to use it, hit the @key{RET} key (``return'' or ``enter'') on the link that "
18302 "follows: @pxref{Top, Info reader,, info-stnd, Stand-alone GNU Info}. Hit "
18303 "@kbd{l} afterwards to come back here."
18307 #: doc/guix.texi:8079
18309 "Alternately, run @command{info info} in another tty to keep the manual "
18313 #. type: Plain text
18314 #: doc/guix.texi:8104
18316 "As of version @value{VERSION}, the Guix System Distribution (GuixSD) is not "
18317 "production-ready. It may contain bugs and lack important features. Thus, "
18318 "if you are looking for a stable production system that respects your freedom "
18319 "as a computer user, a good solution at this point is to consider @url{http://"
18320 "www.gnu.org/distros/free-distros.html, one of the more established GNU/Linux "
18321 "distributions}. We hope you can soon switch to the GuixSD without fear, of "
18322 "course. In the meantime, you can also keep using your distribution and try "
18323 "out the package manager on top of it (@pxref{Installation})."
18326 #. type: Plain text
18327 #: doc/guix.texi:8107
18329 "Before you proceed with the installation, be aware of the following "
18330 "noteworthy limitations applicable to version @value{VERSION}:"
18334 #: doc/guix.texi:8113
18336 "The installation process does not include a graphical user interface and "
18337 "requires familiarity with GNU/Linux (see the following subsections to get a "
18338 "feel of what that means.)"
18342 #: doc/guix.texi:8116
18343 msgid "Support for the Logical Volume Manager (LVM) is missing."
18347 #: doc/guix.texi:8120
18349 "More and more system services are provided (@pxref{Services}), but some may "
18354 #: doc/guix.texi:8124
18356 "More than 6,500 packages are available, but you might occasionally find that "
18357 "a useful package is missing."
18361 #: doc/guix.texi:8129
18363 "GNOME, Xfce, LXDE, and Enlightenment are available (@pxref{Desktop "
18364 "Services}), as well as a number of X11 window managers. However, some "
18365 "graphical applications may be missing, as well as KDE."
18368 #. type: Plain text
18369 #: doc/guix.texi:8134
18371 "You have been warned! But more than a disclaimer, this is an invitation to "
18372 "report issues (and success stories!), and to join us in improving it. "
18373 "@xref{Contributing}, for more info."
18377 #: doc/guix.texi:8139
18379 msgid "hardware support on GuixSD"
18382 #. type: Plain text
18383 #: doc/guix.texi:8148
18385 "GNU@tie{}GuixSD focuses on respecting the user's computing freedom. It "
18386 "builds around the kernel Linux-libre, which means that only hardware for "
18387 "which free software drivers and firmware exist is supported. Nowadays, a "
18388 "wide range of off-the-shelf hardware is supported on GNU/Linux-libre---from "
18389 "keyboards to graphics cards to scanners and Ethernet controllers. "
18390 "Unfortunately, there are still areas where hardware vendors deny users "
18391 "control over their own computing, and such hardware is not supported on "
18396 #: doc/guix.texi:8149
18398 msgid "WiFi, hardware support"
18401 #. type: Plain text
18402 #: doc/guix.texi:8158
18404 "One of the main areas where free drivers or firmware are lacking is WiFi "
18405 "devices. WiFi devices known to work include those using Atheros chips "
18406 "(AR9271 and AR7010), which corresponds to the @code{ath9k} Linux-libre "
18407 "driver, and those using Broadcom/AirForce chips (BCM43xx with Wireless-Core "
18408 "Revision 5), which corresponds to the @code{b43-open} Linux-libre driver. "
18409 "Free firmware exists for both and is available out-of-the-box on GuixSD, as "
18410 "part of @var{%base-firmware} (@pxref{operating-system Reference, "
18411 "@code{firmware}})."
18415 #: doc/guix.texi:8159
18417 msgid "RYF, Respects Your Freedom"
18420 #. type: Plain text
18421 #: doc/guix.texi:8165
18423 "The @uref{https://www.fsf.org/, Free Software Foundation} runs @uref{https://"
18424 "www.fsf.org/ryf, @dfn{Respects Your Freedom}} (RYF), a certification program "
18425 "for hardware products that respect your freedom and your privacy and ensure "
18426 "that you have control over your device. We encourage you to check the list "
18427 "of RYF-certified devices."
18430 #. type: Plain text
18431 #: doc/guix.texi:8169
18433 "Another useful resource is the @uref{https://www.h-node.org/, H-Node} web "
18434 "site. It contains a catalog of hardware devices with information about "
18435 "their support in GNU/Linux."
18438 #. type: Plain text
18439 #: doc/guix.texi:8178
18441 "An ISO-9660 installation image that can be written to a USB stick or burnt "
18442 "to a DVD can be downloaded from @indicateurl{ftp://alpha.gnu.org/gnu/guix/"
18443 "guixsd-install-@value{VERSION}.@var{system}.iso.xz}, where @var{system} is "
18448 #: doc/guix.texi:8182
18449 msgid "for a GNU/Linux system on Intel/AMD-compatible 64-bit CPUs;"
18453 #: doc/guix.texi:8185
18454 msgid "for a 32-bit GNU/Linux system on Intel-compatible CPUs."
18457 #. type: Plain text
18458 #: doc/guix.texi:8190
18460 "Make sure to download the associated @file{.sig} file and to verify the "
18461 "authenticity of the image against it, along these lines:"
18465 #: doc/guix.texi:8194
18468 "$ wget ftp://alpha.gnu.org/gnu/guix/guixsd-install-@value{VERSION}.@var{system}.iso.xz.sig\n"
18469 "$ gpg --verify guixsd-install-@value{VERSION}.@var{system}.iso.xz.sig\n"
18472 #. type: Plain text
18473 #: doc/guix.texi:8209
18475 "This image contains the tools necessary for an installation. It is meant to "
18476 "be copied @emph{as is} to a large-enough USB stick or DVD."
18479 #. type: unnumberedsubsubsec
18480 #: doc/guix.texi:8210
18482 msgid "Copying to a USB Stick"
18485 #. type: Plain text
18486 #: doc/guix.texi:8213
18487 msgid "To copy the image to a USB stick, follow these steps:"
18491 #: doc/guix.texi:8217 doc/guix.texi:8242
18492 msgid "Decompress the image using the @command{xz} command:"
18496 #: doc/guix.texi:8220 doc/guix.texi:8245
18498 msgid "xz -d guixsd-install-@value{VERSION}.@var{system}.iso.xz\n"
18502 #: doc/guix.texi:8226
18504 "Insert a USB stick of 1@tie{}GiB or more into your machine, and determine "
18505 "its device name. Assuming that the USB stick is known as @file{/dev/sdX}, "
18506 "copy the image with:"
18510 #: doc/guix.texi:8230
18513 "dd if=guixsd-install-@value{VERSION}.x86_64-linux.iso of=/dev/sdX\n"
18518 #: doc/guix.texi:8233
18519 msgid "Access to @file{/dev/sdX} usually requires root privileges."
18522 #. type: unnumberedsubsubsec
18523 #: doc/guix.texi:8235
18525 msgid "Burning on a DVD"
18528 #. type: Plain text
18529 #: doc/guix.texi:8238
18530 msgid "To copy the image to a DVD, follow these steps:"
18534 #: doc/guix.texi:8251
18536 "Insert a blank DVD into your machine, and determine its device name. "
18537 "Assuming that the DVD drive is known as @file{/dev/srX}, copy the image with:"
18541 #: doc/guix.texi:8254
18543 msgid "growisofs -dvd-compat -Z /dev/srX=guixsd-install-@value{VERSION}.x86_64.iso\n"
18547 #: doc/guix.texi:8257
18548 msgid "Access to @file{/dev/srX} usually requires root privileges."
18551 #. type: unnumberedsubsubsec
18552 #: doc/guix.texi:8259
18557 #. type: Plain text
18558 #: doc/guix.texi:8264
18560 "Once this is done, you should be able to reboot the system and boot from the "
18561 "USB stick or DVD. The latter usually requires you to get in the BIOS or "
18562 "UEFI boot menu, where you can choose to boot from the USB stick."
18565 #. type: Plain text
18566 #: doc/guix.texi:8267
18568 "@xref{Installing GuixSD in a VM}, if, instead, you would like to install "
18569 "GuixSD in a virtual machine (VM)."
18572 #. type: Plain text
18573 #: doc/guix.texi:8279
18575 "Once you have successfully booted your computer using the installation "
18576 "medium, you should end up with a root prompt. Several console TTYs are "
18577 "configured and can be used to run commands as root. TTY2 shows this "
18578 "documentation, browsable using the Info reader commands (@pxref{Top,,, info-"
18579 "stnd, Stand-alone GNU Info}). The installation system runs the GPM mouse "
18580 "daemon, which allows you to select text with the left mouse button and to "
18581 "paste it with the middle button."
18585 #: doc/guix.texi:8284
18587 "Installation requires access to the Internet so that any missing "
18588 "dependencies of your system configuration can be downloaded. See the "
18589 "``Networking'' section below."
18592 #. type: Plain text
18593 #: doc/guix.texi:8290
18595 "The installation system includes many common tools needed for this task. "
18596 "But it is also a full-blown GuixSD system, which means that you can install "
18597 "additional packages, should you need it, using @command{guix package} "
18598 "(@pxref{Invoking guix package})."
18601 #. type: subsubsection
18602 #: doc/guix.texi:8291
18604 msgid "Keyboard Layout"
18608 #: doc/guix.texi:8293 doc/guix.texi:10364
18610 msgid "keyboard layout"
18613 #. type: Plain text
18614 #: doc/guix.texi:8297
18616 "The installation image uses the US qwerty keyboard layout. If you want to "
18617 "change it, you can use the @command{loadkeys} command. For example, the "
18618 "following command selects the Dvorak keyboard layout:"
18622 #: doc/guix.texi:8300
18624 msgid "loadkeys dvorak\n"
18627 #. type: Plain text
18628 #: doc/guix.texi:8305
18630 "See the files under @file{/run/current-system/profile/share/keymaps} for a "
18631 "list of available keyboard layouts. Run @command{man loadkeys} for more "
18635 #. type: subsubsection
18636 #: doc/guix.texi:8306
18641 #. type: Plain text
18642 #: doc/guix.texi:8309
18643 msgid "Run the following command see what your network interfaces are called:"
18647 #: doc/guix.texi:8312
18649 msgid "ifconfig -a\n"
18652 #. type: Plain text
18653 #: doc/guix.texi:8316
18654 msgid "@dots{} or, using the GNU/Linux-specific @command{ip} command:"
18658 #: doc/guix.texi:8319
18663 #. type: Plain text
18664 #: doc/guix.texi:8326
18666 "Wired interfaces have a name starting with @samp{e}; for example, the "
18667 "interface corresponding to the first on-board Ethernet controller is called "
18668 "@samp{eno1}. Wireless interfaces have a name starting with @samp{w}, like "
18673 #: doc/guix.texi:8328
18675 msgid "Wired connection"
18679 #: doc/guix.texi:8331
18681 "To configure a wired network run the following command, substituting "
18682 "@var{interface} with the name of the wired interface you want to use."
18686 #: doc/guix.texi:8334
18688 msgid "ifconfig @var{interface} up\n"
18692 #: doc/guix.texi:8336
18694 msgid "Wireless connection"
18698 #: doc/guix.texi:8337 doc/guix.texi:10763
18704 #: doc/guix.texi:8338 doc/guix.texi:10764
18710 #: doc/guix.texi:8343
18712 "To configure wireless networking, you can create a configuration file for "
18713 "the @command{wpa_supplicant} configuration tool (its location is not "
18714 "important) using one of the available text editors such as @command{nano}:"
18718 #: doc/guix.texi:8346
18720 msgid "nano wpa_supplicant.conf\n"
18724 #: doc/guix.texi:8351
18726 "As an example, the following stanza can go to this file and will work for "
18727 "many wireless networks, provided you give the actual SSID and passphrase for "
18728 "the network you are connecting to:"
18732 #: doc/guix.texi:8358
18736 " ssid=\"@var{my-ssid}\"\n"
18737 " key_mgmt=WPA-PSK\n"
18738 " psk=\"the network's secret passphrase\"\n"
18743 #: doc/guix.texi:8363
18745 "Start the wireless service and run it in the background with the following "
18746 "command (substitute @var{interface} with the name of the network interface "
18747 "you want to use):"
18751 #: doc/guix.texi:8366
18753 msgid "wpa_supplicant -c wpa_supplicant.conf -i @var{interface} -B\n"
18757 #: doc/guix.texi:8369
18758 msgid "Run @command{man wpa_supplicant} for more information."
18762 #: doc/guix.texi:8371
18767 #. type: Plain text
18768 #: doc/guix.texi:8374
18770 "At this point, you need to acquire an IP address. On a network where IP "
18771 "addresses are automatically assigned @i{via} DHCP, you can run:"
18775 #: doc/guix.texi:8377
18777 msgid "dhclient -v @var{interface}\n"
18780 #. type: Plain text
18781 #: doc/guix.texi:8380
18782 msgid "Try to ping a server to see if networking is up and running:"
18786 #: doc/guix.texi:8383
18788 msgid "ping -c 3 gnu.org\n"
18791 #. type: Plain text
18792 #: doc/guix.texi:8387
18794 "Setting up network access is almost always a requirement because the image "
18795 "does not contain all the software and tools that may be needed."
18799 #: doc/guix.texi:8388
18801 msgid "installing over SSH"
18804 #. type: Plain text
18805 #: doc/guix.texi:8391
18807 "If you want to, you can continue the installation remotely by starting an "
18812 #: doc/guix.texi:8394
18814 msgid "herd start ssh-daemon\n"
18817 #. type: Plain text
18818 #: doc/guix.texi:8398
18820 "Make sure to either set a password with @command{passwd}, or configure "
18821 "OpenSSH public key authentication before logging in."
18824 #. type: subsubsection
18825 #: doc/guix.texi:8399
18827 msgid "Disk Partitioning"
18830 #. type: Plain text
18831 #: doc/guix.texi:8403
18833 "Unless this has already been done, the next step is to partition, and then "
18834 "format the target partition(s)."
18837 #. type: Plain text
18838 #: doc/guix.texi:8408
18840 "The installation image includes several partitioning tools, including Parted "
18841 "(@pxref{Overview,,, parted, GNU Parted User Manual}), @command{fdisk}, and "
18842 "@command{cfdisk}. Run it and set up your disk with the partition layout you "
18847 #: doc/guix.texi:8411
18852 #. type: Plain text
18853 #: doc/guix.texi:8417
18855 "If your disk uses the GUID Partition Table (GPT) format and you plan to "
18856 "install BIOS-based GRUB (which is the default), make sure a BIOS Boot "
18857 "Partition is available (@pxref{BIOS installation,,, grub, GNU GRUB manual})."
18861 #: doc/guix.texi:8418
18863 msgid "EFI, installation"
18867 #: doc/guix.texi:8419
18869 msgid "UEFI, installation"
18873 #: doc/guix.texi:8420
18875 msgid "ESP, EFI system partition"
18878 #. type: Plain text
18879 #: doc/guix.texi:8424
18881 "If you instead wish to use EFI-based GRUB, a FAT32 @dfn{EFI System "
18882 "Partition} (ESP) is required. This partition should be mounted at @file{/"
18883 "boot/efi} and must have the @code{esp} flag set. E.g., for @command{parted}:"
18887 #: doc/guix.texi:8427
18889 msgid "parted /dev/sda set 1 esp on\n"
18892 #. type: Plain text
18893 #: doc/guix.texi:8435
18895 "Once you are done partitioning the target hard disk drive, you have to "
18896 "create a file system on the relevant partition(s)@footnote{Currently GuixSD "
18897 "only supports ext4 and btrfs file systems. In particular, code that reads "
18898 "file system UUIDs and labels only works for these file system types.}. For "
18899 "the ESP, if you have one and assuming it is @file{/dev/sda2}, run:"
18903 #: doc/guix.texi:8438
18905 msgid "mkfs.fat -F32 /dev/sda2\n"
18908 #. type: Plain text
18909 #: doc/guix.texi:8446
18911 "Preferably, assign file systems a label so that you can easily and reliably "
18912 "refer to them in @code{file-system} declarations (@pxref{File Systems}). "
18913 "This is typically done using the @code{-L} option of @command{mkfs.ext4} and "
18914 "related commands. So, assuming the target root partition lives at @file{/"
18915 "dev/sda1}, a file system with the label @code{my-root} can be created with:"
18919 #: doc/guix.texi:8449
18921 msgid "mkfs.ext4 -L my-root /dev/sda1\n"
18925 #: doc/guix.texi:8451 doc/guix.texi:8840
18927 msgid "encrypted disk"
18930 #. type: Plain text
18931 #: doc/guix.texi:8458
18933 "If you are instead planning to encrypt the root partition, you can use the "
18934 "Cryptsetup/LUKS utilities to do that (see @inlinefmtifelse{html, "
18935 "@uref{https://linux.die.net/man/8/cryptsetup, @code{man cryptsetup}}, "
18936 "@code{man cryptsetup}} for more information.) Assuming you want to store "
18937 "the root partition on @file{/dev/sda1}, the command sequence would be along "
18942 #: doc/guix.texi:8463
18945 "cryptsetup luksFormat /dev/sda1\n"
18946 "cryptsetup open --type luks /dev/sda1 my-partition\n"
18947 "mkfs.ext4 -L my-root /dev/mapper/my-partition\n"
18950 #. type: Plain text
18951 #: doc/guix.texi:8468
18953 "Once that is done, mount the target file system under @file{/mnt} with a "
18954 "command like (again, assuming @code{my-root} is the label of the root file "
18959 #: doc/guix.texi:8471
18961 msgid "mount LABEL=my-root /mnt\n"
18964 #. type: Plain text
18965 #: doc/guix.texi:8477
18967 "Also mount any other file systems you would like to use on the target system "
18968 "relative to this path. If you have @file{/boot} on a separate partition for "
18969 "example, mount it at @file{/mnt/boot} now so it is found by @code{guix "
18970 "system init} afterwards."
18973 #. type: Plain text
18974 #: doc/guix.texi:8482
18976 "Finally, if you plan to use one or more swap partitions (@pxref{Memory "
18977 "Concepts, swap space,, libc, The GNU C Library Reference Manual}), make sure "
18978 "to initialize them with @command{mkswap}. Assuming you have one swap "
18979 "partition on @file{/dev/sda2}, you would run:"
18983 #: doc/guix.texi:8486
18986 "mkswap /dev/sda2\n"
18987 "swapon /dev/sda2\n"
18990 #. type: Plain text
18991 #: doc/guix.texi:8494
18993 "Alternatively, you may use a swap file. For example, assuming that in the "
18994 "new system you want to use the file @file{/swapfile} as a swap file, you "
18995 "would run@footnote{This example will work for many types of file systems (e."
18996 "g., ext4). However, for copy-on-write file systems (e.g., btrfs), the "
18997 "required steps may be different. For details, see the manual pages for "
18998 "@command{mkswap} and @command{swapon}.}:"
19002 #: doc/guix.texi:8502
19005 "# This is 10 GiB of swap space. Adjust \"count\" to change the size.\n"
19006 "dd if=/dev/zero of=/mnt/swapfile bs=1MiB count=10240\n"
19007 "# For security, make the file readable and writable only by root.\n"
19008 "chmod 600 /mnt/swapfile\n"
19009 "mkswap /mnt/swapfile\n"
19010 "swapon /mnt/swapfile\n"
19013 #. type: Plain text
19014 #: doc/guix.texi:8507
19016 "Note that if you have encrypted the root partition and created a swap file "
19017 "in its file system as described above, then the encryption also protects the "
19018 "swap file, just like any other file in that file system."
19021 #. type: Plain text
19022 #: doc/guix.texi:8513
19024 "With the target partitions ready and the target root mounted on @file{/mnt}, "
19025 "we're ready to go. First, run:"
19029 #: doc/guix.texi:8516
19031 msgid "herd start cow-store /mnt\n"
19034 #. type: Plain text
19035 #: doc/guix.texi:8523
19037 "This makes @file{/gnu/store} copy-on-write, such that packages added to it "
19038 "during the installation phase are written to the target disk on @file{/mnt} "
19039 "rather than kept in memory. This is necessary because the first phase of "
19040 "the @command{guix system init} command (see below) entails downloads or "
19041 "builds to @file{/gnu/store} which, initially, is an in-memory file system."
19044 #. type: Plain text
19045 #: doc/guix.texi:8534
19047 "Next, you have to edit a file and provide the declaration of the operating "
19048 "system to be installed. To that end, the installation system comes with "
19049 "three text editors. We recommend GNU nano (@pxref{Top,,, nano, GNU nano "
19050 "Manual}), which supports syntax highlighting and parentheses matching; other "
19051 "editors include GNU Zile (an Emacs clone), and nvi (a clone of the original "
19052 "BSD @command{vi} editor). We strongly recommend storing that file on the "
19053 "target root file system, say, as @file{/mnt/etc/config.scm}. Failing to do "
19054 "that, you will have lost your configuration file once you have rebooted into "
19055 "the newly-installed system."
19058 #. type: Plain text
19059 #: doc/guix.texi:8541
19061 "@xref{Using the Configuration System}, for an overview of the configuration "
19062 "file. The example configurations discussed in that section are available "
19063 "under @file{/etc/configuration} in the installation image. Thus, to get "
19064 "started with a system configuration providing a graphical display server (a "
19065 "``desktop'' system), you can run something along these lines:"
19069 #: doc/guix.texi:8546
19072 "# mkdir /mnt/etc\n"
19073 "# cp /etc/configuration/desktop.scm /mnt/etc/config.scm\n"
19074 "# nano /mnt/etc/config.scm\n"
19077 #. type: Plain text
19078 #: doc/guix.texi:8550
19080 "You should pay attention to what your configuration file contains, and in "
19085 #: doc/guix.texi:8560
19087 "Make sure the @code{bootloader-configuration} form refers to the target you "
19088 "want to install GRUB on. It should mention @code{grub-bootloader} if you "
19089 "are installing GRUB in the legacy way, or @code{grub-efi-bootloader} for "
19090 "newer UEFI systems. For legacy systems, the @code{target} field names a "
19091 "device, like @code{/dev/sda}; for UEFI systems it names a path to a mounted "
19092 "EFI partition, like @code{/boot/efi}, and do make sure the path is actually "
19097 #: doc/guix.texi:8566
19099 "Be sure that your file system labels match the value of their respective "
19100 "@code{device} fields in your @code{file-system} configuration, assuming your "
19101 "@code{file-system} configuration sets the value of @code{title} to "
19106 #: doc/guix.texi:8570
19108 "If there are encrypted or RAID partitions, make sure to add a @code{mapped-"
19109 "devices} field to describe them (@pxref{Mapped Devices})."
19112 #. type: Plain text
19113 #: doc/guix.texi:8575
19115 "Once you are done preparing the configuration file, the new system must be "
19116 "initialized (remember that the target root file system is mounted under "
19121 #: doc/guix.texi:8578
19123 msgid "guix system init /mnt/etc/config.scm /mnt\n"
19126 #. type: Plain text
19127 #: doc/guix.texi:8585
19129 "This copies all the necessary files and installs GRUB on @file{/dev/sdX}, "
19130 "unless you pass the @option{--no-bootloader} option. For more information, "
19131 "@pxref{Invoking guix system}. This command may trigger downloads or builds "
19132 "of missing packages, which can take some time."
19135 #. type: Plain text
19136 #: doc/guix.texi:8592
19138 "Once that command has completed---and hopefully succeeded!---you can run "
19139 "@command{reboot} and boot into the new system. The @code{root} password in "
19140 "the new system is initially empty; other users' passwords need to be "
19141 "initialized by running the @command{passwd} command as @code{root}, unless "
19142 "your configuration specifies otherwise (@pxref{user-account-password, user "
19143 "account passwords})."
19147 #: doc/guix.texi:8593
19149 msgid "upgrading GuixSD"
19152 #. type: Plain text
19153 #: doc/guix.texi:8600
19155 "From then on, you can update GuixSD whenever you want by running "
19156 "@command{guix pull} as @code{root} (@pxref{Invoking guix pull}), and then "
19157 "running @command{guix system reconfigure} to build a new system generation "
19158 "with the latest packages and services (@pxref{Invoking guix system}). We "
19159 "recommend doing that regularly so that your system includes the latest "
19160 "security updates (@pxref{Security Updates})."
19163 #. type: Plain text
19164 #: doc/guix.texi:8604
19166 "Join us on @code{#guix} on the Freenode IRC network or on @file{guix-"
19167 "devel@@gnu.org} to share your experience---good or not so good."
19170 #. type: subsection
19171 #: doc/guix.texi:8606
19173 msgid "Installing GuixSD in a Virtual Machine"
19177 #: doc/guix.texi:8608
19179 msgid "virtual machine, GuixSD installation"
19183 #: doc/guix.texi:8609
19185 msgid "virtual private server (VPS)"
19189 #: doc/guix.texi:8610
19191 msgid "VPS (virtual private server)"
19194 #. type: Plain text
19195 #: doc/guix.texi:8614
19197 "If you'd like to install GuixSD in a virtual machine (VM) or on a virtual "
19198 "private server (VPS) rather than on your beloved machine, this section is "
19202 #. type: Plain text
19203 #: doc/guix.texi:8617
19205 "To boot a @uref{http://qemu.org/,QEMU} VM for installing GuixSD in a disk "
19206 "image, follow these steps:"
19210 #: doc/guix.texi:8622
19212 "First, retrieve and decompress the GuixSD installation image as described "
19213 "previously (@pxref{USB Stick and DVD Installation})."
19217 #: doc/guix.texi:8626
19219 "Create a disk image that will hold the installed system. To make a qcow2-"
19220 "formatted disk image, use the @command{qemu-img} command:"
19224 #: doc/guix.texi:8629
19226 msgid "qemu-img create -f qcow2 guixsd.img 50G\n"
19230 #: doc/guix.texi:8633
19232 "The resulting file will be much smaller than 50 GB (typically less than 1 "
19233 "MB), but it will grow as the virtualized storage device is filled up."
19237 #: doc/guix.texi:8636
19238 msgid "Boot the USB installation image in an VM:"
19242 #: doc/guix.texi:8642
19245 "qemu-system-x86_64 -m 1024 -smp 1 \\\n"
19246 " -net user -net nic,model=virtio -boot menu=on \\\n"
19247 " -drive file=guixsd-install-@value{VERSION}.@var{system}.iso \\\n"
19248 " -drive file=guixsd.img\n"
19252 #: doc/guix.texi:8645
19253 msgid "The ordering of the drives matters."
19257 #: doc/guix.texi:8649
19259 "In the VM console, quickly press the @kbd{F12} key to enter the boot menu. "
19260 "Then press the @kbd{2} key and the @kbd{RET} key to validate your selection."
19264 #: doc/guix.texi:8653
19266 "You're now root in the VM, proceed with the installation process. "
19267 "@xref{Preparing for Installation}, and follow the instructions."
19270 #. type: Plain text
19271 #: doc/guix.texi:8658
19273 "Once installation is complete, you can boot the system that's on your "
19274 "@file{guixsd.img} image. @xref{Running GuixSD in a VM}, for how to do that."
19278 #: doc/guix.texi:8662
19280 msgid "installation image"
19283 #. type: Plain text
19284 #: doc/guix.texi:8665
19286 "The installation image described above was built using the @command{guix "
19287 "system} command, specifically:"
19291 #: doc/guix.texi:8668
19293 msgid "guix system disk-image gnu/system/install.scm\n"
19296 #. type: Plain text
19297 #: doc/guix.texi:8673
19299 "Have a look at @file{gnu/system/install.scm} in the source tree, and see "
19300 "also @ref{Invoking guix system} for more information about the installation "
19305 #: doc/guix.texi:8677
19307 msgid "system configuration"
19310 #. type: Plain text
19311 #: doc/guix.texi:8683
19313 "The Guix System Distribution supports a consistent whole-system "
19314 "configuration mechanism. By that we mean that all aspects of the global "
19315 "system configuration---such as the available system services, timezone and "
19316 "locale settings, user accounts---are declared in a single place. Such a "
19317 "@dfn{system configuration} can be @dfn{instantiated}---i.e., effected."
19320 #. type: Plain text
19321 #: doc/guix.texi:8693
19323 "One of the advantages of putting all the system configuration under the "
19324 "control of Guix is that it supports transactional system upgrades, and makes "
19325 "it possible to roll back to a previous system instantiation, should "
19326 "something go wrong with the new one (@pxref{Features}). Another advantage "
19327 "is that it makes it easy to replicate the exact same configuration across "
19328 "different machines, or at different points in time, without having to resort "
19329 "to additional administration tools layered on top of the own tools of the "
19333 #. type: Plain text
19334 #: doc/guix.texi:8698
19336 "This section describes this mechanism. First we focus on the system "
19337 "administrator's viewpoint---explaining how the system is configured and "
19338 "instantiated. Then we show how this mechanism can be extended, for instance "
19339 "to support new system services."
19342 #. type: Plain text
19343 #: doc/guix.texi:8725
19345 "The operating system is configured by providing an @code{operating-system} "
19346 "declaration in a file that can then be passed to the @command{guix system} "
19347 "command (@pxref{Invoking guix system}). A simple setup, with the default "
19348 "system services, the default Linux-Libre kernel, initial RAM disk, and boot "
19349 "loader looks like this:"
19353 #: doc/guix.texi:8726
19355 msgid "operating-system"
19359 #: doc/guix.texi:8728
19361 msgid "os-config-bare-bones.texi"
19364 #. type: Plain text
19365 #: doc/guix.texi:8735
19367 "This example should be self-describing. Some of the fields defined above, "
19368 "such as @code{host-name} and @code{bootloader}, are mandatory. Others, such "
19369 "as @code{packages} and @code{services}, can be omitted, in which case they "
19370 "get a default value."
19373 #. type: Plain text
19374 #: doc/guix.texi:8740
19376 "Below we discuss the effect of some of the most important fields "
19377 "(@pxref{operating-system Reference}, for details about all the available "
19378 "fields), and how to @dfn{instantiate} the operating system using "
19379 "@command{guix system}."
19382 #. type: unnumberedsubsubsec
19383 #: doc/guix.texi:8741
19385 msgid "Globally-Visible Packages"
19389 #: doc/guix.texi:8743
19391 msgid "%base-packages"
19394 #. type: Plain text
19395 #: doc/guix.texi:8756
19397 "The @code{packages} field lists packages that will be globally visible on "
19398 "the system, for all user accounts---i.e., in every user's @code{PATH} "
19399 "environment variable---in addition to the per-user profiles (@pxref{Invoking "
19400 "guix package}). The @var{%base-packages} variable provides all the tools "
19401 "one would expect for basic user and administrator tasks---including the GNU "
19402 "Core Utilities, the GNU Networking Utilities, the GNU Zile lightweight text "
19403 "editor, @command{find}, @command{grep}, etc. The example above adds "
19404 "GNU@tie{}Screen and OpenSSH to those, taken from the @code{(gnu packages "
19405 "screen)} and @code{(gnu packages ssh)} modules (@pxref{Package Modules}). "
19406 "The @code{(list package output)} syntax can be used to add a specific output "
19411 #: doc/guix.texi:8760
19414 "(use-modules (gnu packages))\n"
19415 "(use-modules (gnu packages dns))\n"
19420 #: doc/guix.texi:8765
19423 "(operating-system\n"
19425 " (packages (cons (list bind \"utils\")\n"
19426 " %base-packages)))\n"
19430 #: doc/guix.texi:8767
19432 msgid "specification->package"
19435 #. type: Plain text
19436 #: doc/guix.texi:8776
19438 "Referring to packages by variable name, like @code{bind} above, has the "
19439 "advantage of being unambiguous; it also allows typos and such to be "
19440 "diagnosed right away as ``unbound variables''. The downside is that one "
19441 "needs to know which module defines which package, and to augment the "
19442 "@code{use-package-modules} line accordingly. To avoid that, one can use the "
19443 "@code{specification->package} procedure of the @code{(gnu packages)} module, "
19444 "which returns the best package for a given name or name and version:"
19448 #: doc/guix.texi:8779
19451 "(use-modules (gnu packages))\n"
19456 #: doc/guix.texi:8785
19459 "(operating-system\n"
19461 " (packages (append (map specification->package\n"
19462 " '(\"tcpdump\" \"htop\" \"gnupg@@2.0\"))\n"
19463 " %base-packages)))\n"
19466 #. type: unnumberedsubsubsec
19467 #: doc/guix.texi:8787
19469 msgid "System Services"
19473 #: doc/guix.texi:8789 doc/guix.texi:19933 doc/guix.texi:20851
19479 #: doc/guix.texi:8790
19481 msgid "%base-services"
19484 #. type: Plain text
19485 #: doc/guix.texi:8800
19487 "The @code{services} field lists @dfn{system services} to be made available "
19488 "when the system starts (@pxref{Services}). The @code{operating-system} "
19489 "declaration above specifies that, in addition to the basic services, we want "
19490 "the @command{lshd} secure shell daemon listening on port 2222 "
19491 "(@pxref{Networking Services, @code{lsh-service}}). Under the hood, "
19492 "@code{lsh-service} arranges so that @code{lshd} is started with the right "
19493 "command-line options, possibly with supporting configuration files generated "
19494 "as needed (@pxref{Defining Services})."
19498 #: doc/guix.texi:8801
19500 msgid "customization, of services"
19504 #: doc/guix.texi:8802
19506 msgid "modify-services"
19509 #. type: Plain text
19510 #: doc/guix.texi:8806
19512 "Occasionally, instead of using the base services as is, you will want to "
19513 "customize them. To do this, use @code{modify-services} (@pxref{Service "
19514 "Reference, @code{modify-services}}) to modify the list."
19517 #. type: Plain text
19518 #: doc/guix.texi:8811
19520 "For example, suppose you want to modify @code{guix-daemon} and Mingetty (the "
19521 "console log-in) in the @var{%base-services} list (@pxref{Base Services, "
19522 "@code{%base-services}}). To do that, you can write the following in your "
19523 "operating system declaration:"
19527 #: doc/guix.texi:8824
19530 "(define %my-services\n"
19531 " ;; My very own list of services.\n"
19532 " (modify-services %base-services\n"
19533 " (guix-service-type config =>\n"
19534 " (guix-configuration\n"
19535 " (inherit config)\n"
19536 " (use-substitutes? #f)\n"
19537 " (extra-options '(\"--gc-keep-derivations\"))))\n"
19538 " (mingetty-service-type config =>\n"
19539 " (mingetty-configuration\n"
19540 " (inherit config)))))\n"
19545 #: doc/guix.texi:8828
19548 "(operating-system\n"
19550 " (services %my-services))\n"
19553 #. type: Plain text
19554 #: doc/guix.texi:8839
19556 "This changes the configuration---i.e., the service parameters---of the "
19557 "@code{guix-service-type} instance, and that of all the @code{mingetty-"
19558 "service-type} instances in the @var{%base-services} list. Observe how this "
19559 "is accomplished: first, we arrange for the original configuration to be "
19560 "bound to the identifier @code{config} in the @var{body}, and then we write "
19561 "the @var{body} so that it evaluates to the desired configuration. In "
19562 "particular, notice how we use @code{inherit} to create a new configuration "
19563 "which has the same values as the old configuration, but with a few "
19567 #. type: Plain text
19568 #: doc/guix.texi:8846
19570 "The configuration for a typical ``desktop'' usage, with an encrypted root "
19571 "partition, the X11 display server, GNOME and Xfce (users can choose which of "
19572 "these desktop environments to use at the log-in screen by pressing "
19573 "@kbd{F1}), network management, power management, and more, would look like "
19578 #: doc/guix.texi:8848
19580 msgid "os-config-desktop.texi"
19584 #: doc/guix.texi:8851
19589 #. type: Plain text
19590 #: doc/guix.texi:8854
19592 "A graphical UEFI system with a choice of lightweight window managers instead "
19593 "of full-blown desktop environments would look like this:"
19597 #: doc/guix.texi:8856
19599 msgid "os-config-lightweight-desktop.texi"
19602 #. type: Plain text
19603 #: doc/guix.texi:8862
19605 "This example refers to the @file{/boot/efi} file system by its UUID, "
19606 "@code{1234-ABCD}. Replace this UUID with the right UUID on your system, as "
19607 "returned by the @command{blkid} command."
19610 #. type: Plain text
19611 #: doc/guix.texi:8866
19613 "@xref{Desktop Services}, for the exact list of services provided by "
19614 "@var{%desktop-services}. @xref{X.509 Certificates}, for background "
19615 "information about the @code{nss-certs} package that is used here."
19618 #. type: Plain text
19619 #: doc/guix.texi:8873
19621 "Again, @var{%desktop-services} is just a list of service objects. If you "
19622 "want to remove services from there, you can do so using the procedures for "
19623 "list filtering (@pxref{SRFI-1 Filtering and Partitioning,,, guile, GNU Guile "
19624 "Reference Manual}). For instance, the following expression returns a list "
19625 "that contains all the services in @var{%desktop-services} minus the Avahi "
19630 #: doc/guix.texi:8878
19633 "(remove (lambda (service)\n"
19634 " (eq? (service-kind service) avahi-service-type))\n"
19635 " %desktop-services)\n"
19638 #. type: unnumberedsubsubsec
19639 #: doc/guix.texi:8880
19641 msgid "Instantiating the System"
19644 #. type: Plain text
19645 #: doc/guix.texi:8887
19647 "Assuming the @code{operating-system} declaration is stored in the @file{my-"
19648 "system-config.scm} file, the @command{guix system reconfigure my-system-"
19649 "config.scm} command instantiates that configuration, and makes it the "
19650 "default GRUB boot entry (@pxref{Invoking guix system})."
19653 #. type: Plain text
19654 #: doc/guix.texi:8895
19656 "The normal way to change the system configuration is by updating this file "
19657 "and re-running @command{guix system reconfigure}. One should never have to "
19658 "touch files in @file{/etc} or to run commands that modify the system state "
19659 "such as @command{useradd} or @command{grub-install}. In fact, you must "
19660 "avoid that since that would not only void your warranty but also prevent you "
19661 "from rolling back to previous versions of your system, should you ever need "
19666 #: doc/guix.texi:8896
19668 msgid "roll-back, of the operating system"
19671 #. type: Plain text
19672 #: doc/guix.texi:8906
19674 "Speaking of roll-back, each time you run @command{guix system reconfigure}, "
19675 "a new @dfn{generation} of the system is created---without modifying or "
19676 "deleting previous generations. Old system generations get an entry in the "
19677 "bootloader boot menu, allowing you to boot them in case something went wrong "
19678 "with the latest generation. Reassuring, no? The @command{guix system list-"
19679 "generations} command lists the system generations available on disk. It is "
19680 "also possible to roll back the system via the commands @command{guix system "
19681 "roll-back} and @command{guix system switch-generation}."
19684 #. type: Plain text
19685 #: doc/guix.texi:8912
19687 "Although the command @command{guix system reconfigure} will not modify "
19688 "previous generations, must take care when the current generation is not the "
19689 "latest (e.g., after invoking @command{guix system roll-back}), since the "
19690 "operation might overwrite a later generation (@pxref{Invoking guix system})."
19693 #. type: unnumberedsubsubsec
19694 #: doc/guix.texi:8913
19696 msgid "The Programming Interface"
19699 #. type: Plain text
19700 #: doc/guix.texi:8918
19702 "At the Scheme level, the bulk of an @code{operating-system} declaration is "
19703 "instantiated with the following monadic procedure (@pxref{The Store Monad}):"
19707 #: doc/guix.texi:8919
19709 msgid "{Monadic Procedure} operating-system-derivation os"
19713 #: doc/guix.texi:8922
19715 "Return a derivation that builds @var{os}, an @code{operating-system} object "
19716 "(@pxref{Derivations})."
19720 #: doc/guix.texi:8926
19722 "The output of the derivation is a single directory that refers to all the "
19723 "packages, configuration files, and other supporting files needed to "
19724 "instantiate @var{os}."
19727 #. type: Plain text
19728 #: doc/guix.texi:8931
19730 "This procedure is provided by the @code{(gnu system)} module. Along with "
19731 "@code{(gnu services)} (@pxref{Services}), this module contains the guts of "
19732 "GuixSD. Make sure to visit it!"
19735 #. type: subsection
19736 #: doc/guix.texi:8934
19738 msgid "@code{operating-system} Reference"
19741 #. type: Plain text
19742 #: doc/guix.texi:8939
19744 "This section summarizes all the options available in @code{operating-system} "
19745 "declarations (@pxref{Using the Configuration System})."
19749 #: doc/guix.texi:8940
19751 msgid "{Data Type} operating-system"
19755 #: doc/guix.texi:8944
19757 "This is the data type representing an operating system configuration. By "
19758 "that, we mean all the global system configuration, not per-user "
19759 "configuration (@pxref{Using the Configuration System})."
19763 #: doc/guix.texi:8946
19765 msgid "@code{kernel} (default: @var{linux-libre})"
19769 #: doc/guix.texi:8950
19771 "The package object of the operating system kernel to use@footnote{Currently "
19772 "only the Linux-libre kernel is supported. In the future, it will be "
19773 "possible to use the GNU@tie{}Hurd.}."
19777 #: doc/guix.texi:8951
19779 msgid "@code{kernel-arguments} (default: @code{'()})"
19783 #: doc/guix.texi:8954
19785 "List of strings or gexps representing additional arguments to pass on the "
19786 "command-line of the kernel---e.g., @code{(\"console=ttyS0\")}."
19790 #: doc/guix.texi:8955 doc/guix.texi:20130 doc/guix.texi:20149
19796 #: doc/guix.texi:8957
19798 "The system bootloader configuration object. @xref{Bootloader Configuration}."
19802 #: doc/guix.texi:8958
19804 msgid "@code{initrd-modules} (default: @code{%base-initrd-modules})"
19808 #: doc/guix.texi:8959 doc/guix.texi:19970 doc/guix.texi:20073
19809 #: doc/guix.texi:20268
19815 #: doc/guix.texi:8960 doc/guix.texi:19971 doc/guix.texi:20074
19817 msgid "initial RAM disk"
19821 #: doc/guix.texi:8963
19823 "The list of Linux kernel modules that need to be available in the initial "
19824 "RAM disk. @xref{Initial RAM Disk}."
19828 #: doc/guix.texi:8964
19830 msgid "@code{initrd} (default: @code{base-initrd})"
19834 #: doc/guix.texi:8968
19836 "A monadic procedure that returns an initial RAM disk for the Linux kernel. "
19837 "This field is provided to support low-level customization and should rarely "
19838 "be needed for casual use. @xref{Initial RAM Disk}."
19842 #: doc/guix.texi:8969
19844 msgid "@code{firmware} (default: @var{%base-firmware})"
19848 #: doc/guix.texi:8970
19854 #: doc/guix.texi:8972
19855 msgid "List of firmware packages loadable by the operating system kernel."
19859 #: doc/guix.texi:8977
19861 "The default includes firmware needed for Atheros- and Broadcom-based WiFi "
19862 "devices (Linux-libre modules @code{ath9k} and @code{b43-open}, "
19863 "respectively). @xref{Hardware Considerations}, for more info on supported "
19868 #: doc/guix.texi:8978
19874 #: doc/guix.texi:8980
19875 msgid "The host name."
19879 #: doc/guix.texi:8981
19885 #: doc/guix.texi:8982
19891 #: doc/guix.texi:8987
19893 "A file-like object (@pxref{G-Expressions, file-like objects}) for use as "
19894 "@file{/etc/hosts} (@pxref{Host Names,,, libc, The GNU C Library Reference "
19895 "Manual}). The default is a file with entries for @code{localhost} and "
19900 #: doc/guix.texi:8988
19902 msgid "@code{mapped-devices} (default: @code{'()})"
19906 #: doc/guix.texi:8990
19907 msgid "A list of mapped devices. @xref{Mapped Devices}."
19911 #: doc/guix.texi:8991
19913 msgid "file-systems"
19917 #: doc/guix.texi:8993
19918 msgid "A list of file systems. @xref{File Systems}."
19922 #: doc/guix.texi:8994
19924 msgid "@code{swap-devices} (default: @code{'()})"
19928 #: doc/guix.texi:8995
19930 msgid "swap devices"
19934 #: doc/guix.texi:9002
19936 "A list of strings identifying devices or files to be used for ``swap "
19937 "space'' (@pxref{Memory Concepts,,, libc, The GNU C Library Reference "
19938 "Manual}). For example, @code{'(\"/dev/sda3\")} or @code{'(\"/swapfile\")}. "
19939 "It is possible to specify a swap file in a file system on a mapped device, "
19940 "provided that the necessary device mapping and file system are also "
19941 "specified. @xref{Mapped Devices} and @ref{File Systems}."
19945 #: doc/guix.texi:9003
19947 msgid "@code{users} (default: @code{%base-user-accounts})"
19951 #: doc/guix.texi:9004
19953 msgid "@code{groups} (default: @var{%base-groups})"
19957 #: doc/guix.texi:9006
19958 msgid "List of user accounts and groups. @xref{User Accounts}."
19962 #: doc/guix.texi:9009
19964 "If the @code{users} list lacks a user account with UID@tie{}0, a ``root'' "
19965 "account with UID@tie{}0 is automatically added."
19969 #: doc/guix.texi:9010
19971 msgid "@code{skeletons} (default: @code{(default-skeletons)})"
19975 #: doc/guix.texi:9014
19977 "A list target file name/file-like object tuples (@pxref{G-Expressions, file-"
19978 "like objects}). These are the skeleton files that will be added to the home "
19979 "directory of newly-created user accounts."
19983 #: doc/guix.texi:9016
19984 msgid "For instance, a valid value may look like this:"
19988 #: doc/guix.texi:9022
19991 "`((\".bashrc\" ,(plain-file \"bashrc\" \"echo Hello\\n\"))\n"
19992 " (\".guile\" ,(plain-file \"guile\"\n"
19993 " \"(use-modules (ice-9 readline))\n"
19994 " (activate-readline)\")))\n"
19998 #: doc/guix.texi:9024
20000 msgid "@code{issue} (default: @var{%default-issue})"
20004 #: doc/guix.texi:9027
20006 "A string denoting the contents of the @file{/etc/issue} file, which is "
20007 "displayed when users log in on a text console."
20011 #: doc/guix.texi:9028
20013 msgid "@code{packages} (default: @var{%base-packages})"
20017 #: doc/guix.texi:9031
20019 "The set of packages installed in the global profile, which is accessible at "
20020 "@file{/run/current-system/profile}."
20024 #: doc/guix.texi:9035
20026 "The default set includes core utilities and it is good practice to install "
20027 "non-core utilities in user profiles (@pxref{Invoking guix package})."
20031 #: doc/guix.texi:9036
20037 #: doc/guix.texi:9038
20038 msgid "A timezone identifying string---e.g., @code{\"Europe/Paris\"}."
20042 #: doc/guix.texi:9042
20044 "You can run the @command{tzselect} command to find out which timezone string "
20045 "corresponds to your region. Choosing an invalid timezone name causes "
20046 "@command{guix system} to fail."
20050 #: doc/guix.texi:9043
20052 msgid "@code{locale} (default: @code{\"en_US.utf8\"})"
20056 #: doc/guix.texi:9046
20058 "The name of the default locale (@pxref{Locale Names,,, libc, The GNU C "
20059 "Library Reference Manual}). @xref{Locales}, for more information."
20063 #: doc/guix.texi:9047
20065 msgid "@code{locale-definitions} (default: @var{%default-locale-definitions})"
20069 #: doc/guix.texi:9050
20071 "The list of locale definitions to be compiled and that may be used at run "
20072 "time. @xref{Locales}."
20076 #: doc/guix.texi:9051
20078 msgid "@code{locale-libcs} (default: @code{(list @var{glibc})})"
20082 #: doc/guix.texi:9055
20084 "The list of GNU@tie{}libc packages whose locale data and tools are used to "
20085 "build the locale definitions. @xref{Locales}, for compatibility "
20086 "considerations that justify this option."
20090 #: doc/guix.texi:9056
20092 msgid "@code{name-service-switch} (default: @var{%default-nss})"
20096 #: doc/guix.texi:9060
20098 "Configuration of the libc name service switch (NSS)---a @code{<name-service-"
20099 "switch>} object. @xref{Name Service Switch}, for details."
20103 #: doc/guix.texi:9061
20105 msgid "@code{services} (default: @var{%base-services})"
20109 #: doc/guix.texi:9063
20110 msgid "A list of service objects denoting system services. @xref{Services}."
20114 #: doc/guix.texi:9064
20116 msgid "@code{pam-services} (default: @code{(base-pam-services)})"
20120 #: doc/guix.texi:9065
20126 #: doc/guix.texi:9066
20128 msgid "pluggable authentication modules"
20132 #: doc/guix.texi:9069
20133 msgid "Linux @dfn{pluggable authentication module} (PAM) services."
20137 #: doc/guix.texi:9070
20139 msgid "@code{setuid-programs} (default: @var{%setuid-programs})"
20143 #: doc/guix.texi:9073
20145 "List of string-valued G-expressions denoting setuid programs. @xref{Setuid "
20150 #: doc/guix.texi:9074
20152 msgid "@code{sudoers-file} (default: @var{%sudoers-specification})"
20156 #: doc/guix.texi:9075
20158 msgid "sudoers file"
20162 #: doc/guix.texi:9078
20164 "The contents of the @file{/etc/sudoers} file as a file-like object (@pxref{G-"
20165 "Expressions, @code{local-file} and @code{plain-file}})."
20169 #: doc/guix.texi:9083
20171 "This file specifies which users can use the @command{sudo} command, what "
20172 "they are allowed to do, and what privileges they may gain. The default is "
20173 "that only @code{root} and members of the @code{wheel} group may use "
20177 #. type: Plain text
20178 #: doc/guix.texi:9094
20180 "The list of file systems to be mounted is specified in the @code{file-"
20181 "systems} field of the operating system declaration (@pxref{Using the "
20182 "Configuration System}). Each file system is declared using the @code{file-"
20183 "system} form, like this:"
20187 #: doc/guix.texi:9100
20191 " (mount-point \"/home\")\n"
20192 " (device \"/dev/sda3\")\n"
20193 " (type \"ext4\"))\n"
20196 #. type: Plain text
20197 #: doc/guix.texi:9104
20199 "As usual, some of the fields are mandatory---those shown in the example "
20200 "above---while others can be omitted. These are described below."
20204 #: doc/guix.texi:9105
20206 msgid "{Data Type} file-system"
20210 #: doc/guix.texi:9108
20212 "Objects of this type represent file systems to be mounted. They contain the "
20213 "following members:"
20217 #: doc/guix.texi:9110 doc/guix.texi:9294
20223 #: doc/guix.texi:9113
20225 "This is a string specifying the type of the file system---e.g., "
20230 #: doc/guix.texi:9114
20232 msgid "mount-point"
20236 #: doc/guix.texi:9116
20237 msgid "This designates the place where the file system is to be mounted."
20241 #: doc/guix.texi:9117
20247 #: doc/guix.texi:9121
20249 "This names the ``source'' of the file system. By default it is the name of "
20250 "a node under @file{/dev}, but its meaning depends on the @code{title} field "
20255 #: doc/guix.texi:9122
20257 msgid "@code{title} (default: @code{'device})"
20261 #: doc/guix.texi:9125
20263 "This is a symbol that specifies how the @code{device} field is to be "
20268 #: doc/guix.texi:9130
20270 "When it is the symbol @code{device}, then the @code{device} field is "
20271 "interpreted as a file name; when it is @code{label}, then @code{device} is "
20272 "interpreted as a file system label name; when it is @code{uuid}, "
20273 "@code{device} is interpreted as a file system unique identifier (UUID)."
20277 #: doc/guix.texi:9138
20279 "UUIDs may be converted from their string representation (as shown by the "
20280 "@command{tune2fs -l} command) using the @code{uuid} form@footnote{The "
20281 "@code{uuid} form expects 16-byte UUIDs as defined in @uref{https://tools."
20282 "ietf.org/html/rfc4122, RFC@tie{}4122}. This is the form of UUID used by the "
20283 "ext2 family of file systems and others, but it is different from ``UUIDs'' "
20284 "found in FAT file systems, for instance.}, like this:"
20288 #: doc/guix.texi:9145
20292 " (mount-point \"/home\")\n"
20293 " (type \"ext4\")\n"
20295 " (device (uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")))\n"
20299 #: doc/guix.texi:9154
20301 "The @code{label} and @code{uuid} options offer a way to refer to file "
20302 "systems without having to hard-code their actual device name@footnote{Note "
20303 "that, while it is tempting to use @file{/dev/disk/by-uuid} and similar "
20304 "device names to achieve the same result, this is not recommended: These "
20305 "special device nodes are created by the udev daemon and may be unavailable "
20306 "at the time the device is mounted.}."
20310 #: doc/guix.texi:9161
20312 "However, when the source of a file system is a mapped device (@pxref{Mapped "
20313 "Devices}), its @code{device} field @emph{must} refer to the mapped device "
20314 "name---e.g., @file{/dev/mapper/root-partition}---and consequently "
20315 "@code{title} must be set to @code{'device}. This is required so that the "
20316 "system knows that mounting the file system depends on having the "
20317 "corresponding device mapping established."
20321 #: doc/guix.texi:9162
20323 msgid "@code{flags} (default: @code{'()})"
20327 #: doc/guix.texi:9167
20329 "This is a list of symbols denoting mount flags. Recognized flags include "
20330 "@code{read-only}, @code{bind-mount}, @code{no-dev} (disallow access to "
20331 "special files), @code{no-suid} (ignore setuid and setgid bits), and @code{no-"
20332 "exec} (disallow program execution.)"
20336 #: doc/guix.texi:9168
20338 msgid "@code{options} (default: @code{#f})"
20342 #: doc/guix.texi:9170
20343 msgid "This is either @code{#f}, or a string denoting mount options."
20347 #: doc/guix.texi:9171
20349 msgid "@code{mount?} (default: @code{#t})"
20353 #: doc/guix.texi:9176
20355 "This value indicates whether to automatically mount the file system when the "
20356 "system is brought up. When set to @code{#f}, the file system gets an entry "
20357 "in @file{/etc/fstab} (read by the @command{mount} command) but is not "
20358 "automatically mounted."
20362 #: doc/guix.texi:9177
20364 msgid "@code{needed-for-boot?} (default: @code{#f})"
20368 #: doc/guix.texi:9182
20370 "This Boolean value indicates whether the file system is needed when "
20371 "booting. If that is true, then the file system is mounted when the initial "
20372 "RAM disk (initrd) is loaded. This is always the case, for instance, for the "
20373 "root file system."
20377 #: doc/guix.texi:9183
20379 msgid "@code{check?} (default: @code{#t})"
20383 #: doc/guix.texi:9186
20385 "This Boolean indicates whether the file system needs to be checked for "
20386 "errors before being mounted."
20390 #: doc/guix.texi:9187
20392 msgid "@code{create-mount-point?} (default: @code{#f})"
20396 #: doc/guix.texi:9189
20397 msgid "When true, the mount point is created if it does not exist yet."
20401 #: doc/guix.texi:9190
20403 msgid "@code{dependencies} (default: @code{'()})"
20407 #: doc/guix.texi:9194
20409 "This is a list of @code{<file-system>} or @code{<mapped-device>} objects "
20410 "representing file systems that must be mounted or mapped devices that must "
20411 "be opened before (and unmounted or closed after) this one."
20415 #: doc/guix.texi:9198
20417 "As an example, consider a hierarchy of mounts: @file{/sys/fs/cgroup} is a "
20418 "dependency of @file{/sys/fs/cgroup/cpu} and @file{/sys/fs/cgroup/memory}."
20422 #: doc/guix.texi:9201
20424 "Another example is a file system that depends on a mapped device, for "
20425 "example for an encrypted partition (@pxref{Mapped Devices})."
20428 #. type: Plain text
20429 #: doc/guix.texi:9206
20431 "The @code{(gnu system file-systems)} exports the following useful variables."
20435 #: doc/guix.texi:9207
20437 msgid "{Scheme Variable} %base-file-systems"
20441 #: doc/guix.texi:9212
20443 "These are essential file systems that are required on normal systems, such "
20444 "as @var{%pseudo-terminal-file-system} and @var{%immutable-store} (see "
20445 "below.) Operating system declarations should always contain at least these."
20449 #: doc/guix.texi:9214
20451 msgid "{Scheme Variable} %pseudo-terminal-file-system"
20455 #: doc/guix.texi:9220
20457 "This is the file system to be mounted as @file{/dev/pts}. It supports "
20458 "@dfn{pseudo-terminals} created @i{via} @code{openpty} and similar functions "
20459 "(@pxref{Pseudo-Terminals,,, libc, The GNU C Library Reference Manual}). "
20460 "Pseudo-terminals are used by terminal emulators such as @command{xterm}."
20464 #: doc/guix.texi:9222
20466 msgid "{Scheme Variable} %shared-memory-file-system"
20470 #: doc/guix.texi:9226
20472 "This file system is mounted as @file{/dev/shm} and is used to support memory "
20473 "sharing across processes (@pxref{Memory-mapped I/O, @code{shm_open},, libc, "
20474 "The GNU C Library Reference Manual})."
20478 #: doc/guix.texi:9228
20480 msgid "{Scheme Variable} %immutable-store"
20484 #: doc/guix.texi:9233
20486 "This file system performs a read-only ``bind mount'' of @file{/gnu/store}, "
20487 "making it read-only for all the users including @code{root}. This prevents "
20488 "against accidental modification by software running as @code{root} or by "
20489 "system administrators."
20493 #: doc/guix.texi:9236
20495 "The daemon itself is still able to write to the store: it remounts it read-"
20496 "write in its own ``name space.''"
20500 #: doc/guix.texi:9238
20502 msgid "{Scheme Variable} %binary-format-file-system"
20506 #: doc/guix.texi:9242
20508 "The @code{binfmt_misc} file system, which allows handling of arbitrary "
20509 "executable file types to be delegated to user space. This requires the "
20510 "@code{binfmt.ko} kernel module to be loaded."
20514 #: doc/guix.texi:9244
20516 msgid "{Scheme Variable} %fuse-control-file-system"
20520 #: doc/guix.texi:9248
20522 "The @code{fusectl} file system, which allows unprivileged users to mount and "
20523 "unmount user-space FUSE file systems. This requires the @code{fuse.ko} "
20524 "kernel module to be loaded."
20528 #: doc/guix.texi:9253
20530 msgid "device mapping"
20534 #: doc/guix.texi:9254
20536 msgid "mapped devices"
20539 #. type: Plain text
20540 #: doc/guix.texi:9272
20542 "The Linux kernel has a notion of @dfn{device mapping}: a block device, such "
20543 "as a hard disk partition, can be @dfn{mapped} into another device, usually "
20544 "in @code{/dev/mapper/}, with additional processing over the data that flows "
20545 "through it@footnote{Note that the GNU@tie{}Hurd makes no difference between "
20546 "the concept of a ``mapped device'' and that of a file system: both boil down "
20547 "to @emph{translating} input/output operations made on a file to operations "
20548 "on its backing store. Thus, the Hurd implements mapped devices, like file "
20549 "systems, using the generic @dfn{translator} mechanism (@pxref{Translators,,, "
20550 "hurd, The GNU Hurd Reference Manual}).}. A typical example is encryption "
20551 "device mapping: all writes to the mapped device are encrypted, and all reads "
20552 "are deciphered, transparently. Guix extends this notion by considering any "
20553 "device or set of devices that are @dfn{transformed} in some way to create a "
20554 "new device; for instance, RAID devices are obtained by @dfn{assembling} "
20555 "several other devices, such as hard disks or partitions, into a new one that "
20556 "behaves as one partition. Other examples, not yet implemented, are LVM "
20560 #. type: Plain text
20561 #: doc/guix.texi:9275
20563 "Mapped devices are declared using the @code{mapped-device} form, defined as "
20564 "follows; for examples, see below."
20568 #: doc/guix.texi:9276
20570 msgid "{Data Type} mapped-device"
20574 #: doc/guix.texi:9279
20576 "Objects of this type represent device mappings that will be made when the "
20581 #: doc/guix.texi:9285
20583 "This is either a string specifying the name of the block device to be "
20584 "mapped, such as @code{\"/dev/sda3\"}, or a list of such strings when several "
20585 "devices need to be assembled for creating a new one."
20589 #: doc/guix.texi:9286 doc/guix.texi:20162
20595 #: doc/guix.texi:9293
20597 "This string specifies the name of the resulting mapped device. For kernel "
20598 "mappers such as encrypted devices of type @code{luks-device-mapping}, "
20599 "specifying @code{\"my-partition\"} leads to the creation of the @code{\"/dev/"
20600 "mapper/my-partition\"} device. For RAID devices of type @code{raid-device-"
20601 "mapping}, the full device name such as @code{\"/dev/md0\"} needs to be given."
20605 #: doc/guix.texi:9297
20607 "This must be a @code{mapped-device-kind} object, which specifies how "
20608 "@var{source} is mapped to @var{target}."
20612 #: doc/guix.texi:9300
20614 msgid "{Scheme Variable} luks-device-mapping"
20618 #: doc/guix.texi:9304
20620 "This defines LUKS block device encryption using the @command{cryptsetup} "
20621 "command from the package with the same name. It relies on the @code{dm-"
20622 "crypt} Linux kernel module."
20626 #: doc/guix.texi:9306
20628 msgid "{Scheme Variable} raid-device-mapping"
20632 #: doc/guix.texi:9311
20634 "This defines a RAID device, which is assembled using the @code{mdadm} "
20635 "command from the package with the same name. It requires a Linux kernel "
20636 "module for the appropriate RAID level to be loaded, such as @code{raid456} "
20637 "for RAID-4, RAID-5 or RAID-6, or @code{raid10} for RAID-10."
20641 #: doc/guix.texi:9313
20643 msgid "disk encryption"
20647 #: doc/guix.texi:9314
20652 #. type: Plain text
20653 #: doc/guix.texi:9322
20655 "The following example specifies a mapping from @file{/dev/sda3} to @file{/"
20656 "dev/mapper/home} using LUKS---the @url{https://gitlab.com/cryptsetup/"
20657 "cryptsetup,Linux Unified Key Setup}, a standard mechanism for disk "
20658 "encryption. The @file{/dev/mapper/home} device can then be used as the "
20659 "@code{device} of a @code{file-system} declaration (@pxref{File Systems})."
20663 #: doc/guix.texi:9328
20667 " (source \"/dev/sda3\")\n"
20668 " (target \"home\")\n"
20669 " (type luks-device-mapping))\n"
20672 #. type: Plain text
20673 #: doc/guix.texi:9333
20675 "Alternatively, to become independent of device numbering, one may obtain the "
20676 "LUKS UUID (@dfn{unique identifier}) of the source device by a command like:"
20680 #: doc/guix.texi:9336
20682 msgid "cryptsetup luksUUID /dev/sda3\n"
20685 #. type: Plain text
20686 #: doc/guix.texi:9339
20687 msgid "and use it as follows:"
20691 #: doc/guix.texi:9345
20695 " (source (uuid \"cb67fc72-0d54-4c88-9d4b-b225f30b0f44\"))\n"
20696 " (target \"home\")\n"
20697 " (type luks-device-mapping))\n"
20701 #: doc/guix.texi:9347
20703 msgid "swap encryption"
20706 #. type: Plain text
20707 #: doc/guix.texi:9353
20709 "It is also desirable to encrypt swap space, since swap space may contain "
20710 "sensitive data. One way to accomplish that is to use a swap file in a file "
20711 "system on a device mapped via LUKS encryption. In this way, the swap file "
20712 "is encrypted because the entire device is encrypted. @xref{Preparing for "
20713 "Installation,,Disk Partitioning}, for an example."
20716 #. type: Plain text
20717 #: doc/guix.texi:9356
20719 "A RAID device formed of the partitions @file{/dev/sda1} and @file{/dev/sdb1} "
20720 "may be declared as follows:"
20724 #: doc/guix.texi:9362
20728 " (source (list \"/dev/sda1\" \"/dev/sdb1\"))\n"
20729 " (target \"/dev/md0\")\n"
20730 " (type raid-device-mapping))\n"
20733 #. type: Plain text
20734 #: doc/guix.texi:9369
20736 "The @file{/dev/md0} device can then be used as the @code{device} of a "
20737 "@code{file-system} declaration (@pxref{File Systems}). Note that the RAID "
20738 "level need not be given; it is chosen during the initial creation and "
20739 "formatting of the RAID device and is determined automatically later."
20743 #: doc/guix.texi:9374
20749 #: doc/guix.texi:9375
20755 #: doc/guix.texi:9376
20757 msgid "user accounts"
20760 #. type: Plain text
20761 #: doc/guix.texi:9380
20763 "User accounts and groups are entirely managed through the @code{operating-"
20764 "system} declaration. They are specified with the @code{user-account} and "
20765 "@code{user-group} forms:"
20769 #: doc/guix.texi:9391
20773 " (name \"alice\")\n"
20774 " (group \"users\")\n"
20775 " (supplementary-groups '(\"wheel\" ;allow use of sudo, etc.\n"
20776 " \"audio\" ;sound card\n"
20777 " \"video\" ;video devices such as webcams\n"
20778 " \"cdrom\")) ;the good ol' CD-ROM\n"
20779 " (comment \"Bob's sister\")\n"
20780 " (home-directory \"/home/alice\"))\n"
20783 #. type: Plain text
20784 #: doc/guix.texi:9400
20786 "When booting or upon completion of @command{guix system reconfigure}, the "
20787 "system ensures that only the user accounts and groups specified in the "
20788 "@code{operating-system} declaration exist, and with the specified "
20789 "properties. Thus, account or group creations or modifications made by "
20790 "directly invoking commands such as @command{useradd} are lost upon "
20791 "reconfiguration or reboot. This ensures that the system remains exactly as "
20796 #: doc/guix.texi:9401
20798 msgid "{Data Type} user-account"
20802 #: doc/guix.texi:9404
20804 "Objects of this type represent user accounts. The following members may be "
20809 #: doc/guix.texi:9408
20810 msgid "The name of the user account."
20814 #: doc/guix.texi:9409 doc/guix.texi:19924
20820 #: doc/guix.texi:9410 doc/guix.texi:9459
20826 #: doc/guix.texi:9413
20828 "This is the name (a string) or identifier (a number) of the user group this "
20829 "account belongs to."
20833 #: doc/guix.texi:9414
20835 msgid "@code{supplementary-groups} (default: @code{'()})"
20839 #: doc/guix.texi:9417
20841 "Optionally, this can be defined as a list of group names that this account "
20846 #: doc/guix.texi:9418
20848 msgid "@code{uid} (default: @code{#f})"
20852 #: doc/guix.texi:9422
20854 "This is the user ID for this account (a number), or @code{#f}. In the "
20855 "latter case, a number is automatically chosen by the system when the account "
20860 #: doc/guix.texi:9423
20862 msgid "@code{comment} (default: @code{\"\"})"
20866 #: doc/guix.texi:9425
20867 msgid "A comment about the account, such as the account owner's full name."
20871 #: doc/guix.texi:9426
20873 msgid "home-directory"
20877 #: doc/guix.texi:9428
20878 msgid "This is the name of the home directory for the account."
20882 #: doc/guix.texi:9429
20884 msgid "@code{create-home-directory?} (default: @code{#t})"
20888 #: doc/guix.texi:9432
20890 "Indicates whether the home directory of this account should be created if it "
20891 "does not exist yet."
20895 #: doc/guix.texi:9433
20897 msgid "@code{shell} (default: Bash)"
20901 #: doc/guix.texi:9436
20903 "This is a G-expression denoting the file name of a program to be used as the "
20904 "shell (@pxref{G-Expressions})."
20908 #: doc/guix.texi:9437 doc/guix.texi:9477
20910 msgid "@code{system?} (default: @code{#f})"
20914 #: doc/guix.texi:9441
20916 "This Boolean value indicates whether the account is a ``system'' account. "
20917 "System accounts are sometimes treated specially; for instance, graphical "
20918 "login managers do not list them."
20921 #. type: anchor{#1}
20922 #: doc/guix.texi:9443
20923 msgid "user-account-password"
20927 #: doc/guix.texi:9443 doc/guix.texi:9481
20929 msgid "@code{password} (default: @code{#f})"
20933 #: doc/guix.texi:9449
20935 "You would normally leave this field to @code{#f}, initialize user passwords "
20936 "as @code{root} with the @command{passwd} command, and then let users change "
20937 "it with @command{passwd}. Passwords set with @command{passwd} are of course "
20938 "preserved across reboot and reconfiguration."
20942 #: doc/guix.texi:9455
20944 "If you @emph{do} want to have a preset password for an account, then this "
20945 "field must contain the encrypted password, as a string. @xref{crypt,,, "
20946 "libc, The GNU C Library Reference Manual}, for more information on password "
20947 "encryption, and @ref{Encryption,,, guile, GNU Guile Reference Manual}, for "
20948 "information on Guile's @code{crypt} procedure."
20951 #. type: Plain text
20952 #: doc/guix.texi:9461
20953 msgid "User group declarations are even simpler:"
20957 #: doc/guix.texi:9464
20959 msgid "(user-group (name \"students\"))\n"
20963 #: doc/guix.texi:9466
20965 msgid "{Data Type} user-group"
20969 #: doc/guix.texi:9468
20970 msgid "This type is for, well, user groups. There are just a few fields:"
20974 #: doc/guix.texi:9472
20975 msgid "The name of the group."
20979 #: doc/guix.texi:9473
20981 msgid "@code{id} (default: @code{#f})"
20985 #: doc/guix.texi:9476
20987 "The group identifier (a number). If @code{#f}, a new number is "
20988 "automatically allocated when the group is created."
20992 #: doc/guix.texi:9480
20994 "This Boolean value indicates whether the group is a ``system'' group. "
20995 "System groups have low numerical IDs."
20999 #: doc/guix.texi:9484
21001 "What, user groups can have a password? Well, apparently yes. Unless "
21002 "@code{#f}, this field specifies the password of the group."
21005 #. type: Plain text
21006 #: doc/guix.texi:9490
21008 "For convenience, a variable lists all the basic user groups one may expect:"
21012 #: doc/guix.texi:9491
21014 msgid "{Scheme Variable} %base-groups"
21018 #: doc/guix.texi:9496
21020 "This is the list of basic user groups that users and/or packages expect to "
21021 "be present on the system. This includes groups such as ``root'', ``wheel'', "
21022 "and ``users'', as well as groups used to control access to specific devices "
21023 "such as ``audio'', ``disk'', and ``cdrom''."
21027 #: doc/guix.texi:9498
21029 msgid "{Scheme Variable} %base-user-accounts"
21033 #: doc/guix.texi:9501
21035 "This is the list of basic system accounts that programs may expect to find "
21036 "on a GNU/Linux system, such as the ``nobody'' account."
21040 #: doc/guix.texi:9504
21042 "Note that the ``root'' account is not included here. It is a special-case "
21043 "and is automatically added whether or not it is specified."
21047 #: doc/guix.texi:9509
21052 #. type: Plain text
21053 #: doc/guix.texi:9516
21055 "A @dfn{locale} defines cultural conventions for a particular language and "
21056 "region of the world (@pxref{Locales,,, libc, The GNU C Library Reference "
21057 "Manual}). Each locale has a name that typically has the form "
21058 "@code{@var{language}_@var{territory}.@var{codeset}}---e.g., @code{fr_LU."
21059 "utf8} designates the locale for the French language, with cultural "
21060 "conventions from Luxembourg, and using the UTF-8 encoding."
21064 #: doc/guix.texi:9517
21066 msgid "locale definition"
21069 #. type: Plain text
21070 #: doc/guix.texi:9521
21072 "Usually, you will want to specify the default locale for the machine using "
21073 "the @code{locale} field of the @code{operating-system} declaration "
21074 "(@pxref{operating-system Reference, @code{locale}})."
21077 #. type: Plain text
21078 #: doc/guix.texi:9530
21080 "The selected locale is automatically added to the @dfn{locale definitions} "
21081 "known to the system if needed, with its codeset inferred from its name---e."
21082 "g., @code{bo_CN.utf8} will be assumed to use the @code{UTF-8} codeset. "
21083 "Additional locale definitions can be specified in the @code{locale-"
21084 "definitions} slot of @code{operating-system}---this is useful, for instance, "
21085 "if the codeset could not be inferred from the locale name. The default set "
21086 "of locale definitions includes some widely used locales, but not all the "
21087 "available locales, in order to save space."
21090 #. type: Plain text
21091 #: doc/guix.texi:9533
21093 "For instance, to add the North Frisian locale for Germany, the value of that "
21098 #: doc/guix.texi:9538
21101 "(cons (locale-definition\n"
21102 " (name \"fy_DE.utf8\") (source \"fy_DE\"))\n"
21103 " %default-locale-definitions)\n"
21106 #. type: Plain text
21107 #: doc/guix.texi:9542
21109 "Likewise, to save space, one might want @code{locale-definitions} to list "
21110 "only the locales that are actually used, as in:"
21114 #: doc/guix.texi:9547
21117 "(list (locale-definition\n"
21118 " (name \"ja_JP.eucjp\") (source \"ja_JP\")\n"
21119 " (charset \"EUC-JP\")))\n"
21122 #. type: Plain text
21123 #: doc/guix.texi:9556
21125 "The compiled locale definitions are available at @file{/run/current-system/"
21126 "locale/X.Y}, where @code{X.Y} is the libc version, which is the default "
21127 "location where the GNU@tie{}libc provided by Guix looks for locale data. "
21128 "This can be overridden using the @code{LOCPATH} environment variable "
21129 "(@pxref{locales-and-locpath, @code{LOCPATH} and locale packages})."
21132 #. type: Plain text
21133 #: doc/guix.texi:9559
21135 "The @code{locale-definition} form is provided by the @code{(gnu system "
21136 "locale)} module. Details are given below."
21140 #: doc/guix.texi:9560
21142 msgid "{Data Type} locale-definition"
21146 #: doc/guix.texi:9562
21147 msgid "This is the data type of a locale definition."
21151 #: doc/guix.texi:9568
21153 "The name of the locale. @xref{Locale Names,,, libc, The GNU C Library "
21154 "Reference Manual}, for more information on locale names."
21158 #: doc/guix.texi:9572
21160 "The name of the source for that locale. This is typically the "
21161 "@code{@var{language}_@var{territory}} part of the locale name."
21165 #: doc/guix.texi:9573
21167 msgid "@code{charset} (default: @code{\"UTF-8\"})"
21171 #: doc/guix.texi:9577
21173 "The ``character set'' or ``code set'' for that locale, @uref{http://www.iana."
21174 "org/assignments/character-sets, as defined by IANA}."
21178 #: doc/guix.texi:9581
21180 msgid "{Scheme Variable} %default-locale-definitions"
21184 #: doc/guix.texi:9585
21186 "A list of commonly used UTF-8 locales, used as the default value of the "
21187 "@code{locale-definitions} field of @code{operating-system} declarations."
21191 #: doc/guix.texi:9586
21193 msgid "locale name"
21197 #: doc/guix.texi:9587
21199 msgid "normalized codeset in locale names"
21203 #: doc/guix.texi:9593
21205 "These locale definitions use the @dfn{normalized codeset} for the part that "
21206 "follows the dot in the name (@pxref{Using gettextized software, normalized "
21207 "codeset,, libc, The GNU C Library Reference Manual}). So for instance it "
21208 "has @code{uk_UA.utf8} but @emph{not}, say, @code{uk_UA.UTF-8}."
21211 #. type: subsubsection
21212 #: doc/guix.texi:9595
21214 msgid "Locale Data Compatibility Considerations"
21218 #: doc/guix.texi:9597
21220 msgid "incompatibility, of locale data"
21223 #. type: Plain text
21224 #: doc/guix.texi:9604
21226 "@code{operating-system} declarations provide a @code{locale-libcs} field to "
21227 "specify the GNU@tie{}libc packages that are used to compile locale "
21228 "declarations (@pxref{operating-system Reference}). ``Why would I care?'', "
21229 "you may ask. Well, it turns out that the binary format of locale data is "
21230 "occasionally incompatible from one libc version to another."
21233 #. type: Plain text
21234 #: doc/guix.texi:9616
21236 "For instance, a program linked against libc version 2.21 is unable to read "
21237 "locale data produced with libc 2.22; worse, that program @emph{aborts} "
21238 "instead of simply ignoring the incompatible locale data@footnote{Versions "
21239 "2.23 and later of GNU@tie{}libc will simply skip the incompatible locale "
21240 "data, which is already an improvement.}. Similarly, a program linked "
21241 "against libc 2.22 can read most, but not all, of the locale data from libc "
21242 "2.21 (specifically, @code{LC_COLLATE} data is incompatible); thus calls to "
21243 "@code{setlocale} may fail, but programs will not abort."
21246 #. type: Plain text
21247 #: doc/guix.texi:9621
21249 "The ``problem'' in GuixSD is that users have a lot of freedom: They can "
21250 "choose whether and when to upgrade software in their profiles, and might be "
21251 "using a libc version different from the one the system administrator used to "
21252 "build the system-wide locale data."
21255 #. type: Plain text
21256 #: doc/guix.texi:9625
21258 "Fortunately, unprivileged users can also install their own locale data and "
21259 "define @var{GUIX_LOCPATH} accordingly (@pxref{locales-and-locpath, "
21260 "@code{GUIX_LOCPATH} and locale packages})."
21263 #. type: Plain text
21264 #: doc/guix.texi:9632
21266 "Still, it is best if the system-wide locale data at @file{/run/current-"
21267 "system/locale} is built for all the libc versions actually in use on the "
21268 "system, so that all the programs can access it---this is especially crucial "
21269 "on a multi-user system. To do that, the administrator can specify several "
21270 "libc packages in the @code{locale-libcs} field of @code{operating-system}:"
21274 #: doc/guix.texi:9635
21277 "(use-package-modules base)\n"
21282 #: doc/guix.texi:9639
21285 "(operating-system\n"
21287 " (locale-libcs (list glibc-2.21 (canonical-package glibc))))\n"
21290 #. type: Plain text
21291 #: doc/guix.texi:9644
21293 "This example would lead to a system containing locale definitions for both "
21294 "libc 2.21 and the current version of libc in @file{/run/current-system/"
21299 #: doc/guix.texi:9649
21301 msgid "system services"
21304 #. type: Plain text
21305 #: doc/guix.texi:9655
21307 "An important part of preparing an @code{operating-system} declaration is "
21308 "listing @dfn{system services} and their configuration (@pxref{Using the "
21309 "Configuration System}). System services are typically daemons launched when "
21310 "the system boots, or other actions needed at that time---e.g., configuring "
21314 #. type: Plain text
21315 #: doc/guix.texi:9662
21317 "GuixSD has a broad definition of ``service'' (@pxref{Service Composition}), "
21318 "but many services are managed by the GNU@tie{}Shepherd (@pxref{Shepherd "
21319 "Services}). On a running system, the @command{herd} command allows you to "
21320 "list the available services, show their status, start and stop them, or do "
21321 "other specific operations (@pxref{Jump Start,,, shepherd, The GNU Shepherd "
21322 "Manual}). For example:"
21326 #: doc/guix.texi:9665
21328 msgid "# herd status\n"
21331 #. type: Plain text
21332 #: doc/guix.texi:9670
21334 "The above command, run as @code{root}, lists the currently defined "
21335 "services. The @command{herd doc} command shows a synopsis of the given "
21340 #: doc/guix.texi:9674
21343 "# herd doc nscd\n"
21344 "Run libc's name service cache daemon (nscd).\n"
21347 #. type: Plain text
21348 #: doc/guix.texi:9679
21350 "The @command{start}, @command{stop}, and @command{restart} sub-commands have "
21351 "the effect you would expect. For instance, the commands below stop the nscd "
21352 "service and restart the Xorg display server:"
21356 #: doc/guix.texi:9686
21359 "# herd stop nscd\n"
21360 "Service nscd has been stopped.\n"
21361 "# herd restart xorg-server\n"
21362 "Service xorg-server has been stopped.\n"
21363 "Service xorg-server has been started.\n"
21366 #. type: Plain text
21367 #: doc/guix.texi:9691
21369 "The following sections document the available services, starting with the "
21370 "core services, that may be used in an @code{operating-system} declaration."
21373 #. type: Plain text
21374 #: doc/guix.texi:9726
21376 "The @code{(gnu services base)} module provides definitions for the basic "
21377 "services that one expects from the system. The services exported by this "
21378 "module are listed below."
21382 #: doc/guix.texi:9727
21384 msgid "{Scheme Variable} %base-services"
21388 #: doc/guix.texi:9733
21390 "This variable contains a list of basic services (@pxref{Service Types and "
21391 "Services}, for more information on service objects) one would expect from "
21392 "the system: a login service (mingetty) on each tty, syslogd, the libc name "
21393 "service cache daemon (nscd), the udev device manager, and more."
21397 #: doc/guix.texi:9738
21399 "This is the default value of the @code{services} field of @code{operating-"
21400 "system} declarations. Usually, when customizing a system, you will want to "
21401 "append services to @var{%base-services}, like this:"
21405 #: doc/guix.texi:9741
21407 msgid "(cons* (avahi-service) (lsh-service) %base-services)\n"
21411 #: doc/guix.texi:9744
21413 msgid "{Scheme Variable} special-files-service-type"
21417 #: doc/guix.texi:9747
21419 "This is the service that sets up ``special files'' such as @file{/bin/sh}; "
21420 "an instance of it is part of @code{%base-services}."
21424 #: doc/guix.texi:9751
21426 "The value associated with @code{special-files-service-type} services must be "
21427 "a list of tuples where the first element is the ``special file'' and the "
21428 "second element is its target. By default it is:"
21432 #: doc/guix.texi:9752
21438 #: doc/guix.texi:9753
21440 msgid "@file{sh}, in @file{/bin}"
21444 #: doc/guix.texi:9756
21446 msgid "`((\"/bin/sh\" ,(file-append @var{bash} \"/bin/sh\")))\n"
21450 #: doc/guix.texi:9758
21452 msgid "/usr/bin/env"
21456 #: doc/guix.texi:9759
21458 msgid "@file{env}, in @file{/usr/bin}"
21462 #: doc/guix.texi:9762
21464 "If you want to add, say, @code{/usr/bin/env} to your system, you can change "
21469 #: doc/guix.texi:9766
21472 "`((\"/bin/sh\" ,(file-append @var{bash} \"/bin/sh\"))\n"
21473 " (\"/usr/bin/env\" ,(file-append @var{coreutils} \"/bin/env\")))\n"
21477 #: doc/guix.texi:9773
21479 "Since this is part of @code{%base-services}, you can use @code{modify-"
21480 "services} to customize the set of special files (@pxref{Service Reference, "
21481 "@code{modify-services}}). But the simple way to add a special file is "
21482 "@i{via} the @code{extra-special-file} procedure (see below.)"
21486 #: doc/guix.texi:9775
21488 msgid "{Scheme Procedure} extra-special-file @var{file} @var{target}"
21492 #: doc/guix.texi:9777
21493 msgid "Use @var{target} as the ``special file'' @var{file}."
21497 #: doc/guix.texi:9781
21499 "For example, adding the following lines to the @code{services} field of your "
21500 "operating system declaration leads to a @file{/usr/bin/env} symlink:"
21504 #: doc/guix.texi:9785
21507 "(extra-special-file \"/usr/bin/env\"\n"
21508 " (file-append coreutils \"/bin/env\"))\n"
21512 #: doc/guix.texi:9788
21514 msgid "{Scheme Procedure} host-name-service @var{name}"
21518 #: doc/guix.texi:9790
21519 msgid "Return a service that sets the host name to @var{name}."
21523 #: doc/guix.texi:9792
21525 msgid "{Scheme Procedure} login-service @var{config}"
21529 #: doc/guix.texi:9796
21531 "Return a service to run login according to @var{config}, a @code{<login-"
21532 "configuration>} object, which specifies the message of the day, among other "
21537 #: doc/guix.texi:9798
21539 msgid "{Data Type} login-configuration"
21543 #: doc/guix.texi:9800
21544 msgid "This is the data type representing the configuration of login."
21548 #: doc/guix.texi:9803
21554 #: doc/guix.texi:9804
21556 msgid "message of the day"
21560 #: doc/guix.texi:9806
21561 msgid "A file-like object containing the ``message of the day''."
21565 #: doc/guix.texi:9807 doc/guix.texi:11469
21567 msgid "@code{allow-empty-passwords?} (default: @code{#t})"
21571 #: doc/guix.texi:9810
21573 "Allow empty passwords by default so that first-time users can log in when "
21574 "the 'root' account has just been created."
21578 #: doc/guix.texi:9814
21580 msgid "{Scheme Procedure} mingetty-service @var{config}"
21584 #: doc/guix.texi:9818
21586 "Return a service to run mingetty according to @var{config}, a "
21587 "@code{<mingetty-configuration>} object, which specifies the tty to run, "
21588 "among other things."
21592 #: doc/guix.texi:9820
21594 msgid "{Data Type} mingetty-configuration"
21598 #: doc/guix.texi:9823
21600 "This is the data type representing the configuration of Mingetty, which "
21601 "provides the default implementation of virtual console log-in."
21605 #: doc/guix.texi:9826 doc/guix.texi:9862
21611 #: doc/guix.texi:9828
21612 msgid "The name of the console this Mingetty runs on---e.g., @code{\"tty1\"}."
21616 #: doc/guix.texi:9829 doc/guix.texi:9891
21618 msgid "@code{auto-login} (default: @code{#f})"
21622 #: doc/guix.texi:9833
21624 "When true, this field must be a string denoting the user name under which "
21625 "the system automatically logs in. When it is @code{#f}, a user name and "
21626 "password must be entered to log in."
21630 #: doc/guix.texi:9834
21632 msgid "@code{login-program} (default: @code{#f})"
21636 #: doc/guix.texi:9838
21638 "This must be either @code{#f}, in which case the default log-in program is "
21639 "used (@command{login} from the Shadow tool suite), or a gexp denoting the "
21640 "name of the log-in program."
21644 #: doc/guix.texi:9839
21646 msgid "@code{login-pause?} (default: @code{#f})"
21650 #: doc/guix.texi:9842
21652 "When set to @code{#t} in conjunction with @var{auto-login}, the user will "
21653 "have to press a key before the log-in shell is launched."
21657 #: doc/guix.texi:9843
21659 msgid "@code{mingetty} (default: @var{mingetty})"
21663 #: doc/guix.texi:9845
21664 msgid "The Mingetty package to use."
21668 #: doc/guix.texi:9849
21670 msgid "{Scheme Procedure} agetty-service @var{config}"
21674 #: doc/guix.texi:9853
21676 "Return a service to run agetty according to @var{config}, an @code{<agetty-"
21677 "configuration>} object, which specifies the tty to run, among other things."
21681 #: doc/guix.texi:9855
21683 msgid "{Data Type} agetty-configuration"
21687 #: doc/guix.texi:9859
21689 "This is the data type representing the configuration of agetty, which "
21690 "implements virtual and serial console log-in. See the @code{agetty(8)} man "
21691 "page for more information."
21695 #: doc/guix.texi:9866
21697 "The name of the console this agetty runs on, as a string---e.g., "
21698 "@code{\"ttyS0\"}. This argument is optional, it will default to a reasonable "
21699 "default serial port used by the kernel Linux."
21703 #: doc/guix.texi:9870
21705 "For this, if there is a value for an option @code{agetty.tty} in the kernel "
21706 "command line, agetty will extract the device name of the serial port from it "
21711 #: doc/guix.texi:9874
21713 "If not and if there is a value for an option @code{console} with a tty in "
21714 "the Linux command line, agetty will extract the device name of the serial "
21715 "port from it and use that."
21719 #: doc/guix.texi:9878
21721 "In both cases, agetty will leave the other serial device settings (baud rate "
21722 "etc.) alone---in the hope that Linux pinned them to the correct values."
21726 #: doc/guix.texi:9879
21728 msgid "@code{baud-rate} (default: @code{#f})"
21732 #: doc/guix.texi:9882
21734 "A string containing a comma-separated list of one or more baud rates, in "
21735 "descending order."
21739 #: doc/guix.texi:9883
21741 msgid "@code{term} (default: @code{#f})"
21745 #: doc/guix.texi:9886
21747 "A string containing the value used for the @code{TERM} environment variable."
21751 #: doc/guix.texi:9887
21753 msgid "@code{eight-bits?} (default: @code{#f})"
21757 #: doc/guix.texi:9890
21759 "When @code{#t}, the tty is assumed to be 8-bit clean, and parity detection "
21764 #: doc/guix.texi:9894
21766 "When passed a login name, as a string, the specified user will be logged in "
21767 "automatically without prompting for their login name or password."
21771 #: doc/guix.texi:9895
21773 msgid "@code{no-reset?} (default: @code{#f})"
21777 #: doc/guix.texi:9897
21778 msgid "When @code{#t}, don't reset terminal cflags (control modes)."
21782 #: doc/guix.texi:9898
21784 msgid "@code{host} (default: @code{#f})"
21788 #: doc/guix.texi:9901
21790 "This accepts a string containing the \"login_host\", which will be written "
21791 "into the @file{/var/run/utmpx} file."
21795 #: doc/guix.texi:9902
21797 msgid "@code{remote?} (default: @code{#f})"
21801 #: doc/guix.texi:9906
21803 "When set to @code{#t} in conjunction with @var{host}, this will add an "
21804 "@code{-r} fakehost option to the command line of the login program specified "
21805 "in @var{login-program}."
21809 #: doc/guix.texi:9907
21811 msgid "@code{flow-control?} (default: @code{#f})"
21815 #: doc/guix.texi:9909
21816 msgid "When set to @code{#t}, enable hardware (RTS/CTS) flow control."
21820 #: doc/guix.texi:9910
21822 msgid "@code{no-issue?} (default: @code{#f})"
21826 #: doc/guix.texi:9913
21828 "When set to @code{#t}, the contents of the @file{/etc/issue} file will not "
21829 "be displayed before presenting the login prompt."
21833 #: doc/guix.texi:9914
21835 msgid "@code{init-string} (default: @code{#f})"
21839 #: doc/guix.texi:9917
21841 "This accepts a string that will be sent to the tty or modem before sending "
21842 "anything else. It can be used to initialize a modem."
21846 #: doc/guix.texi:9918
21848 msgid "@code{no-clear?} (default: @code{#f})"
21852 #: doc/guix.texi:9921
21854 "When set to @code{#t}, agetty will not clear the screen before showing the "
21859 #: doc/guix.texi:9922
21861 msgid "@code{login-program} (default: (file-append shadow \"/bin/login\"))"
21865 #: doc/guix.texi:9926
21867 "This must be either a gexp denoting the name of a log-in program, or unset, "
21868 "in which case the default value is the @command{login} from the Shadow tool "
21873 #: doc/guix.texi:9927
21875 msgid "@code{local-line} (default: @code{#f})"
21879 #: doc/guix.texi:9931
21881 "Control the CLOCAL line flag. This accepts one of three symbols as "
21882 "arguments, @code{'auto}, @code{'always}, or @code{'never}. If @code{#f}, the "
21883 "default value chosen by agetty is @code{'auto}."
21887 #: doc/guix.texi:9932
21889 msgid "@code{extract-baud?} (default: @code{#f})"
21893 #: doc/guix.texi:9935
21895 "When set to @code{#t}, instruct agetty to try to extract the baud rate from "
21896 "the status messages produced by certain types of modems."
21900 #: doc/guix.texi:9936
21902 msgid "@code{skip-login?} (default: @code{#f})"
21906 #: doc/guix.texi:9940
21908 "When set to @code{#t}, do not prompt the user for a login name. This can be "
21909 "used with @var{login-program} field to use non-standard login systems."
21913 #: doc/guix.texi:9941
21915 msgid "@code{no-newline?} (default: @code{#f})"
21919 #: doc/guix.texi:9944
21921 "When set to @code{#t}, do not print a newline before printing the @file{/etc/"
21926 #: doc/guix.texi:9946
21928 msgid "@code{login-options} (default: @code{#f})"
21932 #: doc/guix.texi:9951
21934 "This option accepts a string containing options that are passed to the login "
21935 "program. When used with the @var{login-program}, be aware that a malicious "
21936 "user could try to enter a login name containing embedded options that could "
21937 "be parsed by the login program."
21941 #: doc/guix.texi:9952
21943 msgid "@code{login-pause} (default: @code{#f})"
21947 #: doc/guix.texi:9956
21949 "When set to @code{#t}, wait for any key before showing the login prompt. "
21950 "This can be used in conjunction with @var{auto-login} to save memory by "
21951 "lazily spawning shells."
21955 #: doc/guix.texi:9957
21957 msgid "@code{chroot} (default: @code{#f})"
21961 #: doc/guix.texi:9960
21963 "Change root to the specified directory. This option accepts a directory "
21964 "path as a string."
21968 #: doc/guix.texi:9961
21970 msgid "@code{hangup?} (default: @code{#f})"
21974 #: doc/guix.texi:9964
21976 "Use the Linux system call @code{vhangup} to do a virtual hangup of the "
21977 "specified terminal."
21981 #: doc/guix.texi:9965
21983 msgid "@code{keep-baud?} (default: @code{#f})"
21987 #: doc/guix.texi:9969
21989 "When set to @code{#t}, try to keep the existing baud rate. The baud rates "
21990 "from @var{baud-rate} are used when agetty receives a @key{BREAK} character."
21994 #: doc/guix.texi:9970
21996 msgid "@code{timeout} (default: @code{#f})"
22000 #: doc/guix.texi:9973
22002 "When set to an integer value, terminate if no user name could be read within "
22003 "@var{timeout} seconds."
22007 #: doc/guix.texi:9974
22009 msgid "@code{detect-case?} (default: @code{#f})"
22013 #: doc/guix.texi:9980
22015 "When set to @code{#t}, turn on support for detecting an uppercase-only "
22016 "terminal. This setting will detect a login name containing only uppercase "
22017 "letters as indicating an uppercase-only terminal and turn on some upper-to-"
22018 "lower case conversions. Note that this will not support Unicode characters."
22022 #: doc/guix.texi:9981
22024 msgid "@code{wait-cr?} (default: @code{#f})"
22028 #: doc/guix.texi:9986
22030 "When set to @code{#t}, wait for the user or modem to send a carriage-return "
22031 "or linefeed character before displaying @file{/etc/issue} or login prompt. "
22032 "This is typically used with the @var{init-string} option."
22036 #: doc/guix.texi:9987
22038 msgid "@code{no-hints?} (default: @code{#f})"
22042 #: doc/guix.texi:9990
22044 "When set to @code{#t}, do not print hints about Num, Caps, and Scroll locks."
22048 #: doc/guix.texi:9991
22050 msgid "@code{no-hostname?} (default: @code{#f})"
22054 #: doc/guix.texi:9994
22056 "By default, the hostname is printed. When this option is set to @code{#t}, "
22057 "no hostname will be shown at all."
22061 #: doc/guix.texi:9995
22063 msgid "@code{long-hostname?} (default: @code{#f})"
22067 #: doc/guix.texi:9999
22069 "By default, the hostname is only printed until the first dot. When this "
22070 "option is set to @code{#t}, the fully qualified hostname by "
22071 "@code{gethostname} or @code{getaddrinfo} is shown."
22075 #: doc/guix.texi:10000
22077 msgid "@code{erase-characters} (default: @code{#f})"
22081 #: doc/guix.texi:10003
22083 "This option accepts a string of additional characters that should be "
22084 "interpreted as backspace when the user types their login name."
22088 #: doc/guix.texi:10004
22090 msgid "@code{kill-characters} (default: @code{#f})"
22094 #: doc/guix.texi:10008
22096 "This option accepts a string that should be interpreted to mean \"ignore all "
22097 "previous characters\" (also called a \"kill\" character) when the types "
22098 "their login name."
22102 #: doc/guix.texi:10009
22104 msgid "@code{chdir} (default: @code{#f})"
22108 #: doc/guix.texi:10012
22110 "This option accepts, as a string, a directory path that will be changed to "
22115 #: doc/guix.texi:10013
22117 msgid "@code{delay} (default: @code{#f})"
22121 #: doc/guix.texi:10016
22123 "This options accepts, as an integer, the number of seconds to sleep before "
22124 "opening the tty and displaying the login prompt."
22128 #: doc/guix.texi:10017
22130 msgid "@code{nice} (default: @code{#f})"
22134 #: doc/guix.texi:10020
22136 "This option accepts, as an integer, the nice value with which to run the "
22137 "@command{login} program."
22141 #: doc/guix.texi:10021 doc/guix.texi:10221
22143 msgid "@code{extra-options} (default: @code{'()})"
22147 #: doc/guix.texi:10024
22149 "This option provides an \"escape hatch\" for the user to provide arbitrary "
22150 "command-line arguments to @command{agetty} as a list of strings."
22154 #: doc/guix.texi:10028
22156 msgid "{Scheme Procedure} kmscon-service-type @var{config}"
22160 #: doc/guix.texi:10032
22162 "Return a service to run @uref{https://www.freedesktop.org/wiki/Software/"
22163 "kmscon,kmscon} according to @var{config}, a @code{<kmscon-configuration>} "
22164 "object, which specifies the tty to run, among other things."
22168 #: doc/guix.texi:10034
22170 msgid "{Data Type} kmscon-configuration"
22174 #: doc/guix.texi:10037
22176 "This is the data type representing the configuration of Kmscon, which "
22177 "implements virtual console log-in."
22181 #: doc/guix.texi:10040
22183 msgid "virtual-terminal"
22187 #: doc/guix.texi:10042
22188 msgid "The name of the console this Kmscon runs on---e.g., @code{\"tty1\"}."
22192 #: doc/guix.texi:10043
22194 msgid "@code{login-program} (default: @code{#~(string-append #$shadow \"/bin/login\")})"
22198 #: doc/guix.texi:10046
22200 "A gexp denoting the name of the log-in program. The default log-in program "
22201 "is @command{login} from the Shadow tool suite."
22205 #: doc/guix.texi:10047
22207 msgid "@code{login-arguments} (default: @code{'(\"-p\")})"
22211 #: doc/guix.texi:10049
22212 msgid "A list of arguments to pass to @command{login}."
22216 #: doc/guix.texi:10050
22218 msgid "@code{hardware-acceleration?} (default: #f)"
22222 #: doc/guix.texi:10052
22223 msgid "Whether to use hardware acceleration."
22227 #: doc/guix.texi:10053
22229 msgid "@code{kmscon} (default: @var{kmscon})"
22233 #: doc/guix.texi:10055
22234 msgid "The Kmscon package to use."
22238 #: doc/guix.texi:10059
22240 msgid "name service cache daemon"
22244 #: doc/guix.texi:10060
22250 #: doc/guix.texi:10061
22252 msgid "{Scheme Procedure} nscd-service [@var{config}] [#:glibc glibc] @"
22256 #: doc/guix.texi:10066
22258 "[#:name-services '()] Return a service that runs the libc name service cache "
22259 "daemon (nscd) with the given @var{config}---an @code{<nscd-configuration>} "
22260 "object. @xref{Name Service Switch}, for an example."
22264 #: doc/guix.texi:10068
22266 msgid "{Scheme Variable} %nscd-default-configuration"
22270 #: doc/guix.texi:10072
22272 "This is the default @code{<nscd-configuration>} value (see below) used by "
22273 "@code{nscd-service}. It uses the caches defined by @var{%nscd-default-"
22274 "caches}; see below."
22278 #: doc/guix.texi:10074
22280 msgid "{Data Type} nscd-configuration"
22284 #: doc/guix.texi:10077
22286 "This is the data type representing the name service cache daemon (nscd) "
22291 #: doc/guix.texi:10080
22293 msgid "@code{name-services} (default: @code{'()})"
22297 #: doc/guix.texi:10083
22299 "List of packages denoting @dfn{name services} that must be visible to the "
22300 "nscd---e.g., @code{(list @var{nss-mdns})}."
22304 #: doc/guix.texi:10084
22306 msgid "@code{glibc} (default: @var{glibc})"
22310 #: doc/guix.texi:10087
22312 "Package object denoting the GNU C Library providing the @command{nscd} "
22317 #: doc/guix.texi:10088
22319 msgid "@code{log-file} (default: @code{\"/var/log/nscd.log\"})"
22323 #: doc/guix.texi:10091
22325 "Name of the nscd log file. This is where debugging output goes when "
22326 "@code{debug-level} is strictly positive."
22330 #: doc/guix.texi:10092
22332 msgid "@code{debug-level} (default: @code{0})"
22336 #: doc/guix.texi:10095
22338 "Integer denoting the debugging levels. Higher numbers mean that more "
22339 "debugging output is logged."
22343 #: doc/guix.texi:10096
22345 msgid "@code{caches} (default: @var{%nscd-default-caches})"
22349 #: doc/guix.texi:10099
22351 "List of @code{<nscd-cache>} objects denoting things to be cached; see below."
22355 #: doc/guix.texi:10103
22357 msgid "{Data Type} nscd-cache"
22361 #: doc/guix.texi:10105
22362 msgid "Data type representing a cache database of nscd and its parameters."
22366 #: doc/guix.texi:10108 doc/guix.texi:12810
22372 #: doc/guix.texi:10113
22374 "This is a symbol representing the name of the database to be cached. Valid "
22375 "values are @code{passwd}, @code{group}, @code{hosts}, and @code{services}, "
22376 "which designate the corresponding NSS database (@pxref{NSS Basics,,, libc, "
22377 "The GNU C Library Reference Manual})."
22381 #: doc/guix.texi:10114
22383 msgid "positive-time-to-live"
22387 #: doc/guix.texi:10115
22389 msgid "@code{negative-time-to-live} (default: @code{20})"
22393 #: doc/guix.texi:10118
22395 "A number representing the number of seconds during which a positive or "
22396 "negative lookup result remains in cache."
22400 #: doc/guix.texi:10119
22402 msgid "@code{check-files?} (default: @code{#t})"
22406 #: doc/guix.texi:10122
22408 "Whether to check for updates of the files corresponding to @var{database}."
22412 #: doc/guix.texi:10126
22414 "For instance, when @var{database} is @code{hosts}, setting this flag "
22415 "instructs nscd to check for updates in @file{/etc/hosts} and to take them "
22420 #: doc/guix.texi:10127
22422 msgid "@code{persistent?} (default: @code{#t})"
22426 #: doc/guix.texi:10129
22427 msgid "Whether the cache should be stored persistently on disk."
22431 #: doc/guix.texi:10130
22433 msgid "@code{shared?} (default: @code{#t})"
22437 #: doc/guix.texi:10132
22438 msgid "Whether the cache should be shared among users."
22442 #: doc/guix.texi:10133
22444 msgid "@code{max-database-size} (default: 32@tie{}MiB)"
22448 #: doc/guix.texi:10135
22449 msgid "Maximum size in bytes of the database cache."
22453 #: doc/guix.texi:10142
22455 msgid "{Scheme Variable} %nscd-default-caches"
22459 #: doc/guix.texi:10145
22461 "List of @code{<nscd-cache>} objects used by default by @code{nscd-"
22462 "configuration} (see above)."
22466 #: doc/guix.texi:10151
22468 "It enables persistent and aggressive caching of service and host name "
22469 "lookups. The latter provides better host name lookup performance, "
22470 "resilience in the face of unreliable name servers, and also better privacy---"
22471 "often the result of host name lookups is in local cache, so external name "
22472 "servers do not even need to be queried."
22475 #. type: anchor{#1}
22476 #: doc/guix.texi:10154
22477 msgid "syslog-configuration-type"
22481 #: doc/guix.texi:10154 doc/guix.texi:10170
22487 #: doc/guix.texi:10155 doc/guix.texi:10588
22493 #: doc/guix.texi:10156
22495 msgid "{Data Type} syslog-configuration"
22499 #: doc/guix.texi:10158
22500 msgid "This data type represents the configuration of the syslog daemon."
22504 #: doc/guix.texi:10160
22506 msgid "@code{syslogd} (default: @code{#~(string-append #$inetutils \"/libexec/syslogd\")})"
22510 #: doc/guix.texi:10162
22511 msgid "The syslog daemon to use."
22515 #: doc/guix.texi:10163
22517 msgid "@code{config-file} (default: @code{%default-syslog.conf})"
22521 #: doc/guix.texi:10165
22522 msgid "The syslog configuration file to use."
22525 #. type: anchor{#1}
22526 #: doc/guix.texi:10170
22527 msgid "syslog-service"
22531 #: doc/guix.texi:10171
22533 msgid "{Scheme Procedure} syslog-service @var{config}"
22537 #: doc/guix.texi:10173
22538 msgid "Return a service that runs a syslog daemon according to @var{config}."
22542 #: doc/guix.texi:10176
22544 "@xref{syslogd invocation,,, inetutils, GNU Inetutils}, for more information "
22545 "on the configuration file syntax."
22548 #. type: anchor{#1}
22549 #: doc/guix.texi:10179
22550 msgid "guix-configuration-type"
22554 #: doc/guix.texi:10179
22556 msgid "{Data Type} guix-configuration"
22560 #: doc/guix.texi:10182
22562 "This data type represents the configuration of the Guix build daemon. "
22563 "@xref{Invoking guix-daemon}, for more information."
22567 #: doc/guix.texi:10184
22569 msgid "@code{guix} (default: @var{guix})"
22573 #: doc/guix.texi:10186 doc/guix.texi:10414
22574 msgid "The Guix package to use."
22578 #: doc/guix.texi:10187
22580 msgid "@code{build-group} (default: @code{\"guixbuild\"})"
22584 #: doc/guix.texi:10189
22585 msgid "Name of the group for build user accounts."
22589 #: doc/guix.texi:10190
22591 msgid "@code{build-accounts} (default: @code{10})"
22595 #: doc/guix.texi:10192
22596 msgid "Number of build user accounts to create."
22600 #: doc/guix.texi:10193
22602 msgid "@code{authorize-key?} (default: @code{#t})"
22606 #: doc/guix.texi:10198
22608 "Whether to authorize the substitute keys listed in @code{authorized-keys}---"
22609 "by default that of @code{hydra.gnu.org} (@pxref{Substitutes})."
22611 "Autoriser ou non les clefs de substituts listées dans @code{authorize-keys} "
22612 "— par défaut celle de @code{hydra.gny.org} (@pxref{Substituts})."
22615 #: doc/guix.texi:10199
22617 msgid "%default-authorized-guix-keys"
22621 #: doc/guix.texi:10200
22623 msgid "@code{authorized-keys} (default: @var{%default-authorized-guix-keys})"
22627 #: doc/guix.texi:10204
22629 "The list of authorized key files for archive imports, as a list of string-"
22630 "valued gexps (@pxref{Invoking guix archive}). By default, it contains that "
22631 "of @code{hydra.gnu.org} (@pxref{Substitutes})."
22633 "La liste des fichiers de clefs autorisées pour les imports d'archives, en "
22634 "tant que liste de gexps sous forme de chaînes (@pxref{Invoking guix "
22635 "archive}). Par défaut, elle contient celle de @code{hydra.gnu.org} "
22636 "(@pxref{Substituts})."
22639 #: doc/guix.texi:10205
22641 msgid "@code{use-substitutes?} (default: @code{#t})"
22645 #: doc/guix.texi:10207
22646 msgid "Whether to use substitutes."
22650 #: doc/guix.texi:10208
22652 msgid "@code{substitute-urls} (default: @var{%default-substitute-urls})"
22656 #: doc/guix.texi:10210
22657 msgid "The list of URLs where to look for substitutes by default."
22661 #: doc/guix.texi:10211
22663 msgid "@code{max-silent-time} (default: @code{0})"
22667 #: doc/guix.texi:10212
22669 msgid "@code{timeout} (default: @code{0})"
22673 #: doc/guix.texi:10216
22675 "The number of seconds of silence and the number of seconds of activity, "
22676 "respectively, after which a build process times out. A value of zero "
22677 "disables the timeout."
22681 #: doc/guix.texi:10217
22683 msgid "@code{log-compression} (default: @code{'bzip2})"
22687 #: doc/guix.texi:10220
22689 "The type of compression used for build logs---one of @code{gzip}, "
22690 "@code{bzip2}, or @code{none}."
22694 #: doc/guix.texi:10223
22695 msgid "List of extra command-line options for @command{guix-daemon}."
22699 #: doc/guix.texi:10224
22701 msgid "@code{log-file} (default: @code{\"/var/log/guix-daemon.log\"})"
22705 #: doc/guix.texi:10227
22707 "File where @command{guix-daemon}'s standard output and standard error are "
22712 #: doc/guix.texi:10228
22714 msgid "@code{http-proxy} (default: @code{#f})"
22718 #: doc/guix.texi:10231
22720 "The HTTP proxy used for downloading fixed-output derivations and substitutes."
22724 #: doc/guix.texi:10232
22726 msgid "@code{tmpdir} (default: @code{#f})"
22730 #: doc/guix.texi:10234
22731 msgid "A directory path where the @command{guix-daemon} will perform builds."
22735 #: doc/guix.texi:10238
22737 msgid "{Scheme Procedure} guix-service @var{config}"
22741 #: doc/guix.texi:10241
22743 "Return a service that runs the Guix build daemon according to @var{config}."
22747 #: doc/guix.texi:10243
22749 msgid "{Scheme Procedure} udev-service [#:udev @var{eudev} #:rules @code{'()}]"
22753 #: doc/guix.texi:10248
22755 "Run @var{udev}, which populates the @file{/dev} directory dynamically. udev "
22756 "rules can be provided as a list of files through the @var{rules} variable. "
22757 "The procedures @var{udev-rule} and @var{file->udev-rule} from @code{(gnu "
22758 "services base)} simplify the creation of such rule files."
22762 #: doc/guix.texi:10249
22764 msgid "{Scheme Procedure} udev-rule [@var{file-name} @var{contents}]"
22768 #: doc/guix.texi:10252
22770 "Return a udev-rule file named @var{file-name} containing the rules defined "
22771 "by the @var{contents} literal."
22775 #: doc/guix.texi:10256
22777 "In the following example, a rule for a USB device is defined to be stored in "
22778 "the file @file{90-usb-thing.rules}. The rule runs a script upon detecting a "
22779 "USB device with a given product identifier."
22783 #: doc/guix.texi:10264
22786 "(define %example-udev-rule\n"
22788 " \"90-usb-thing.rules\"\n"
22789 " (string-append \"ACTION==\\\"add\\\", SUBSYSTEM==\\\"usb\\\", \"\n"
22790 " \"ATTR@{product@}==\\\"Example\\\", \"\n"
22791 " \"RUN+=\\\"/path/to/script\\\"\")))\n"
22795 #: doc/guix.texi:10268
22797 "Here we show how the default @var{udev-service} can be extended with it."
22801 #: doc/guix.texi:10278
22804 "(operating-system\n"
22807 " (modify-services %desktop-services\n"
22808 " (udev-service-type config =>\n"
22809 " (udev-configuration (inherit config)\n"
22810 " (rules (append (udev-configuration-rules config)\n"
22811 " (list %example-udev-rule))))))))\n"
22815 #: doc/guix.texi:10280
22817 msgid "{Scheme Procedure} file->udev-rule [@var{file-name} @var{file}]"
22821 #: doc/guix.texi:10283
22823 "Return a udev file named @var{file-name} containing the rules defined within "
22824 "@var{file}, a file-like object."
22828 #: doc/guix.texi:10285
22829 msgid "The following example showcases how we can use an existing rule file."
22833 #: doc/guix.texi:10290
22836 "(use-modules (guix download) ;for url-fetch\n"
22837 " (guix packages) ;for origin\n"
22843 #: doc/guix.texi:10301
22846 "(define %android-udev-rules\n"
22847 " (file->udev-rule\n"
22848 " \"51-android-udev.rules\"\n"
22849 " (let ((version \"20170910\"))\n"
22851 " (method url-fetch)\n"
22852 " (uri (string-append \"https://raw.githubusercontent.com/M0Rf30/\"\n"
22853 " \"android-udev-rules/\" version \"/51-android.rules\"))\n"
22855 " (base32 \"0lmmagpyb6xsq6zcr2w1cyx9qmjqmajkvrdbhjx32gqf1d9is003\"))))))\n"
22859 #: doc/guix.texi:10310
22861 "Additionally, Guix package definitions can be included in @var{rules} in "
22862 "order to extend the udev rules with the definitions found under their "
22863 "@file{lib/udev/rules.d} sub-directory. In lieu of the previous @var{file-"
22864 ">udev-rule} example, we could have used the @var{android-udev-rules} package "
22865 "which exists in Guix in the @code{(gnu packages android)} module."
22869 #: doc/guix.texi:10319
22871 "The following example shows how to use the @var{android-udev-rules} package "
22872 "so that the Android tool @command{adb} can detect devices without root "
22873 "privileges. It also details how to create the @code{adbusers} group, which "
22874 "is required for the proper functioning of the rules defined within the "
22875 "@var{android-udev-rules} package. To create such a group, we must define it "
22876 "both as part of the @var{supplementary-groups} of our @var{user-account} "
22877 "declaration, as well as in the @var{groups} field of the @var{operating-"
22882 #: doc/guix.texi:10324
22885 "(use-modules (gnu packages android) ;for android-udev-rules\n"
22886 " (gnu system shadow) ;for user-group\n"
22892 #: doc/guix.texi:10333
22895 "(operating-system\n"
22897 " (users (cons (user-acount\n"
22899 " (supplementary-groups\n"
22900 " '(\"adbusers\" ;for adb\n"
22901 " \"wheel\" \"netdev\" \"audio\" \"video\"))\n"
22907 #: doc/guix.texi:10336
22910 " (groups (cons (user-group (system? #t) (name \"adbusers\"))\n"
22911 " %base-groups))\n"
22916 #: doc/guix.texi:10338
22924 #: doc/guix.texi:10345
22928 " (modify-services %desktop-services\n"
22929 " (udev-service-type config =>\n"
22930 " (udev-configuration (inherit config)\n"
22931 " (rules (cons* android-udev-rules\n"
22932 " (udev-configuration-rules config))))))))\n"
22936 #: doc/guix.texi:10348
22938 msgid "{Scheme Variable} urandom-seed-service-type"
22942 #: doc/guix.texi:10353
22944 "Save some entropy in @var{%random-seed-file} to seed @file{/dev/urandom} "
22945 "when rebooting. It also tries to seed @file{/dev/urandom} from @file{/dev/"
22946 "hwrng} while booting, if @file{/dev/hwrng} exists and is readable."
22950 #: doc/guix.texi:10355
22952 msgid "{Scheme Variable} %random-seed-file"
22956 #: doc/guix.texi:10359
22958 "This is the name of the file where some random bytes are saved by "
22959 "@var{urandom-seed-service} to seed @file{/dev/urandom} when rebooting. It "
22960 "defaults to @file{/var/lib/random-seed}."
22964 #: doc/guix.texi:10361
22970 #: doc/guix.texi:10362
22976 #: doc/guix.texi:10363
22978 msgid "{Scheme Procedure} console-keymap-service @var{files} ..."
22982 #: doc/guix.texi:10368
22984 "Return a service to load console keymaps from @var{files} using "
22985 "@command{loadkeys} command. Most likely, you want to load some default "
22986 "keymap, which can be done like this:"
22990 #: doc/guix.texi:10371
22992 msgid "(console-keymap-service \"dvorak\")\n"
22996 #: doc/guix.texi:10375
22998 "Or, for example, for a Swedish keyboard, you may need to combine the "
22999 "following keymaps:"
23003 #: doc/guix.texi:10377
23005 msgid "(console-keymap-service \"se-lat6\" \"se-fi-lat6\")\n"
23009 #: doc/guix.texi:10381
23011 "Also you can specify a full file name (or file names) of your keymap(s). "
23012 "See @code{man loadkeys} for details."
23016 #: doc/guix.texi:10384
23022 #: doc/guix.texi:10385
23028 #: doc/guix.texi:10386
23030 msgid "{Scheme Procedure} gpm-service [#:gpm @var{gpm}] @"
23034 #: doc/guix.texi:10392
23036 "[#:options] Run @var{gpm}, the general-purpose mouse daemon, with the given "
23037 "command-line @var{options}. GPM allows users to use the mouse in the "
23038 "console, notably to select, copy, and paste text. The default value of "
23039 "@var{options} uses the @code{ps2} protocol, which works for both USB and "
23044 #: doc/guix.texi:10394
23045 msgid "This service is not part of @var{%base-services}."
23048 #. type: anchor{#1}
23049 #: doc/guix.texi:10397
23050 msgid "guix-publish-service-type"
23054 #: doc/guix.texi:10397
23056 msgid "{Scheme Variable} guix-publish-service-type"
23060 #: doc/guix.texi:10401
23062 "This is the service type for @command{guix publish} (@pxref{Invoking guix "
23063 "publish}). Its value must be a @code{guix-configuration} object, as "
23068 #: doc/guix.texi:10405
23070 "This assumes that @file{/etc/guix} already contains a signing key pair as "
23071 "created by @command{guix archive --generate-key} (@pxref{Invoking guix "
23072 "archive}). If that is not the case, the service will fail to start."
23076 #: doc/guix.texi:10407
23078 msgid "{Data Type} guix-publish-configuration"
23082 #: doc/guix.texi:10410
23084 "Data type representing the configuration of the @code{guix publish} service."
23088 #: doc/guix.texi:10412
23090 msgid "@code{guix} (default: @code{guix})"
23094 #: doc/guix.texi:10415
23096 msgid "@code{port} (default: @code{80})"
23100 #: doc/guix.texi:10417
23101 msgid "The TCP port to listen for connections."
23105 #: doc/guix.texi:10418
23107 msgid "@code{host} (default: @code{\"localhost\"})"
23111 #: doc/guix.texi:10421
23113 "The host (and thus, network interface) to listen to. Use @code{\"0.0.0.0\"} "
23114 "to listen on all the network interfaces."
23118 #: doc/guix.texi:10426
23120 "The gzip compression level at which substitutes are compressed. Use "
23121 "@code{0} to disable compression altogether, and @code{9} to get the best "
23122 "compression ratio at the expense of increased CPU usage."
23126 #: doc/guix.texi:10427
23128 msgid "@code{nar-path} (default: @code{\"nar\"})"
23132 #: doc/guix.texi:10430
23134 "The URL path at which ``nars'' can be fetched. @xref{Invoking guix publish, "
23135 "@code{--nar-path}}, for details."
23139 #: doc/guix.texi:10431
23141 msgid "@code{cache} (default: @code{#f})"
23145 #: doc/guix.texi:10437
23147 "When it is @code{#f}, disable caching and instead generate archives on "
23148 "demand. Otherwise, this should be the name of a directory---e.g., @code{\"/"
23149 "var/cache/guix/publish\"}---where @command{guix publish} caches archives and "
23150 "meta-data ready to be sent. @xref{Invoking guix publish, @option{--cache}}, "
23151 "for more information on the tradeoffs involved."
23155 #: doc/guix.texi:10438
23157 msgid "@code{workers} (default: @code{#f})"
23161 #: doc/guix.texi:10442
23163 "When it is an integer, this is the number of worker threads used for "
23164 "caching; when @code{#f}, the number of processors is used. @xref{Invoking "
23165 "guix publish, @option{--workers}}, for more information."
23169 #: doc/guix.texi:10443
23171 msgid "@code{ttl} (default: @code{#f})"
23175 #: doc/guix.texi:10447
23177 "When it is an integer, this denotes the @dfn{time-to-live} in seconds of the "
23178 "published archives. @xref{Invoking guix publish, @option{--ttl}}, for more "
23182 #. type: anchor{#1}
23183 #: doc/guix.texi:10451
23184 msgid "rngd-service"
23188 #: doc/guix.texi:10451
23190 msgid "{Scheme Procedure} rngd-service [#:rng-tools @var{rng-tools}] @"
23194 #: doc/guix.texi:10456
23196 "[#:device \"/dev/hwrng\"] Return a service that runs the @command{rngd} "
23197 "program from @var{rng-tools} to add @var{device} to the kernel's entropy "
23198 "pool. The service will fail if @var{device} does not exist."
23201 #. type: anchor{#1}
23202 #: doc/guix.texi:10459
23203 msgid "pam-limits-service"
23207 #: doc/guix.texi:10459
23209 msgid "session limits"
23213 #: doc/guix.texi:10460
23219 #: doc/guix.texi:10461
23225 #: doc/guix.texi:10462
23231 #: doc/guix.texi:10463
23237 #: doc/guix.texi:10464
23239 msgid "{Scheme Procedure} pam-limits-service [#:limits @code{'()}]"
23243 #: doc/guix.texi:10471
23245 "Return a service that installs a configuration file for the @uref{http://"
23246 "linux-pam.org/Linux-PAM-html/sag-pam_limits.html, @code{pam_limits} "
23247 "module}. The procedure optionally takes a list of @code{pam-limits-entry} "
23248 "values, which can be used to specify @code{ulimit} limits and nice priority "
23249 "limits to user sessions."
23253 #: doc/guix.texi:10474
23255 "The following limits definition sets two hard and soft limits for all login "
23256 "sessions of users in the @code{realtime} group:"
23260 #: doc/guix.texi:10480
23263 "(pam-limits-service\n"
23265 " (pam-limits-entry \"@@realtime\" 'both 'rtprio 99)\n"
23266 " (pam-limits-entry \"@@realtime\" 'both 'memlock 'unlimited)))\n"
23270 #: doc/guix.texi:10486
23272 "The first entry increases the maximum realtime priority for non-privileged "
23273 "processes; the second entry lifts any restriction of the maximum address "
23274 "space that can be locked in memory. These settings are commonly used for "
23275 "real-time audio systems."
23279 #: doc/guix.texi:10491
23285 #: doc/guix.texi:10492
23291 #: doc/guix.texi:10493
23293 msgid "scheduling jobs"
23296 #. type: Plain text
23297 #: doc/guix.texi:10500
23299 "The @code{(gnu services mcron)} module provides an interface to GNU@tie{}"
23300 "mcron, a daemon to run jobs at scheduled times (@pxref{Top,,, mcron, "
23301 "GNU@tie{}mcron}). GNU@tie{}mcron is similar to the traditional Unix "
23302 "@command{cron} daemon; the main difference is that it is implemented in "
23303 "Guile Scheme, which provides a lot of flexibility when specifying the "
23304 "scheduling of jobs and their actions."
23307 #. type: Plain text
23308 #: doc/guix.texi:10508
23310 "The example below defines an operating system that runs the "
23311 "@command{updatedb} (@pxref{Invoking updatedb,,, find, Finding Files}) and "
23312 "the @command{guix gc} commands (@pxref{Invoking guix gc}) daily, as well as "
23313 "the @command{mkid} command on behalf of an unprivileged user (@pxref{mkid "
23314 "invocation,,, idutils, ID Database Utilities}). It uses gexps to introduce "
23315 "job definitions that are passed to mcron (@pxref{G-Expressions})."
23319 #: doc/guix.texi:10512
23322 "(use-modules (guix) (gnu) (gnu services mcron))\n"
23323 "(use-package-modules base idutils)\n"
23328 #: doc/guix.texi:10521
23331 "(define updatedb-job\n"
23332 " ;; Run 'updatedb' at 3AM every day. Here we write the\n"
23333 " ;; job's action as a Scheme procedure.\n"
23334 " #~(job '(next-hour '(3))\n"
23336 " (execl (string-append #$findutils \"/bin/updatedb\")\n"
23338 " \"--prunepaths=/tmp /var/tmp /gnu/store\"))))\n"
23343 #: doc/guix.texi:10527
23346 "(define garbage-collector-job\n"
23347 " ;; Collect garbage 5 minutes after midnight every day.\n"
23348 " ;; The job's action is a shell command.\n"
23349 " #~(job \"5 0 * * *\" ;Vixie cron syntax\n"
23350 " \"guix gc -F 1G\"))\n"
23355 #: doc/guix.texi:10534
23358 "(define idutils-job\n"
23359 " ;; Update the index database as user \"charlie\" at 12:15PM\n"
23360 " ;; and 19:15PM. This runs from the user's home directory.\n"
23361 " #~(job '(next-minute-from (next-hour '(12 19)) '(15))\n"
23362 " (string-append #$idutils \"/bin/mkid src\")\n"
23363 " #:user \"charlie\"))\n"
23368 #: doc/guix.texi:10541
23371 "(operating-system\n"
23373 " (services (cons (mcron-service (list garbage-collector-job\n"
23376 " %base-services)))\n"
23379 #. type: Plain text
23380 #: doc/guix.texi:10546
23382 "@xref{Guile Syntax, mcron job specifications,, mcron, GNU@tie{}mcron}, for "
23383 "more information on mcron job specifications. Below is the reference of the "
23388 #: doc/guix.texi:10547
23390 msgid "{Scheme Procedure} mcron-service @var{jobs} [#:mcron @var{mcron}]"
23394 #: doc/guix.texi:10550
23396 "Return an mcron service running @var{mcron} that schedules @var{jobs}, a "
23397 "list of gexps denoting mcron job specifications."
23401 #: doc/guix.texi:10552
23402 msgid "This is a shorthand for:"
23406 #: doc/guix.texi:10555
23409 "(service mcron-service-type\n"
23410 " (mcron-configuration (mcron mcron) (jobs jobs)))\n"
23414 #: doc/guix.texi:10558
23416 msgid "{Scheme Variable} mcron-service-type"
23420 #: doc/guix.texi:10561
23422 "This is the type of the @code{mcron} service, whose value is an @code{mcron-"
23423 "configuration} object."
23427 #: doc/guix.texi:10566
23429 "This service type can be the target of a service extension that provides it "
23430 "additional job specifications (@pxref{Service Composition}). In other "
23431 "words, it is possible to define services that provide additional mcron jobs "
23436 #: doc/guix.texi:10568
23438 msgid "{Data Type} mcron-configuration"
23442 #: doc/guix.texi:10570
23443 msgid "Data type representing the configuration of mcron."
23447 #: doc/guix.texi:10572
23449 msgid "@code{mcron} (default: @var{mcron})"
23453 #: doc/guix.texi:10574
23454 msgid "The mcron package to use."
23458 #: doc/guix.texi:10575 doc/guix.texi:10634
23464 #: doc/guix.texi:10579
23466 "This is a list of gexps (@pxref{G-Expressions}), where each gexp corresponds "
23467 "to an mcron job specification (@pxref{Syntax, mcron job specifications,, "
23468 "mcron, GNU@tie{}mcron})."
23472 #: doc/guix.texi:10586
23478 #: doc/guix.texi:10587
23480 msgid "log rotation"
23483 #. type: Plain text
23484 #: doc/guix.texi:10594
23486 "Log files such as those found in @file{/var/log} tend to grow endlessly, so "
23487 "it's a good idea to @dfn{rotate} them once in a while---i.e., archive their "
23488 "contents in separate files, possibly compressed. The @code{(gnu services "
23489 "admin)} module provides an interface to GNU@tie{}Rot[t]log, a log rotation "
23490 "tool (@pxref{Top,,, rottlog, GNU Rot[t]log Manual})."
23493 #. type: Plain text
23494 #: doc/guix.texi:10597
23496 "The example below defines an operating system that provides log rotation "
23497 "with the default settings, for commonly encountered log files."
23501 #: doc/guix.texi:10602
23504 "(use-modules (guix) (gnu))\n"
23505 "(use-service-modules admin mcron)\n"
23506 "(use-package-modules base idutils)\n"
23511 #: doc/guix.texi:10607
23514 "(operating-system\n"
23516 " (services (cons (service rottlog-service-type)\n"
23517 " %base-services)))\n"
23521 #: doc/guix.texi:10609
23523 msgid "{Scheme Variable} rottlog-service-type"
23527 #: doc/guix.texi:10612
23529 "This is the type of the Rottlog service, whose value is a @code{rottlog-"
23530 "configuration} object."
23534 #: doc/guix.texi:10615
23536 "Other services can extend this one with new @code{log-rotation} objects (see "
23537 "below), thereby augmenting the set of files to be rotated."
23541 #: doc/guix.texi:10618
23543 "This service type can define mcron jobs (@pxref{Scheduled Job Execution}) to "
23544 "run the rottlog service."
23548 #: doc/guix.texi:10620
23550 msgid "{Data Type} rottlog-configuration"
23554 #: doc/guix.texi:10622
23555 msgid "Data type representing the configuration of rottlog."
23559 #: doc/guix.texi:10624
23561 msgid "@code{rottlog} (default: @code{rottlog})"
23565 #: doc/guix.texi:10626
23566 msgid "The Rottlog package to use."
23570 #: doc/guix.texi:10627
23572 msgid "@code{rc-file} (default: @code{(file-append rottlog \"/etc/rc\")})"
23576 #: doc/guix.texi:10630
23578 "The Rottlog configuration file to use (@pxref{Mandatory RC Variables,,, "
23579 "rottlog, GNU Rot[t]log Manual})."
23583 #: doc/guix.texi:10631
23585 msgid "@code{rotations} (default: @code{%default-rotations})"
23589 #: doc/guix.texi:10633
23590 msgid "A list of @code{log-rotation} objects as defined below."
23594 #: doc/guix.texi:10637
23596 "This is a list of gexps where each gexp corresponds to an mcron job "
23597 "specification (@pxref{Scheduled Job Execution})."
23601 #: doc/guix.texi:10640
23603 msgid "{Data Type} log-rotation"
23607 #: doc/guix.texi:10642
23608 msgid "Data type representing the rotation of a group of log files."
23612 #: doc/guix.texi:10646
23614 "Taking an example from the Rottlog manual (@pxref{Period Related File "
23615 "Examples,,, rottlog, GNU Rot[t]log Manual}), a log rotation might be defined "
23620 #: doc/guix.texi:10655
23624 " (frequency 'daily)\n"
23625 " (files '(\"/var/log/apache/*\"))\n"
23626 " (options '(\"storedir apache-archives\"\n"
23628 " \"notifempty\"\n"
23629 " \"nocompress\")))\n"
23633 #: doc/guix.texi:10658
23634 msgid "The list of fields is as follows:"
23638 #: doc/guix.texi:10660
23640 msgid "@code{frequency} (default: @code{'weekly})"
23644 #: doc/guix.texi:10662
23645 msgid "The log rotation frequency, a symbol."
23649 #: doc/guix.texi:10663
23655 #: doc/guix.texi:10665
23656 msgid "The list of files or file glob patterns to rotate."
23660 #: doc/guix.texi:10666
23662 msgid "@code{options} (default: @code{'()})"
23666 #: doc/guix.texi:10669
23668 "The list of rottlog options for this rotation (@pxref{Configuration "
23669 "parameters,,, rottlog, GNU Rot[t]lg Manual})."
23673 #: doc/guix.texi:10670
23675 msgid "@code{post-rotate} (default: @code{#f})"
23679 #: doc/guix.texi:10672
23680 msgid "Either @code{#f} or a gexp to execute once the rotation has completed."
23684 #: doc/guix.texi:10675
23686 msgid "{Scheme Variable} %default-rotations"
23690 #: doc/guix.texi:10678
23692 "Specifies weekly rotation of @var{%rotated-files} and a couple of other "
23697 #: doc/guix.texi:10680
23699 msgid "{Scheme Variable} %rotated-files"
23703 #: doc/guix.texi:10683
23705 "The list of syslog-controlled files to be rotated. By default it is: "
23706 "@code{'(\"/var/log/messages\" \"/var/log/secure\")}."
23709 #. type: Plain text
23710 #: doc/guix.texi:10690
23712 "The @code{(gnu services networking)} module provides services to configure "
23713 "the network interface."
23717 #: doc/guix.texi:10691
23719 msgid "DHCP, networking service"
23723 #: doc/guix.texi:10692
23725 msgid "{Scheme Procedure} dhcp-client-service [#:dhcp @var{isc-dhcp}]"
23729 #: doc/guix.texi:10695
23731 "Return a service that runs @var{dhcp}, a Dynamic Host Configuration Protocol "
23732 "(DHCP) client, on all the non-loopback network interfaces."
23736 #: doc/guix.texi:10697
23738 msgid "{Scheme Procedure} dhcpd-service-type"
23742 #: doc/guix.texi:10701
23744 "This type defines a service that runs a DHCP daemon. To create a service of "
23745 "this type, you must supply a @code{<dhcpd-configuration>}. For example:"
23749 #: doc/guix.texi:10707
23752 "(service dhcpd-service-type\n"
23753 " (dhcpd-configuration\n"
23754 " (config-file (local-file \"my-dhcpd.conf\"))\n"
23755 " (interfaces '(\"enp0s25\"))))\n"
23759 #: doc/guix.texi:10710
23761 msgid "{Data Type} dhcpd-configuration"
23765 #: doc/guix.texi:10712
23767 msgid "@code{package} (default: @code{isc-dhcp})"
23771 #: doc/guix.texi:10717
23773 "The package that provides the DHCP daemon. This package is expected to "
23774 "provide the daemon at @file{sbin/dhcpd} relative to its output directory. "
23775 "The default package is the @uref{http://www.isc.org/products/DHCP, ISC's "
23780 #: doc/guix.texi:10717 doc/guix.texi:14345
23782 msgid "@code{config-file} (default: @code{#f})"
23786 #: doc/guix.texi:10722
23788 "The configuration file to use. This is required. It will be passed to "
23789 "@code{dhcpd} via its @code{-cf} option. This may be any ``file-like'' "
23790 "object (@pxref{G-Expressions, file-like objects}). See @code{man dhcpd."
23791 "conf} for details on the configuration file syntax."
23795 #: doc/guix.texi:10722
23797 msgid "@code{version} (default: @code{\"4\"})"
23801 #: doc/guix.texi:10727
23803 "The DHCP version to use. The ISC DHCP server supports the values ``4'', "
23804 "``6'', and ``4o6''. These correspond to the @code{dhcpd} program options "
23805 "@code{-4}, @code{-6}, and @code{-4o6}. See @code{man dhcpd} for details."
23809 #: doc/guix.texi:10727
23811 msgid "@code{run-directory} (default: @code{\"/run/dhcpd\"})"
23815 #: doc/guix.texi:10730
23817 "The run directory to use. At service activation time, this directory will "
23818 "be created if it does not exist."
23822 #: doc/guix.texi:10730
23824 msgid "@code{pid-file} (default: @code{\"/run/dhcpd/dhcpd.pid\"})"
23828 #: doc/guix.texi:10733
23830 "The PID file to use. This corresponds to the @code{-pf} option of "
23831 "@code{dhcpd}. See @code{man dhcpd} for details."
23835 #: doc/guix.texi:10733
23837 msgid "@code{interfaces} (default: @code{'()})"
23841 #: doc/guix.texi:10739
23843 "The names of the network interfaces on which dhcpd should listen for "
23844 "broadcasts. If this list is not empty, then its elements (which must be "
23845 "strings) will be appended to the @code{dhcpd} invocation when starting the "
23846 "daemon. It may not be necessary to explicitly specify any interfaces here; "
23847 "see @code{man dhcpd} for details."
23851 #: doc/guix.texi:10742
23853 msgid "{Scheme Variable} static-networking-service-type"
23857 #: doc/guix.texi:10745
23858 msgid "This is the type for statically-configured network interfaces."
23862 #: doc/guix.texi:10747
23864 msgid "{Scheme Procedure} static-networking-service @var{interface} @var{ip} @"
23868 #: doc/guix.texi:10755
23870 "[#:netmask #f] [#:gateway #f] [#:name-servers @code{'()}] [#:requirement "
23871 "@code{'(udev)}] Return a service that starts @var{interface} with address "
23872 "@var{ip}. If @var{netmask} is true, use it as the network mask. If "
23873 "@var{gateway} is true, it must be a string specifying the default network "
23874 "gateway. @var{requirement} can be used to declare a dependency on another "
23875 "service before configuring the interface."
23879 #: doc/guix.texi:10760
23881 "This procedure can be called several times, one for each network interface "
23882 "of interest. Behind the scenes what it does is extend @code{static-"
23883 "networking-service-type} with additional network interfaces to handle."
23887 #: doc/guix.texi:10762
23893 #: doc/guix.texi:10765
23895 msgid "network management"
23899 #: doc/guix.texi:10766
23901 msgid "{Scheme Procedure} wicd-service [#:wicd @var{wicd}]"
23905 #: doc/guix.texi:10769
23907 "Return a service that runs @url{https://launchpad.net/wicd,Wicd}, a network "
23908 "management daemon that aims to simplify wired and wireless networking."
23912 #: doc/guix.texi:10774
23914 "This service adds the @var{wicd} package to the global profile, providing "
23915 "several commands to interact with the daemon and configure networking: "
23916 "@command{wicd-client}, a graphical user interface, and the @command{wicd-"
23917 "cli} and @command{wicd-curses} user interfaces."
23921 #: doc/guix.texi:10776
23923 msgid "NetworkManager"
23927 #: doc/guix.texi:10778
23929 msgid "{Scheme Variable} network-manager-service-type"
23933 #: doc/guix.texi:10783
23935 "This is the service type for the @uref{https://wiki.gnome.org/Projects/"
23936 "NetworkManager, NetworkManager} service. The value for this service type is "
23937 "a @code{network-manager-configuration} record."
23941 #: doc/guix.texi:10786
23943 "This service is part of @code{%desktop-services} (@pxref{Desktop Services})."
23947 #: doc/guix.texi:10788
23949 msgid "{Data Type} network-manager-configuration"
23953 #: doc/guix.texi:10790
23954 msgid "Data type representing the configuration of NetworkManager."
23958 #: doc/guix.texi:10792
23960 msgid "@code{network-manager} (default: @code{network-manager})"
23964 #: doc/guix.texi:10794
23965 msgid "The NetworkManager package to use."
23969 #: doc/guix.texi:10795
23971 msgid "@code{dns} (default: @code{\"default\"})"
23975 #: doc/guix.texi:10798
23977 "Processing mode for DNS, which affects how NetworkManager uses the "
23978 "@code{resolv.conf} configuration file."
23982 #: doc/guix.texi:10800
23988 #: doc/guix.texi:10803
23990 "NetworkManager will update @code{resolv.conf} to reflect the nameservers "
23991 "provided by currently active connections."
23995 #: doc/guix.texi:10804
24001 #: doc/guix.texi:10808
24003 "NetworkManager will run @code{dnsmasq} as a local caching nameserver, using "
24004 "a \"split DNS\" configuration if you are connected to a VPN, and then update "
24005 "@code{resolv.conf} to point to the local nameserver."
24009 #: doc/guix.texi:10809 doc/guix.texi:11795
24015 #: doc/guix.texi:10811
24016 msgid "NetworkManager will not modify @code{resolv.conf}."
24020 #: doc/guix.texi:10813
24022 msgid "@code{vpn-plugins} (default: @code{'()})"
24026 #: doc/guix.texi:10817
24028 "This is the list of available plugins for virtual private networks (VPNs). "
24029 "An example of this is the @code{network-manager-openvpn} package, which "
24030 "allows NetworkManager to manage VPNs @i{via} OpenVPN."
24034 #: doc/guix.texi:10821
24040 #: doc/guix.texi:10822
24042 msgid "{Scheme Variable} connman-service-type"
24046 #: doc/guix.texi:10825
24048 "This is the service type to run @url{https://01.org/connman,Connman}, a "
24049 "network connection manager."
24053 #: doc/guix.texi:10828
24055 "Its value must be an @code{connman-configuration} record as in this example:"
24059 #: doc/guix.texi:10833
24062 "(service connman-service-type\n"
24063 " (connman-configuration\n"
24064 " (disable-vpn? #t)))\n"
24068 #: doc/guix.texi:10836
24069 msgid "See below for details about @code{connman-configuration}."
24073 #: doc/guix.texi:10838
24075 msgid "{Data Type} connman-configuration"
24079 #: doc/guix.texi:10840
24080 msgid "Data Type representing the configuration of connman."
24084 #: doc/guix.texi:10842
24086 msgid "@code{connman} (default: @var{connman})"
24090 #: doc/guix.texi:10844
24091 msgid "The connman package to use."
24095 #: doc/guix.texi:10845
24097 msgid "@code{disable-vpn?} (default: @code{#f})"
24101 #: doc/guix.texi:10847
24102 msgid "When true, enable connman's vpn plugin."
24106 #: doc/guix.texi:10850
24108 msgid "WPA Supplicant"
24112 #: doc/guix.texi:10851
24114 msgid "{Scheme Variable} wpa-supplicant-service-type"
24118 #: doc/guix.texi:10856
24120 "This is the service type to run @url{https://w1.fi/wpa_supplicant/,WPA "
24121 "supplicant}, an authentication daemon required to authenticate against "
24122 "encrypted WiFi or ethernet networks. It is configured to listen for "
24123 "requests on D-Bus."
24127 #: doc/guix.texi:10859
24129 "The value of this service is the @code{wpa-supplicant} package to use. "
24130 "Thus, it can be instantiated like this:"
24134 #: doc/guix.texi:10862
24137 "(use-modules (gnu services networking))\n"
24142 #: doc/guix.texi:10864
24144 msgid "(service wpa-supplicant-service-type)\n"
24148 #: doc/guix.texi:10867
24154 #: doc/guix.texi:10868
24156 msgid "real time clock"
24160 #: doc/guix.texi:10869
24162 msgid "{Scheme Procedure} ntp-service [#:ntp @var{ntp}] @"
24166 #: doc/guix.texi:10877
24168 "[#:servers @var{%ntp-servers}] @ [#:allow-large-adjustment? #f] Return a "
24169 "service that runs the daemon from @var{ntp}, the @uref{http://www.ntp.org, "
24170 "Network Time Protocol package}. The daemon will keep the system clock "
24171 "synchronized with that of @var{servers}. @var{allow-large-adjustment?} "
24172 "determines whether @command{ntpd} is allowed to make an initial adjustment "
24173 "of more than 1,000 seconds."
24177 #: doc/guix.texi:10879
24179 msgid "{Scheme Variable} %ntp-servers"
24183 #: doc/guix.texi:10881
24184 msgid "List of host names used as the default NTP servers."
24188 #: doc/guix.texi:10883
24194 #: doc/guix.texi:10884
24196 msgid "{Scheme Procedure} openntpd-service-type"
24200 #: doc/guix.texi:10888
24202 "Run the @command{ntpd}, the Network Time Protocol (NTP) daemon, as "
24203 "implemented by @uref{http://www.openntpd.org, OpenNTPD}. The daemon will "
24204 "keep the system clock synchronized with that of the given servers."
24208 #: doc/guix.texi:10898
24212 " openntpd-service-type\n"
24213 " (openntpd-configuration\n"
24214 " (listen-on '(\"127.0.0.1\" \"::1\"))\n"
24215 " (sensor '(\"udcf0 correction 70000\"))\n"
24216 " (constraint-from '(\"www.gnu.org\"))\n"
24217 " (constraints-from '(\"https://www.google.com/\"))\n"
24218 " (allow-large-adjustment? #t)))\n"
24223 #: doc/guix.texi:10902
24225 msgid "{Data Type} openntpd-configuration"
24229 #: doc/guix.texi:10904
24231 msgid "@code{openntpd} (default: @code{(file-append openntpd \"/sbin/ntpd\")})"
24235 #: doc/guix.texi:10906
24236 msgid "The openntpd executable to use."
24240 #: doc/guix.texi:10906
24242 msgid "@code{listen-on} (default: @code{'(\"127.0.0.1\" \"::1\")})"
24246 #: doc/guix.texi:10908
24248 "A list of local IP addresses or hostnames the ntpd daemon should listen on."
24252 #: doc/guix.texi:10908
24254 msgid "@code{query-from} (default: @code{'()})"
24258 #: doc/guix.texi:10910
24260 "A list of local IP address the ntpd daemon should use for outgoing queries."
24264 #: doc/guix.texi:10910
24266 msgid "@code{sensor} (default: @code{'()})"
24270 #: doc/guix.texi:10915
24272 "Specify a list of timedelta sensor devices ntpd should use. @code{ntpd} "
24273 "will listen to each sensor that acutally exists and ignore non-existant "
24274 "ones. See @uref{https://man.openbsd.org/ntpd.conf, upstream documentation} "
24275 "for more information."
24279 #: doc/guix.texi:10915
24281 msgid "@code{server} (default: @var{%ntp-servers})"
24285 #: doc/guix.texi:10917
24287 "Specify a list of IP addresses or hostnames of NTP servers to synchronize to."
24291 #: doc/guix.texi:10917
24293 msgid "@code{servers} (default: @code{'()})"
24297 #: doc/guix.texi:10919
24299 "Specify a list of IP addresses or hostnames of NTP pools to synchronize to."
24303 #: doc/guix.texi:10919
24305 msgid "@code{constraint-from} (default: @code{'()})"
24309 #: doc/guix.texi:10926
24311 "@code{ntpd} can be configured to query the ‘Date’ from trusted HTTPS servers "
24312 "via TLS. This time information is not used for precision but acts as an "
24313 "authenticated constraint, thereby reducing the impact of unauthenticated NTP "
24314 "man-in-the-middle attacks. Specify a list of URLs, IP addresses or "
24315 "hostnames of HTTPS servers to provide a constraint."
24319 #: doc/guix.texi:10926
24321 msgid "@code{constraints-from} (default: @code{'()})"
24325 #: doc/guix.texi:10930
24327 "As with constraint from, specify a list of URLs, IP addresses or hostnames "
24328 "of HTTPS servers to provide a constraint. Should the hostname resolve to "
24329 "multiple IP addresses, @code{ntpd} will calculate a median constraint from "
24334 #: doc/guix.texi:10930
24336 msgid "@code{allow-large-adjustment?} (default: @code{#f})"
24340 #: doc/guix.texi:10933
24342 "Determines if @code{ntpd} is allowed to make an initial adjustment of more "
24343 "than 180 seconds."
24347 #: doc/guix.texi:10936
24353 #: doc/guix.texi:10937
24355 msgid "{Scheme variable} inetd-service-type"
24359 #: doc/guix.texi:10942
24361 "This service runs the @command{inetd} (@pxref{inetd invocation,,, inetutils, "
24362 "GNU Inetutils}) daemon. @command{inetd} listens for connections on internet "
24363 "sockets, and lazily starts the specified server program when a connection is "
24364 "made on one of these sockets."
24368 #: doc/guix.texi:10948
24370 "The value of this service is an @code{inetd-configuration} object. The "
24371 "following example configures the @command{inetd} daemon to provide the built-"
24372 "in @command{echo} service, as well as an smtp service which forwards smtp "
24373 "traffic over ssh to a server @code{smtp-server} behind a gateway "
24378 #: doc/guix.texi:10971
24382 " inetd-service-type\n"
24383 " (inetd-configuration\n"
24384 " (entries (list\n"
24386 " (name \"echo\")\n"
24387 " (socket-type 'stream)\n"
24388 " (protocol \"tcp\")\n"
24390 " (user \"root\"))\n"
24392 " (node \"127.0.0.1\")\n"
24393 " (name \"smtp\")\n"
24394 " (socket-type 'stream)\n"
24395 " (protocol \"tcp\")\n"
24397 " (user \"root\")\n"
24398 " (program (file-append openssh \"/bin/ssh\"))\n"
24400 " '(\"ssh\" \"-qT\" \"-i\" \"/path/to/ssh_key\"\n"
24401 " \"-W\" \"smtp-server:25\" \"user@@hostname\")))))\n"
24405 #: doc/guix.texi:10974
24406 msgid "See below for more details about @code{inetd-configuration}."
24410 #: doc/guix.texi:10976
24412 msgid "{Data Type} inetd-configuration"
24416 #: doc/guix.texi:10978
24417 msgid "Data type representing the configuration of @command{inetd}."
24421 #: doc/guix.texi:10980
24423 msgid "@code{program} (default: @code{(file-append inetutils \"/libexec/inetd\")})"
24427 #: doc/guix.texi:10982
24428 msgid "The @command{inetd} executable to use."
24432 #: doc/guix.texi:10983 doc/guix.texi:16240
24434 msgid "@code{entries} (default: @code{'()})"
24438 #: doc/guix.texi:10986
24440 "A list of @command{inetd} service entries. Each entry should be created by "
24441 "the @code{inetd-entry} constructor."
24445 #: doc/guix.texi:10989
24447 msgid "{Data Type} inetd-entry"
24451 #: doc/guix.texi:10993
24453 "Data type representing an entry in the @command{inetd} configuration. Each "
24454 "entry corresponds to a socket where @command{inetd} will listen for requests."
24458 #: doc/guix.texi:10995
24460 msgid "@code{node} (default: @code{#f})"
24464 #: doc/guix.texi:11000
24466 "Optional string, a comma-separated list of local addresses @command{inetd} "
24467 "should use when listening for this service. @xref{Configuration file,,, "
24468 "inetutils, GNU Inetutils} for a complete description of all options."
24472 #: doc/guix.texi:11002
24473 msgid "A string, the name must correspond to an entry in @code{/etc/services}."
24477 #: doc/guix.texi:11002
24479 msgid "socket-type"
24483 #: doc/guix.texi:11005
24485 "One of @code{'stream}, @code{'dgram}, @code{'raw}, @code{'rdm} or "
24486 "@code{'seqpacket}."
24490 #: doc/guix.texi:11005
24496 #: doc/guix.texi:11007
24497 msgid "A string, must correspond to an entry in @code{/etc/protocols}."
24501 #: doc/guix.texi:11007
24503 msgid "@code{wait?} (default: @code{#t})"
24507 #: doc/guix.texi:11010
24509 "Whether @command{inetd} should wait for the server to exit before listening "
24510 "to new service requests."
24514 #: doc/guix.texi:11015
24516 "A string containing the user (and, optionally, group) name of the user as "
24517 "whom the server should run. The group name can be specified in a suffix, "
24518 "separated by a colon or period, i.e. @code{\"user\"}, @code{\"user:group\"} "
24519 "or @code{\"user.group\"}."
24523 #: doc/guix.texi:11015
24525 msgid "@code{program} (default: @code{\"internal\"})"
24529 #: doc/guix.texi:11018
24531 "The server program which will serve the requests, or @code{\"internal\"} if "
24532 "@command{inetd} should use a built-in service."
24536 #: doc/guix.texi:11023
24538 "A list strings or file-like objects, which are the server program's "
24539 "arguments, starting with the zeroth argument, i.e. the name of the program "
24540 "itself. For @command{inetd}'s internal services, this entry must be "
24541 "@code{'()} or @code{'(\"internal\")}."
24545 #: doc/guix.texi:11027
24547 "@xref{Configuration file,,, inetutils, GNU Inetutils} for a more detailed "
24548 "discussion of each configuration field."
24552 #: doc/guix.texi:11029
24558 #: doc/guix.texi:11030
24560 msgid "{Scheme Procedure} tor-service [@var{config-file}] [#:tor @var{tor}]"
24564 #: doc/guix.texi:11033
24566 "Return a service to run the @uref{https://torproject.org, Tor} anonymous "
24567 "networking daemon."
24571 #: doc/guix.texi:11038
24573 "The daemon runs as the @code{tor} unprivileged user. It is passed "
24574 "@var{config-file}, a file-like object, with an additional @code{User tor} "
24575 "line and lines for hidden services added via @code{tor-hidden-service}. Run "
24576 "@command{man tor} for information about the configuration file."
24580 #: doc/guix.texi:11040
24582 msgid "hidden service"
24586 #: doc/guix.texi:11041
24588 msgid "{Scheme Procedure} tor-hidden-service @var{name} @var{mapping}"
24592 #: doc/guix.texi:11044
24594 "Define a new Tor @dfn{hidden service} called @var{name} and implementing "
24595 "@var{mapping}. @var{mapping} is a list of port/host tuples, such as:"
24599 #: doc/guix.texi:11048
24602 " '((22 \"127.0.0.1:22\")\n"
24603 " (80 \"127.0.0.1:8080\"))\n"
24607 #: doc/guix.texi:11052
24609 "In this example, port 22 of the hidden service is mapped to local port 22, "
24610 "and port 80 is mapped to local port 8080."
24614 #: doc/guix.texi:11056
24616 "This creates a @file{/var/lib/tor/hidden-services/@var{name}} directory, "
24617 "where the @file{hostname} file contains the @code{.onion} host name for the "
24622 #: doc/guix.texi:11059
24624 "See @uref{https://www.torproject.org/docs/tor-hidden-service.html.en, the "
24625 "Tor project's documentation} for more information."
24628 #. type: Plain text
24629 #: doc/guix.texi:11062
24630 msgid "The @code{(gnu services rsync)} module provides the following services:"
24633 #. type: Plain text
24634 #: doc/guix.texi:11066
24636 "You might want an rsync daemon if you have files that you want available so "
24637 "anyone (or just yourself) can download existing files or upload new files."
24641 #: doc/guix.texi:11067
24643 msgid "{Scheme Variable} rsync-service-type"
24647 #: doc/guix.texi:11070
24649 "This is the type for the @uref{https://rsync.samba.org, rsync} rsync daemon, "
24650 "@command{rsync-configuration} record as in this example:"
24654 #: doc/guix.texi:11073
24656 msgid "(service rsync-service-type)\n"
24660 #: doc/guix.texi:11076
24661 msgid "See below for details about @code{rsync-configuration}."
24665 #: doc/guix.texi:11078
24667 msgid "{Data Type} rsync-configuration"
24671 #: doc/guix.texi:11080
24672 msgid "Data type representing the configuration for @code{rsync-service}."
24676 #: doc/guix.texi:11082
24678 msgid "@code{package} (default: @var{rsync})"
24682 #: doc/guix.texi:11084
24683 msgid "@code{rsync} package to use."
24687 #: doc/guix.texi:11085
24689 msgid "@code{port-number} (default: @code{873})"
24693 #: doc/guix.texi:11089
24695 "TCP port on which @command{rsync} listens for incoming connections. If port "
24696 "is less than @code{1024} @command{rsync} needs to be started as the "
24697 "@code{root} user and group."
24701 #: doc/guix.texi:11090
24703 msgid "@code{pid-file} (default: @code{\"/var/run/rsyncd/rsyncd.pid\"})"
24707 #: doc/guix.texi:11092
24708 msgid "Name of the file where @command{rsync} writes its PID."
24712 #: doc/guix.texi:11093
24714 msgid "@code{lock-file} (default: @code{\"/var/run/rsyncd/rsyncd.lock\"})"
24718 #: doc/guix.texi:11095
24719 msgid "Name of the file where @command{rsync} writes its lock file."
24723 #: doc/guix.texi:11096
24725 msgid "@code{log-file} (default: @code{\"/var/log/rsyncd.log\"})"
24729 #: doc/guix.texi:11098
24730 msgid "Name of the file where @command{rsync} writes its log file."
24734 #: doc/guix.texi:11099
24736 msgid "@code{use-chroot?} (default: @var{#t})"
24740 #: doc/guix.texi:11101
24741 msgid "Whether to use chroot for @command{rsync} shared directory."
24745 #: doc/guix.texi:11102
24747 msgid "@code{share-path} (default: @file{/srv/rsync})"
24751 #: doc/guix.texi:11104
24752 msgid "Location of the @command{rsync} shared directory."
24756 #: doc/guix.texi:11105
24758 msgid "@code{share-comment} (default: @code{\"Rsync share\"})"
24762 #: doc/guix.texi:11107
24763 msgid "Comment of the @command{rsync} shared directory."
24767 #: doc/guix.texi:11108
24769 msgid "@code{read-only?} (default: @var{#f})"
24773 #: doc/guix.texi:11110
24774 msgid "Read-write permissions to shared directory."
24778 #: doc/guix.texi:11111
24780 msgid "@code{timeout} (default: @code{300})"
24784 #: doc/guix.texi:11113
24785 msgid "I/O timeout in seconds."
24789 #: doc/guix.texi:11114
24791 msgid "@code{user} (default: @var{\"root\"})"
24795 #: doc/guix.texi:11116
24796 msgid "Owner of the @code{rsync} process."
24800 #: doc/guix.texi:11117
24802 msgid "@code{group} (default: @var{\"root\"})"
24806 #: doc/guix.texi:11119
24807 msgid "Group of the @code{rsync} process."
24811 #: doc/guix.texi:11120
24813 msgid "@code{uid} (default: @var{\"rsyncd\"})"
24817 #: doc/guix.texi:11123
24819 "User name or user ID that file transfers to and from that module should take "
24820 "place as when the daemon was run as @code{root}."
24824 #: doc/guix.texi:11124
24826 msgid "@code{gid} (default: @var{\"rsyncd\"})"
24830 #: doc/guix.texi:11126
24831 msgid "Group name or group ID that will be used when accessing the module."
24834 #. type: Plain text
24835 #: doc/guix.texi:11131
24836 msgid "Furthermore, @code{(gnu services ssh)} provides the following services."
24840 #: doc/guix.texi:11131 doc/guix.texi:11170 doc/guix.texi:20791
24846 #: doc/guix.texi:11132 doc/guix.texi:11171 doc/guix.texi:20792
24852 #: doc/guix.texi:11134
24854 msgid "{Scheme Procedure} lsh-service [#:host-key \"/etc/lsh/host-key\"] @"
24858 #: doc/guix.texi:11143
24860 "[#:daemonic? #t] [#:interfaces '()] [#:port-number 22] @ [#:allow-empty-"
24861 "passwords? #f] [#:root-login? #f] @ [#:syslog-output? #t] [#:x11-forwarding? "
24862 "#t] @ [#:tcp/ip-forwarding? #t] [#:password-authentication? #t] @ [#:public-"
24863 "key-authentication? #t] [#:initialize? #t] Run the @command{lshd} program "
24864 "from @var{lsh} to listen on port @var{port-number}. @var{host-key} must "
24865 "designate a file containing the host key, and readable only by root."
24869 #: doc/guix.texi:11149
24871 "When @var{daemonic?} is true, @command{lshd} will detach from the "
24872 "controlling terminal and log its output to syslogd, unless one sets "
24873 "@var{syslog-output?} to false. Obviously, it also makes lsh-service depend "
24874 "on existence of syslogd service. When @var{pid-file?} is true, "
24875 "@command{lshd} writes its PID to the file called @var{pid-file}."
24879 #: doc/guix.texi:11153
24881 "When @var{initialize?} is true, automatically create the seed and host key "
24882 "upon service activation if they do not exist yet. This may take long and "
24883 "require interaction."
24887 #: doc/guix.texi:11158
24889 "When @var{initialize?} is false, it is up to the user to initialize the "
24890 "randomness generator (@pxref{lsh-make-seed,,, lsh, LSH Manual}), and to "
24891 "create a key pair with the private key stored in file @var{host-key} "
24892 "(@pxref{lshd basics,,, lsh, LSH Manual})."
24896 #: doc/guix.texi:11162
24898 "When @var{interfaces} is empty, lshd listens for connections on all the "
24899 "network interfaces; otherwise, @var{interfaces} must be a list of host names "
24904 #: doc/guix.texi:11166
24906 "@var{allow-empty-passwords?} specifies whether to accept log-ins with empty "
24907 "passwords, and @var{root-login?} specifies whether to accept log-ins as root."
24911 #: doc/guix.texi:11168
24912 msgid "The other options should be self-descriptive."
24916 #: doc/guix.texi:11172
24918 msgid "{Scheme Variable} openssh-service-type"
24922 #: doc/guix.texi:11176
24924 "This is the type for the @uref{http://www.openssh.org, OpenSSH} secure shell "
24925 "daemon, @command{sshd}. Its value must be an @code{openssh-configuration} "
24926 "record as in this example:"
24930 #: doc/guix.texi:11185
24933 "(service openssh-service-type\n"
24934 " (openssh-configuration\n"
24935 " (x11-forwarding? #t)\n"
24936 " (permit-root-login 'without-password)\n"
24937 " (authorized-keys\n"
24938 " `((\"alice\" ,(local-file \"alice.pub\"))\n"
24939 " (\"bob\" ,(local-file \"bob.pub\"))))))\n"
24943 #: doc/guix.texi:11188
24944 msgid "See below for details about @code{openssh-configuration}."
24948 #: doc/guix.texi:11191
24950 "This service can be extended with extra authorized keys, as in this example:"
24954 #: doc/guix.texi:11196
24957 "(service-extension openssh-service-type\n"
24958 " (const `((\"charlie\"\n"
24959 " ,(local-file \"charlie.pub\")))))\n"
24963 #: doc/guix.texi:11199
24965 msgid "{Data Type} openssh-configuration"
24969 #: doc/guix.texi:11201
24970 msgid "This is the configuration record for OpenSSH's @command{sshd}."
24974 #: doc/guix.texi:11203
24976 msgid "@code{pid-file} (default: @code{\"/var/run/sshd.pid\"})"
24980 #: doc/guix.texi:11205
24981 msgid "Name of the file where @command{sshd} writes its PID."
24985 #: doc/guix.texi:11206
24987 msgid "@code{port-number} (default: @code{22})"
24991 #: doc/guix.texi:11208
24992 msgid "TCP port on which @command{sshd} listens for incoming connections."
24996 #: doc/guix.texi:11209
24998 msgid "@code{permit-root-login} (default: @code{#f})"
25002 #: doc/guix.texi:11214
25004 "This field determines whether and when to allow logins as root. If "
25005 "@code{#f}, root logins are disallowed; if @code{#t}, they are allowed. If "
25006 "it's the symbol @code{'without-password}, then root logins are permitted but "
25007 "not with password-based authentication."
25011 #: doc/guix.texi:11215 doc/guix.texi:11348
25013 msgid "@code{allow-empty-passwords?} (default: @code{#f})"
25017 #: doc/guix.texi:11218
25019 "When true, users with empty passwords may log in. When false, they may not."
25023 #: doc/guix.texi:11219 doc/guix.texi:11351
25025 msgid "@code{password-authentication?} (default: @code{#t})"
25029 #: doc/guix.texi:11222
25031 "When true, users may log in with their password. When false, they have "
25032 "other authentication methods."
25036 #: doc/guix.texi:11223
25038 msgid "@code{public-key-authentication?} (default: @code{#t})"
25042 #: doc/guix.texi:11226
25044 "When true, users may log in using public key authentication. When false, "
25045 "users have to use other authentication method."
25049 #: doc/guix.texi:11229
25051 "Authorized public keys are stored in @file{~/.ssh/authorized_keys}. This is "
25052 "used only by protocol version 2."
25056 #: doc/guix.texi:11230
25058 msgid "@code{x11-forwarding?} (default: @code{#f})"
25062 #: doc/guix.texi:11234
25064 "When true, forwarding of X11 graphical client connections is enabled---in "
25065 "other words, @command{ssh} options @option{-X} and @option{-Y} will work."
25069 #: doc/guix.texi:11235
25071 msgid "@code{challenge-response-authentication?} (default: @code{#f})"
25075 #: doc/guix.texi:11238
25077 "Specifies whether challenge response authentication is allowed (e.g. via "
25082 #: doc/guix.texi:11239
25084 msgid "@code{use-pam?} (default: @code{#t})"
25088 #: doc/guix.texi:11245
25090 "Enables the Pluggable Authentication Module interface. If set to @code{#t}, "
25091 "this will enable PAM authentication using @code{challenge-response-"
25092 "authentication?} and @code{password-authentication?}, in addition to PAM "
25093 "account and session module processing for all authentication types."
25097 #: doc/guix.texi:11250
25099 "Because PAM challenge response authentication usually serves an equivalent "
25100 "role to password authentication, you should disable either @code{challenge-"
25101 "response-authentication?} or @code{password-authentication?}."
25105 #: doc/guix.texi:11251
25107 msgid "@code{print-last-log?} (default: @code{#t})"
25111 #: doc/guix.texi:11254
25113 "Specifies whether @command{sshd} should print the date and time of the last "
25114 "user login when a user logs in interactively."
25118 #: doc/guix.texi:11255
25120 msgid "@code{subsystems} (default: @code{'((\"sftp\" \"internal-sftp\"))})"
25124 #: doc/guix.texi:11257
25125 msgid "Configures external subsystems (e.g. file transfer daemon)."
25129 #: doc/guix.texi:11261
25131 "This is a list of two-element lists, each of which containing the subsystem "
25132 "name and a command (with optional arguments) to execute upon subsystem "
25137 #: doc/guix.texi:11264
25139 "The command @command{internal-sftp} implements an in-process SFTP server. "
25140 "Alternately, one can specify the @command{sftp-server} command:"
25144 #: doc/guix.texi:11269
25147 "(service openssh-service-type\n"
25148 " (openssh-configuration\n"
25150 " `((\"sftp\" ,(file-append openssh \"/libexec/sftp-server\"))))))\n"
25154 #: doc/guix.texi:11271
25156 msgid "@code{accepted-environment} (default: @code{'()})"
25160 #: doc/guix.texi:11273
25161 msgid "List of strings describing which environment variables may be exported."
25165 #: doc/guix.texi:11276
25167 "Each string gets on its own line. See the @code{AcceptEnv} option in "
25168 "@code{man sshd_config}."
25172 #: doc/guix.texi:11281
25174 "This example allows ssh-clients to export the @code{COLORTERM} variable. It "
25175 "is set by terminal emulators, which support colors. You can use it in your "
25176 "shell's ressource file to enable colors for the prompt and commands if this "
25181 #: doc/guix.texi:11286
25184 "(service openssh-service-type\n"
25185 " (openssh-configuration\n"
25186 " (accepted-environment '(\"COLORTERM\"))))\n"
25190 #: doc/guix.texi:11288
25192 msgid "@code{authorized-keys} (default: @code{'()})"
25196 #: doc/guix.texi:11289
25198 msgid "authorized keys, SSH"
25202 #: doc/guix.texi:11290
25204 msgid "SSH authorized keys"
25208 #: doc/guix.texi:11294
25210 "This is the list of authorized keys. Each element of the list is a user "
25211 "name followed by one or more file-like objects that represent SSH public "
25212 "keys. For example:"
25216 #: doc/guix.texi:11301
25219 "(openssh-configuration\n"
25220 " (authorized-keys\n"
25221 " `((\"rekado\" ,(local-file \"rekado.pub\"))\n"
25222 " (\"chris\" ,(local-file \"chris.pub\"))\n"
25223 " (\"root\" ,(local-file \"rekado.pub\") ,(local-file \"chris.pub\")))))\n"
25227 #: doc/guix.texi:11306
25229 "registers the specified public keys for user accounts @code{rekado}, "
25230 "@code{chris}, and @code{root}."
25234 #: doc/guix.texi:11309
25236 "Additional authorized keys can be specified @i{via} @code{service-extension}."
25240 #: doc/guix.texi:11312
25242 "Note that this does @emph{not} interfere with the use of @file{~/.ssh/"
25243 "authorized_keys}."
25247 #: doc/guix.texi:11315
25249 msgid "{Scheme Procedure} dropbear-service [@var{config}]"
25253 #: doc/guix.texi:11319
25255 "Run the @uref{https://matt.ucc.asn.au/dropbear/dropbear.html,Dropbear SSH "
25256 "daemon} with the given @var{config}, a @code{<dropbear-configuration>} "
25261 #: doc/guix.texi:11322
25263 "For example, to specify a Dropbear service listening on port 1234, add this "
25264 "call to the operating system's @code{services} field:"
25268 #: doc/guix.texi:11326
25271 "(dropbear-service (dropbear-configuration\n"
25272 " (port-number 1234)))\n"
25276 #: doc/guix.texi:11329
25278 msgid "{Data Type} dropbear-configuration"
25282 #: doc/guix.texi:11331
25283 msgid "This data type represents the configuration of a Dropbear SSH daemon."
25287 #: doc/guix.texi:11333
25289 msgid "@code{dropbear} (default: @var{dropbear})"
25293 #: doc/guix.texi:11335
25294 msgid "The Dropbear package to use."
25298 #: doc/guix.texi:11336
25300 msgid "@code{port-number} (default: 22)"
25304 #: doc/guix.texi:11338
25305 msgid "The TCP port where the daemon waits for incoming connections."
25309 #: doc/guix.texi:11339
25311 msgid "@code{syslog-output?} (default: @code{#t})"
25315 #: doc/guix.texi:11341
25316 msgid "Whether to enable syslog output."
25320 #: doc/guix.texi:11342
25322 msgid "@code{pid-file} (default: @code{\"/var/run/dropbear.pid\"})"
25326 #: doc/guix.texi:11344
25327 msgid "File name of the daemon's PID file."
25331 #: doc/guix.texi:11345
25333 msgid "@code{root-login?} (default: @code{#f})"
25337 #: doc/guix.texi:11347
25338 msgid "Whether to allow @code{root} logins."
25342 #: doc/guix.texi:11350
25343 msgid "Whether to allow empty passwords."
25347 #: doc/guix.texi:11353
25348 msgid "Whether to enable password-based authentication."
25352 #: doc/guix.texi:11356
25354 msgid "{Scheme Variable} %facebook-host-aliases"
25358 #: doc/guix.texi:11362
25360 "This variable contains a string for use in @file{/etc/hosts} (@pxref{Host "
25361 "Names,,, libc, The GNU C Library Reference Manual}). Each line contains a "
25362 "entry that maps a known server name of the Facebook on-line service---e.g., "
25363 "@code{www.facebook.com}---to the local host---@code{127.0.0.1} or its IPv6 "
25364 "equivalent, @code{::1}."
25368 #: doc/guix.texi:11366
25370 "This variable is typically used in the @code{hosts-file} field of an "
25371 "@code{operating-system} declaration (@pxref{operating-system Reference, "
25372 "@file{/etc/hosts}}):"
25376 #: doc/guix.texi:11369
25379 "(use-modules (gnu) (guix))\n"
25384 #: doc/guix.texi:11379
25387 "(operating-system\n"
25388 " (host-name \"mymachine\")\n"
25391 " ;; Create a /etc/hosts file with aliases for \"localhost\"\n"
25392 " ;; and \"mymachine\", as well as for Facebook servers.\n"
25393 " (plain-file \"hosts\"\n"
25394 " (string-append (local-host-aliases host-name)\n"
25395 " %facebook-host-aliases))))\n"
25399 #: doc/guix.texi:11383
25401 "This mechanism can prevent programs running locally, such as Web browsers, "
25402 "from accessing Facebook."
25405 #. type: Plain text
25406 #: doc/guix.texi:11386
25407 msgid "The @code{(gnu services avahi)} provides the following definition."
25411 #: doc/guix.texi:11387
25413 msgid "{Scheme Procedure} avahi-service [#:avahi @var{avahi}] @"
25417 #: doc/guix.texi:11399
25419 "[#:host-name #f] [#:publish? #t] [#:ipv4? #t] @ [#:ipv6? #t] [#:wide-area? "
25420 "#f] @ [#:domains-to-browse '()] [#:debug? #f] Return a service that runs "
25421 "@command{avahi-daemon}, a system-wide mDNS/DNS-SD responder that allows for "
25422 "service discovery and \"zero-configuration\" host name lookups (see "
25423 "@uref{http://avahi.org/}), and extends the name service cache daemon (nscd) "
25424 "so that it can resolve @code{.local} host names using @uref{http://0pointer."
25425 "de/lennart/projects/nss-mdns/, nss-mdns}. Additionally, add the @var{avahi} "
25426 "package to the system profile so that commands such as @command{avahi-"
25427 "browse} are directly usable."
25431 #: doc/guix.texi:11402
25433 "If @var{host-name} is different from @code{#f}, use that as the host name to "
25434 "publish for this machine; otherwise, use the machine's actual host name."
25438 #: doc/guix.texi:11406
25440 "When @var{publish?} is true, publishing of host names and services is "
25441 "allowed; in particular, avahi-daemon will publish the machine's host name "
25442 "and IP address via mDNS on the local network."
25446 #: doc/guix.texi:11408
25447 msgid "When @var{wide-area?} is true, DNS-SD over unicast DNS is enabled."
25451 #: doc/guix.texi:11411
25453 "Boolean values @var{ipv4?} and @var{ipv6?} determine whether to use IPv4/"
25458 #: doc/guix.texi:11413
25460 msgid "{Scheme Variable} openvswitch-service-type"
25464 #: doc/guix.texi:11417
25466 "This is the type of the @uref{http://www.openvswitch.org, Open vSwitch} "
25467 "service, whose value should be an @code{openvswitch-configuration} object."
25471 #: doc/guix.texi:11419
25473 msgid "{Data Type} openvswitch-configuration"
25477 #: doc/guix.texi:11423
25479 "Data type representing the configuration of Open vSwitch, a multilayer "
25480 "virtual switch which is designed to enable massive network automation "
25481 "through programmatic extension."
25485 #: doc/guix.texi:11425
25487 msgid "@code{package} (default: @var{openvswitch})"
25491 #: doc/guix.texi:11427
25492 msgid "Package object of the Open vSwitch."
25496 #: doc/guix.texi:11434
25502 #: doc/guix.texi:11435
25504 msgid "X Window System"
25508 #: doc/guix.texi:11436 doc/guix.texi:11613
25510 msgid "login manager"
25513 #. type: Plain text
25514 #: doc/guix.texi:11441
25516 "Support for the X Window graphical display system---specifically Xorg---is "
25517 "provided by the @code{(gnu services xorg)} module. Note that there is no "
25518 "@code{xorg-service} procedure. Instead, the X server is started by the "
25519 "@dfn{login manager}, by default SLiM."
25523 #: doc/guix.texi:11442
25525 msgid "window manager"
25528 #. type: Plain text
25529 #: doc/guix.texi:11447
25531 "To use X11, you must install at least one @dfn{window manager}---for example "
25532 "the @code{windowmaker} or @code{openbox} packages---preferably by adding it "
25533 "to the @code{packages} field of your operating system definition "
25534 "(@pxref{operating-system Reference, system-wide packages})."
25538 #: doc/guix.texi:11448
25540 msgid "{Scheme Variable} slim-service-type"
25544 #: doc/guix.texi:11450
25545 msgid "This is the type for the SLiM graphical login manager for X11."
25549 #: doc/guix.texi:11451
25551 msgid "session types (X11)"
25555 #: doc/guix.texi:11452
25557 msgid "X11 session types"
25561 #: doc/guix.texi:11459
25563 "SLiM looks for @dfn{session types} described by the @file{.desktop} files in "
25564 "@file{/run/current-system/profile/share/xsessions} and allows users to "
25565 "choose a session from the log-in screen using @kbd{F1}. Packages such as "
25566 "@code{xfce}, @code{sawfish}, and @code{ratpoison} provide @file{.desktop} "
25567 "files; adding them to the system-wide set of packages automatically makes "
25568 "them available at the log-in screen."
25572 #: doc/guix.texi:11463
25574 "In addition, @file{~/.xsession} files are honored. When available, @file{~/."
25575 "xsession} must be an executable that starts a window manager and/or other X "
25580 #: doc/guix.texi:11465
25582 msgid "{Data Type} slim-configuration"
25586 #: doc/guix.texi:11467
25587 msgid "Data type representing the configuration of @code{slim-service-type}."
25591 #: doc/guix.texi:11471
25592 msgid "Whether to allow logins with empty passwords."
25596 #: doc/guix.texi:11472
25598 msgid "@code{auto-login?} (default: @code{#f})"
25602 #: doc/guix.texi:11473
25604 msgid "@code{default-user} (default: @code{\"\"})"
25608 #: doc/guix.texi:11475
25609 msgid "When @code{auto-login?} is false, SLiM presents a log-in screen."
25613 #: doc/guix.texi:11478
25615 "When @code{auto-login?} is true, SLiM logs in directly as @code{default-"
25620 #: doc/guix.texi:11479
25622 msgid "@code{theme} (default: @code{%default-slim-theme})"
25626 #: doc/guix.texi:11480
25628 msgid "@code{theme-name} (default: @code{%default-slim-theme-name})"
25632 #: doc/guix.texi:11482
25633 msgid "The graphical theme to use and its name."
25637 #: doc/guix.texi:11483
25639 msgid "@code{auto-login-session} (default: @code{#f})"
25643 #: doc/guix.texi:11486
25645 "If true, this must be the name of the executable to start as the default "
25646 "session---e.g., @code{(file-append windowmaker \"/bin/windowmaker\")}."
25650 #: doc/guix.texi:11490
25652 "If false, a session described by one of the available @file{.desktop} files "
25653 "in @code{/run/current-system/profile} and @code{~/.guix-profile} will be "
25658 #: doc/guix.texi:11495
25660 "You must install at least one window manager in the system profile or in "
25661 "your user profile. Failing to do that, if @code{auto-login-session} is "
25662 "false, you will be unable to log in."
25666 #: doc/guix.texi:11497
25668 msgid "@code{startx} (default: @code{(xorg-start-command)})"
25672 #: doc/guix.texi:11499
25673 msgid "The command used to start the X11 graphical server."
25677 #: doc/guix.texi:11500
25679 msgid "@code{xauth} (default: @code{xauth})"
25683 #: doc/guix.texi:11502
25684 msgid "The XAuth package to use."
25688 #: doc/guix.texi:11503
25690 msgid "@code{shepherd} (default: @code{shepherd})"
25694 #: doc/guix.texi:11506
25696 "The Shepherd package used when invoking @command{halt} and @command{reboot}."
25700 #: doc/guix.texi:11507
25702 msgid "@code{sessreg} (default: @code{sessreg})"
25706 #: doc/guix.texi:11509
25707 msgid "The sessreg package used in order to register the session."
25711 #: doc/guix.texi:11510
25713 msgid "@code{slim} (default: @code{slim})"
25717 #: doc/guix.texi:11512
25718 msgid "The SLiM package to use."
25722 #: doc/guix.texi:11515 doc/guix.texi:20288
25724 msgid "{Scheme Variable} %default-theme"
25728 #: doc/guix.texi:11516
25730 msgid "{Scheme Variable} %default-theme-name"
25734 #: doc/guix.texi:11518
25735 msgid "The default SLiM theme and its name."
25739 #: doc/guix.texi:11521
25741 msgid "{Data Type} sddm-configuration"
25745 #: doc/guix.texi:11523
25746 msgid "This is the data type representing the sddm service configuration."
25750 #: doc/guix.texi:11525
25752 msgid "@code{display-server} (default: \"x11\")"
25756 #: doc/guix.texi:11528
25758 "Select display server to use for the greeter. Valid values are \"x11\" or "
25763 #: doc/guix.texi:11529
25765 msgid "@code{numlock} (default: \"on\")"
25769 #: doc/guix.texi:11531
25770 msgid "Valid values are \"on\", \"off\" or \"none\"."
25774 #: doc/guix.texi:11532
25776 msgid "@code{halt-command} (default @code{#~(string-apppend #$shepherd \"/sbin/halt\")})"
25780 #: doc/guix.texi:11534
25781 msgid "Command to run when halting."
25785 #: doc/guix.texi:11535
25787 msgid "@code{reboot-command} (default @code{#~(string-append #$shepherd \"/sbin/reboot\")})"
25791 #: doc/guix.texi:11537
25792 msgid "Command to run when rebooting."
25796 #: doc/guix.texi:11538
25798 msgid "@code{theme} (default \"maldives\")"
25802 #: doc/guix.texi:11540
25804 "Theme to use. Default themes provided by SDDM are \"elarun\" or \"maldives\"."
25808 #: doc/guix.texi:11541
25810 msgid "@code{themes-directory} (default \"/run/current-system/profile/share/sddm/themes\")"
25814 #: doc/guix.texi:11543
25815 msgid "Directory to look for themes."
25819 #: doc/guix.texi:11544
25821 msgid "@code{faces-directory} (default \"/run/current-system/profile/share/sddm/faces\")"
25825 #: doc/guix.texi:11546
25826 msgid "Directory to look for faces."
25830 #: doc/guix.texi:11547
25832 msgid "@code{default-path} (default \"/run/current-system/profile/bin\")"
25836 #: doc/guix.texi:11549
25837 msgid "Default PATH to use."
25841 #: doc/guix.texi:11550
25843 msgid "@code{minimum-uid} (default 1000)"
25847 #: doc/guix.texi:11552
25848 msgid "Minimum UID to display in SDDM."
25852 #: doc/guix.texi:11553
25854 msgid "@code{maximum-uid} (default 2000)"
25858 #: doc/guix.texi:11555
25859 msgid "Maximum UID to display in SDDM"
25863 #: doc/guix.texi:11556
25865 msgid "@code{remember-last-user?} (default #t)"
25869 #: doc/guix.texi:11558
25870 msgid "Remember last user."
25874 #: doc/guix.texi:11559
25876 msgid "@code{remember-last-session?} (default #t)"
25880 #: doc/guix.texi:11561
25881 msgid "Remember last session."
25885 #: doc/guix.texi:11562
25887 msgid "@code{hide-users} (default \"\")"
25891 #: doc/guix.texi:11564
25892 msgid "Usernames to hide from SDDM greeter."
25896 #: doc/guix.texi:11565
25898 msgid "@code{hide-shells} (default @code{#~(string-append #$shadow \"/sbin/nologin\")})"
25902 #: doc/guix.texi:11567
25903 msgid "Users with shells listed will be hidden from the SDDM greeter."
25907 #: doc/guix.texi:11568
25909 msgid "@code{session-command} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/wayland-session\")})"
25913 #: doc/guix.texi:11570
25914 msgid "Script to run before starting a wayland session."
25918 #: doc/guix.texi:11571
25920 msgid "@code{sessions-directory} (default \"/run/current-system/profile/share/wayland-sessions\")"
25924 #: doc/guix.texi:11573
25925 msgid "Directory to look for desktop files starting wayland sessions."
25929 #: doc/guix.texi:11574
25931 msgid "@code{xorg-server-path} (default @code{xorg-start-command})"
25935 #: doc/guix.texi:11576
25936 msgid "Path to xorg-server."
25940 #: doc/guix.texi:11577
25942 msgid "@code{xauth-path} (default @code{#~(string-append #$xauth \"/bin/xauth\")})"
25946 #: doc/guix.texi:11579
25947 msgid "Path to xauth."
25951 #: doc/guix.texi:11580
25953 msgid "@code{xephyr-path} (default @code{#~(string-append #$xorg-server \"/bin/Xephyr\")})"
25957 #: doc/guix.texi:11582
25958 msgid "Path to Xephyr."
25962 #: doc/guix.texi:11583
25964 msgid "@code{xdisplay-start} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xsetup\")})"
25968 #: doc/guix.texi:11585
25969 msgid "Script to run after starting xorg-server."
25973 #: doc/guix.texi:11586
25975 msgid "@code{xdisplay-stop} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xstop\")})"
25979 #: doc/guix.texi:11588
25980 msgid "Script to run before stopping xorg-server."
25984 #: doc/guix.texi:11589
25986 msgid "@code{xsession-command} (default: @code{xinitr })"
25990 #: doc/guix.texi:11591
25991 msgid "Script to run before starting a X session."
25995 #: doc/guix.texi:11592
25997 msgid "@code{xsessions-directory} (default: \"/run/current-system/profile/share/xsessions\")"
26001 #: doc/guix.texi:11594
26002 msgid "Directory to look for desktop files starting X sessions."
26006 #: doc/guix.texi:11595
26008 msgid "@code{minimum-vt} (default: 7)"
26012 #: doc/guix.texi:11597
26013 msgid "Minimum VT to use."
26017 #: doc/guix.texi:11598
26019 msgid "@code{xserver-arguments} (default \"-nolisten tcp\")"
26023 #: doc/guix.texi:11600
26024 msgid "Arguments to pass to xorg-server."
26028 #: doc/guix.texi:11601
26030 msgid "@code{auto-login-user} (default \"\")"
26034 #: doc/guix.texi:11603
26035 msgid "User to use for auto-login."
26039 #: doc/guix.texi:11604
26041 msgid "@code{auto-login-session} (default \"\")"
26045 #: doc/guix.texi:11606
26046 msgid "Desktop file to use for auto-login."
26050 #: doc/guix.texi:11607
26052 msgid "@code{relogin?} (default #f)"
26056 #: doc/guix.texi:11609
26057 msgid "Relogin after logout."
26061 #: doc/guix.texi:11614
26067 #: doc/guix.texi:11615
26069 msgid "{Scheme Procedure} sddm-service config"
26073 #: doc/guix.texi:11618
26075 "Return a service that spawns the SDDM graphical login manager for config of "
26076 "type @code{<sddm-configuration>}."
26080 #: doc/guix.texi:11623
26083 " (sddm-service (sddm-configuration\n"
26084 " (auto-login-user \"Alice\")\n"
26085 " (auto-login-session \"xfce.desktop\")))\n"
26089 #: doc/guix.texi:11626
26091 msgid "{Scheme Procedure} xorg-start-command [#:guile] @"
26095 #: doc/guix.texi:11635
26097 "[#:modules %default-xorg-modules] @ [#:fonts %default-xorg-fonts] @ [#:"
26098 "configuration-file (xorg-configuration-file @dots{})] @ [#:xorg-server "
26099 "@var{xorg-server}] Return a @code{startx} script in which @var{modules}, a "
26100 "list of X module packages, and @var{fonts}, a list of X font directories, "
26101 "are available. See @code{xorg-wrapper} for more details on the arguments. "
26102 "The result should be used in place of @code{startx}."
26106 #: doc/guix.texi:11637
26107 msgid "Usually the X server is started by a login manager."
26111 #: doc/guix.texi:11639
26113 msgid "{Scheme Procedure} xorg-configuration-file @"
26117 #: doc/guix.texi:11645
26119 "[#:modules %default-xorg-modules] @ [#:fonts %default-xorg-fonts] @ [#:"
26120 "drivers '()] [#:resolutions '()] [#:extra-config '()] Return a configuration "
26121 "file for the Xorg server containing search paths for all the common drivers."
26125 #: doc/guix.texi:11650
26127 "@var{modules} must be a list of @dfn{module packages} loaded by the Xorg "
26128 "server---e.g., @code{xf86-video-vesa}, @code{xf86-input-keyboard}, and so "
26129 "on. @var{fonts} must be a list of font directories to add to the server's "
26134 #: doc/guix.texi:11654
26136 "@var{drivers} must be either the empty list, in which case Xorg chooses a "
26137 "graphics driver automatically, or a list of driver names that will be tried "
26138 "in this order---e.g., @code{(\"modesetting\" \"vesa\")}."
26142 #: doc/guix.texi:11658
26144 "Likewise, when @var{resolutions} is the empty list, Xorg chooses an "
26145 "appropriate screen resolution; otherwise, it must be a list of resolutions---"
26146 "e.g., @code{((1024 768) (640 480))}."
26150 #: doc/guix.texi:11662
26152 "Last, @var{extra-config} is a list of strings or objects appended to the "
26153 "configuration file. It is used to pass extra text to be added verbatim to "
26154 "the configuration file."
26158 #: doc/guix.texi:11664
26160 msgid "{Scheme Procedure} screen-locker-service @var{package} [@var{program}]"
26164 #: doc/guix.texi:11668
26166 "Add @var{package}, a package for a screen locker or screen saver whose "
26167 "command is @var{program}, to the set of setuid programs and add a PAM entry "
26168 "for it. For example:"
26172 #: doc/guix.texi:11671
26174 msgid "(screen-locker-service xlockmore \"xlock\")\n"
26178 #: doc/guix.texi:11674
26179 msgid "makes the good ol' XlockMore usable."
26183 #: doc/guix.texi:11680
26185 msgid "printer support with CUPS"
26188 #. type: Plain text
26189 #: doc/guix.texi:11684
26191 "The @code{(gnu services cups)} module provides a Guix service definition for "
26192 "the CUPS printing service. To add printer support to a GuixSD system, add a "
26193 "@code{cups-service} to the operating system definition:"
26197 #: doc/guix.texi:11685
26199 msgid "{Scheme Variable} cups-service-type"
26203 #: doc/guix.texi:11689
26205 "The service type for the CUPS print server. Its value should be a valid "
26206 "CUPS configuration (see below). To use the default settings, simply write:"
26210 #: doc/guix.texi:11691
26212 msgid "(service cups-service-type)\n"
26215 #. type: Plain text
26216 #: doc/guix.texi:11701
26218 "The CUPS configuration controls the basic things about your CUPS "
26219 "installation: what interfaces it listens on, what to do if a print job "
26220 "fails, how much logging to do, and so on. To actually add a printer, you "
26221 "have to visit the @url{http://localhost:631} URL, or use a tool such as "
26222 "GNOME's printer configuration services. By default, configuring a CUPS "
26223 "service will generate a self-signed certificate if needed, for secure "
26224 "connections to the print server."
26227 #. type: Plain text
26228 #: doc/guix.texi:11706
26230 "Suppose you want to enable the Web interface of CUPS and also add support "
26231 "for Epson printers @i{via} the @code{escpr} package and for HP printers "
26232 "@i{via} the @code{hplip} package. You can do that directly, like this (you "
26233 "need to use the @code{(gnu packages cups)} module):"
26237 #: doc/guix.texi:11713
26240 "(service cups-service-type\n"
26241 " (cups-configuration\n"
26242 " (web-interface? #t)\n"
26244 " (list cups-filters escpr hplip))))\n"
26247 #. type: Plain text
26248 #: doc/guix.texi:11721
26250 "The available configuration parameters follow. Each parameter definition is "
26251 "preceded by its type; for example, @samp{string-list foo} indicates that the "
26252 "@code{foo} parameter should be specified as a list of strings. There is "
26253 "also a way to specify the configuration as a string, if you have an old "
26254 "@code{cupsd.conf} file that you want to port over from some other system; "
26255 "see the end for more details."
26258 #. type: Plain text
26259 #: doc/guix.texi:11732
26260 msgid "Available @code{cups-configuration} fields are:"
26264 #: doc/guix.texi:11733
26266 msgid "{@code{cups-configuration} parameter} package cups"
26270 #: doc/guix.texi:11735 doc/guix.texi:12492
26271 msgid "The CUPS package."
26275 #: doc/guix.texi:11737
26277 msgid "{@code{cups-configuration} parameter} package-list extensions"
26281 #: doc/guix.texi:11739
26282 msgid "Drivers and other extensions to the CUPS package."
26286 #: doc/guix.texi:11741
26288 msgid "{@code{cups-configuration} parameter} files-configuration files-configuration"
26292 #: doc/guix.texi:11744
26294 "Configuration of where to write logs, what directories to use for print "
26295 "spools, and related privileged configuration parameters."
26299 #: doc/guix.texi:11746
26300 msgid "Available @code{files-configuration} fields are:"
26304 #: doc/guix.texi:11747
26306 msgid "{@code{files-configuration} parameter} log-location access-log"
26310 #: doc/guix.texi:11755
26312 "Defines the access log filename. Specifying a blank filename disables "
26313 "access log generation. The value @code{stderr} causes log entries to be "
26314 "sent to the standard error file when the scheduler is running in the "
26315 "foreground, or to the system log daemon when run in the background. The "
26316 "value @code{syslog} causes log entries to be sent to the system log daemon. "
26317 "The server name may be included in filenames using the string @code{%s}, as "
26318 "in @code{/var/log/cups/%s-access_log}."
26322 #: doc/guix.texi:11757
26323 msgid "Defaults to @samp{\"/var/log/cups/access_log\"}."
26327 #: doc/guix.texi:11759
26329 msgid "{@code{files-configuration} parameter} file-name cache-dir"
26333 #: doc/guix.texi:11761
26334 msgid "Where CUPS should cache data."
26338 #: doc/guix.texi:11763
26339 msgid "Defaults to @samp{\"/var/cache/cups\"}."
26343 #: doc/guix.texi:11765
26345 msgid "{@code{files-configuration} parameter} string config-file-perm"
26349 #: doc/guix.texi:11768
26351 "Specifies the permissions for all configuration files that the scheduler "
26356 #: doc/guix.texi:11774
26358 "Note that the permissions for the printers.conf file are currently masked to "
26359 "only allow access from the scheduler user (typically root). This is done "
26360 "because printer device URIs sometimes contain sensitive authentication "
26361 "information that should not be generally known on the system. There is no "
26362 "way to disable this security feature."
26366 #: doc/guix.texi:11776
26367 msgid "Defaults to @samp{\"0640\"}."
26371 #: doc/guix.texi:11778
26373 msgid "{@code{files-configuration} parameter} log-location error-log"
26377 #: doc/guix.texi:11786
26379 "Defines the error log filename. Specifying a blank filename disables access "
26380 "log generation. The value @code{stderr} causes log entries to be sent to "
26381 "the standard error file when the scheduler is running in the foreground, or "
26382 "to the system log daemon when run in the background. The value "
26383 "@code{syslog} causes log entries to be sent to the system log daemon. The "
26384 "server name may be included in filenames using the string @code{%s}, as in "
26385 "@code{/var/log/cups/%s-error_log}."
26389 #: doc/guix.texi:11788
26390 msgid "Defaults to @samp{\"/var/log/cups/error_log\"}."
26394 #: doc/guix.texi:11790
26396 msgid "{@code{files-configuration} parameter} string fatal-errors"
26400 #: doc/guix.texi:11793
26402 "Specifies which errors are fatal, causing the scheduler to exit. The kind "
26407 #: doc/guix.texi:11797
26408 msgid "No errors are fatal."
26412 #: doc/guix.texi:11800
26413 msgid "All of the errors below are fatal."
26417 #: doc/guix.texi:11801
26423 #: doc/guix.texi:11804
26425 "Browsing initialization errors are fatal, for example failed connections to "
26426 "the DNS-SD daemon."
26430 #: doc/guix.texi:11805
26436 #: doc/guix.texi:11807
26437 msgid "Configuration file syntax errors are fatal."
26441 #: doc/guix.texi:11808
26447 #: doc/guix.texi:11811
26449 "Listen or Port errors are fatal, except for IPv6 failures on the loopback or "
26450 "@code{any} addresses."
26454 #: doc/guix.texi:11812
26460 #: doc/guix.texi:11814
26461 msgid "Log file creation or write errors are fatal."
26465 #: doc/guix.texi:11815
26467 msgid "permissions"
26471 #: doc/guix.texi:11818
26473 "Bad startup file permissions are fatal, for example shared TLS certificate "
26474 "and key files with world-read permissions."
26478 #: doc/guix.texi:11821
26479 msgid "Defaults to @samp{\"all -browse\"}."
26483 #: doc/guix.texi:11823
26485 msgid "{@code{files-configuration} parameter} boolean file-device?"
26489 #: doc/guix.texi:11826
26491 "Specifies whether the file pseudo-device can be used for new printer "
26492 "queues. The URI @uref{file:///dev/null} is always allowed."
26496 #: doc/guix.texi:11828 doc/guix.texi:11898 doc/guix.texi:11934
26497 #: doc/guix.texi:11946 doc/guix.texi:11952 doc/guix.texi:11968
26498 #: doc/guix.texi:12056 doc/guix.texi:12150 doc/guix.texi:12466
26499 #: doc/guix.texi:12479 doc/guix.texi:16606 doc/guix.texi:16620
26500 #: doc/guix.texi:16742 doc/guix.texi:16763 doc/guix.texi:16784
26501 #: doc/guix.texi:16791 doc/guix.texi:16836 doc/guix.texi:16843
26502 #: doc/guix.texi:17246 doc/guix.texi:17260 doc/guix.texi:17432
26503 #: doc/guix.texi:17477 doc/guix.texi:17564 doc/guix.texi:17693
26504 #: doc/guix.texi:17726 doc/guix.texi:17866 doc/guix.texi:17877
26505 #: doc/guix.texi:18127 doc/guix.texi:18769 doc/guix.texi:18778
26506 #: doc/guix.texi:18786 doc/guix.texi:18794 doc/guix.texi:18810
26507 #: doc/guix.texi:18826 doc/guix.texi:18834 doc/guix.texi:18842
26508 #: doc/guix.texi:18851 doc/guix.texi:18860 doc/guix.texi:18876
26509 #: doc/guix.texi:18940 doc/guix.texi:19046 doc/guix.texi:19054
26510 #: doc/guix.texi:19062 doc/guix.texi:19087 doc/guix.texi:19141
26511 #: doc/guix.texi:19189 doc/guix.texi:19342 doc/guix.texi:19350
26512 #: doc/guix.texi:19358 doc/guix.texi:19366 doc/guix.texi:19374
26513 #: doc/guix.texi:19382 doc/guix.texi:19390 doc/guix.texi:19397
26514 msgid "Defaults to @samp{#f}."
26518 #: doc/guix.texi:11830
26520 msgid "{@code{files-configuration} parameter} string group"
26524 #: doc/guix.texi:11833
26526 "Specifies the group name or ID that will be used when executing external "
26531 #: doc/guix.texi:11835 doc/guix.texi:11915
26532 msgid "Defaults to @samp{\"lp\"}."
26536 #: doc/guix.texi:11837
26538 msgid "{@code{files-configuration} parameter} string log-file-perm"
26542 #: doc/guix.texi:11839
26543 msgid "Specifies the permissions for all log files that the scheduler writes."
26547 #: doc/guix.texi:11841
26548 msgid "Defaults to @samp{\"0644\"}."
26552 #: doc/guix.texi:11843
26554 msgid "{@code{files-configuration} parameter} log-location page-log"
26558 #: doc/guix.texi:11851
26560 "Defines the page log filename. Specifying a blank filename disables access "
26561 "log generation. The value @code{stderr} causes log entries to be sent to "
26562 "the standard error file when the scheduler is running in the foreground, or "
26563 "to the system log daemon when run in the background. The value "
26564 "@code{syslog} causes log entries to be sent to the system log daemon. The "
26565 "server name may be included in filenames using the string @code{%s}, as in "
26566 "@code{/var/log/cups/%s-page_log}."
26570 #: doc/guix.texi:11853
26571 msgid "Defaults to @samp{\"/var/log/cups/page_log\"}."
26575 #: doc/guix.texi:11855
26577 msgid "{@code{files-configuration} parameter} string remote-root"
26581 #: doc/guix.texi:11858
26583 "Specifies the username that is associated with unauthenticated accesses by "
26584 "clients claiming to be the root user. The default is @code{remroot}."
26588 #: doc/guix.texi:11860
26589 msgid "Defaults to @samp{\"remroot\"}."
26593 #: doc/guix.texi:11862
26595 msgid "{@code{files-configuration} parameter} file-name request-root"
26599 #: doc/guix.texi:11865
26601 "Specifies the directory that contains print jobs and other HTTP request data."
26605 #: doc/guix.texi:11867
26606 msgid "Defaults to @samp{\"/var/spool/cups\"}."
26610 #: doc/guix.texi:11869
26612 msgid "{@code{files-configuration} parameter} sandboxing sandboxing"
26616 #: doc/guix.texi:11874
26618 "Specifies the level of security sandboxing that is applied to print filters, "
26619 "backends, and other child processes of the scheduler; either @code{relaxed} "
26620 "or @code{strict}. This directive is currently only used/supported on macOS."
26624 #: doc/guix.texi:11876
26625 msgid "Defaults to @samp{strict}."
26629 #: doc/guix.texi:11878
26631 msgid "{@code{files-configuration} parameter} file-name server-keychain"
26635 #: doc/guix.texi:11883
26637 "Specifies the location of TLS certificates and private keys. CUPS will look "
26638 "for public and private keys in this directory: a @code{.crt} files for PEM-"
26639 "encoded certificates and corresponding @code{.key} files for PEM-encoded "
26644 #: doc/guix.texi:11885
26645 msgid "Defaults to @samp{\"/etc/cups/ssl\"}."
26649 #: doc/guix.texi:11887
26651 msgid "{@code{files-configuration} parameter} file-name server-root"
26655 #: doc/guix.texi:11889
26656 msgid "Specifies the directory containing the server configuration files."
26660 #: doc/guix.texi:11891
26661 msgid "Defaults to @samp{\"/etc/cups\"}."
26665 #: doc/guix.texi:11893
26667 msgid "{@code{files-configuration} parameter} boolean sync-on-close?"
26671 #: doc/guix.texi:11896
26673 "Specifies whether the scheduler calls fsync(2) after writing configuration "
26678 #: doc/guix.texi:11900
26680 msgid "{@code{files-configuration} parameter} space-separated-string-list system-group"
26684 #: doc/guix.texi:11902
26685 msgid "Specifies the group(s) to use for @code{@@SYSTEM} group authentication."
26689 #: doc/guix.texi:11904
26691 msgid "{@code{files-configuration} parameter} file-name temp-dir"
26695 #: doc/guix.texi:11906
26696 msgid "Specifies the directory where temporary files are stored."
26700 #: doc/guix.texi:11908
26701 msgid "Defaults to @samp{\"/var/spool/cups/tmp\"}."
26705 #: doc/guix.texi:11910
26707 msgid "{@code{files-configuration} parameter} string user"
26711 #: doc/guix.texi:11913
26713 "Specifies the user name or ID that is used when running external programs."
26717 #: doc/guix.texi:11918
26719 msgid "{@code{cups-configuration} parameter} access-log-level access-log-level"
26723 #: doc/guix.texi:11925
26725 "Specifies the logging level for the AccessLog file. The @code{config} level "
26726 "logs when printers and classes are added, deleted, or modified and when "
26727 "configuration files are accessed or updated. The @code{actions} level logs "
26728 "when print jobs are submitted, held, released, modified, or canceled, and "
26729 "any of the conditions for @code{config}. The @code{all} level logs all "
26734 #: doc/guix.texi:11927
26735 msgid "Defaults to @samp{actions}."
26739 #: doc/guix.texi:11929
26741 msgid "{@code{cups-configuration} parameter} boolean auto-purge-jobs?"
26745 #: doc/guix.texi:11932
26747 "Specifies whether to purge job history data automatically when it is no "
26748 "longer required for quotas."
26752 #: doc/guix.texi:11936
26754 msgid "{@code{cups-configuration} parameter} browse-local-protocols browse-local-protocols"
26758 #: doc/guix.texi:11938
26759 msgid "Specifies which protocols to use for local printer sharing."
26763 #: doc/guix.texi:11940
26764 msgid "Defaults to @samp{dnssd}."
26768 #: doc/guix.texi:11942
26770 msgid "{@code{cups-configuration} parameter} boolean browse-web-if?"
26774 #: doc/guix.texi:11944
26775 msgid "Specifies whether the CUPS web interface is advertised."
26779 #: doc/guix.texi:11948
26781 msgid "{@code{cups-configuration} parameter} boolean browsing?"
26785 #: doc/guix.texi:11950
26786 msgid "Specifies whether shared printers are advertised."
26790 #: doc/guix.texi:11954
26792 msgid "{@code{cups-configuration} parameter} string classification"
26796 #: doc/guix.texi:11959
26798 "Specifies the security classification of the server. Any valid banner name "
26799 "can be used, including \"classified\", \"confidential\", \"secret\", "
26800 "\"topsecret\", and \"unclassified\", or the banner can be omitted to disable "
26801 "secure printing functions."
26805 #: doc/guix.texi:11961 doc/guix.texi:12298 doc/guix.texi:13657
26806 #: doc/guix.texi:13669 doc/guix.texi:17832 doc/guix.texi:17840
26807 #: doc/guix.texi:17848 doc/guix.texi:17856 doc/guix.texi:18134
26808 #: doc/guix.texi:18612 doc/guix.texi:18620 doc/guix.texi:18628
26809 #: doc/guix.texi:18736 doc/guix.texi:18761 doc/guix.texi:18892
26810 #: doc/guix.texi:18900 doc/guix.texi:18908 doc/guix.texi:18916
26811 #: doc/guix.texi:18924 doc/guix.texi:18932 doc/guix.texi:18955
26812 #: doc/guix.texi:18963 doc/guix.texi:19015 doc/guix.texi:19031
26813 #: doc/guix.texi:19039 doc/guix.texi:19078 doc/guix.texi:19101
26814 #: doc/guix.texi:19123 doc/guix.texi:19130 doc/guix.texi:19165
26815 #: doc/guix.texi:19173 doc/guix.texi:19197 doc/guix.texi:19229
26816 #: doc/guix.texi:19258 doc/guix.texi:19265 doc/guix.texi:19272
26817 #: doc/guix.texi:19280 doc/guix.texi:19294 doc/guix.texi:19303
26818 #: doc/guix.texi:19313 doc/guix.texi:19320 doc/guix.texi:19327
26819 #: doc/guix.texi:19334 doc/guix.texi:19405 doc/guix.texi:19412
26820 #: doc/guix.texi:19419 doc/guix.texi:19428 doc/guix.texi:19444
26821 #: doc/guix.texi:19451 doc/guix.texi:19458 doc/guix.texi:19465
26822 #: doc/guix.texi:19473 doc/guix.texi:19481
26823 msgid "Defaults to @samp{\"\"}."
26827 #: doc/guix.texi:11963
26829 msgid "{@code{cups-configuration} parameter} boolean classify-override?"
26833 #: doc/guix.texi:11966
26835 "Specifies whether users may override the classification (cover page) of "
26836 "individual print jobs using the @code{job-sheets} option."
26840 #: doc/guix.texi:11970
26842 msgid "{@code{cups-configuration} parameter} default-auth-type default-auth-type"
26846 #: doc/guix.texi:11972
26847 msgid "Specifies the default type of authentication to use."
26851 #: doc/guix.texi:11974
26852 msgid "Defaults to @samp{Basic}."
26856 #: doc/guix.texi:11976
26858 msgid "{@code{cups-configuration} parameter} default-encryption default-encryption"
26862 #: doc/guix.texi:11978
26863 msgid "Specifies whether encryption will be used for authenticated requests."
26867 #: doc/guix.texi:11980
26868 msgid "Defaults to @samp{Required}."
26872 #: doc/guix.texi:11982
26874 msgid "{@code{cups-configuration} parameter} string default-language"
26878 #: doc/guix.texi:11984
26879 msgid "Specifies the default language to use for text and web content."
26883 #: doc/guix.texi:11986
26884 msgid "Defaults to @samp{\"en\"}."
26888 #: doc/guix.texi:11988
26890 msgid "{@code{cups-configuration} parameter} string default-paper-size"
26894 #: doc/guix.texi:11993
26896 "Specifies the default paper size for new print queues. @samp{\"Auto\"} uses "
26897 "a locale-specific default, while @samp{\"None\"} specifies there is no "
26898 "default paper size. Specific size names are typically @samp{\"Letter\"} or "
26903 #: doc/guix.texi:11995
26904 msgid "Defaults to @samp{\"Auto\"}."
26908 #: doc/guix.texi:11997
26910 msgid "{@code{cups-configuration} parameter} string default-policy"
26914 #: doc/guix.texi:11999
26915 msgid "Specifies the default access policy to use."
26919 #: doc/guix.texi:12001
26920 msgid "Defaults to @samp{\"default\"}."
26924 #: doc/guix.texi:12003
26926 msgid "{@code{cups-configuration} parameter} boolean default-shared?"
26930 #: doc/guix.texi:12005
26931 msgid "Specifies whether local printers are shared by default."
26935 #: doc/guix.texi:12007 doc/guix.texi:12087 doc/guix.texi:12383
26936 #: doc/guix.texi:16576 doc/guix.texi:16583 doc/guix.texi:16591
26937 #: doc/guix.texi:16613 doc/guix.texi:16627 doc/guix.texi:16712
26938 #: doc/guix.texi:16719 doc/guix.texi:16727 doc/guix.texi:17113
26939 #: doc/guix.texi:17253 doc/guix.texi:17439 doc/guix.texi:17446
26940 #: doc/guix.texi:17468 doc/guix.texi:17507 doc/guix.texi:17527
26941 #: doc/guix.texi:17541 doc/guix.texi:17681 doc/guix.texi:18714
26942 #: doc/guix.texi:18802 doc/guix.texi:18818 doc/guix.texi:18868
26943 msgid "Defaults to @samp{#t}."
26947 #: doc/guix.texi:12009
26949 msgid "{@code{cups-configuration} parameter} non-negative-integer dirty-clean-interval"
26953 #: doc/guix.texi:12013
26955 "Specifies the delay for updating of configuration and state files, in "
26956 "seconds. A value of 0 causes the update to happen as soon as possible, "
26957 "typically within a few milliseconds."
26961 #: doc/guix.texi:12015 doc/guix.texi:12063 doc/guix.texi:12072
26962 #: doc/guix.texi:12093 doc/guix.texi:12390
26963 msgid "Defaults to @samp{30}."
26967 #: doc/guix.texi:12017
26969 msgid "{@code{cups-configuration} parameter} error-policy error-policy"
26973 #: doc/guix.texi:12023
26975 "Specifies what to do when an error occurs. Possible values are @code{abort-"
26976 "job}, which will discard the failed print job; @code{retry-job}, which will "
26977 "retry the job at a later time; @code{retry-this-job}, which retries the "
26978 "failed job immediately; and @code{stop-printer}, which stops the printer."
26982 #: doc/guix.texi:12025
26983 msgid "Defaults to @samp{stop-printer}."
26987 #: doc/guix.texi:12027
26989 msgid "{@code{cups-configuration} parameter} non-negative-integer filter-limit"
26993 #: doc/guix.texi:12035
26995 "Specifies the maximum cost of filters that are run concurrently, which can "
26996 "be used to minimize disk, memory, and CPU resource problems. A limit of 0 "
26997 "disables filter limiting. An average print to a non-PostScript printer "
26998 "needs a filter limit of about 200. A PostScript printer needs about half "
26999 "that (100). Setting the limit below these thresholds will effectively limit "
27000 "the scheduler to printing a single job at any time."
27004 #: doc/guix.texi:12037 doc/guix.texi:12045 doc/guix.texi:12100
27005 #: doc/guix.texi:12216 doc/guix.texi:12230 doc/guix.texi:12237
27006 #: doc/guix.texi:13761 doc/guix.texi:13773 doc/guix.texi:17129
27007 #: doc/guix.texi:17454 doc/guix.texi:18707 doc/guix.texi:19007
27008 #: doc/guix.texi:19181
27009 msgid "Defaults to @samp{0}."
27013 #: doc/guix.texi:12039
27015 msgid "{@code{cups-configuration} parameter} non-negative-integer filter-nice"
27019 #: doc/guix.texi:12043
27021 "Specifies the scheduling priority of filters that are run to print a job. "
27022 "The nice value ranges from 0, the highest priority, to 19, the lowest "
27027 #: doc/guix.texi:12047
27029 msgid "{@code{cups-configuration} parameter} host-name-lookups host-name-lookups"
27033 #: doc/guix.texi:12054
27035 "Specifies whether to do reverse lookups on connecting clients. The "
27036 "@code{double} setting causes @code{cupsd} to verify that the hostname "
27037 "resolved from the address matches one of the addresses returned for that "
27038 "hostname. Double lookups also prevent clients with unregistered addresses "
27039 "from connecting to your server. Only set this option to @code{#t} or "
27040 "@code{double} if absolutely required."
27044 #: doc/guix.texi:12058
27046 msgid "{@code{cups-configuration} parameter} non-negative-integer job-kill-delay"
27050 #: doc/guix.texi:12061
27052 "Specifies the number of seconds to wait before killing the filters and "
27053 "backend associated with a canceled or held job."
27057 #: doc/guix.texi:12065
27059 msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-interval"
27063 #: doc/guix.texi:12070
27065 "Specifies the interval between retries of jobs in seconds. This is "
27066 "typically used for fax queues but can also be used with normal print queues "
27067 "whose error policy is @code{retry-job} or @code{retry-current-job}."
27071 #: doc/guix.texi:12074
27073 msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-limit"
27077 #: doc/guix.texi:12079
27079 "Specifies the number of retries that are done for jobs. This is typically "
27080 "used for fax queues but can also be used with normal print queues whose "
27081 "error policy is @code{retry-job} or @code{retry-current-job}."
27085 #: doc/guix.texi:12081 doc/guix.texi:17933 doc/guix.texi:17953
27086 #: doc/guix.texi:17969 doc/guix.texi:17983 doc/guix.texi:17990
27087 #: doc/guix.texi:17997 doc/guix.texi:18004 doc/guix.texi:18163
27088 #: doc/guix.texi:18179 doc/guix.texi:18186 doc/guix.texi:18193
27089 #: doc/guix.texi:18204 doc/guix.texi:18659 doc/guix.texi:18667
27090 #: doc/guix.texi:18675 doc/guix.texi:18699
27091 msgid "Defaults to @samp{5}."
27095 #: doc/guix.texi:12083
27097 msgid "{@code{cups-configuration} parameter} boolean keep-alive?"
27101 #: doc/guix.texi:12085
27102 msgid "Specifies whether to support HTTP keep-alive connections."
27106 #: doc/guix.texi:12089
27108 msgid "{@code{cups-configuration} parameter} non-negative-integer keep-alive-timeout"
27112 #: doc/guix.texi:12091
27113 msgid "Specifies how long an idle client connection remains open, in seconds."
27117 #: doc/guix.texi:12095
27119 msgid "{@code{cups-configuration} parameter} non-negative-integer limit-request-body"
27123 #: doc/guix.texi:12098
27125 "Specifies the maximum size of print files, IPP requests, and HTML form "
27126 "data. A limit of 0 disables the limit check."
27130 #: doc/guix.texi:12102
27132 msgid "{@code{cups-configuration} parameter} multiline-string-list listen"
27136 #: doc/guix.texi:12109
27138 "Listens on the specified interfaces for connections. Valid values are of "
27139 "the form @var{address}:@var{port}, where @var{address} is either an IPv6 "
27140 "address enclosed in brackets, an IPv4 address, or @code{*} to indicate all "
27141 "addresses. Values can also be file names of local UNIX domain sockets. The "
27142 "Listen directive is similar to the Port directive but allows you to restrict "
27143 "access to specific interfaces or networks."
27147 #: doc/guix.texi:12111
27149 msgid "{@code{cups-configuration} parameter} non-negative-integer listen-back-log"
27153 #: doc/guix.texi:12118
27155 "Specifies the number of pending connections that will be allowed. This "
27156 "normally only affects very busy servers that have reached the MaxClients "
27157 "limit, but can also be triggered by large numbers of simultaneous "
27158 "connections. When the limit is reached, the operating system will refuse "
27159 "additional connections until the scheduler can accept the pending ones."
27163 #: doc/guix.texi:12120
27164 msgid "Defaults to @samp{128}."
27168 #: doc/guix.texi:12122
27170 msgid "{@code{cups-configuration} parameter} location-access-control-list location-access-controls"
27174 #: doc/guix.texi:12124
27175 msgid "Specifies a set of additional access controls."
27179 #: doc/guix.texi:12126
27180 msgid "Available @code{location-access-controls} fields are:"
27184 #: doc/guix.texi:12127
27186 msgid "{@code{location-access-controls} parameter} file-name path"
27190 #: doc/guix.texi:12129
27191 msgid "Specifies the URI path to which the access control applies."
27195 #: doc/guix.texi:12131
27197 msgid "{@code{location-access-controls} parameter} access-control-list access-controls"
27201 #: doc/guix.texi:12134
27203 "Access controls for all access to this path, in the same format as the "
27204 "@code{access-controls} of @code{operation-access-control}."
27208 #: doc/guix.texi:12136 doc/guix.texi:12142 doc/guix.texi:12156
27209 #: doc/guix.texi:12163 doc/guix.texi:12305 doc/guix.texi:12364
27210 #: doc/guix.texi:12448 doc/guix.texi:12459 doc/guix.texi:14247
27211 #: doc/guix.texi:16634 doc/guix.texi:16822 doc/guix.texi:17824
27212 #: doc/guix.texi:17884 doc/guix.texi:17892 doc/guix.texi:18722
27213 #: doc/guix.texi:18729 doc/guix.texi:19071 doc/guix.texi:19149
27214 #: doc/guix.texi:19243 doc/guix.texi:19251 doc/guix.texi:19287
27215 #: doc/guix.texi:19437 doc/guix.texi:19488 doc/guix.texi:19497
27216 msgid "Defaults to @samp{()}."
27220 #: doc/guix.texi:12138
27222 msgid "{@code{location-access-controls} parameter} method-access-control-list method-access-controls"
27226 #: doc/guix.texi:12140
27227 msgid "Access controls for method-specific access to this path."
27231 #: doc/guix.texi:12144
27232 msgid "Available @code{method-access-controls} fields are:"
27236 #: doc/guix.texi:12145
27238 msgid "{@code{method-access-controls} parameter} boolean reverse?"
27242 #: doc/guix.texi:12148
27244 "If @code{#t}, apply access controls to all methods except the listed "
27245 "methods. Otherwise apply to only the listed methods."
27249 #: doc/guix.texi:12152
27251 msgid "{@code{method-access-controls} parameter} method-list methods"
27255 #: doc/guix.texi:12154
27256 msgid "Methods to which this access control applies."
27260 #: doc/guix.texi:12158
27262 msgid "{@code{method-access-controls} parameter} access-control-list access-controls"
27266 #: doc/guix.texi:12161
27268 "Access control directives, as a list of strings. Each string should be one "
27269 "directive, such as \"Order allow,deny\"."
27273 #: doc/guix.texi:12167
27275 msgid "{@code{cups-configuration} parameter} non-negative-integer log-debug-history"
27279 #: doc/guix.texi:12171
27281 "Specifies the number of debugging messages that are retained for logging if "
27282 "an error occurs in a print job. Debug messages are logged regardless of the "
27283 "LogLevel setting."
27287 #: doc/guix.texi:12173 doc/guix.texi:12194 doc/guix.texi:12201
27288 #: doc/guix.texi:14007 doc/guix.texi:16807
27289 msgid "Defaults to @samp{100}."
27293 #: doc/guix.texi:12175
27295 msgid "{@code{cups-configuration} parameter} log-level log-level"
27299 #: doc/guix.texi:12178
27301 "Specifies the level of logging for the ErrorLog file. The value @code{none} "
27302 "stops all logging while @code{debug2} logs everything."
27306 #: doc/guix.texi:12180
27307 msgid "Defaults to @samp{info}."
27311 #: doc/guix.texi:12182
27313 msgid "{@code{cups-configuration} parameter} log-time-format log-time-format"
27317 #: doc/guix.texi:12185
27319 "Specifies the format of the date and time in the log files. The value "
27320 "@code{standard} logs whole seconds while @code{usecs} logs microseconds."
27324 #: doc/guix.texi:12187
27325 msgid "Defaults to @samp{standard}."
27329 #: doc/guix.texi:12189
27331 msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients"
27335 #: doc/guix.texi:12192
27337 "Specifies the maximum number of simultaneous clients that are allowed by the "
27342 #: doc/guix.texi:12196
27344 msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients-per-host"
27348 #: doc/guix.texi:12199
27350 "Specifies the maximum number of simultaneous clients that are allowed from a "
27355 #: doc/guix.texi:12203
27357 msgid "{@code{cups-configuration} parameter} non-negative-integer max-copies"
27361 #: doc/guix.texi:12206
27363 "Specifies the maximum number of copies that a user can print of each job."
27367 #: doc/guix.texi:12208
27368 msgid "Defaults to @samp{9999}."
27372 #: doc/guix.texi:12210
27374 msgid "{@code{cups-configuration} parameter} non-negative-integer max-hold-time"
27378 #: doc/guix.texi:12214
27380 "Specifies the maximum time a job may remain in the @code{indefinite} hold "
27381 "state before it is canceled. A value of 0 disables cancellation of held "
27386 #: doc/guix.texi:12218
27388 msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs"
27392 #: doc/guix.texi:12221
27394 "Specifies the maximum number of simultaneous jobs that are allowed. Set to "
27395 "0 to allow an unlimited number of jobs."
27399 #: doc/guix.texi:12223
27400 msgid "Defaults to @samp{500}."
27404 #: doc/guix.texi:12225
27406 msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-printer"
27410 #: doc/guix.texi:12228
27412 "Specifies the maximum number of simultaneous jobs that are allowed per "
27413 "printer. A value of 0 allows up to MaxJobs jobs per printer."
27417 #: doc/guix.texi:12232
27419 msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-user"
27423 #: doc/guix.texi:12235
27425 "Specifies the maximum number of simultaneous jobs that are allowed per "
27426 "user. A value of 0 allows up to MaxJobs jobs per user."
27430 #: doc/guix.texi:12239
27432 msgid "{@code{cups-configuration} parameter} non-negative-integer max-job-time"
27436 #: doc/guix.texi:12242
27438 "Specifies the maximum time a job may take to print before it is canceled, in "
27439 "seconds. Set to 0 to disable cancellation of \"stuck\" jobs."
27443 #: doc/guix.texi:12244
27444 msgid "Defaults to @samp{10800}."
27448 #: doc/guix.texi:12246
27450 msgid "{@code{cups-configuration} parameter} non-negative-integer max-log-size"
27454 #: doc/guix.texi:12249
27456 "Specifies the maximum size of the log files before they are rotated, in "
27457 "bytes. The value 0 disables log rotation."
27461 #: doc/guix.texi:12251
27462 msgid "Defaults to @samp{1048576}."
27466 #: doc/guix.texi:12253
27468 msgid "{@code{cups-configuration} parameter} non-negative-integer multiple-operation-timeout"
27472 #: doc/guix.texi:12256
27474 "Specifies the maximum amount of time to allow between files in a multiple "
27475 "file print job, in seconds."
27479 #: doc/guix.texi:12258 doc/guix.texi:12472
27480 msgid "Defaults to @samp{300}."
27484 #: doc/guix.texi:12260
27486 msgid "{@code{cups-configuration} parameter} string page-log-format"
27490 #: doc/guix.texi:12265
27492 "Specifies the format of PageLog lines. Sequences beginning with percent "
27493 "(@samp{%}) characters are replaced with the corresponding information, while "
27494 "all other characters are copied literally. The following percent sequences "
27499 #: doc/guix.texi:12267
27505 #: doc/guix.texi:12269
27506 msgid "insert a single percent character"
27510 #: doc/guix.texi:12270
27516 #: doc/guix.texi:12272
27517 msgid "insert the value of the specified IPP attribute"
27521 #: doc/guix.texi:12273
27527 #: doc/guix.texi:12275
27528 msgid "insert the number of copies for the current page"
27532 #: doc/guix.texi:12276
27538 #: doc/guix.texi:12278
27539 msgid "insert the current page number"
27543 #: doc/guix.texi:12279
27549 #: doc/guix.texi:12281
27550 msgid "insert the current date and time in common log format"
27554 #: doc/guix.texi:12282
27560 #: doc/guix.texi:12284
27561 msgid "insert the job ID"
27565 #: doc/guix.texi:12285 doc/guix.texi:13617
27571 #: doc/guix.texi:12287
27572 msgid "insert the printer name"
27576 #: doc/guix.texi:12288 doc/guix.texi:13640
27582 #: doc/guix.texi:12290
27583 msgid "insert the username"
27587 #: doc/guix.texi:12296
27589 "A value of the empty string disables page logging. The string @code{%p %u "
27590 "%j %T %P %C %@{job-billing@} %@{job-originating-host-name@} %@{job-name@} "
27591 "%@{media@} %@{sides@}} creates a page log with the standard items."
27595 #: doc/guix.texi:12300
27597 msgid "{@code{cups-configuration} parameter} environment-variables environment-variables"
27601 #: doc/guix.texi:12303
27603 "Passes the specified environment variable(s) to child processes; a list of "
27608 #: doc/guix.texi:12307
27610 msgid "{@code{cups-configuration} parameter} policy-configuration-list policies"
27614 #: doc/guix.texi:12309
27615 msgid "Specifies named access control policies."
27619 #: doc/guix.texi:12311
27620 msgid "Available @code{policy-configuration} fields are:"
27624 #: doc/guix.texi:12312
27626 msgid "{@code{policy-configuration} parameter} string name"
27630 #: doc/guix.texi:12314
27631 msgid "Name of the policy."
27635 #: doc/guix.texi:12316
27637 msgid "{@code{policy-configuration} parameter} string job-private-access"
27641 #: doc/guix.texi:12326
27643 "Specifies an access list for a job's private values. @code{@@ACL} maps to "
27644 "the printer's requesting-user-name-allowed or requesting-user-name-denied "
27645 "values. @code{@@OWNER} maps to the job's owner. @code{@@SYSTEM} maps to "
27646 "the groups listed for the @code{system-group} field of the @code{files-"
27647 "config} configuration, which is reified into the @code{cups-files.conf(5)} "
27648 "file. Other possible elements of the access list include specific user "
27649 "names, and @code{@@@var{group}} to indicate members of a specific group. "
27650 "The access list may also be simply @code{all} or @code{default}."
27654 #: doc/guix.texi:12328 doc/guix.texi:12350
27655 msgid "Defaults to @samp{\"@@OWNER @@SYSTEM\"}."
27659 #: doc/guix.texi:12330
27661 msgid "{@code{policy-configuration} parameter} string job-private-values"
27665 #: doc/guix.texi:12333 doc/guix.texi:12355
27667 "Specifies the list of job values to make private, or @code{all}, "
27668 "@code{default}, or @code{none}."
27672 #: doc/guix.texi:12336
27674 "Defaults to @samp{\"job-name job-originating-host-name job-originating-user-"
27679 #: doc/guix.texi:12338
27681 msgid "{@code{policy-configuration} parameter} string subscription-private-access"
27685 #: doc/guix.texi:12348
27687 "Specifies an access list for a subscription's private values. @code{@@ACL} "
27688 "maps to the printer's requesting-user-name-allowed or requesting-user-name-"
27689 "denied values. @code{@@OWNER} maps to the job's owner. @code{@@SYSTEM} "
27690 "maps to the groups listed for the @code{system-group} field of the "
27691 "@code{files-config} configuration, which is reified into the @code{cups-"
27692 "files.conf(5)} file. Other possible elements of the access list include "
27693 "specific user names, and @code{@@@var{group}} to indicate members of a "
27694 "specific group. The access list may also be simply @code{all} or "
27699 #: doc/guix.texi:12352
27701 msgid "{@code{policy-configuration} parameter} string subscription-private-values"
27705 #: doc/guix.texi:12358
27707 "Defaults to @samp{\"notify-events notify-pull-method notify-recipient-uri "
27708 "notify-subscriber-user-name notify-user-data\"}."
27712 #: doc/guix.texi:12360
27714 msgid "{@code{policy-configuration} parameter} operation-access-control-list access-controls"
27718 #: doc/guix.texi:12362
27719 msgid "Access control by IPP operation."
27723 #: doc/guix.texi:12367
27725 msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-files"
27729 #: doc/guix.texi:12372
27731 "Specifies whether job files (documents) are preserved after a job is "
27732 "printed. If a numeric value is specified, job files are preserved for the "
27733 "indicated number of seconds after printing. Otherwise a boolean value "
27734 "applies indefinitely."
27738 #: doc/guix.texi:12374
27739 msgid "Defaults to @samp{86400}."
27743 #: doc/guix.texi:12376
27745 msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-history"
27749 #: doc/guix.texi:12381
27751 "Specifies whether the job history is preserved after a job is printed. If a "
27752 "numeric value is specified, the job history is preserved for the indicated "
27753 "number of seconds after printing. If @code{#t}, the job history is "
27754 "preserved until the MaxJobs limit is reached."
27758 #: doc/guix.texi:12385
27760 msgid "{@code{cups-configuration} parameter} non-negative-integer reload-timeout"
27764 #: doc/guix.texi:12388
27766 "Specifies the amount of time to wait for job completion before restarting "
27771 #: doc/guix.texi:12392
27773 msgid "{@code{cups-configuration} parameter} string rip-cache"
27777 #: doc/guix.texi:12395
27779 "Specifies the maximum amount of memory to use when converting documents into "
27780 "bitmaps for a printer."
27784 #: doc/guix.texi:12397
27785 msgid "Defaults to @samp{\"128m\"}."
27789 #: doc/guix.texi:12399
27791 msgid "{@code{cups-configuration} parameter} string server-admin"
27795 #: doc/guix.texi:12401
27796 msgid "Specifies the email address of the server administrator."
27800 #: doc/guix.texi:12403
27801 msgid "Defaults to @samp{\"root@@localhost.localdomain\"}."
27805 #: doc/guix.texi:12405
27807 msgid "{@code{cups-configuration} parameter} host-name-list-or-* server-alias"
27811 #: doc/guix.texi:12413
27813 "The ServerAlias directive is used for HTTP Host header validation when "
27814 "clients connect to the scheduler from external interfaces. Using the "
27815 "special name @code{*} can expose your system to known browser-based DNS "
27816 "rebinding attacks, even when accessing sites through a firewall. If the "
27817 "auto-discovery of alternate names does not work, we recommend listing each "
27818 "alternate name with a ServerAlias directive instead of using @code{*}."
27822 #: doc/guix.texi:12415
27823 msgid "Defaults to @samp{*}."
27827 #: doc/guix.texi:12417
27829 msgid "{@code{cups-configuration} parameter} string server-name"
27833 #: doc/guix.texi:12419
27834 msgid "Specifies the fully-qualified host name of the server."
27838 #: doc/guix.texi:12421
27839 msgid "Defaults to @samp{\"localhost\"}."
27843 #: doc/guix.texi:12423
27845 msgid "{@code{cups-configuration} parameter} server-tokens server-tokens"
27849 #: doc/guix.texi:12431
27851 "Specifies what information is included in the Server header of HTTP "
27852 "responses. @code{None} disables the Server header. @code{ProductOnly} "
27853 "reports @code{CUPS}. @code{Major} reports @code{CUPS 2}. @code{Minor} "
27854 "reports @code{CUPS 2.0}. @code{Minimal} reports @code{CUPS 2.0.0}. "
27855 "@code{OS} reports @code{CUPS 2.0.0 (@var{uname})} where @var{uname} is the "
27856 "output of the @code{uname} command. @code{Full} reports @code{CUPS 2.0.0 "
27857 "(@var{uname}) IPP/2.0}."
27861 #: doc/guix.texi:12433
27862 msgid "Defaults to @samp{Minimal}."
27866 #: doc/guix.texi:12435
27868 msgid "{@code{cups-configuration} parameter} string set-env"
27872 #: doc/guix.texi:12437
27873 msgid "Set the specified environment variable to be passed to child processes."
27877 #: doc/guix.texi:12439
27878 msgid "Defaults to @samp{\"variable value\"}."
27882 #: doc/guix.texi:12441
27884 msgid "{@code{cups-configuration} parameter} multiline-string-list ssl-listen"
27888 #: doc/guix.texi:12446
27890 "Listens on the specified interfaces for encrypted connections. Valid values "
27891 "are of the form @var{address}:@var{port}, where @var{address} is either an "
27892 "IPv6 address enclosed in brackets, an IPv4 address, or @code{*} to indicate "
27897 #: doc/guix.texi:12450
27899 msgid "{@code{cups-configuration} parameter} ssl-options ssl-options"
27903 #: doc/guix.texi:12457
27905 "Sets encryption options. By default, CUPS only supports encryption using "
27906 "TLS v1.0 or higher using known secure cipher suites. The @code{AllowRC4} "
27907 "option enables the 128-bit RC4 cipher suites, which are required for some "
27908 "older clients that do not implement newer ones. The @code{AllowSSL3} option "
27909 "enables SSL v3.0, which is required for some older clients that do not "
27910 "support TLS v1.0."
27914 #: doc/guix.texi:12461
27916 msgid "{@code{cups-configuration} parameter} boolean strict-conformance?"
27920 #: doc/guix.texi:12464
27922 "Specifies whether the scheduler requires clients to strictly adhere to the "
27923 "IPP specifications."
27927 #: doc/guix.texi:12468
27929 msgid "{@code{cups-configuration} parameter} non-negative-integer timeout"
27933 #: doc/guix.texi:12470
27934 msgid "Specifies the HTTP request timeout, in seconds."
27938 #: doc/guix.texi:12475
27940 msgid "{@code{cups-configuration} parameter} boolean web-interface?"
27944 #: doc/guix.texi:12477
27945 msgid "Specifies whether the web interface is enabled."
27948 #. type: Plain text
27949 #: doc/guix.texi:12487
27951 "At this point you're probably thinking ``oh dear, Guix manual, I like you "
27952 "but you can stop already with the configuration options''. Indeed. "
27953 "However, one more point: it could be that you have an existing @code{cupsd."
27954 "conf} that you want to use. In that case, you can pass an @code{opaque-cups-"
27955 "configuration} as the configuration of a @code{cups-service-type}."
27958 #. type: Plain text
27959 #: doc/guix.texi:12489
27960 msgid "Available @code{opaque-cups-configuration} fields are:"
27964 #: doc/guix.texi:12490
27966 msgid "{@code{opaque-cups-configuration} parameter} package cups"
27970 #: doc/guix.texi:12494
27972 msgid "{@code{opaque-cups-configuration} parameter} string cupsd.conf"
27976 #: doc/guix.texi:12496
27977 msgid "The contents of the @code{cupsd.conf}, as a string."
27981 #: doc/guix.texi:12498
27983 msgid "{@code{opaque-cups-configuration} parameter} string cups-files.conf"
27987 #: doc/guix.texi:12500
27988 msgid "The contents of the @code{cups-files.conf} file, as a string."
27991 #. type: Plain text
27992 #: doc/guix.texi:12505
27994 "For example, if your @code{cupsd.conf} and @code{cups-files.conf} are in "
27995 "strings of the same name, you could instantiate a CUPS service like this:"
27999 #: doc/guix.texi:12511
28002 "(service cups-service-type\n"
28003 " (opaque-cups-configuration\n"
28004 " (cupsd.conf cupsd.conf)\n"
28005 " (cups-files.conf cups-files.conf)))\n"
28008 #. type: Plain text
28009 #: doc/guix.texi:12522
28011 "The @code{(gnu services desktop)} module provides services that are usually "
28012 "useful in the context of a ``desktop'' setup---that is, on a machine running "
28013 "a graphical display server, possibly with graphical user interfaces, etc. "
28014 "It also defines services that provide specific desktop environments like "
28015 "GNOME, XFCE or MATE."
28018 #. type: Plain text
28019 #: doc/guix.texi:12526
28021 "To simplify things, the module defines a variable containing the set of "
28022 "services that users typically expect on a machine with a graphical "
28023 "environment and networking:"
28027 #: doc/guix.texi:12527
28029 msgid "{Scheme Variable} %desktop-services"
28033 #: doc/guix.texi:12530
28035 "This is a list of services that builds upon @var{%base-services} and adds or "
28036 "adjusts services for a typical ``desktop'' setup."
28040 #: doc/guix.texi:12540
28042 "In particular, it adds a graphical login manager (@pxref{X Window, "
28043 "@code{slim-service}}), screen lockers, a network management tool "
28044 "(@pxref{Networking Services, @code{network-manager-service-type}}), energy "
28045 "and color management services, the @code{elogind} login and seat manager, "
28046 "the Polkit privilege service, the GeoClue location service, the "
28047 "AccountsService daemon that allows authorized users change system passwords, "
28048 "an NTP client (@pxref{Networking Services}), the Avahi daemon, and has the "
28049 "name service switch service configured to be able to use @code{nss-mdns} "
28050 "(@pxref{Name Service Switch, mDNS})."
28053 #. type: Plain text
28054 #: doc/guix.texi:12545
28056 "The @var{%desktop-services} variable can be used as the @code{services} "
28057 "field of an @code{operating-system} declaration (@pxref{operating-system "
28058 "Reference, @code{services}})."
28061 #. type: Plain text
28062 #: doc/guix.texi:12565
28064 "Additionally, the @code{gnome-desktop-service}, @code{xfce-desktop-service} "
28065 "and @code{mate-desktop-service} procedures can add GNOME, XFCE and/or MATE "
28066 "to a system. To ``add GNOME'' means that system-level services like the "
28067 "backlight adjustment helpers and the power management utilities are added to "
28068 "the system, extending @code{polkit} and @code{dbus} appropriately, allowing "
28069 "GNOME to operate with elevated privileges on a limited number of special-"
28070 "purpose system interfaces. Additionally, adding a service made by "
28071 "@code{gnome-desktop-service} adds the GNOME metapackage to the system "
28072 "profile. Likewise, adding the XFCE service not only adds the @code{xfce} "
28073 "metapackage to the system profile, but it also gives the Thunar file manager "
28074 "the ability to open a ``root-mode'' file management window, if the user "
28075 "authenticates using the administrator's password via the standard polkit "
28076 "graphical interface. To ``add MATE'' means that @code{polkit} and "
28077 "@code{dbus} are extended appropriately, allowing MATE to operate with "
28078 "elevated privileges on a limited number of special-purpose system "
28079 "interfaces. Additionally, adding a service made by @code{mate-desktop-"
28080 "service} adds the MATE metapackage to the system profile."
28083 #. type: Plain text
28084 #: doc/guix.texi:12574
28086 "The desktop environments in Guix use the Xorg display server by default. If "
28087 "you'd like to use the newer display server protocol called Wayland, you need "
28088 "to use the @code{sddm-service} instead of the @code{slim-service} for the "
28089 "graphical login manager. You should then select the ``GNOME (Wayland)'' "
28090 "session in SDDM. Alternatively you can also try starting GNOME on Wayland "
28091 "manually from a TTY with the command ``XDG_SESSION_TYPE=wayland exec dbus-"
28092 "run-session gnome-session``. Currently only GNOME has support for Wayland."
28096 #: doc/guix.texi:12575
28098 msgid "{Scheme Procedure} gnome-desktop-service"
28102 #: doc/guix.texi:12579
28104 "Return a service that adds the @code{gnome} package to the system profile, "
28105 "and extends polkit with the actions from @code{gnome-settings-daemon}."
28109 #: doc/guix.texi:12581
28111 msgid "{Scheme Procedure} xfce-desktop-service"
28115 #: doc/guix.texi:12586
28117 "Return a service that adds the @code{xfce} package to the system profile, "
28118 "and extends polkit with the ability for @code{thunar} to manipulate the file "
28119 "system as root from within a user session, after the user has authenticated "
28120 "with the administrator's password."
28124 #: doc/guix.texi:12588
28126 msgid "{Scheme Procedure} mate-desktop-service"
28130 #: doc/guix.texi:12592
28132 "Return a service that adds the @code{mate} package to the system profile, "
28133 "and extends polkit with the actions from @code{mate-settings-daemon}."
28136 #. type: Plain text
28137 #: doc/guix.texi:12599
28139 "Because the GNOME, XFCE and MATE desktop services pull in so many packages, "
28140 "the default @code{%desktop-services} variable doesn't include either of them "
28141 "by default. To add GNOME, XFCE or MATE, just @code{cons} them onto "
28142 "@code{%desktop-services} in the @code{services} field of your "
28143 "@code{operating-system}:"
28147 #: doc/guix.texi:12610
28150 "(use-modules (gnu))\n"
28151 "(use-service-modules desktop)\n"
28152 "(operating-system\n"
28154 " ;; cons* adds items to the list given as its last argument.\n"
28155 " (services (cons* (gnome-desktop-service)\n"
28156 " (xfce-desktop-service)\n"
28157 " %desktop-services))\n"
28161 #. type: Plain text
28162 #: doc/guix.texi:12614
28164 "These desktop environments will then be available as options in the "
28165 "graphical login window."
28168 #. type: Plain text
28169 #: doc/guix.texi:12618
28171 "The actual service definitions included in @code{%desktop-services} and "
28172 "provided by @code{(gnu services dbus)} and @code{(gnu services desktop)} are "
28177 #: doc/guix.texi:12619
28179 msgid "{Scheme Procedure} dbus-service [#:dbus @var{dbus}] [#:services '()]"
28183 #: doc/guix.texi:12622
28185 "Return a service that runs the ``system bus'', using @var{dbus}, with "
28186 "support for @var{services}."
28190 #: doc/guix.texi:12626
28192 "@uref{http://dbus.freedesktop.org/, D-Bus} is an inter-process communication "
28193 "facility. Its system bus is used to allow system services to communicate "
28194 "and to be notified of system-wide events."
28198 #: doc/guix.texi:12631
28200 "@var{services} must be a list of packages that provide an @file{etc/dbus-1/"
28201 "system.d} directory containing additional D-Bus configuration and policy "
28202 "files. For example, to allow avahi-daemon to use the system bus, "
28203 "@var{services} must be equal to @code{(list avahi)}."
28207 #: doc/guix.texi:12633
28209 msgid "{Scheme Procedure} elogind-service [#:config @var{config}]"
28213 #: doc/guix.texi:12639
28215 "Return a service that runs the @code{elogind} login and seat management "
28216 "daemon. @uref{https://github.com/elogind/elogind, Elogind} exposes a D-Bus "
28217 "interface that can be used to know which users are logged in, know what kind "
28218 "of sessions they have open, suspend the system, inhibit system suspend, "
28219 "reboot the system, and other tasks."
28223 #: doc/guix.texi:12643
28225 "Elogind handles most system-level power events for a computer, for example "
28226 "suspending the system when a lid is closed, or shutting it down when the "
28227 "power button is pressed."
28231 #: doc/guix.texi:12648
28233 "The @var{config} keyword argument specifies the configuration for elogind, "
28234 "and should be the result of an @code{(elogind-configuration (@var{parameter} "
28235 "@var{value})...)} invocation. Available parameters and their default values "
28240 #: doc/guix.texi:12650
28242 msgid "kill-user-processes?"
28246 #: doc/guix.texi:12652 doc/guix.texi:12670 doc/guix.texi:12672
28247 #: doc/guix.texi:12674 doc/guix.texi:12686
28252 #: doc/guix.texi:12652
28254 msgid "kill-only-users"
28258 #: doc/guix.texi:12654 doc/guix.texi:12692
28263 #: doc/guix.texi:12654
28265 msgid "kill-exclude-users"
28269 #: doc/guix.texi:12656
28274 #: doc/guix.texi:12656
28276 msgid "inhibit-delay-max-seconds"
28280 #: doc/guix.texi:12658
28285 #: doc/guix.texi:12658
28287 msgid "handle-power-key"
28291 #: doc/guix.texi:12660
28296 #: doc/guix.texi:12660
28298 msgid "handle-suspend-key"
28302 #: doc/guix.texi:12662 doc/guix.texi:12666
28307 #: doc/guix.texi:12662
28309 msgid "handle-hibernate-key"
28313 #: doc/guix.texi:12664
28318 #: doc/guix.texi:12664
28320 msgid "handle-lid-switch"
28324 #: doc/guix.texi:12666
28326 msgid "handle-lid-switch-docked"
28330 #: doc/guix.texi:12668 doc/guix.texi:12680
28335 #: doc/guix.texi:12668
28337 msgid "power-key-ignore-inhibited?"
28341 #: doc/guix.texi:12670
28343 msgid "suspend-key-ignore-inhibited?"
28347 #: doc/guix.texi:12672
28349 msgid "hibernate-key-ignore-inhibited?"
28353 #: doc/guix.texi:12674
28355 msgid "lid-switch-ignore-inhibited?"
28359 #: doc/guix.texi:12676 doc/guix.texi:12688
28364 #: doc/guix.texi:12676
28366 msgid "holdoff-timeout-seconds"
28370 #: doc/guix.texi:12678
28375 #: doc/guix.texi:12678
28377 msgid "idle-action"
28381 #: doc/guix.texi:12680
28383 msgid "idle-action-seconds"
28387 #: doc/guix.texi:12682
28392 #: doc/guix.texi:12682
28394 msgid "runtime-directory-size-percent"
28398 #: doc/guix.texi:12684
28403 #: doc/guix.texi:12684
28405 msgid "runtime-directory-size"
28409 #: doc/guix.texi:12686
28411 msgid "remove-ipc?"
28415 #: doc/guix.texi:12688
28417 msgid "suspend-state"
28421 #: doc/guix.texi:12690
28422 msgid "(\"mem\" \"standby\" \"freeze\")"
28426 #: doc/guix.texi:12690
28428 msgid "suspend-mode"
28432 #: doc/guix.texi:12692
28434 msgid "hibernate-state"
28438 #: doc/guix.texi:12694 doc/guix.texi:12698
28443 #: doc/guix.texi:12694
28445 msgid "hibernate-mode"
28449 #: doc/guix.texi:12696
28450 msgid "(\"platform\" \"shutdown\")"
28454 #: doc/guix.texi:12696
28456 msgid "hybrid-sleep-state"
28460 #: doc/guix.texi:12698
28462 msgid "hybrid-sleep-mode"
28466 #: doc/guix.texi:12700
28467 msgid "(\"suspend\" \"platform\" \"shutdown\")"
28471 #: doc/guix.texi:12703
28473 msgid "{Scheme Procedure} accountsservice-service @"
28477 #: doc/guix.texi:12711
28479 "[#:accountsservice @var{accountsservice}] Return a service that runs "
28480 "AccountsService, a system service that can list available accounts, change "
28481 "their passwords, and so on. AccountsService integrates with PolicyKit to "
28482 "enable unprivileged users to acquire the capability to modify their system "
28483 "configuration. @uref{https://www.freedesktop.org/wiki/Software/"
28484 "AccountsService/, the accountsservice web site} for more information."
28488 #: doc/guix.texi:12714
28490 "The @var{accountsservice} keyword argument is the @code{accountsservice} "
28491 "package to expose as a service."
28495 #: doc/guix.texi:12716
28497 msgid "{Scheme Procedure} polkit-service @"
28501 #: doc/guix.texi:12725
28503 "[#:polkit @var{polkit}] Return a service that runs the @uref{http://www."
28504 "freedesktop.org/wiki/Software/polkit/, Polkit privilege management service}, "
28505 "which allows system administrators to grant access to privileged operations "
28506 "in a structured way. By querying the Polkit service, a privileged system "
28507 "component can know when it should grant additional capabilities to ordinary "
28508 "users. For example, an ordinary user can be granted the capability to "
28509 "suspend the system if the user is logged in locally."
28513 #: doc/guix.texi:12727
28515 msgid "{Scheme Procedure} upower-service [#:upower @var{upower}] @"
28519 #: doc/guix.texi:12744
28521 "[#:watts-up-pro? #f] @ [#:poll-batteries? #t] @ [#:ignore-lid? #f] @ [#:use-"
28522 "percentage-for-policy? #f] @ [#:percentage-low 10] @ [#:percentage-critical "
28523 "3] @ [#:percentage-action 2] @ [#:time-low 1200] @ [#:time-critical 300] @ "
28524 "[#:time-action 120] @ [#:critical-power-action 'hybrid-sleep] Return a "
28525 "service that runs @uref{http://upower.freedesktop.org/, @command{upowerd}}, "
28526 "a system-wide monitor for power consumption and battery levels, with the "
28527 "given configuration settings. It implements the @code{org.freedesktop."
28528 "UPower} D-Bus interface, and is notably used by GNOME."
28532 #: doc/guix.texi:12746
28534 msgid "{Scheme Procedure} udisks-service [#:udisks @var{udisks}]"
28538 #: doc/guix.texi:12751
28540 "Return a service for @uref{http://udisks.freedesktop.org/docs/latest/, "
28541 "UDisks}, a @dfn{disk management} daemon that provides user interfaces with "
28542 "notifications and ways to mount/unmount disks. Programs that talk to UDisks "
28543 "include the @command{udisksctl} command, part of UDisks, and GNOME Disks."
28547 #: doc/guix.texi:12753
28549 msgid "{Scheme Procedure} colord-service [#:colord @var{colord}]"
28553 #: doc/guix.texi:12759
28555 "Return a service that runs @command{colord}, a system service with a D-Bus "
28556 "interface to manage the color profiles of input and output devices such as "
28557 "screens and scanners. It is notably used by the GNOME Color Manager "
28558 "graphical tool. See @uref{http://www.freedesktop.org/software/colord/, the "
28559 "colord web site} for more information."
28563 #: doc/guix.texi:12761
28565 msgid "{Scheme Procedure} geoclue-application name [#:allowed? #t] [#:system? #f] [#:users '()]"
28569 #: doc/guix.texi:12770
28571 "Return a configuration allowing an application to access GeoClue location "
28572 "data. @var{name} is the Desktop ID of the application, without the @code{."
28573 "desktop} part. If @var{allowed?} is true, the application will have access "
28574 "to location information by default. The boolean @var{system?} value "
28575 "indicates whether an application is a system component or not. Finally "
28576 "@var{users} is a list of UIDs of all users for which this application is "
28577 "allowed location info access. An empty users list means that all users are "
28582 #: doc/guix.texi:12772
28584 msgid "{Scheme Variable} %standard-geoclue-applications"
28588 #: doc/guix.texi:12779
28590 "The standard list of well-known GeoClue application configurations, granting "
28591 "authority to the GNOME date-and-time utility to ask for the current location "
28592 "in order to set the time zone, and allowing the IceCat and Epiphany web "
28593 "browsers to request location information. IceCat and Epiphany both query "
28594 "the user before allowing a web page to know the user's location."
28598 #: doc/guix.texi:12781
28600 msgid "{Scheme Procedure} geoclue-service [#:colord @var{colord}] @"
28604 #: doc/guix.texi:12794
28606 "[#:whitelist '()] @ [#:wifi-geolocation-url \"https://location.services."
28607 "mozilla.com/v1/geolocate?key=geoclue\"] @ [#:submit-data? #f] [#:wifi-"
28608 "submission-url \"https://location.services.mozilla.com/v1/submit?key=geoclue"
28609 "\"] @ [#:submission-nick \"geoclue\"] @ [#:applications %standard-geoclue-"
28610 "applications] Return a service that runs the GeoClue location service. This "
28611 "service provides a D-Bus interface to allow applications to request access "
28612 "to a user's physical location, and optionally to add information to online "
28613 "location databases. See @uref{https://wiki.freedesktop.org/www/Software/"
28614 "GeoClue/, the GeoClue web site} for more information."
28618 #: doc/guix.texi:12796
28620 msgid "{Scheme Procedure} bluetooth-service [#:bluez @var{bluez}] @"
28624 #: doc/guix.texi:12803
28626 "[@w{#:auto-enable? #f}] Return a service that runs the @command{bluetoothd} "
28627 "daemon, which manages all the Bluetooth devices and provides a number of D-"
28628 "Bus interfaces. When AUTO-ENABLE? is true, the bluetooth controller is "
28629 "powered automatically at boot, which can be useful when using a bluetooth "
28630 "keyboard or mouse."
28634 #: doc/guix.texi:12805
28635 msgid "Users need to be in the @code{lp} group to access the D-Bus service."
28639 #: doc/guix.texi:12811
28644 #. type: Plain text
28645 #: doc/guix.texi:12813
28647 "The @code{(gnu services databases)} module provides the following services."
28651 #: doc/guix.texi:12814
28653 msgid "{Scheme Procedure} postgresql-service [#:postgresql postgresql] @"
28657 #: doc/guix.texi:12819
28659 "[#:config-file] [#:data-directory ``/var/lib/postgresql/data''] @ [#:port "
28660 "5432] [#:locale ``en_US.utf8''] Return a service that runs @var{postgresql}, "
28661 "the PostgreSQL database server."
28665 #: doc/guix.texi:12823
28667 "The PostgreSQL daemon loads its runtime configuration from @var{config-"
28668 "file}, creates a database cluster with @var{locale} as the default locale, "
28669 "stored in @var{data-directory}. It then listens on @var{port}."
28673 #: doc/guix.texi:12825
28675 msgid "{Scheme Procedure} mysql-service [#:config (mysql-configuration)]"
28679 #: doc/guix.texi:12828
28681 "Return a service that runs @command{mysqld}, the MySQL or MariaDB database "
28686 #: doc/guix.texi:12831
28688 "The optional @var{config} argument specifies the configuration for "
28689 "@command{mysqld}, which should be a @code{<mysql-configuration>} object."
28693 #: doc/guix.texi:12833
28695 msgid "{Data Type} mysql-configuration"
28699 #: doc/guix.texi:12835
28700 msgid "Data type representing the configuration of @var{mysql-service}."
28704 #: doc/guix.texi:12837
28706 msgid "@code{mysql} (default: @var{mariadb})"
28710 #: doc/guix.texi:12840
28712 "Package object of the MySQL database server, can be either @var{mariadb} or "
28717 #: doc/guix.texi:12843
28719 "For MySQL, a temporary root password will be displayed at activation time. "
28720 "For MariaDB, the root password is empty."
28724 #: doc/guix.texi:12844
28726 msgid "@code{port} (default: @code{3306})"
28730 #: doc/guix.texi:12846
28731 msgid "TCP port on which the database server listens for incoming connections."
28735 #: doc/guix.texi:12849
28737 msgid "{Scheme Variable} memcached-service-type"
28741 #: doc/guix.texi:12853
28743 "This is the service type for the @uref{https://memcached.org/, Memcached} "
28744 "service, which provides a distributed in memory cache. The value for the "
28745 "service type is a @code{memcached-configuration} object."
28749 #: doc/guix.texi:12857
28751 msgid "(service memcached-service-type)\n"
28755 #: doc/guix.texi:12859
28757 msgid "{Data Type} memcached-configuration"
28761 #: doc/guix.texi:12861
28762 msgid "Data type representing the configuration of memcached."
28766 #: doc/guix.texi:12863
28768 msgid "@code{memcached} (default: @code{memcached})"
28772 #: doc/guix.texi:12865
28773 msgid "The Memcached package to use."
28777 #: doc/guix.texi:12866
28779 msgid "@code{interfaces} (default: @code{'(\"0.0.0.0\")})"
28783 #: doc/guix.texi:12868
28784 msgid "Network interfaces on which to listen."
28788 #: doc/guix.texi:12869
28790 msgid "@code{tcp-port} (default: @code{11211})"
28794 #: doc/guix.texi:12871
28795 msgid "Port on which to accept connections on,"
28799 #: doc/guix.texi:12872
28801 msgid "@code{udp-port} (default: @code{11211})"
28805 #: doc/guix.texi:12875
28807 "Port on which to accept UDP connections on, a value of 0 will disable "
28808 "listening on a UDP socket."
28812 #: doc/guix.texi:12876
28814 msgid "@code{additional-options} (default: @code{'()})"
28818 #: doc/guix.texi:12878
28819 msgid "Additional command line options to pass to @code{memcached}."
28823 #: doc/guix.texi:12881
28825 msgid "{Scheme Variable} mongodb-service-type"
28829 #: doc/guix.texi:12884
28831 "This is the service type for @uref{https://www.mongodb.com/, MongoDB}. The "
28832 "value for the service type is a @code{mongodb-configuration} object."
28836 #: doc/guix.texi:12888
28838 msgid "(service mongodb-service-type)\n"
28842 #: doc/guix.texi:12890
28844 msgid "{Data Type} mongodb-configuration"
28848 #: doc/guix.texi:12892
28849 msgid "Data type representing the configuration of mongodb."
28853 #: doc/guix.texi:12894
28855 msgid "@code{mongodb} (default: @code{mongodb})"
28859 #: doc/guix.texi:12896
28860 msgid "The MongoDB package to use."
28864 #: doc/guix.texi:12897
28866 msgid "@code{config-file} (default: @code{%default-mongodb-configuration-file})"
28870 #: doc/guix.texi:12899
28871 msgid "The configuration file for MongoDB."
28875 #: doc/guix.texi:12900
28877 msgid "@code{data-directory} (default: @code{\"/var/lib/mongodb\"})"
28881 #: doc/guix.texi:12904
28883 "This value is used to create the directory, so that it exists and is owned "
28884 "by the mongodb user. It should match the data-directory which MongoDB is "
28885 "configured to use through the configuration file."
28889 #: doc/guix.texi:12907
28891 msgid "{Scheme Variable} redis-service-type"
28895 #: doc/guix.texi:12910
28897 "This is the service type for the @uref{https://redis.io/, Redis} key/value "
28898 "store, whose value is a @code{redis-configuration} object."
28902 #: doc/guix.texi:12912
28904 msgid "{Data Type} redis-configuration"
28908 #: doc/guix.texi:12914
28909 msgid "Data type representing the configuration of redis."
28913 #: doc/guix.texi:12916
28915 msgid "@code{redis} (default: @code{redis})"
28919 #: doc/guix.texi:12918
28920 msgid "The Redis package to use."
28924 #: doc/guix.texi:12919
28926 msgid "@code{bind} (default: @code{\"127.0.0.1\"})"
28930 #: doc/guix.texi:12921
28931 msgid "Network interface on which to listen."
28935 #: doc/guix.texi:12922
28937 msgid "@code{port} (default: @code{6379})"
28941 #: doc/guix.texi:12925
28943 "Port on which to accept connections on, a value of 0 will disable listening "
28948 #: doc/guix.texi:12926
28950 msgid "@code{working-directory} (default: @code{\"/var/lib/redis\"})"
28954 #: doc/guix.texi:12928
28955 msgid "Directory in which to store the database and related files."
28959 #: doc/guix.texi:12934
28965 #: doc/guix.texi:12935 doc/guix.texi:16030
28970 #. type: Plain text
28971 #: doc/guix.texi:12940
28973 "The @code{(gnu services mail)} module provides Guix service definitions for "
28974 "email services: IMAP, POP3, and LMTP servers, as well as mail transport "
28975 "agents (MTAs). Lots of acronyms! These services are detailed in the "
28976 "subsections below."
28979 #. type: subsubheading
28980 #: doc/guix.texi:12941
28982 msgid "Dovecot Service"
28986 #: doc/guix.texi:12943
28988 msgid "{Scheme Procedure} dovecot-service [#:config (dovecot-configuration)]"
28992 #: doc/guix.texi:12945
28993 msgid "Return a service that runs the Dovecot IMAP/POP3/LMTP mail server."
28996 #. type: Plain text
28997 #: doc/guix.texi:12955
28999 "By default, Dovecot does not need much configuration; the default "
29000 "configuration object created by @code{(dovecot-configuration)} will suffice "
29001 "if your mail is delivered to @code{~/Maildir}. A self-signed certificate "
29002 "will be generated for TLS-protected connections, though Dovecot will also "
29003 "listen on cleartext ports by default. There are a number of options, "
29004 "though, which mail administrators might need to change, and as is the case "
29005 "with other services, Guix allows the system administrator to specify these "
29006 "parameters via a uniform Scheme interface."
29009 #. type: Plain text
29010 #: doc/guix.texi:12958
29012 "For example, to specify that mail is located at @code{maildir~/.mail}, one "
29013 "would instantiate the Dovecot service like this:"
29017 #: doc/guix.texi:12963
29020 "(dovecot-service #:config\n"
29021 " (dovecot-configuration\n"
29022 " (mail-location \"maildir:~/.mail\")))\n"
29025 #. type: Plain text
29026 #: doc/guix.texi:12971
29028 "The available configuration parameters follow. Each parameter definition is "
29029 "preceded by its type; for example, @samp{string-list foo} indicates that the "
29030 "@code{foo} parameter should be specified as a list of strings. There is "
29031 "also a way to specify the configuration as a string, if you have an old "
29032 "@code{dovecot.conf} file that you want to port over from some other system; "
29033 "see the end for more details."
29036 #. type: Plain text
29037 #: doc/guix.texi:12981
29038 msgid "Available @code{dovecot-configuration} fields are:"
29042 #: doc/guix.texi:12982
29044 msgid "{@code{dovecot-configuration} parameter} package dovecot"
29048 #: doc/guix.texi:12984 doc/guix.texi:14271
29049 msgid "The dovecot package."
29053 #: doc/guix.texi:12986
29055 msgid "{@code{dovecot-configuration} parameter} comma-separated-string-list listen"
29059 #: doc/guix.texi:12992
29061 "A list of IPs or hosts where to listen for connections. @samp{*} listens on "
29062 "all IPv4 interfaces, @samp{::} listens on all IPv6 interfaces. If you want "
29063 "to specify non-default ports or anything more complex, customize the address "
29064 "and port fields of the @samp{inet-listener} of the specific services you are "
29069 #: doc/guix.texi:12994
29071 msgid "{@code{dovecot-configuration} parameter} protocol-configuration-list protocols"
29075 #: doc/guix.texi:12997
29077 "List of protocols we want to serve. Available protocols include "
29078 "@samp{imap}, @samp{pop3}, and @samp{lmtp}."
29082 #: doc/guix.texi:12999
29083 msgid "Available @code{protocol-configuration} fields are:"
29087 #: doc/guix.texi:13000
29089 msgid "{@code{protocol-configuration} parameter} string name"
29093 #: doc/guix.texi:13002
29094 msgid "The name of the protocol."
29098 #: doc/guix.texi:13004
29100 msgid "{@code{protocol-configuration} parameter} string auth-socket-path"
29104 #: doc/guix.texi:13008
29106 "UNIX socket path to the master authentication server to find users. This is "
29107 "used by imap (for shared users) and lda. It defaults to @samp{\"/var/run/"
29108 "dovecot/auth-userdb\"}."
29112 #: doc/guix.texi:13010
29114 msgid "{@code{protocol-configuration} parameter} space-separated-string-list mail-plugins"
29118 #: doc/guix.texi:13012
29119 msgid "Space separated list of plugins to load."
29123 #: doc/guix.texi:13014
29125 msgid "{@code{protocol-configuration} parameter} non-negative-integer mail-max-userip-connections"
29129 #: doc/guix.texi:13018
29131 "Maximum number of IMAP connections allowed for a user from each IP address. "
29132 "NOTE: The username is compared case-sensitively. Defaults to @samp{10}."
29136 #: doc/guix.texi:13022
29138 msgid "{@code{dovecot-configuration} parameter} service-configuration-list services"
29142 #: doc/guix.texi:13026
29144 "List of services to enable. Available services include @samp{imap}, "
29145 "@samp{imap-login}, @samp{pop3}, @samp{pop3-login}, @samp{auth}, and "
29150 #: doc/guix.texi:13028
29151 msgid "Available @code{service-configuration} fields are:"
29155 #: doc/guix.texi:13029
29157 msgid "{@code{service-configuration} parameter} string kind"
29161 #: doc/guix.texi:13034
29163 "The service kind. Valid values include @code{director}, @code{imap-login}, "
29164 "@code{pop3-login}, @code{lmtp}, @code{imap}, @code{pop3}, @code{auth}, "
29165 "@code{auth-worker}, @code{dict}, @code{tcpwrap}, @code{quota-warning}, or "
29170 #: doc/guix.texi:13036
29172 msgid "{@code{service-configuration} parameter} listener-configuration-list listeners"
29176 #: doc/guix.texi:13041
29178 "Listeners for the service. A listener is either a @code{unix-listener-"
29179 "configuration}, a @code{fifo-listener-configuration}, or an @code{inet-"
29180 "listener-configuration}. Defaults to @samp{()}."
29184 #: doc/guix.texi:13043
29185 msgid "Available @code{unix-listener-configuration} fields are:"
29189 #: doc/guix.texi:13044
29191 msgid "{@code{unix-listener-configuration} parameter} string path"
29195 #: doc/guix.texi:13047 doc/guix.texi:13070
29197 "Path to the file, relative to @code{base-dir} field. This is also used as "
29198 "the section name."
29202 #: doc/guix.texi:13049
29204 msgid "{@code{unix-listener-configuration} parameter} string mode"
29208 #: doc/guix.texi:13052 doc/guix.texi:13075
29209 msgid "The access mode for the socket. Defaults to @samp{\"0600\"}."
29213 #: doc/guix.texi:13054
29215 msgid "{@code{unix-listener-configuration} parameter} string user"
29219 #: doc/guix.texi:13057 doc/guix.texi:13080
29220 msgid "The user to own the socket. Defaults to @samp{\"\"}."
29224 #: doc/guix.texi:13059
29226 msgid "{@code{unix-listener-configuration} parameter} string group"
29230 #: doc/guix.texi:13062 doc/guix.texi:13085
29231 msgid "The group to own the socket. Defaults to @samp{\"\"}."
29235 #: doc/guix.texi:13066
29236 msgid "Available @code{fifo-listener-configuration} fields are:"
29240 #: doc/guix.texi:13067
29242 msgid "{@code{fifo-listener-configuration} parameter} string path"
29246 #: doc/guix.texi:13072
29248 msgid "{@code{fifo-listener-configuration} parameter} string mode"
29252 #: doc/guix.texi:13077
29254 msgid "{@code{fifo-listener-configuration} parameter} string user"
29258 #: doc/guix.texi:13082
29260 msgid "{@code{fifo-listener-configuration} parameter} string group"
29264 #: doc/guix.texi:13089
29265 msgid "Available @code{inet-listener-configuration} fields are:"
29269 #: doc/guix.texi:13090
29271 msgid "{@code{inet-listener-configuration} parameter} string protocol"
29275 #: doc/guix.texi:13092
29276 msgid "The protocol to listen for."
29280 #: doc/guix.texi:13094
29282 msgid "{@code{inet-listener-configuration} parameter} string address"
29286 #: doc/guix.texi:13097
29288 "The address on which to listen, or empty for all addresses. Defaults to "
29293 #: doc/guix.texi:13099
29295 msgid "{@code{inet-listener-configuration} parameter} non-negative-integer port"
29299 #: doc/guix.texi:13101
29300 msgid "The port on which to listen."
29304 #: doc/guix.texi:13103
29306 msgid "{@code{inet-listener-configuration} parameter} boolean ssl?"
29310 #: doc/guix.texi:13107
29312 "Whether to use SSL for this service; @samp{yes}, @samp{no}, or "
29313 "@samp{required}. Defaults to @samp{#t}."
29317 #: doc/guix.texi:13111
29319 msgid "{@code{service-configuration} parameter} non-negative-integer service-count"
29323 #: doc/guix.texi:13116
29325 "Number of connections to handle before starting a new process. Typically "
29326 "the only useful values are 0 (unlimited) or 1. 1 is more secure, but 0 is "
29327 "faster. <doc/wiki/LoginProcess.txt>. Defaults to @samp{1}."
29331 #: doc/guix.texi:13118
29333 msgid "{@code{service-configuration} parameter} non-negative-integer process-min-avail"
29337 #: doc/guix.texi:13121
29339 "Number of processes to always keep waiting for more connections. Defaults "
29344 #: doc/guix.texi:13123
29346 msgid "{@code{service-configuration} parameter} non-negative-integer vsz-limit"
29350 #: doc/guix.texi:13127
29352 "If you set @samp{service-count 0}, you probably need to grow this. Defaults "
29353 "to @samp{256000000}."
29357 #: doc/guix.texi:13131
29359 msgid "{@code{dovecot-configuration} parameter} dict-configuration dict"
29363 #: doc/guix.texi:13134
29365 "Dict configuration, as created by the @code{dict-configuration} constructor."
29369 #: doc/guix.texi:13136
29370 msgid "Available @code{dict-configuration} fields are:"
29374 #: doc/guix.texi:13137
29376 msgid "{@code{dict-configuration} parameter} free-form-fields entries"
29380 #: doc/guix.texi:13140
29382 "A list of key-value pairs that this dict should hold. Defaults to @samp{()}."
29386 #: doc/guix.texi:13144
29388 msgid "{@code{dovecot-configuration} parameter} passdb-configuration-list passdbs"
29392 #: doc/guix.texi:13147
29394 "A list of passdb configurations, each one created by the @code{passdb-"
29395 "configuration} constructor."
29399 #: doc/guix.texi:13149
29400 msgid "Available @code{passdb-configuration} fields are:"
29404 #: doc/guix.texi:13150
29406 msgid "{@code{passdb-configuration} parameter} string driver"
29410 #: doc/guix.texi:13155
29412 "The driver that the passdb should use. Valid values include @samp{pam}, "
29413 "@samp{passwd}, @samp{shadow}, @samp{bsdauth}, and @samp{static}. Defaults "
29414 "to @samp{\"pam\"}."
29418 #: doc/guix.texi:13157
29420 msgid "{@code{passdb-configuration} parameter} space-separated-string-list args"
29424 #: doc/guix.texi:13160
29426 "Space separated list of arguments to the passdb driver. Defaults to "
29431 #: doc/guix.texi:13164
29433 msgid "{@code{dovecot-configuration} parameter} userdb-configuration-list userdbs"
29437 #: doc/guix.texi:13167
29439 "List of userdb configurations, each one created by the @code{userdb-"
29440 "configuration} constructor."
29444 #: doc/guix.texi:13169
29445 msgid "Available @code{userdb-configuration} fields are:"
29449 #: doc/guix.texi:13170
29451 msgid "{@code{userdb-configuration} parameter} string driver"
29455 #: doc/guix.texi:13174
29457 "The driver that the userdb should use. Valid values include @samp{passwd} "
29458 "and @samp{static}. Defaults to @samp{\"passwd\"}."
29462 #: doc/guix.texi:13176
29464 msgid "{@code{userdb-configuration} parameter} space-separated-string-list args"
29468 #: doc/guix.texi:13179
29470 "Space separated list of arguments to the userdb driver. Defaults to "
29475 #: doc/guix.texi:13181
29477 msgid "{@code{userdb-configuration} parameter} free-form-args override-fields"
29481 #: doc/guix.texi:13184
29482 msgid "Override fields from passwd. Defaults to @samp{()}."
29486 #: doc/guix.texi:13188
29488 msgid "{@code{dovecot-configuration} parameter} plugin-configuration plugin-configuration"
29492 #: doc/guix.texi:13191
29494 "Plug-in configuration, created by the @code{plugin-configuration} "
29499 #: doc/guix.texi:13193
29501 msgid "{@code{dovecot-configuration} parameter} list-of-namespace-configuration namespaces"
29505 #: doc/guix.texi:13196
29507 "List of namespaces. Each item in the list is created by the @code{namespace-"
29508 "configuration} constructor."
29512 #: doc/guix.texi:13198
29513 msgid "Available @code{namespace-configuration} fields are:"
29517 #: doc/guix.texi:13199
29519 msgid "{@code{namespace-configuration} parameter} string name"
29523 #: doc/guix.texi:13201
29524 msgid "Name for this namespace."
29528 #: doc/guix.texi:13203
29530 msgid "{@code{namespace-configuration} parameter} string type"
29534 #: doc/guix.texi:13206
29536 "Namespace type: @samp{private}, @samp{shared} or @samp{public}. Defaults to "
29537 "@samp{\"private\"}."
29541 #: doc/guix.texi:13208
29543 msgid "{@code{namespace-configuration} parameter} string separator"
29547 #: doc/guix.texi:13214
29549 "Hierarchy separator to use. You should use the same separator for all "
29550 "namespaces or some clients get confused. @samp{/} is usually a good one. "
29551 "The default however depends on the underlying mail storage format. Defaults "
29556 #: doc/guix.texi:13216
29558 msgid "{@code{namespace-configuration} parameter} string prefix"
29562 #: doc/guix.texi:13220
29564 "Prefix required to access this namespace. This needs to be different for "
29565 "all namespaces. For example @samp{Public/}. Defaults to @samp{\"\"}."
29569 #: doc/guix.texi:13222
29571 msgid "{@code{namespace-configuration} parameter} string location"
29575 #: doc/guix.texi:13226
29577 "Physical location of the mailbox. This is in the same format as "
29578 "mail_location, which is also the default for it. Defaults to @samp{\"\"}."
29582 #: doc/guix.texi:13228
29584 msgid "{@code{namespace-configuration} parameter} boolean inbox?"
29588 #: doc/guix.texi:13232
29590 "There can be only one INBOX, and this setting defines which namespace has "
29591 "it. Defaults to @samp{#f}."
29595 #: doc/guix.texi:13234
29597 msgid "{@code{namespace-configuration} parameter} boolean hidden?"
29601 #: doc/guix.texi:13242
29603 "If namespace is hidden, it's not advertised to clients via NAMESPACE "
29604 "extension. You'll most likely also want to set @samp{list? #f}. This is "
29605 "mostly useful when converting from another server with different namespaces "
29606 "which you want to deprecate but still keep working. For example you can "
29607 "create hidden namespaces with prefixes @samp{~/mail/}, @samp{~%u/mail/} and "
29608 "@samp{mail/}. Defaults to @samp{#f}."
29612 #: doc/guix.texi:13244
29614 msgid "{@code{namespace-configuration} parameter} boolean list?"
29618 #: doc/guix.texi:13250
29620 "Show the mailboxes under this namespace with the LIST command. This makes "
29621 "the namespace visible for clients that do not support the NAMESPACE "
29622 "extension. The special @code{children} value lists child mailboxes, but "
29623 "hides the namespace prefix. Defaults to @samp{#t}."
29627 #: doc/guix.texi:13252
29629 msgid "{@code{namespace-configuration} parameter} boolean subscriptions?"
29633 #: doc/guix.texi:13257
29635 "Namespace handles its own subscriptions. If set to @code{#f}, the parent "
29636 "namespace handles them. The empty prefix should always have this as "
29637 "@code{#t}). Defaults to @samp{#t}."
29641 #: doc/guix.texi:13259
29643 msgid "{@code{namespace-configuration} parameter} mailbox-configuration-list mailboxes"
29647 #: doc/guix.texi:13262
29648 msgid "List of predefined mailboxes in this namespace. Defaults to @samp{()}."
29652 #: doc/guix.texi:13264
29653 msgid "Available @code{mailbox-configuration} fields are:"
29657 #: doc/guix.texi:13265
29659 msgid "{@code{mailbox-configuration} parameter} string name"
29663 #: doc/guix.texi:13267
29664 msgid "Name for this mailbox."
29668 #: doc/guix.texi:13269
29670 msgid "{@code{mailbox-configuration} parameter} string auto"
29674 #: doc/guix.texi:13273
29676 "@samp{create} will automatically create this mailbox. @samp{subscribe} will "
29677 "both create and subscribe to the mailbox. Defaults to @samp{\"no\"}."
29681 #: doc/guix.texi:13275
29683 msgid "{@code{mailbox-configuration} parameter} space-separated-string-list special-use"
29687 #: doc/guix.texi:13280
29689 "List of IMAP @code{SPECIAL-USE} attributes as specified by RFC 6154. Valid "
29690 "values are @code{\\All}, @code{\\Archive}, @code{\\Drafts}, "
29691 "@code{\\Flagged}, @code{\\Junk}, @code{\\Sent}, and @code{\\Trash}. "
29692 "Defaults to @samp{()}."
29696 #: doc/guix.texi:13286
29698 msgid "{@code{dovecot-configuration} parameter} file-name base-dir"
29702 #: doc/guix.texi:13289
29704 "Base directory where to store runtime data. Defaults to @samp{\"/var/run/"
29709 #: doc/guix.texi:13291
29711 msgid "{@code{dovecot-configuration} parameter} string login-greeting"
29715 #: doc/guix.texi:13294
29716 msgid "Greeting message for clients. Defaults to @samp{\"Dovecot ready.\"}."
29720 #: doc/guix.texi:13296
29722 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-trusted-networks"
29726 #: doc/guix.texi:13303
29728 "List of trusted network ranges. Connections from these IPs are allowed to "
29729 "override their IP addresses and ports (for logging and for authentication "
29730 "checks). @samp{disable-plaintext-auth} is also ignored for these networks. "
29731 "Typically you would specify your IMAP proxy servers here. Defaults to "
29736 #: doc/guix.texi:13305
29738 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-access-sockets"
29742 #: doc/guix.texi:13308
29744 "List of login access check sockets (e.g. tcpwrap). Defaults to @samp{()}."
29748 #: doc/guix.texi:13310
29750 msgid "{@code{dovecot-configuration} parameter} boolean verbose-proctitle?"
29754 #: doc/guix.texi:13316
29756 "Show more verbose process titles (in ps). Currently shows user name and IP "
29757 "address. Useful for seeing who is actually using the IMAP processes (e.g. "
29758 "shared mailboxes or if the same uid is used for multiple accounts). "
29759 "Defaults to @samp{#f}."
29763 #: doc/guix.texi:13318
29765 msgid "{@code{dovecot-configuration} parameter} boolean shutdown-clients?"
29769 #: doc/guix.texi:13324
29771 "Should all processes be killed when Dovecot master process shuts down. "
29772 "Setting this to @code{#f} means that Dovecot can be upgraded without forcing "
29773 "existing client connections to close (although that could also be a problem "
29774 "if the upgrade is e.g. due to a security fix). Defaults to @samp{#t}."
29778 #: doc/guix.texi:13326
29780 msgid "{@code{dovecot-configuration} parameter} non-negative-integer doveadm-worker-count"
29784 #: doc/guix.texi:13330
29786 "If non-zero, run mail commands via this many connections to doveadm server, "
29787 "instead of running them directly in the same process. Defaults to @samp{0}."
29791 #: doc/guix.texi:13332
29793 msgid "{@code{dovecot-configuration} parameter} string doveadm-socket-path"
29797 #: doc/guix.texi:13335
29799 "UNIX socket or host:port used for connecting to doveadm server. Defaults to "
29800 "@samp{\"doveadm-server\"}."
29804 #: doc/guix.texi:13337
29806 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list import-environment"
29810 #: doc/guix.texi:13341
29812 "List of environment variables that are preserved on Dovecot startup and "
29813 "passed down to all of its child processes. You can also give key=value "
29814 "pairs to always set specific settings."
29818 #: doc/guix.texi:13343
29820 msgid "{@code{dovecot-configuration} parameter} boolean disable-plaintext-auth?"
29824 #: doc/guix.texi:13350
29826 "Disable LOGIN command and all other plaintext authentications unless SSL/TLS "
29827 "is used (LOGINDISABLED capability). Note that if the remote IP matches the "
29828 "local IP (i.e. you're connecting from the same computer), the connection is "
29829 "considered secure and plaintext authentication is allowed. See also "
29830 "ssl=required setting. Defaults to @samp{#t}."
29834 #: doc/guix.texi:13352
29836 msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-cache-size"
29840 #: doc/guix.texi:13357
29842 "Authentication cache size (e.g. @samp{#e10e6}). 0 means it's disabled. "
29843 "Note that bsdauth, PAM and vpopmail require @samp{cache-key} to be set for "
29844 "caching to be used. Defaults to @samp{0}."
29848 #: doc/guix.texi:13359
29850 msgid "{@code{dovecot-configuration} parameter} string auth-cache-ttl"
29854 #: doc/guix.texi:13367
29856 "Time to live for cached data. After TTL expires the cached record is no "
29857 "longer used, *except* if the main database lookup returns internal failure. "
29858 "We also try to handle password changes automatically: If user's previous "
29859 "authentication was successful, but this one wasn't, the cache isn't used. "
29860 "For now this works only with plaintext authentication. Defaults to "
29861 "@samp{\"1 hour\"}."
29865 #: doc/guix.texi:13369
29867 msgid "{@code{dovecot-configuration} parameter} string auth-cache-negative-ttl"
29871 #: doc/guix.texi:13373
29873 "TTL for negative hits (user not found, password mismatch). 0 disables "
29874 "caching them completely. Defaults to @samp{\"1 hour\"}."
29878 #: doc/guix.texi:13375
29880 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-realms"
29884 #: doc/guix.texi:13381
29886 "List of realms for SASL authentication mechanisms that need them. You can "
29887 "leave it empty if you don't want to support multiple realms. Many clients "
29888 "simply use the first one listed here, so keep the default realm first. "
29889 "Defaults to @samp{()}."
29893 #: doc/guix.texi:13383
29895 msgid "{@code{dovecot-configuration} parameter} string auth-default-realm"
29899 #: doc/guix.texi:13388
29901 "Default realm/domain to use if none was specified. This is used for both "
29902 "SASL realms and appending @@domain to username in plaintext logins. "
29903 "Defaults to @samp{\"\"}."
29907 #: doc/guix.texi:13390
29909 msgid "{@code{dovecot-configuration} parameter} string auth-username-chars"
29913 #: doc/guix.texi:13397
29915 "List of allowed characters in username. If the user-given username contains "
29916 "a character not listed in here, the login automatically fails. This is just "
29917 "an extra check to make sure user can't exploit any potential quote escaping "
29918 "vulnerabilities with SQL/LDAP databases. If you want to allow all "
29919 "characters, set this value to empty. Defaults to "
29920 "@samp{\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@@"
29925 #: doc/guix.texi:13399
29927 msgid "{@code{dovecot-configuration} parameter} string auth-username-translation"
29931 #: doc/guix.texi:13405
29933 "Username character translations before it's looked up from databases. The "
29934 "value contains series of from -> to characters. For example @samp{#@@/@@} "
29935 "means that @samp{#} and @samp{/} characters are translated to @samp{@@}. "
29936 "Defaults to @samp{\"\"}."
29940 #: doc/guix.texi:13407
29942 msgid "{@code{dovecot-configuration} parameter} string auth-username-format"
29946 #: doc/guix.texi:13414
29948 "Username formatting before it's looked up from databases. You can use the "
29949 "standard variables here, e.g. %Lu would lowercase the username, %n would "
29950 "drop away the domain if it was given, or @samp{%n-AT-%d} would change the "
29951 "@samp{@@} into @samp{-AT-}. This translation is done after @samp{auth-"
29952 "username-translation} changes. Defaults to @samp{\"%Lu\"}."
29956 #: doc/guix.texi:13416
29958 msgid "{@code{dovecot-configuration} parameter} string auth-master-user-separator"
29962 #: doc/guix.texi:13424
29964 "If you want to allow master users to log in by specifying the master "
29965 "username within the normal username string (i.e. not using SASL mechanism's "
29966 "support for it), you can specify the separator character here. The format "
29967 "is then <username><separator><master username>. UW-IMAP uses @samp{*} as "
29968 "the separator, so that could be a good choice. Defaults to @samp{\"\"}."
29972 #: doc/guix.texi:13426
29974 msgid "{@code{dovecot-configuration} parameter} string auth-anonymous-username"
29978 #: doc/guix.texi:13430
29980 "Username to use for users logging in with ANONYMOUS SASL mechanism. "
29981 "Defaults to @samp{\"anonymous\"}."
29985 #: doc/guix.texi:13432
29987 msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-worker-max-count"
29991 #: doc/guix.texi:13437
29993 "Maximum number of dovecot-auth worker processes. They're used to execute "
29994 "blocking passdb and userdb queries (e.g. MySQL and PAM). They're "
29995 "automatically created and destroyed as needed. Defaults to @samp{30}."
29999 #: doc/guix.texi:13439
30001 msgid "{@code{dovecot-configuration} parameter} string auth-gssapi-hostname"
30005 #: doc/guix.texi:13444
30007 "Host name to use in GSSAPI principal names. The default is to use the name "
30008 "returned by gethostname(). Use @samp{$ALL} (with quotes) to allow all "
30009 "keytab entries. Defaults to @samp{\"\"}."
30013 #: doc/guix.texi:13446
30015 msgid "{@code{dovecot-configuration} parameter} string auth-krb5-keytab"
30019 #: doc/guix.texi:13452
30021 "Kerberos keytab to use for the GSSAPI mechanism. Will use the system "
30022 "default (usually @file{/etc/krb5.keytab}) if not specified. You may need to "
30023 "change the auth service to run as root to be able to read this file. "
30024 "Defaults to @samp{\"\"}."
30028 #: doc/guix.texi:13454
30030 msgid "{@code{dovecot-configuration} parameter} boolean auth-use-winbind?"
30034 #: doc/guix.texi:13459
30036 "Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon and "
30037 "@samp{ntlm-auth} helper. <doc/wiki/Authentication/Mechanisms/Winbind.txt>. "
30038 "Defaults to @samp{#f}."
30042 #: doc/guix.texi:13461
30044 msgid "{@code{dovecot-configuration} parameter} file-name auth-winbind-helper-path"
30048 #: doc/guix.texi:13464
30050 "Path for Samba's @samp{ntlm-auth} helper binary. Defaults to @samp{\"/usr/"
30051 "bin/ntlm_auth\"}."
30055 #: doc/guix.texi:13466
30057 msgid "{@code{dovecot-configuration} parameter} string auth-failure-delay"
30061 #: doc/guix.texi:13469
30063 "Time to delay before replying to failed authentications. Defaults to "
30064 "@samp{\"2 secs\"}."
30068 #: doc/guix.texi:13471
30070 msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-require-client-cert?"
30074 #: doc/guix.texi:13475
30076 "Require a valid SSL client certificate or the authentication fails. "
30077 "Defaults to @samp{#f}."
30081 #: doc/guix.texi:13477
30083 msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-username-from-cert?"
30087 #: doc/guix.texi:13482
30089 "Take the username from client's SSL certificate, using "
30090 "@code{X509_NAME_get_text_by_NID()} which returns the subject's DN's "
30091 "CommonName. Defaults to @samp{#f}."
30095 #: doc/guix.texi:13484
30097 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-mechanisms"
30101 #: doc/guix.texi:13490
30103 "List of wanted authentication mechanisms. Supported mechanisms are: "
30104 "@samp{plain}, @samp{login}, @samp{digest-md5}, @samp{cram-md5}, @samp{ntlm}, "
30105 "@samp{rpa}, @samp{apop}, @samp{anonymous}, @samp{gssapi}, @samp{otp}, "
30106 "@samp{skey}, and @samp{gss-spnego}. NOTE: See also @samp{disable-plaintext-"
30111 #: doc/guix.texi:13492
30113 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-servers"
30117 #: doc/guix.texi:13497
30119 "List of IPs or hostnames to all director servers, including ourself. Ports "
30120 "can be specified as ip:port. The default port is the same as what director "
30121 "service's @samp{inet-listener} is using. Defaults to @samp{()}."
30125 #: doc/guix.texi:13499
30127 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-mail-servers"
30131 #: doc/guix.texi:13503
30133 "List of IPs or hostnames to all backend mail servers. Ranges are allowed "
30134 "too, like 10.0.0.10-10.0.0.30. Defaults to @samp{()}."
30138 #: doc/guix.texi:13505
30140 msgid "{@code{dovecot-configuration} parameter} string director-user-expire"
30144 #: doc/guix.texi:13509
30146 "How long to redirect users to a specific server after it no longer has any "
30147 "connections. Defaults to @samp{\"15 min\"}."
30151 #: doc/guix.texi:13511
30153 msgid "{@code{dovecot-configuration} parameter} string director-username-hash"
30157 #: doc/guix.texi:13516
30159 "How the username is translated before being hashed. Useful values include "
30160 "%Ln if user can log in with or without @@domain, %Ld if mailboxes are shared "
30161 "within domain. Defaults to @samp{\"%Lu\"}."
30165 #: doc/guix.texi:13518
30167 msgid "{@code{dovecot-configuration} parameter} string log-path"
30171 #: doc/guix.texi:13522
30173 "Log file to use for error messages. @samp{syslog} logs to syslog, @samp{/"
30174 "dev/stderr} logs to stderr. Defaults to @samp{\"syslog\"}."
30178 #: doc/guix.texi:13524
30180 msgid "{@code{dovecot-configuration} parameter} string info-log-path"
30184 #: doc/guix.texi:13528
30186 "Log file to use for informational messages. Defaults to @samp{log-path}. "
30187 "Defaults to @samp{\"\"}."
30191 #: doc/guix.texi:13530
30193 msgid "{@code{dovecot-configuration} parameter} string debug-log-path"
30197 #: doc/guix.texi:13534
30199 "Log file to use for debug messages. Defaults to @samp{info-log-path}. "
30200 "Defaults to @samp{\"\"}."
30204 #: doc/guix.texi:13536
30206 msgid "{@code{dovecot-configuration} parameter} string syslog-facility"
30210 #: doc/guix.texi:13541
30212 "Syslog facility to use if you're logging to syslog. Usually if you don't "
30213 "want to use @samp{mail}, you'll use local0..local7. Also other standard "
30214 "facilities are supported. Defaults to @samp{\"mail\"}."
30218 #: doc/guix.texi:13543
30220 msgid "{@code{dovecot-configuration} parameter} boolean auth-verbose?"
30224 #: doc/guix.texi:13547
30226 "Log unsuccessful authentication attempts and the reasons why they failed. "
30227 "Defaults to @samp{#f}."
30231 #: doc/guix.texi:13549
30233 msgid "{@code{dovecot-configuration} parameter} boolean auth-verbose-passwords?"
30237 #: doc/guix.texi:13556
30239 "In case of password mismatches, log the attempted password. Valid values "
30240 "are no, plain and sha1. sha1 can be useful for detecting brute force "
30241 "password attempts vs. user simply trying the same password over and over "
30242 "again. You can also truncate the value to n chars by appending \":n\" (e.g. "
30243 "sha1:6). Defaults to @samp{#f}."
30247 #: doc/guix.texi:13558
30249 msgid "{@code{dovecot-configuration} parameter} boolean auth-debug?"
30253 #: doc/guix.texi:13562
30255 "Even more verbose logging for debugging purposes. Shows for example SQL "
30256 "queries. Defaults to @samp{#f}."
30260 #: doc/guix.texi:13564
30262 msgid "{@code{dovecot-configuration} parameter} boolean auth-debug-passwords?"
30266 #: doc/guix.texi:13569
30268 "In case of password mismatches, log the passwords and used scheme so the "
30269 "problem can be debugged. Enabling this also enables @samp{auth-debug}. "
30270 "Defaults to @samp{#f}."
30274 #: doc/guix.texi:13571
30276 msgid "{@code{dovecot-configuration} parameter} boolean mail-debug?"
30280 #: doc/guix.texi:13575
30282 "Enable mail process debugging. This can help you figure out why Dovecot "
30283 "isn't finding your mails. Defaults to @samp{#f}."
30287 #: doc/guix.texi:13577
30289 msgid "{@code{dovecot-configuration} parameter} boolean verbose-ssl?"
30293 #: doc/guix.texi:13580
30294 msgid "Show protocol level SSL errors. Defaults to @samp{#f}."
30298 #: doc/guix.texi:13582
30300 msgid "{@code{dovecot-configuration} parameter} string log-timestamp"
30304 #: doc/guix.texi:13586
30306 "Prefix for each line written to log file. % codes are in strftime(3) "
30307 "format. Defaults to @samp{\"\\\"%b %d %H:%M:%S \\\"\"}."
30311 #: doc/guix.texi:13588
30313 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-log-format-elements"
30317 #: doc/guix.texi:13592
30319 "List of elements we want to log. The elements which have a non-empty "
30320 "variable value are joined together to form a comma-separated string."
30324 #: doc/guix.texi:13594
30326 msgid "{@code{dovecot-configuration} parameter} string login-log-format"
30330 #: doc/guix.texi:13598
30332 "Login log format. %s contains @samp{login-log-format-elements} string, %$ "
30333 "contains the data we want to log. Defaults to @samp{\"%$: %s\"}."
30337 #: doc/guix.texi:13600
30339 msgid "{@code{dovecot-configuration} parameter} string mail-log-prefix"
30343 #: doc/guix.texi:13604
30345 "Log prefix for mail processes. See doc/wiki/Variables.txt for list of "
30346 "possible variables you can use. Defaults to @samp{\"\\\"%s(%u)<%@{pid@}><"
30347 "%@{session@}>: \\\"\"}."
30351 #: doc/guix.texi:13606
30353 msgid "{@code{dovecot-configuration} parameter} string deliver-log-format"
30357 #: doc/guix.texi:13608
30358 msgid "Format to use for logging mail deliveries. You can use variables:"
30362 #: doc/guix.texi:13609
30368 #: doc/guix.texi:13611
30369 msgid "Delivery status message (e.g. @samp{saved to INBOX})"
30373 #: doc/guix.texi:13611
30379 #: doc/guix.texi:13613
30384 #: doc/guix.texi:13613 doc/guix.texi:14145
30390 #: doc/guix.texi:13615
30395 #: doc/guix.texi:13615
30401 #: doc/guix.texi:13617
30402 msgid "From address"
30406 #: doc/guix.texi:13619
30407 msgid "Physical size"
30411 #: doc/guix.texi:13619
30417 #: doc/guix.texi:13621
30418 msgid "Virtual size."
30422 #: doc/guix.texi:13623
30423 msgid "Defaults to @samp{\"msgid=%m: %$\"}."
30427 #: doc/guix.texi:13625
30429 msgid "{@code{dovecot-configuration} parameter} string mail-location"
30433 #: doc/guix.texi:13630
30435 "Location for users' mailboxes. The default is empty, which means that "
30436 "Dovecot tries to find the mailboxes automatically. This won't work if the "
30437 "user doesn't yet have any mail, so you should explicitly tell Dovecot the "
30442 #: doc/guix.texi:13636
30444 "If you're using mbox, giving a path to the INBOX file (e.g. /var/mail/%u) "
30445 "isn't enough. You'll also need to tell Dovecot where the other mailboxes "
30446 "are kept. This is called the \"root mail directory\", and it must be the "
30447 "first path given in the @samp{mail-location} setting."
30451 #: doc/guix.texi:13638
30452 msgid "There are a few special variables you can use, eg.:"
30456 #: doc/guix.texi:13642
30461 #: doc/guix.texi:13642 doc/guix.texi:14141
30467 #: doc/guix.texi:13644
30468 msgid "user part in user@@domain, same as %u if there's no domain"
30472 #: doc/guix.texi:13644
30478 #: doc/guix.texi:13646
30479 msgid "domain part in user@@domain, empty if there's no domain"
30483 #: doc/guix.texi:13646
30489 #: doc/guix.texi:13648
30490 msgid "home director"
30494 #: doc/guix.texi:13651
30495 msgid "See doc/wiki/Variables.txt for full list. Some examples:"
30499 #: doc/guix.texi:13652
30501 msgid "maildir:~/Maildir"
30505 #: doc/guix.texi:13653
30507 msgid "mbox:~/mail:INBOX=/var/mail/%u"
30511 #: doc/guix.texi:13654
30513 msgid "mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%"
30517 #: doc/guix.texi:13659
30519 msgid "{@code{dovecot-configuration} parameter} string mail-uid"
30523 #: doc/guix.texi:13664
30525 "System user and group used to access mails. If you use multiple, userdb can "
30526 "override these by returning uid or gid fields. You can use either numbers "
30527 "or names. <doc/wiki/UserIds.txt>. Defaults to @samp{\"\"}."
30531 #: doc/guix.texi:13666
30533 msgid "{@code{dovecot-configuration} parameter} string mail-gid"
30537 #: doc/guix.texi:13671
30539 msgid "{@code{dovecot-configuration} parameter} string mail-privileged-group"
30543 #: doc/guix.texi:13677
30545 "Group to enable temporarily for privileged operations. Currently this is "
30546 "used only with INBOX when either its initial creation or dotlocking fails. "
30547 "Typically this is set to \"mail\" to give access to /var/mail. Defaults to "
30552 #: doc/guix.texi:13679
30554 msgid "{@code{dovecot-configuration} parameter} string mail-access-groups"
30558 #: doc/guix.texi:13687
30560 "Grant access to these supplementary groups for mail processes. Typically "
30561 "these are used to set up access to shared mailboxes. Note that it may be "
30562 "dangerous to set these if users can create symlinks (e.g. if \"mail\" group "
30563 "is set here, ln -s /var/mail ~/mail/var could allow a user to delete others' "
30564 "mailboxes, or ln -s /secret/shared/box ~/mail/mybox would allow reading "
30565 "it). Defaults to @samp{\"\"}."
30569 #: doc/guix.texi:13689
30571 msgid "{@code{dovecot-configuration} parameter} boolean mail-full-filesystem-access?"
30575 #: doc/guix.texi:13695
30577 "Allow full file system access to clients. There's no access checks other "
30578 "than what the operating system does for the active UID/GID. It works with "
30579 "both maildir and mboxes, allowing you to prefix mailboxes names with e.g. /"
30580 "path/ or ~user/. Defaults to @samp{#f}."
30584 #: doc/guix.texi:13697
30586 msgid "{@code{dovecot-configuration} parameter} boolean mmap-disable?"
30590 #: doc/guix.texi:13701
30592 "Don't use mmap() at all. This is required if you store indexes to shared "
30593 "file systems (NFS or clustered file system). Defaults to @samp{#f}."
30597 #: doc/guix.texi:13703
30599 msgid "{@code{dovecot-configuration} parameter} boolean dotlock-use-excl?"
30603 #: doc/guix.texi:13708
30605 "Rely on @samp{O_EXCL} to work when creating dotlock files. NFS supports "
30606 "@samp{O_EXCL} since version 3, so this should be safe to use nowadays by "
30607 "default. Defaults to @samp{#t}."
30611 #: doc/guix.texi:13710
30613 msgid "{@code{dovecot-configuration} parameter} string mail-fsync"
30617 #: doc/guix.texi:13712
30618 msgid "When to use fsync() or fdatasync() calls:"
30622 #: doc/guix.texi:13713
30628 #: doc/guix.texi:13715
30629 msgid "Whenever necessary to avoid losing important data"
30633 #: doc/guix.texi:13717
30634 msgid "Useful with e.g. NFS when write()s are delayed"
30638 #: doc/guix.texi:13719
30639 msgid "Never use it (best performance, but crashes can lose data)."
30643 #: doc/guix.texi:13721
30644 msgid "Defaults to @samp{\"optimized\"}."
30648 #: doc/guix.texi:13723
30650 msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-storage?"
30654 #: doc/guix.texi:13728
30656 "Mail storage exists in NFS. Set this to yes to make Dovecot flush NFS "
30657 "caches whenever needed. If you're using only a single mail server this "
30658 "isn't needed. Defaults to @samp{#f}."
30662 #: doc/guix.texi:13730
30664 msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-index?"
30668 #: doc/guix.texi:13734
30670 "Mail index files also exist in NFS. Setting this to yes requires @samp{mmap-"
30671 "disable? #t} and @samp{fsync-disable? #f}. Defaults to @samp{#f}."
30675 #: doc/guix.texi:13736
30677 msgid "{@code{dovecot-configuration} parameter} string lock-method"
30681 #: doc/guix.texi:13742
30683 "Locking method for index files. Alternatives are fcntl, flock and dotlock. "
30684 "Dotlocking uses some tricks which may create more disk I/O than other "
30685 "locking methods. NFS users: flock doesn't work, remember to change "
30686 "@samp{mmap-disable}. Defaults to @samp{\"fcntl\"}."
30690 #: doc/guix.texi:13744
30692 msgid "{@code{dovecot-configuration} parameter} file-name mail-temp-dir"
30696 #: doc/guix.texi:13748
30698 "Directory in which LDA/LMTP temporarily stores incoming mails >128 kB. "
30699 "Defaults to @samp{\"/tmp\"}."
30703 #: doc/guix.texi:13750
30705 msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-uid"
30709 #: doc/guix.texi:13756
30711 "Valid UID range for users. This is mostly to make sure that users can't log "
30712 "in as daemons or other system users. Note that denying root logins is "
30713 "hardcoded to dovecot binary and can't be done even if @samp{first-valid-uid} "
30714 "is set to 0. Defaults to @samp{500}."
30718 #: doc/guix.texi:13758
30720 msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-uid"
30724 #: doc/guix.texi:13763
30726 msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-gid"
30730 #: doc/guix.texi:13768
30732 "Valid GID range for users. Users having non-valid GID as primary group ID "
30733 "aren't allowed to log in. If user belongs to supplementary groups with non-"
30734 "valid GIDs, those groups are not set. Defaults to @samp{1}."
30738 #: doc/guix.texi:13770
30740 msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-gid"
30744 #: doc/guix.texi:13775
30746 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-max-keyword-length"
30750 #: doc/guix.texi:13779
30752 "Maximum allowed length for mail keyword name. It's only forced when trying "
30753 "to create new keywords. Defaults to @samp{50}."
30757 #: doc/guix.texi:13781
30759 msgid "{@code{dovecot-configuration} parameter} colon-separated-file-name-list valid-chroot-dirs"
30763 #: doc/guix.texi:13791
30765 "List of directories under which chrooting is allowed for mail processes (i."
30766 "e. /var/mail will allow chrooting to /var/mail/foo/bar too). This setting "
30767 "doesn't affect @samp{login-chroot} @samp{mail-chroot} or auth chroot "
30768 "settings. If this setting is empty, \"/./\" in home dirs are ignored. "
30769 "WARNING: Never add directories here which local users can modify, that may "
30770 "lead to root exploit. Usually this should be done only if you don't allow "
30771 "shell access for users. <doc/wiki/Chrooting.txt>. Defaults to @samp{()}."
30775 #: doc/guix.texi:13793
30777 msgid "{@code{dovecot-configuration} parameter} string mail-chroot"
30781 #: doc/guix.texi:13802
30783 "Default chroot directory for mail processes. This can be overridden for "
30784 "specific users in user database by giving /./ in user's home directory (e."
30785 "g. /home/./user chroots into /home). Note that usually there is no real "
30786 "need to do chrooting, Dovecot doesn't allow users to access files outside "
30787 "their mail directory anyway. If your home directories are prefixed with the "
30788 "chroot directory, append \"/.\" to @samp{mail-chroot}. <doc/wiki/Chrooting."
30789 "txt>. Defaults to @samp{\"\"}."
30793 #: doc/guix.texi:13804
30795 msgid "{@code{dovecot-configuration} parameter} file-name auth-socket-path"
30799 #: doc/guix.texi:13808
30801 "UNIX socket path to master authentication server to find users. This is "
30802 "used by imap (for shared users) and lda. Defaults to @samp{\"/var/run/"
30803 "dovecot/auth-userdb\"}."
30807 #: doc/guix.texi:13810
30809 msgid "{@code{dovecot-configuration} parameter} file-name mail-plugin-dir"
30813 #: doc/guix.texi:13813
30815 "Directory where to look up mail plugins. Defaults to @samp{\"/usr/lib/"
30820 #: doc/guix.texi:13815
30822 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mail-plugins"
30826 #: doc/guix.texi:13819
30828 "List of plugins to load for all services. Plugins specific to IMAP, LDA, "
30829 "etc. are added to this list in their own .conf files. Defaults to @samp{()}."
30833 #: doc/guix.texi:13821
30835 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-cache-min-mail-count"
30839 #: doc/guix.texi:13826
30841 "The minimum number of mails in a mailbox before updates are done to cache "
30842 "file. This allows optimizing Dovecot's behavior to do less disk writes at "
30843 "the cost of more disk reads. Defaults to @samp{0}."
30847 #: doc/guix.texi:13828
30849 msgid "{@code{dovecot-configuration} parameter} string mailbox-idle-check-interval"
30853 #: doc/guix.texi:13835
30855 "When IDLE command is running, mailbox is checked once in a while to see if "
30856 "there are any new mails or other changes. This setting defines the minimum "
30857 "time to wait between those checks. Dovecot can also use dnotify, inotify "
30858 "and kqueue to find out immediately when changes occur. Defaults to "
30859 "@samp{\"30 secs\"}."
30863 #: doc/guix.texi:13837
30865 msgid "{@code{dovecot-configuration} parameter} boolean mail-save-crlf?"
30869 #: doc/guix.texi:13844
30871 "Save mails with CR+LF instead of plain LF. This makes sending those mails "
30872 "take less CPU, especially with sendfile() syscall with Linux and FreeBSD. "
30873 "But it also creates a bit more disk I/O which may just make it slower. Also "
30874 "note that if other software reads the mboxes/maildirs, they may handle the "
30875 "extra CRs wrong and cause problems. Defaults to @samp{#f}."
30879 #: doc/guix.texi:13846
30881 msgid "{@code{dovecot-configuration} parameter} boolean maildir-stat-dirs?"
30885 #: doc/guix.texi:13854
30887 "By default LIST command returns all entries in maildir beginning with a "
30888 "dot. Enabling this option makes Dovecot return only entries which are "
30889 "directories. This is done by stat()ing each entry, so it causes more disk I/"
30890 "O. (For systems setting struct @samp{dirent->d_type} this check is free and "
30891 "it's done always regardless of this setting). Defaults to @samp{#f}."
30895 #: doc/guix.texi:13856
30897 msgid "{@code{dovecot-configuration} parameter} boolean maildir-copy-with-hardlinks?"
30901 #: doc/guix.texi:13861
30903 "When copying a message, do it with hard links whenever possible. This makes "
30904 "the performance much better, and it's unlikely to have any side effects. "
30905 "Defaults to @samp{#t}."
30909 #: doc/guix.texi:13863
30911 msgid "{@code{dovecot-configuration} parameter} boolean maildir-very-dirty-syncs?"
30915 #: doc/guix.texi:13868
30917 "Assume Dovecot is the only MUA accessing Maildir: Scan cur/ directory only "
30918 "when its mtime changes unexpectedly or when we can't find the mail "
30919 "otherwise. Defaults to @samp{#f}."
30923 #: doc/guix.texi:13870
30925 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-read-locks"
30929 #: doc/guix.texi:13873
30931 "Which locking methods to use for locking mbox. There are four available:"
30935 #: doc/guix.texi:13875
30941 #: doc/guix.texi:13879
30943 "Create <mailbox>.lock file. This is the oldest and most NFS-safe solution. "
30944 "If you want to use /var/mail/ like directory, the users will need write "
30945 "access to that directory."
30949 #: doc/guix.texi:13879
30951 msgid "dotlock-try"
30955 #: doc/guix.texi:13882
30957 "Same as dotlock, but if it fails because of permissions or because there "
30958 "isn't enough disk space, just skip it."
30962 #: doc/guix.texi:13882
30968 #: doc/guix.texi:13884
30969 msgid "Use this if possible. Works with NFS too if lockd is used."
30973 #: doc/guix.texi:13884
30979 #: doc/guix.texi:13886 doc/guix.texi:13888
30980 msgid "May not exist in all systems. Doesn't work with NFS."
30984 #: doc/guix.texi:13886
30990 #: doc/guix.texi:13894
30992 "You can use multiple locking methods; if you do the order they're declared "
30993 "in is important to avoid deadlocks if other MTAs/MUAs are using multiple "
30994 "locking methods as well. Some operating systems don't allow using some of "
30995 "them simultaneously."
30999 #: doc/guix.texi:13896
31001 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-write-locks"
31005 #: doc/guix.texi:13900
31007 msgid "{@code{dovecot-configuration} parameter} string mbox-lock-timeout"
31011 #: doc/guix.texi:13903
31013 "Maximum time to wait for lock (all of them) before aborting. Defaults to "
31014 "@samp{\"5 mins\"}."
31018 #: doc/guix.texi:13905
31020 msgid "{@code{dovecot-configuration} parameter} string mbox-dotlock-change-timeout"
31024 #: doc/guix.texi:13909
31026 "If dotlock exists but the mailbox isn't modified in any way, override the "
31027 "lock file after this much time. Defaults to @samp{\"2 mins\"}."
31031 #: doc/guix.texi:13911
31033 msgid "{@code{dovecot-configuration} parameter} boolean mbox-dirty-syncs?"
31037 #: doc/guix.texi:13922
31039 "When mbox changes unexpectedly we have to fully read it to find out what "
31040 "changed. If the mbox is large this can take a long time. Since the change "
31041 "is usually just a newly appended mail, it'd be faster to simply read the new "
31042 "mails. If this setting is enabled, Dovecot does this but still safely "
31043 "fallbacks to re-reading the whole mbox file whenever something in mbox isn't "
31044 "how it's expected to be. The only real downside to this setting is that if "
31045 "some other MUA changes message flags, Dovecot doesn't notice it "
31046 "immediately. Note that a full sync is done with SELECT, EXAMINE, EXPUNGE "
31047 "and CHECK commands. Defaults to @samp{#t}."
31051 #: doc/guix.texi:13924
31053 msgid "{@code{dovecot-configuration} parameter} boolean mbox-very-dirty-syncs?"
31057 #: doc/guix.texi:13929
31059 "Like @samp{mbox-dirty-syncs}, but don't do full syncs even with SELECT, "
31060 "EXAMINE, EXPUNGE or CHECK commands. If this is set, @samp{mbox-dirty-syncs} "
31061 "is ignored. Defaults to @samp{#f}."
31065 #: doc/guix.texi:13931
31067 msgid "{@code{dovecot-configuration} parameter} boolean mbox-lazy-writes?"
31071 #: doc/guix.texi:13937
31073 "Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK "
31074 "commands and when closing the mailbox). This is especially useful for POP3 "
31075 "where clients often delete all mails. The downside is that our changes "
31076 "aren't immediately visible to other MUAs. Defaults to @samp{#t}."
31080 #: doc/guix.texi:13939
31082 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mbox-min-index-size"
31086 #: doc/guix.texi:13944
31088 "If mbox size is smaller than this (e.g. 100k), don't write index files. If "
31089 "an index file already exists it's still read, just not updated. Defaults to "
31094 #: doc/guix.texi:13946
31096 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mdbox-rotate-size"
31100 #: doc/guix.texi:13949
31102 "Maximum dbox file size until it's rotated. Defaults to @samp{10000000}."
31106 #: doc/guix.texi:13951
31108 msgid "{@code{dovecot-configuration} parameter} string mdbox-rotate-interval"
31112 #: doc/guix.texi:13956
31114 "Maximum dbox file age until it's rotated. Typically in days. Day begins "
31115 "from midnight, so 1d = today, 2d = yesterday, etc. 0 = check disabled. "
31116 "Defaults to @samp{\"1d\"}."
31120 #: doc/guix.texi:13958
31122 msgid "{@code{dovecot-configuration} parameter} boolean mdbox-preallocate-space?"
31126 #: doc/guix.texi:13963
31128 "When creating new mdbox files, immediately preallocate their size to "
31129 "@samp{mdbox-rotate-size}. This setting currently works only in Linux with "
31130 "some file systems (ext4, xfs). Defaults to @samp{#f}."
31134 #: doc/guix.texi:13965
31136 msgid "{@code{dovecot-configuration} parameter} string mail-attachment-dir"
31140 #: doc/guix.texi:13969
31142 "sdbox and mdbox support saving mail attachments to external files, which "
31143 "also allows single instance storage for them. Other backends don't support "
31148 #: doc/guix.texi:13971
31150 "WARNING: This feature hasn't been tested much yet. Use at your own risk."
31154 #: doc/guix.texi:13974
31156 "Directory root where to store mail attachments. Disabled, if empty. "
31157 "Defaults to @samp{\"\"}."
31161 #: doc/guix.texi:13976
31163 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-attachment-min-size"
31167 #: doc/guix.texi:13981
31169 "Attachments smaller than this aren't saved externally. It's also possible "
31170 "to write a plugin to disable saving specific attachments externally. "
31171 "Defaults to @samp{128000}."
31175 #: doc/guix.texi:13983
31177 msgid "{@code{dovecot-configuration} parameter} string mail-attachment-fs"
31181 #: doc/guix.texi:13985
31182 msgid "File system backend to use for saving attachments:"
31186 #: doc/guix.texi:13986
31192 #: doc/guix.texi:13988
31193 msgid "No SiS done by Dovecot (but this might help FS's own deduplication)"
31197 #: doc/guix.texi:13988
31203 #: doc/guix.texi:13990
31204 msgid "SiS with immediate byte-by-byte comparison during saving"
31208 #: doc/guix.texi:13990
31210 msgid "sis-queue posix"
31214 #: doc/guix.texi:13992
31215 msgid "SiS with delayed comparison and deduplication."
31219 #: doc/guix.texi:13994
31220 msgid "Defaults to @samp{\"sis posix\"}."
31224 #: doc/guix.texi:13996
31226 msgid "{@code{dovecot-configuration} parameter} string mail-attachment-hash"
31230 #: doc/guix.texi:14002
31232 "Hash format to use in attachment filenames. You can add any text and "
31233 "variables: @code{%@{md4@}}, @code{%@{md5@}}, @code{%@{sha1@}}, "
31234 "@code{%@{sha256@}}, @code{%@{sha512@}}, @code{%@{size@}}. Variables can be "
31235 "truncated, e.g. @code{%@{sha256:80@}} returns only first 80 bits. Defaults "
31236 "to @samp{\"%@{sha1@}\"}."
31240 #: doc/guix.texi:14004
31242 msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-process-limit"
31246 #: doc/guix.texi:14009
31248 msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-client-limit"
31252 #: doc/guix.texi:14012 doc/guix.texi:17918
31253 msgid "Defaults to @samp{1000}."
31257 #: doc/guix.texi:14014
31259 msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-vsz-limit"
31263 #: doc/guix.texi:14019
31265 "Default VSZ (virtual memory size) limit for service processes. This is "
31266 "mainly intended to catch and kill processes that leak memory before they eat "
31267 "up everything. Defaults to @samp{256000000}."
31271 #: doc/guix.texi:14021
31273 msgid "{@code{dovecot-configuration} parameter} string default-login-user"
31277 #: doc/guix.texi:14026
31279 "Login user is internally used by login processes. This is the most "
31280 "untrusted user in Dovecot system. It shouldn't have access to anything at "
31281 "all. Defaults to @samp{\"dovenull\"}."
31285 #: doc/guix.texi:14028
31287 msgid "{@code{dovecot-configuration} parameter} string default-internal-user"
31291 #: doc/guix.texi:14033
31293 "Internal user is used by unprivileged processes. It should be separate from "
31294 "login user, so that login processes can't disturb other processes. Defaults "
31295 "to @samp{\"dovecot\"}."
31299 #: doc/guix.texi:14035
31301 msgid "{@code{dovecot-configuration} parameter} string ssl?"
31305 #: doc/guix.texi:14038
31307 "SSL/TLS support: yes, no, required. <doc/wiki/SSL.txt>. Defaults to "
31308 "@samp{\"required\"}."
31312 #: doc/guix.texi:14040
31314 msgid "{@code{dovecot-configuration} parameter} string ssl-cert"
31318 #: doc/guix.texi:14043
31320 "PEM encoded X.509 SSL/TLS certificate (public key). Defaults to @samp{\"</"
31321 "etc/dovecot/default.pem\"}."
31325 #: doc/guix.texi:14045
31327 msgid "{@code{dovecot-configuration} parameter} string ssl-key"
31331 #: doc/guix.texi:14050
31333 "PEM encoded SSL/TLS private key. The key is opened before dropping root "
31334 "privileges, so keep the key file unreadable by anyone but root. Defaults to "
31335 "@samp{\"</etc/dovecot/private/default.pem\"}."
31339 #: doc/guix.texi:14052
31341 msgid "{@code{dovecot-configuration} parameter} string ssl-key-password"
31345 #: doc/guix.texi:14058
31347 "If key file is password protected, give the password here. Alternatively "
31348 "give it when starting dovecot with -p parameter. Since this file is often "
31349 "world-readable, you may want to place this setting instead to a different. "
31350 "Defaults to @samp{\"\"}."
31354 #: doc/guix.texi:14060
31356 msgid "{@code{dovecot-configuration} parameter} string ssl-ca"
31360 #: doc/guix.texi:14066
31362 "PEM encoded trusted certificate authority. Set this only if you intend to "
31363 "use @samp{ssl-verify-client-cert? #t}. The file should contain the CA "
31364 "certificate(s) followed by the matching CRL(s). (e.g. @samp{ssl-ca </etc/"
31365 "ssl/certs/ca.pem}). Defaults to @samp{\"\"}."
31369 #: doc/guix.texi:14068
31371 msgid "{@code{dovecot-configuration} parameter} boolean ssl-require-crl?"
31375 #: doc/guix.texi:14071
31377 "Require that CRL check succeeds for client certificates. Defaults to "
31382 #: doc/guix.texi:14073
31384 msgid "{@code{dovecot-configuration} parameter} boolean ssl-verify-client-cert?"
31388 #: doc/guix.texi:14077
31390 "Request client to send a certificate. If you also want to require it, set "
31391 "@samp{auth-ssl-require-client-cert? #t} in auth section. Defaults to "
31396 #: doc/guix.texi:14079
31398 msgid "{@code{dovecot-configuration} parameter} string ssl-cert-username-field"
31402 #: doc/guix.texi:14084
31404 "Which field from certificate to use for username. commonName and "
31405 "x500UniqueIdentifier are the usual choices. You'll also need to set "
31406 "@samp{auth-ssl-username-from-cert? #t}. Defaults to @samp{\"commonName\"}."
31410 #: doc/guix.texi:14086
31412 msgid "{@code{dovecot-configuration} parameter} string ssl-min-protocol"
31416 #: doc/guix.texi:14089
31417 msgid "Minimum SSL protocol version to accept. Defaults to @samp{\"TLSv1\"}."
31421 #: doc/guix.texi:14091
31423 msgid "{@code{dovecot-configuration} parameter} string ssl-cipher-list"
31427 #: doc/guix.texi:14094
31429 "SSL ciphers to use. Defaults to @samp{\"ALL:!kRSA:!SRP:!kDHd:!DSS:!aNULL:!"
31430 "eNULL:!EXPORT:!DES:!3DES:!MD5:!PSK:!RC4:!ADH:!LOW@@STRENGTH\"}."
31434 #: doc/guix.texi:14096
31436 msgid "{@code{dovecot-configuration} parameter} string ssl-crypto-device"
31440 #: doc/guix.texi:14099
31442 "SSL crypto device to use, for valid values run \"openssl engine\". Defaults "
31447 #: doc/guix.texi:14101
31449 msgid "{@code{dovecot-configuration} parameter} string postmaster-address"
31453 #: doc/guix.texi:14105
31455 "Address to use when sending rejection mails. %d expands to recipient "
31456 "domain. Defaults to @samp{\"postmaster@@%d\"}."
31460 #: doc/guix.texi:14107
31462 msgid "{@code{dovecot-configuration} parameter} string hostname"
31466 #: doc/guix.texi:14111
31468 "Hostname to use in various parts of sent mails (e.g. in Message-Id) and in "
31469 "LMTP replies. Default is the system's real hostname@@domain. Defaults to "
31474 #: doc/guix.texi:14113
31476 msgid "{@code{dovecot-configuration} parameter} boolean quota-full-tempfail?"
31480 #: doc/guix.texi:14117
31482 "If user is over quota, return with temporary failure instead of bouncing the "
31483 "mail. Defaults to @samp{#f}."
31487 #: doc/guix.texi:14119
31489 msgid "{@code{dovecot-configuration} parameter} file-name sendmail-path"
31493 #: doc/guix.texi:14122
31495 "Binary to use for sending mails. Defaults to @samp{\"/usr/sbin/sendmail\"}."
31499 #: doc/guix.texi:14124
31501 msgid "{@code{dovecot-configuration} parameter} string submission-host"
31505 #: doc/guix.texi:14128
31507 "If non-empty, send mails via this SMTP host[:port] instead of sendmail. "
31508 "Defaults to @samp{\"\"}."
31512 #: doc/guix.texi:14130
31514 msgid "{@code{dovecot-configuration} parameter} string rejection-subject"
31518 #: doc/guix.texi:14134
31520 "Subject: header to use for rejection mails. You can use the same variables "
31521 "as for @samp{rejection-reason} below. Defaults to @samp{\"Rejected: %s\"}."
31525 #: doc/guix.texi:14136
31527 msgid "{@code{dovecot-configuration} parameter} string rejection-reason"
31531 #: doc/guix.texi:14139
31533 "Human readable error message for rejection mails. You can use variables:"
31537 #: doc/guix.texi:14143
31542 #: doc/guix.texi:14143
31548 #: doc/guix.texi:14145
31553 #: doc/guix.texi:14147
31554 msgid "original subject"
31558 #: doc/guix.texi:14147
31564 #: doc/guix.texi:14149
31569 #: doc/guix.texi:14151
31571 "Defaults to @samp{\"Your message to <%t> was automatically rejected:%n%r\"}."
31575 #: doc/guix.texi:14153
31577 msgid "{@code{dovecot-configuration} parameter} string recipient-delimiter"
31581 #: doc/guix.texi:14157
31583 "Delimiter character between local-part and detail in email address. "
31584 "Defaults to @samp{\"+\"}."
31588 #: doc/guix.texi:14159
31590 msgid "{@code{dovecot-configuration} parameter} string lda-original-recipient-header"
31594 #: doc/guix.texi:14165
31596 "Header where the original recipient address (SMTP's RCPT TO: address) is "
31597 "taken from if not available elsewhere. With dovecot-lda -a parameter "
31598 "overrides this. A commonly used header for this is X-Original-To. Defaults "
31603 #: doc/guix.texi:14167
31605 msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autocreate?"
31609 #: doc/guix.texi:14171
31611 "Should saving a mail to a nonexistent mailbox automatically create it?. "
31612 "Defaults to @samp{#f}."
31616 #: doc/guix.texi:14173
31618 msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autosubscribe?"
31622 #: doc/guix.texi:14177
31624 "Should automatically created mailboxes be also automatically subscribed?. "
31625 "Defaults to @samp{#f}."
31629 #: doc/guix.texi:14179
31631 msgid "{@code{dovecot-configuration} parameter} non-negative-integer imap-max-line-length"
31635 #: doc/guix.texi:14185
31637 "Maximum IMAP command line length. Some clients generate very long command "
31638 "lines with huge mailboxes, so you may need to raise this if you get \"Too "
31639 "long argument\" or \"IMAP command line too large\" errors often. Defaults "
31644 #: doc/guix.texi:14187
31646 msgid "{@code{dovecot-configuration} parameter} string imap-logout-format"
31650 #: doc/guix.texi:14189
31651 msgid "IMAP logout format string:"
31655 #: doc/guix.texi:14190
31661 #: doc/guix.texi:14192
31662 msgid "total number of bytes read from client"
31666 #: doc/guix.texi:14192
31672 #: doc/guix.texi:14194
31673 msgid "total number of bytes sent to client."
31677 #: doc/guix.texi:14197
31679 "See @file{doc/wiki/Variables.txt} for a list of all the variables you can "
31680 "use. Defaults to @samp{\"in=%i out=%o deleted=%@{deleted@} expunged="
31681 "%@{expunged@} trashed=%@{trashed@} hdr_count=%@{fetch_hdr_count@} hdr_bytes="
31682 "%@{fetch_hdr_bytes@} body_count=%@{fetch_body_count@} body_bytes="
31683 "%@{fetch_body_bytes@}\"}."
31687 #: doc/guix.texi:14199
31689 msgid "{@code{dovecot-configuration} parameter} string imap-capability"
31693 #: doc/guix.texi:14203
31695 "Override the IMAP CAPABILITY response. If the value begins with '+', add "
31696 "the given capabilities on top of the defaults (e.g. +XFOO XBAR). Defaults "
31701 #: doc/guix.texi:14205
31703 msgid "{@code{dovecot-configuration} parameter} string imap-idle-notify-interval"
31707 #: doc/guix.texi:14209
31709 "How long to wait between \"OK Still here\" notifications when client is "
31710 "IDLEing. Defaults to @samp{\"2 mins\"}."
31714 #: doc/guix.texi:14211
31716 msgid "{@code{dovecot-configuration} parameter} string imap-id-send"
31720 #: doc/guix.texi:14217
31722 "ID field names and values to send to clients. Using * as the value makes "
31723 "Dovecot use the default value. The following fields have default values "
31724 "currently: name, version, os, os-version, support-url, support-email. "
31725 "Defaults to @samp{\"\"}."
31729 #: doc/guix.texi:14219
31731 msgid "{@code{dovecot-configuration} parameter} string imap-id-log"
31735 #: doc/guix.texi:14222
31737 "ID fields sent by client to log. * means everything. Defaults to "
31742 #: doc/guix.texi:14224
31744 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list imap-client-workarounds"
31748 #: doc/guix.texi:14226
31749 msgid "Workarounds for various client bugs:"
31753 #: doc/guix.texi:14228
31755 msgid "delay-newmail"
31759 #: doc/guix.texi:14235
31761 "Send EXISTS/RECENT new mail notifications only when replying to NOOP and "
31762 "CHECK commands. Some clients ignore them otherwise, for example OSX Mail "
31763 "(<v2.1). Outlook Express breaks more badly though, without this it may show "
31764 "user \"Message no longer in server\" errors. Note that OE6 still breaks "
31765 "even with this workaround if synchronization is set to \"Headers Only\"."
31769 #: doc/guix.texi:14236
31771 msgid "tb-extra-mailbox-sep"
31775 #: doc/guix.texi:14240
31777 "Thunderbird gets somehow confused with LAYOUT=fs (mbox and dbox) and adds "
31778 "extra @samp{/} suffixes to mailbox names. This option causes Dovecot to "
31779 "ignore the extra @samp{/} instead of treating it as invalid mailbox name."
31783 #: doc/guix.texi:14241
31785 msgid "tb-lsub-flags"
31789 #: doc/guix.texi:14245
31791 "Show \\Noselect flags for LSUB replies with LAYOUT=fs (e.g. mbox). This "
31792 "makes Thunderbird realize they aren't selectable and show them greyed out, "
31793 "instead of only later giving \"not selectable\" popup error."
31797 #: doc/guix.texi:14249
31799 msgid "{@code{dovecot-configuration} parameter} string imap-urlauth-host"
31803 #: doc/guix.texi:14252
31805 "Host allowed in URLAUTH URLs sent by client. \"*\" allows all. Defaults to "
31809 #. type: Plain text
31810 #: doc/guix.texi:14260
31812 "Whew! Lots of configuration options. The nice thing about it though is that "
31813 "GuixSD has a complete interface to Dovecot's configuration language. This "
31814 "allows not only a nice way to declare configurations, but also offers "
31815 "reflective capabilities as well: users can write code to inspect and "
31816 "transform configurations from within Scheme."
31819 #. type: Plain text
31820 #: doc/guix.texi:14266
31822 "However, it could be that you just want to get a @code{dovecot.conf} up and "
31823 "running. In that case, you can pass an @code{opaque-dovecot-configuration} "
31824 "as the @code{#:config} parameter to @code{dovecot-service}. As its name "
31825 "indicates, an opaque configuration does not have easy reflective "
31829 #. type: Plain text
31830 #: doc/guix.texi:14268
31831 msgid "Available @code{opaque-dovecot-configuration} fields are:"
31835 #: doc/guix.texi:14269
31837 msgid "{@code{opaque-dovecot-configuration} parameter} package dovecot"
31841 #: doc/guix.texi:14273
31843 msgid "{@code{opaque-dovecot-configuration} parameter} string string"
31847 #: doc/guix.texi:14275
31848 msgid "The contents of the @code{dovecot.conf}, as a string."
31851 #. type: Plain text
31852 #: doc/guix.texi:14279
31854 "For example, if your @code{dovecot.conf} is just the empty string, you could "
31855 "instantiate a dovecot service like this:"
31859 #: doc/guix.texi:14284
31862 "(dovecot-service #:config\n"
31863 " (opaque-dovecot-configuration\n"
31864 " (string \"\")))\n"
31867 #. type: subsubheading
31868 #: doc/guix.texi:14286
31870 msgid "OpenSMTPD Service"
31874 #: doc/guix.texi:14288
31876 msgid "{Scheme Variable} opensmtpd-service-type"
31880 #: doc/guix.texi:14292
31882 "This is the type of the @uref{https://www.opensmtpd.org, OpenSMTPD} service, "
31883 "whose value should be an @code{opensmtpd-configuration} object as in this "
31888 #: doc/guix.texi:14297
31891 "(service opensmtpd-service-type\n"
31892 " (opensmtpd-configuration\n"
31893 " (config-file (local-file \"./my-smtpd.conf\"))))\n"
31897 #: doc/guix.texi:14300
31899 msgid "{Data Type} opensmtpd-configuration"
31903 #: doc/guix.texi:14302
31904 msgid "Data type representing the configuration of opensmtpd."
31908 #: doc/guix.texi:14304
31910 msgid "@code{package} (default: @var{opensmtpd})"
31914 #: doc/guix.texi:14306
31915 msgid "Package object of the OpenSMTPD SMTP server."
31919 #: doc/guix.texi:14307
31921 msgid "@code{config-file} (default: @var{%default-opensmtpd-file})"
31925 #: doc/guix.texi:14312
31927 "File-like object of the OpenSMTPD configuration file to use. By default it "
31928 "listens on the loopback network interface, and allows for mail from users "
31929 "and daemons on the local machine, as well as permitting email to remote "
31930 "servers. Run @command{man smtpd.conf} for more information."
31933 #. type: subsubheading
31934 #: doc/guix.texi:14316
31936 msgid "Exim Service"
31940 #: doc/guix.texi:14318
31942 msgid "mail transfer agent (MTA)"
31946 #: doc/guix.texi:14319
31948 msgid "MTA (mail transfer agent)"
31952 #: doc/guix.texi:14320
31958 #: doc/guix.texi:14322
31960 msgid "{Scheme Variable} exim-service-type"
31964 #: doc/guix.texi:14326
31966 "This is the type of the @uref{https://exim.org, Exim} mail transfer agent "
31967 "(MTA), whose value should be an @code{exim-configuration} object as in this "
31972 #: doc/guix.texi:14331
31975 "(service exim-service-type\n"
31976 " (exim-configuration\n"
31977 " (config-file (local-file \"./my-exim.conf\"))))\n"
31980 #. type: Plain text
31981 #: doc/guix.texi:14337
31983 "In order to use an @code{exim-service-type} service you must also have a "
31984 "@code{mail-aliases-service-type} service present in your @code{operating-"
31985 "system} (even if it has no aliases)."
31989 #: doc/guix.texi:14338
31991 msgid "{Data Type} exim-configuration"
31995 #: doc/guix.texi:14340
31996 msgid "Data type representing the configuration of exim."
32000 #: doc/guix.texi:14342
32002 msgid "@code{package} (default: @var{exim})"
32006 #: doc/guix.texi:14344
32007 msgid "Package object of the Exim server."
32011 #: doc/guix.texi:14351
32013 "File-like object of the Exim configuration file to use. If its value is "
32014 "@code{#f} then use the default configuration file from the package provided "
32015 "in @code{package}. The resulting configuration file is loaded after setting "
32016 "the @code{exim_user} and @code{exim_group} configuration variables."
32019 #. type: subsubheading
32020 #: doc/guix.texi:14355
32022 msgid "Mail Aliases Service"
32026 #: doc/guix.texi:14357
32028 msgid "email aliases"
32032 #: doc/guix.texi:14358
32034 msgid "aliases, for email addresses"
32038 #: doc/guix.texi:14360
32040 msgid "{Scheme Variable} mail-aliases-service-type"
32044 #: doc/guix.texi:14363
32046 "This is the type of the service which provides @code{/etc/aliases}, "
32047 "specifying how to deliver mail to users on this system."
32051 #: doc/guix.texi:14368
32054 "(service mail-aliases-service-type\n"
32055 " '((\"postmaster\" \"bob\")\n"
32056 " (\"bob\" \"bob@@example.com\" \"bob@@example2.com\")))\n"
32059 #. type: Plain text
32060 #: doc/guix.texi:14376
32062 "The configuration for a @code{mail-aliases-service-type} service is an "
32063 "association list denoting how to deliver mail that comes to this system. "
32064 "Each entry is of the form @code{(alias addresses ...)}, with @code{alias} "
32065 "specifying the local alias and @code{addresses} specifying where to deliver "
32066 "this user's mail."
32069 #. type: Plain text
32070 #: doc/guix.texi:14382
32072 "The aliases aren't required to exist as users on the local system. In the "
32073 "above example, there doesn't need to be a @code{postmaster} entry in the "
32074 "@code{operating-system}'s @code{user-accounts} in order to deliver the "
32075 "@code{postmaster} mail to @code{bob} (which subsequently would deliver mail "
32076 "to @code{bob@@example.com} and @code{bob@@example2.com})."
32080 #: doc/guix.texi:14386
32086 #: doc/guix.texi:14387
32092 #: doc/guix.texi:14388
32097 #. type: Plain text
32098 #: doc/guix.texi:14391
32100 "The @code{(gnu services messaging)} module provides Guix service definitions "
32101 "for messaging services: currently only Prosody is supported."
32104 #. type: subsubheading
32105 #: doc/guix.texi:14392
32107 msgid "Prosody Service"
32111 #: doc/guix.texi:14394
32113 msgid "{Scheme Variable} prosody-service-type"
32117 #: doc/guix.texi:14398
32119 "This is the type for the @uref{https://prosody.im, Prosody XMPP "
32120 "communication server}. Its value must be a @code{prosody-configuration} "
32121 "record as in this example:"
32125 #: doc/guix.texi:14413
32128 "(service prosody-service-type\n"
32129 " (prosody-configuration\n"
32130 " (modules-enabled (cons \"groups\" \"mam\" %default-modules-enabled))\n"
32131 " (int-components\n"
32133 " (int-component-configuration\n"
32134 " (hostname \"conference.example.net\")\n"
32135 " (plugin \"muc\")\n"
32136 " (mod-muc (mod-muc-configuration)))))\n"
32139 " (virtualhost-configuration\n"
32140 " (domain \"example.net\"))))))\n"
32144 #: doc/guix.texi:14416
32145 msgid "See below for details about @code{prosody-configuration}."
32148 #. type: Plain text
32149 #: doc/guix.texi:14422
32151 "By default, Prosody does not need much configuration. Only one "
32152 "@code{virtualhosts} field is needed: it specifies the domain you wish "
32153 "Prosody to serve."
32156 #. type: Plain text
32157 #: doc/guix.texi:14425
32159 "You can perform various sanity checks on the generated configuration with "
32160 "the @code{prosodyctl check} command."
32163 #. type: Plain text
32164 #: doc/guix.texi:14429
32166 "Prosodyctl will also help you to import certificates from the "
32167 "@code{letsencrypt} directory so that the @code{prosody} user can access "
32168 "them. See @url{https://prosody.im/doc/letsencrypt}."
32172 #: doc/guix.texi:14432
32174 msgid "prosodyctl --root cert import /etc/letsencrypt/live\n"
32177 #. type: Plain text
32178 #: doc/guix.texi:14439
32180 "The available configuration parameters follow. Each parameter definition is "
32181 "preceded by its type; for example, @samp{string-list foo} indicates that the "
32182 "@code{foo} parameter should be specified as a list of strings. Types "
32183 "starting with @code{maybe-} denote parameters that won't show up in "
32184 "@code{prosody.cfg.lua} when their value is @code{'disabled}."
32187 #. type: Plain text
32188 #: doc/guix.texi:14443
32190 "There is also a way to specify the configuration as a string, if you have an "
32191 "old @code{prosody.cfg.lua} file that you want to port over from some other "
32192 "system; see the end for more details."
32195 #. type: Plain text
32196 #: doc/guix.texi:14446
32198 "The @code{file-object} type designates either a file-like object (@pxref{G-"
32199 "Expressions, file-like objects}) or a file name."
32202 #. type: Plain text
32203 #: doc/guix.texi:14456
32204 msgid "Available @code{prosody-configuration} fields are:"
32208 #: doc/guix.texi:14457
32210 msgid "{@code{prosody-configuration} parameter} package prosody"
32214 #: doc/guix.texi:14459
32215 msgid "The Prosody package."
32219 #: doc/guix.texi:14461
32221 msgid "{@code{prosody-configuration} parameter} file-name data-path"
32225 #: doc/guix.texi:14465
32227 "Location of the Prosody data storage directory. See @url{https://prosody.im/"
32228 "doc/configure}. Defaults to @samp{\"/var/lib/prosody\"}."
32232 #: doc/guix.texi:14467
32234 msgid "{@code{prosody-configuration} parameter} file-object-list plugin-paths"
32238 #: doc/guix.texi:14471
32240 "Additional plugin directories. They are searched in all the specified paths "
32241 "in order. See @url{https://prosody.im/doc/plugins_directory}. Defaults to "
32246 #: doc/guix.texi:14473
32248 msgid "{@code{prosody-configuration} parameter} file-name certificates"
32252 #: doc/guix.texi:14478
32254 "Every virtual host and component needs a certificate so that clients and "
32255 "servers can securely verify its identity. Prosody will automatically load "
32256 "certificates/keys from the directory specified here. Defaults to @samp{\"/"
32257 "etc/prosody/certs\"}."
32261 #: doc/guix.texi:14480
32263 msgid "{@code{prosody-configuration} parameter} string-list admins"
32267 #: doc/guix.texi:14486
32269 "This is a list of accounts that are admins for the server. Note that you "
32270 "must create the accounts separately. See @url{https://prosody.im/doc/"
32271 "admins} and @url{https://prosody.im/doc/creating_accounts}. Example: "
32272 "@code{(admins '(\"user1@@example.com\" \"user2@@example.net\"))} Defaults to "
32277 #: doc/guix.texi:14488
32279 msgid "{@code{prosody-configuration} parameter} boolean use-libevent?"
32283 #: doc/guix.texi:14492
32285 "Enable use of libevent for better performance under high load. See "
32286 "@url{https://prosody.im/doc/libevent}. Defaults to @samp{#f}."
32290 #: doc/guix.texi:14494
32292 msgid "{@code{prosody-configuration} parameter} module-list modules-enabled"
32296 #: doc/guix.texi:14500
32298 "This is the list of modules Prosody will load on startup. It looks for "
32299 "@code{mod_modulename.lua} in the plugins folder, so make sure that exists "
32300 "too. Documentation on modules can be found at: @url{https://prosody.im/doc/"
32301 "modules}. Defaults to @samp{(\"roster\" \"saslauth\" \"tls\" \"dialback\" "
32302 "\"disco\" \"carbons\" \"private\" \"blocklist\" \"vcard\" \"version\" "
32303 "\"uptime\" \"time\" \"ping\" \"pep\" \"register\" \"admin_adhoc\")}."
32307 #: doc/guix.texi:14502
32309 msgid "{@code{prosody-configuration} parameter} string-list modules-disabled"
32313 #: doc/guix.texi:14506
32315 "@samp{\"offline\"}, @samp{\"c2s\"} and @samp{\"s2s\"} are auto-loaded, but "
32316 "should you want to disable them then add them to this list. Defaults to "
32321 #: doc/guix.texi:14508
32323 msgid "{@code{prosody-configuration} parameter} file-object groups-file"
32327 #: doc/guix.texi:14513
32329 "Path to a text file where the shared groups are defined. If this path is "
32330 "empty then @samp{mod_groups} does nothing. See @url{https://prosody.im/doc/"
32331 "modules/mod_groups}. Defaults to @samp{\"/var/lib/prosody/sharedgroups.txt"
32336 #: doc/guix.texi:14515
32338 msgid "{@code{prosody-configuration} parameter} boolean allow-registration?"
32342 #: doc/guix.texi:14519
32344 "Disable account creation by default, for security. See @url{https://prosody."
32345 "im/doc/creating_accounts}. Defaults to @samp{#f}."
32349 #: doc/guix.texi:14521
32351 msgid "{@code{prosody-configuration} parameter} maybe-ssl-configuration ssl"
32355 #: doc/guix.texi:14526
32357 "These are the SSL/TLS-related settings. Most of them are disabled so to use "
32358 "Prosody's defaults. If you do not completely understand these options, do "
32359 "not add them to your config, it is easy to lower the security of your server "
32360 "using them. See @url{https://prosody.im/doc/advanced_ssl_config}."
32364 #: doc/guix.texi:14528
32365 msgid "Available @code{ssl-configuration} fields are:"
32369 #: doc/guix.texi:14529
32371 msgid "{@code{ssl-configuration} parameter} maybe-string protocol"
32375 #: doc/guix.texi:14531
32376 msgid "This determines what handshake to use."
32380 #: doc/guix.texi:14533
32382 msgid "{@code{ssl-configuration} parameter} maybe-file-name key"
32386 #: doc/guix.texi:14535
32387 msgid "Path to your private key file."
32391 #: doc/guix.texi:14537
32393 msgid "{@code{ssl-configuration} parameter} maybe-file-name certificate"
32397 #: doc/guix.texi:14539
32398 msgid "Path to your certificate file."
32402 #: doc/guix.texi:14541
32404 msgid "{@code{ssl-configuration} parameter} file-object capath"
32408 #: doc/guix.texi:14545
32410 "Path to directory containing root certificates that you wish Prosody to "
32411 "trust when verifying the certificates of remote servers. Defaults to "
32412 "@samp{\"/etc/ssl/certs\"}."
32416 #: doc/guix.texi:14547
32418 msgid "{@code{ssl-configuration} parameter} maybe-file-object cafile"
32422 #: doc/guix.texi:14550
32424 "Path to a file containing root certificates that you wish Prosody to trust. "
32425 "Similar to @code{capath} but with all certificates concatenated together."
32429 #: doc/guix.texi:14552
32431 msgid "{@code{ssl-configuration} parameter} maybe-string-list verify"
32435 #: doc/guix.texi:14555
32437 "A list of verification options (these mostly map to OpenSSL's "
32438 "@code{set_verify()} flags)."
32442 #: doc/guix.texi:14557
32444 msgid "{@code{ssl-configuration} parameter} maybe-string-list options"
32448 #: doc/guix.texi:14561
32450 "A list of general options relating to SSL/TLS. These map to OpenSSL's "
32451 "@code{set_options()}. For a full list of options available in LuaSec, see "
32452 "the LuaSec source."
32456 #: doc/guix.texi:14563
32458 msgid "{@code{ssl-configuration} parameter} maybe-non-negative-integer depth"
32462 #: doc/guix.texi:14566
32464 "How long a chain of certificate authorities to check when looking for a "
32465 "trusted root certificate."
32469 #: doc/guix.texi:14568
32471 msgid "{@code{ssl-configuration} parameter} maybe-string ciphers"
32475 #: doc/guix.texi:14571
32477 "An OpenSSL cipher string. This selects what ciphers Prosody will offer to "
32478 "clients, and in what order."
32482 #: doc/guix.texi:14573
32484 msgid "{@code{ssl-configuration} parameter} maybe-file-name dhparam"
32488 #: doc/guix.texi:14577
32490 "A path to a file containing parameters for Diffie-Hellman key exchange. You "
32491 "can create such a file with: @code{openssl dhparam -out /etc/prosody/certs/"
32492 "dh-2048.pem 2048}"
32496 #: doc/guix.texi:14579
32498 msgid "{@code{ssl-configuration} parameter} maybe-string curve"
32502 #: doc/guix.texi:14582
32504 "Curve for Elliptic curve Diffie-Hellman. Prosody's default is "
32505 "@samp{\"secp384r1\"}."
32509 #: doc/guix.texi:14584
32511 msgid "{@code{ssl-configuration} parameter} maybe-string-list verifyext"
32515 #: doc/guix.texi:14586
32516 msgid "A list of \"extra\" verification options."
32520 #: doc/guix.texi:14588
32522 msgid "{@code{ssl-configuration} parameter} maybe-string password"
32526 #: doc/guix.texi:14590
32527 msgid "Password for encrypted private keys."
32531 #: doc/guix.texi:14594
32533 msgid "{@code{prosody-configuration} parameter} boolean c2s-require-encryption?"
32537 #: doc/guix.texi:14598
32539 "Whether to force all client-to-server connections to be encrypted or not. "
32540 "See @url{https://prosody.im/doc/modules/mod_tls}. Defaults to @samp{#f}."
32544 #: doc/guix.texi:14600
32546 msgid "{@code{prosody-configuration} parameter} string-list disable-sasl-mechanisms"
32550 #: doc/guix.texi:14604
32552 "Set of mechanisms that will never be offered. See @url{https://prosody.im/"
32553 "doc/modules/mod_saslauth}. Defaults to @samp{(\"DIGEST-MD5\")}."
32557 #: doc/guix.texi:14606
32559 msgid "{@code{prosody-configuration} parameter} boolean s2s-require-encryption?"
32563 #: doc/guix.texi:14610
32565 "Whether to force all server-to-server connections to be encrypted or not. "
32566 "See @url{https://prosody.im/doc/modules/mod_tls}. Defaults to @samp{#f}."
32570 #: doc/guix.texi:14612
32572 msgid "{@code{prosody-configuration} parameter} boolean s2s-secure-auth?"
32576 #: doc/guix.texi:14618
32578 "Whether to require encryption and certificate authentication. This provides "
32579 "ideal security, but requires servers you communicate with to support "
32580 "encryption AND present valid, trusted certificates. See @url{https://"
32581 "prosody.im/doc/s2s#security}. Defaults to @samp{#f}."
32585 #: doc/guix.texi:14620
32587 msgid "{@code{prosody-configuration} parameter} string-list s2s-insecure-domains"
32591 #: doc/guix.texi:14626
32593 "Many servers don't support encryption or have invalid or self-signed "
32594 "certificates. You can list domains here that will not be required to "
32595 "authenticate using certificates. They will be authenticated using DNS. See "
32596 "@url{https://prosody.im/doc/s2s#security}. Defaults to @samp{()}."
32600 #: doc/guix.texi:14628
32602 msgid "{@code{prosody-configuration} parameter} string-list s2s-secure-domains"
32606 #: doc/guix.texi:14633
32608 "Even if you leave @code{s2s-secure-auth?} disabled, you can still require "
32609 "valid certificates for some domains by specifying a list here. See "
32610 "@url{https://prosody.im/doc/s2s#security}. Defaults to @samp{()}."
32614 #: doc/guix.texi:14635
32616 msgid "{@code{prosody-configuration} parameter} string authentication"
32620 #: doc/guix.texi:14643
32622 "Select the authentication backend to use. The default provider stores "
32623 "passwords in plaintext and uses Prosody's configured data storage to store "
32624 "the authentication data. If you do not trust your server please see "
32625 "@url{https://prosody.im/doc/modules/mod_auth_internal_hashed} for "
32626 "information about using the hashed backend. See also @url{https://prosody."
32627 "im/doc/authentication} Defaults to @samp{\"internal_plain\"}."
32631 #: doc/guix.texi:14645
32633 msgid "{@code{prosody-configuration} parameter} maybe-string log"
32637 #: doc/guix.texi:14649
32639 "Set logging options. Advanced logging configuration is not yet supported by "
32640 "the GuixSD Prosody Service. See @url{https://prosody.im/doc/logging}. "
32641 "Defaults to @samp{\"*syslog\"}."
32645 #: doc/guix.texi:14651
32647 msgid "{@code{prosody-configuration} parameter} file-name pidfile"
32651 #: doc/guix.texi:14654
32653 "File to write pid in. See @url{https://prosody.im/doc/modules/mod_posix}. "
32654 "Defaults to @samp{\"/var/run/prosody/prosody.pid\"}."
32658 #: doc/guix.texi:14656
32660 msgid "{@code{prosody-configuration} parameter} maybe-non-negative-integer http-max-content-size"
32664 #: doc/guix.texi:14658
32665 msgid "Maximum allowed size of the HTTP body (in bytes)."
32669 #: doc/guix.texi:14660
32671 msgid "{@code{prosody-configuration} parameter} maybe-string http-external-url"
32675 #: doc/guix.texi:14665
32677 "Some modules expose their own URL in various ways. This URL is built from "
32678 "the protocol, host and port used. If Prosody sits behind a proxy, the "
32679 "public URL will be @code{http-external-url} instead. See @url{https://"
32680 "prosody.im/doc/http#external_url}."
32684 #: doc/guix.texi:14667
32686 msgid "{@code{prosody-configuration} parameter} virtualhost-configuration-list virtualhosts"
32690 #: doc/guix.texi:14672
32692 "A host in Prosody is a domain on which user accounts can be created. For "
32693 "example if you want your users to have addresses like @samp{\"john."
32694 "smith@@example.com\"} then you need to add a host @samp{\"example.com\"}. "
32695 "All options in this list will apply only to this host."
32699 #: doc/guix.texi:14678
32701 "Note: the name \"virtual\" host is used in configuration to avoid confusion "
32702 "with the actual physical host that Prosody is installed on. A single "
32703 "Prosody instance can serve many domains, each one defined as a VirtualHost "
32704 "entry in Prosody's configuration. Conversely a server that hosts a single "
32705 "domain would have just one VirtualHost entry."
32709 #: doc/guix.texi:14680
32710 msgid "See @url{https://prosody.im/doc/configure#virtual_host_settings}."
32714 #: doc/guix.texi:14682
32715 msgid "Available @code{virtualhost-configuration} fields are:"
32719 #: doc/guix.texi:14684 doc/guix.texi:14706 doc/guix.texi:14759
32721 "all these @code{prosody-configuration} fields: @code{admins}, @code{use-"
32722 "libevent?}, @code{modules-enabled}, @code{modules-disabled}, @code{groups-"
32723 "file}, @code{allow-registration?}, @code{ssl}, @code{c2s-require-"
32724 "encryption?}, @code{disable-sasl-mechanisms}, @code{s2s-require-"
32725 "encryption?}, @code{s2s-secure-auth?}, @code{s2s-insecure-domains}, "
32726 "@code{s2s-secure-domains}, @code{authentication}, @code{log}, @code{http-max-"
32727 "content-size}, @code{http-external-url}, @code{raw-content}, plus:"
32731 #: doc/guix.texi:14684
32733 msgid "{@code{virtualhost-configuration} parameter} string domain"
32737 #: doc/guix.texi:14686
32738 msgid "Domain you wish Prosody to serve."
32742 #: doc/guix.texi:14690
32744 msgid "{@code{prosody-configuration} parameter} int-component-configuration-list int-components"
32748 #: doc/guix.texi:14695
32750 "Components are extra services on a server which are available to clients, "
32751 "usually on a subdomain of the main server (such as @samp{\"mycomponent."
32752 "example.com\"}). Example components might be chatroom servers, user "
32753 "directories, or gateways to other protocols."
32757 #: doc/guix.texi:14699
32759 "Internal components are implemented with Prosody-specific plugins. To add "
32760 "an internal component, you simply fill the hostname field, and the plugin "
32761 "you wish to use for the component."
32765 #: doc/guix.texi:14702
32766 msgid "See @url{https://prosody.im/doc/components}. Defaults to @samp{()}."
32770 #: doc/guix.texi:14704
32771 msgid "Available @code{int-component-configuration} fields are:"
32775 #: doc/guix.texi:14706
32777 msgid "{@code{int-component-configuration} parameter} string hostname"
32781 #: doc/guix.texi:14708 doc/guix.texi:14765
32782 msgid "Hostname of the component."
32786 #: doc/guix.texi:14710
32788 msgid "{@code{int-component-configuration} parameter} string plugin"
32792 #: doc/guix.texi:14712
32793 msgid "Plugin you wish to use for the component."
32797 #: doc/guix.texi:14714
32799 msgid "{@code{int-component-configuration} parameter} maybe-mod-muc-configuration mod-muc"
32803 #: doc/guix.texi:14717
32805 "Multi-user chat (MUC) is Prosody's module for allowing you to create hosted "
32806 "chatrooms/conferences for XMPP users."
32810 #: doc/guix.texi:14721
32812 "General information on setting up and using multi-user chatrooms can be "
32813 "found in the \"Chatrooms\" documentation (@url{https://prosody.im/doc/"
32814 "chatrooms}), which you should read if you are new to XMPP chatrooms."
32818 #: doc/guix.texi:14723
32819 msgid "See also @url{https://prosody.im/doc/modules/mod_muc}."
32823 #: doc/guix.texi:14725
32824 msgid "Available @code{mod-muc-configuration} fields are:"
32828 #: doc/guix.texi:14726
32830 msgid "{@code{mod-muc-configuration} parameter} string name"
32834 #: doc/guix.texi:14729
32836 "The name to return in service discovery responses. Defaults to "
32837 "@samp{\"Prosody Chatrooms\"}."
32841 #: doc/guix.texi:14731
32843 msgid "{@code{mod-muc-configuration} parameter} string-or-boolean restrict-room-creation"
32847 #: doc/guix.texi:14738
32849 "If @samp{#t}, this will only allow admins to create new chatrooms. "
32850 "Otherwise anyone can create a room. The value @samp{\"local\"} restricts "
32851 "room creation to users on the service's parent domain. E.g. "
32852 "@samp{user@@example.com} can create rooms on @samp{rooms.example.com}. The "
32853 "value @samp{\"admin\"} restricts to service administrators only. Defaults "
32858 #: doc/guix.texi:14740
32860 msgid "{@code{mod-muc-configuration} parameter} non-negative-integer max-history-messages"
32864 #: doc/guix.texi:14744
32866 "Maximum number of history messages that will be sent to the member that has "
32867 "just joined the room. Defaults to @samp{20}."
32871 #: doc/guix.texi:14750
32873 msgid "{@code{prosody-configuration} parameter} ext-component-configuration-list ext-components"
32877 #: doc/guix.texi:14755
32879 "External components use XEP-0114, which most standalone components support. "
32880 "To add an external component, you simply fill the hostname field. See "
32881 "@url{https://prosody.im/doc/components}. Defaults to @samp{()}."
32885 #: doc/guix.texi:14757
32886 msgid "Available @code{ext-component-configuration} fields are:"
32890 #: doc/guix.texi:14759
32892 msgid "{@code{ext-component-configuration} parameter} string component-secret"
32896 #: doc/guix.texi:14761
32897 msgid "Password which the component will use to log in."
32901 #: doc/guix.texi:14763
32903 msgid "{@code{ext-component-configuration} parameter} string hostname"
32907 #: doc/guix.texi:14769
32909 msgid "{@code{prosody-configuration} parameter} non-negative-integer-list component-ports"
32913 #: doc/guix.texi:14772
32915 "Port(s) Prosody listens on for component connections. Defaults to "
32920 #: doc/guix.texi:14774
32922 msgid "{@code{prosody-configuration} parameter} string component-interface"
32926 #: doc/guix.texi:14777
32928 "Interface Prosody listens on for component connections. Defaults to "
32929 "@samp{\"127.0.0.1\"}."
32933 #: doc/guix.texi:14779
32935 msgid "{@code{prosody-configuration} parameter} maybe-raw-content raw-content"
32939 #: doc/guix.texi:14781
32940 msgid "Raw content that will be added to the configuration file."
32943 #. type: Plain text
32944 #: doc/guix.texi:14789
32946 "It could be that you just want to get a @code{prosody.cfg.lua} up and "
32947 "running. In that case, you can pass an @code{opaque-prosody-configuration} "
32948 "record as the value of @code{prosody-service-type}. As its name indicates, "
32949 "an opaque configuration does not have easy reflective capabilities. "
32950 "Available @code{opaque-prosody-configuration} fields are:"
32954 #: doc/guix.texi:14790
32956 msgid "{@code{opaque-prosody-configuration} parameter} package prosody"
32960 #: doc/guix.texi:14792
32961 msgid "The prosody package."
32965 #: doc/guix.texi:14794
32967 msgid "{@code{opaque-prosody-configuration} parameter} string prosody.cfg.lua"
32971 #: doc/guix.texi:14796
32972 msgid "The contents of the @code{prosody.cfg.lua} to use."
32975 #. type: Plain text
32976 #: doc/guix.texi:14800
32978 "For example, if your @code{prosody.cfg.lua} is just the empty string, you "
32979 "could instantiate a prosody service like this:"
32983 #: doc/guix.texi:14805
32986 "(service prosody-service-type\n"
32987 " (opaque-prosody-configuration\n"
32988 " (prosody.cfg.lua \"\")))\n"
32991 #. type: subsubheading
32992 #: doc/guix.texi:14809
32994 msgid "BitlBee Service"
32998 #: doc/guix.texi:14811
33000 msgid "IRC (Internet Relay Chat)"
33004 #: doc/guix.texi:14812
33006 msgid "IRC gateway"
33009 #. type: Plain text
33010 #: doc/guix.texi:14815
33012 "@url{http://bitlbee.org,BitlBee} is a gateway that provides an IRC interface "
33013 "to a variety of messaging protocols such as XMPP."
33017 #: doc/guix.texi:14816
33019 msgid "{Scheme Variable} bitlbee-service-type"
33023 #: doc/guix.texi:14820
33025 "This is the service type for the @url{http://bitlbee.org,BitlBee} IRC "
33026 "gateway daemon. Its value is a @code{bitlbee-configuration} (see below)."
33030 #: doc/guix.texi:14823
33032 "To have BitlBee listen on port 6667 on localhost, add this line to your "
33037 #: doc/guix.texi:14826
33039 msgid "(service bitlbee-service-type)\n"
33043 #: doc/guix.texi:14829
33045 msgid "{Data Type} bitlbee-configuration"
33049 #: doc/guix.texi:14831
33050 msgid "This is the configuration for BitlBee, with the following fields:"
33054 #: doc/guix.texi:14833
33056 msgid "@code{interface} (default: @code{\"127.0.0.1\"})"
33060 #: doc/guix.texi:14834
33062 msgid "@code{port} (default: @code{6667})"
33066 #: doc/guix.texi:14837
33068 "Listen on the network interface corresponding to the IP address specified in "
33069 "@var{interface}, on @var{port}."
33073 #: doc/guix.texi:14841
33075 "When @var{interface} is @code{127.0.0.1}, only local clients can connect; "
33076 "when it is @code{0.0.0.0}, connections can come from any networking "
33081 #: doc/guix.texi:14842
33083 msgid "@code{package} (default: @code{bitlbee})"
33087 #: doc/guix.texi:14844
33088 msgid "The BitlBee package to use."
33092 #: doc/guix.texi:14845
33094 msgid "@code{extra-settings} (default: @code{\"\"})"
33098 #: doc/guix.texi:14847
33099 msgid "Configuration snippet added as-is to the BitlBee configuration file."
33103 #: doc/guix.texi:14854
33105 msgid "Murmur (VoIP server)"
33109 #: doc/guix.texi:14855
33111 msgid "VoIP server"
33114 #. type: Plain text
33115 #: doc/guix.texi:14859
33117 "This section describes how to set up and run a Murmur server. Murmur is the "
33118 "server of the @uref{https://mumble.info, Mumble} voice-over-IP (VoIP) suite."
33122 #: doc/guix.texi:14860
33124 msgid "{Data Type} murmur-configuration"
33128 #: doc/guix.texi:14863
33130 "The service type for the Murmur server. An example configuration can look "
33135 #: doc/guix.texi:14872
33138 "(service murmur-service-type\n"
33139 " (murmur-configuration\n"
33141 " \"Welcome to this Mumble server running on GuixSD!\")\n"
33142 " (cert-required? #t) ;disallow text password logins\n"
33143 " (ssl-cert \"/etc/letsencrypt/live/mumble.example.com/fullchain.pem\")\n"
33144 " (ssl-key \"/etc/letsencrypt/live/mumble.example.com/privkey.pem\")))\n"
33148 #: doc/guix.texi:14876
33150 "After reconfiguring your system, you can manually set the murmur "
33151 "@code{SuperUser} password with the command that is printed during the "
33152 "activation phase."
33156 #: doc/guix.texi:14885
33158 "It is recommended to register a normal Mumble user account and grant it "
33159 "admin or moderator rights. You can use the @code{mumble} client to login as "
33160 "new normal user, register yourself, and log out. For the next step login "
33161 "with the name @code{SuperUser} use the @code{SuperUser} password that you "
33162 "set previously, and grant your newly registered mumble user administrator or "
33163 "moderator rights and create some channels."
33167 #: doc/guix.texi:14887
33168 msgid "Available @code{murmur-configuration} fields are:"
33172 #: doc/guix.texi:14889
33174 msgid "@code{package} (default: @code{mumble})"
33178 #: doc/guix.texi:14891
33179 msgid "Package that contains @code{bin/murmurd}."
33183 #: doc/guix.texi:14892
33185 msgid "@code{user} (default: @code{\"murmur\"})"
33189 #: doc/guix.texi:14894
33190 msgid "User who will run the Murmur server."
33194 #: doc/guix.texi:14895
33196 msgid "@code{group} (default: @code{\"murmur\"})"
33200 #: doc/guix.texi:14897
33201 msgid "Group of the user who will run the murmur server."
33205 #: doc/guix.texi:14898
33207 msgid "@code{port} (default: @code{64738})"
33211 #: doc/guix.texi:14900
33212 msgid "Port on which the server will listen."
33216 #: doc/guix.texi:14901
33218 msgid "@code{welcome-text} (default: @code{\"\"})"
33222 #: doc/guix.texi:14903
33223 msgid "Welcome text sent to clients when they connect."
33227 #: doc/guix.texi:14904
33229 msgid "@code{server-password} (default: @code{\"\"})"
33233 #: doc/guix.texi:14906
33234 msgid "Password the clients have to enter in order to connect."
33238 #: doc/guix.texi:14907
33240 msgid "@code{max-users} (default: @code{100})"
33244 #: doc/guix.texi:14909
33245 msgid "Maximum of users that can be connected to the server at once."
33249 #: doc/guix.texi:14910
33251 msgid "@code{max-user-bandwidth} (default: @code{#f})"
33255 #: doc/guix.texi:14912
33256 msgid "Maximum voice traffic a user can send per second."
33260 #: doc/guix.texi:14913
33262 msgid "@code{database-file} (default: @code{\"/var/lib/murmur/db.sqlite\"})"
33266 #: doc/guix.texi:14916
33268 "File name of the sqlite database. The service's user will become the owner "
33269 "of the directory."
33273 #: doc/guix.texi:14917
33275 msgid "@code{log-file} (default: @code{\"/var/log/murmur/murmur.log\"})"
33279 #: doc/guix.texi:14920
33281 "File name of the log file. The service's user will become the owner of the "
33286 #: doc/guix.texi:14921
33288 msgid "@code{autoban-attempts} (default: @code{10})"
33292 #: doc/guix.texi:14924
33294 "Maximum number of logins a user can make in @code{autoban-timeframe} without "
33295 "getting auto banned for @code{autoban-time}."
33299 #: doc/guix.texi:14925
33301 msgid "@code{autoban-timeframe} (default: @code{120})"
33305 #: doc/guix.texi:14927
33306 msgid "Timeframe for autoban in seconds."
33310 #: doc/guix.texi:14928
33312 msgid "@code{autoban-time} (default: @code{300})"
33316 #: doc/guix.texi:14931
33318 "Amount of time in seconds for which a client gets banned when violating the "
33323 #: doc/guix.texi:14932
33325 msgid "@code{opus-threshold} (default: @code{100})"
33329 #: doc/guix.texi:14935
33331 "Percentage of clients that need to support opus before switching over to "
33332 "opus audio codec."
33336 #: doc/guix.texi:14936
33338 msgid "@code{channel-nesting-limit} (default: @code{10})"
33342 #: doc/guix.texi:14938
33343 msgid "How deep channels can be nested at maximum."
33347 #: doc/guix.texi:14939
33349 msgid "@code{channelname-regex} (default: @code{#f})"
33353 #: doc/guix.texi:14941
33355 "A string in from of a Qt regular expression that channel names must conform "
33360 #: doc/guix.texi:14942
33362 msgid "@code{username-regex} (default: @code{#f})"
33366 #: doc/guix.texi:14944
33368 "A string in from of a Qt regular expression that user names must conform to."
33372 #: doc/guix.texi:14945
33374 msgid "@code{text-message-length} (default: @code{5000})"
33378 #: doc/guix.texi:14947
33379 msgid "Maximum size in bytes that a user can send in one text chat message."
33383 #: doc/guix.texi:14948
33385 msgid "@code{image-message-length} (default: @code{(* 128 1024)})"
33389 #: doc/guix.texi:14950
33390 msgid "Maximum size in bytes that a user can send in one image message."
33394 #: doc/guix.texi:14951
33396 msgid "@code{cert-required?} (default: @code{#f})"
33400 #: doc/guix.texi:14954
33402 "If it is set to @code{#t} clients that use weak password authentification "
33403 "will not be accepted. Users must have completed the certificate wizard to "
33408 #: doc/guix.texi:14955
33410 msgid "@code{remember-channel?} (defualt @code{#f})"
33414 #: doc/guix.texi:14958
33416 "Should murmur remember the last channel each user was in when they "
33417 "disconnected and put them into the remembered channel when they rejoin."
33421 #: doc/guix.texi:14959
33423 msgid "@code{allow-html?} (default: @code{#f})"
33427 #: doc/guix.texi:14961
33429 "Should html be allowed in text messages, user comments, and channel "
33434 #: doc/guix.texi:14962
33436 msgid "@code{allow-ping?} (default: @code{#f})"
33440 #: doc/guix.texi:14966
33442 "Setting to true exposes the current user count, the maximum user count, and "
33443 "the server's maximum bandwidth per client to unauthenticated users. In the "
33444 "Mumble client, this information is shown in the Connect dialog."
33448 #: doc/guix.texi:14968
33449 msgid "Disabling this setting will prevent public listing of the server."
33453 #: doc/guix.texi:14969
33455 msgid "@code{bonjour?} (default: @code{#f})"
33459 #: doc/guix.texi:14971
33461 "Should the server advertise itself in the local network through the bonjour "
33466 #: doc/guix.texi:14972
33468 msgid "@code{send-version?} (default: @code{#f})"
33472 #: doc/guix.texi:14974
33473 msgid "Should the murmur server version be exposed in ping requests."
33477 #: doc/guix.texi:14975
33479 msgid "@code{log-days} (default: @code{31})"
33483 #: doc/guix.texi:14979
33485 "Murmur also stores logs in the database, which are accessible via RPC. The "
33486 "default is 31 days of months, but you can set this setting to 0 to keep logs "
33487 "forever, or -1 to disable logging to the database."
33491 #: doc/guix.texi:14980
33493 msgid "@code{obfuscate-ips?} (default @code{#t})"
33497 #: doc/guix.texi:14982
33498 msgid "Should logged ips be obfuscated to protect the privacy of users."
33502 #: doc/guix.texi:14983
33504 msgid "@code{ssl-cert} (default: @code{#f})"
33508 #: doc/guix.texi:14985
33509 msgid "File name of the SSL/TLS certificate used for encrypted connections."
33513 #: doc/guix.texi:14988
33515 msgid "(ssl-cert \"/etc/letsencrypt/live/example.com/fullchain.pem\")\n"
33519 #: doc/guix.texi:14989
33521 msgid "@code{ssl-key} (default: @code{#f})"
33525 #: doc/guix.texi:14991
33526 msgid "Filepath to the ssl private key used for encrypted connections."
33530 #: doc/guix.texi:14993
33532 msgid "(ssl-key \"/etc/letsencrypt/live/example.com/privkey.pem\")\n"
33536 #: doc/guix.texi:14995
33538 msgid "@code{ssl-dh-params} (default: @code{#f})"
33542 #: doc/guix.texi:15000
33544 "File name of a PEM-encoded file with Diffie-Hellman parameters for the SSL/"
33545 "TLS encryption. Alternatively you set it to @code{\"@@ffdhe2048\"}, "
33546 "@code{\"@@ffdhe3072\"}, @code{\"@@ffdhe4096\"}, @code{\"@@ffdhe6144\"} or "
33547 "@code{\"@@ffdhe8192\"} to use bundled parameters from RFC 7919."
33551 #: doc/guix.texi:15001
33553 msgid "@code{ssl-ciphers} (default: @code{#f})"
33557 #: doc/guix.texi:15004
33559 "The @code{ssl-ciphers} option chooses the cipher suites to make available "
33560 "for use in SSL/TLS."
33564 #: doc/guix.texi:15008
33566 "This option is specified using @uref{https://www.openssl.org/docs/apps/"
33567 "ciphers.html#CIPHER-LIST-FORMAT, OpenSSL cipher list notation}."
33571 #: doc/guix.texi:15013
33573 "It is recommended that you try your cipher string using 'openssl ciphers "
33574 "<string>' before setting it here, to get a feel for which cipher suites you "
33575 "will get. After setting this option, it is recommend that you inspect your "
33576 "Murmur log to ensure that Murmur is using the cipher suites that you "
33581 #: doc/guix.texi:15017
33583 "Note: Changing this option may impact the backwards compatibility of your "
33584 "Murmur server, and can remove the ability for older Mumble clients to be "
33585 "able to connect to it."
33589 #: doc/guix.texi:15018
33591 msgid "@code{public-registration} (default: @code{#f})"
33595 #: doc/guix.texi:15020
33597 "Must be a @code{<murmur-public-registration-configuration>} record or "
33602 #: doc/guix.texi:15025
33604 "You can optionally register your server in the public server list that the "
33605 "@code{mumble} client shows on startup. You cannot register your server if "
33606 "you have set a @code{server-password}, or set @code{allow-ping} to @code{#f}."
33610 #: doc/guix.texi:15027
33611 msgid "It might take a few hours until it shows up in the public list."
33615 #: doc/guix.texi:15028 doc/guix.texi:15599
33617 msgid "@code{file} (default: @code{#f})"
33621 #: doc/guix.texi:15030
33622 msgid "Optional alternative override for this configuration."
33626 #: doc/guix.texi:15033
33628 msgid "{Data Type} murmur-public-registration-configuration"
33632 #: doc/guix.texi:15035
33633 msgid "Configuration for public registration of a murmur service."
33637 #: doc/guix.texi:15039
33639 "This is a display name for your server. Not to be confused with the hostname."
33643 #: doc/guix.texi:15040 doc/guix.texi:19930
33649 #: doc/guix.texi:15043
33651 "A password to identify your registration. Subsequent updates will need the "
33652 "same password. Don't lose your password."
33656 #: doc/guix.texi:15044
33662 #: doc/guix.texi:15047
33664 "This should be a @code{http://} or @code{https://} link to your web site."
33668 #: doc/guix.texi:15048
33670 msgid "@code{hostname} (default: @code{#f})"
33674 #: doc/guix.texi:15051
33676 "By default your server will be listed by its IP address. If it is set your "
33677 "server will be linked by this host name instead."
33680 #. type: subsubheading
33681 #: doc/guix.texi:15059
33683 msgid "Tailon Service"
33686 #. type: Plain text
33687 #: doc/guix.texi:15063
33689 "@uref{https://tailon.readthedocs.io/, Tailon} is a web application for "
33690 "viewing and searching log files."
33693 #. type: Plain text
33694 #: doc/guix.texi:15066
33696 "The following example will configure the service with default values. By "
33697 "default, Tailon can be accessed on port 8080 (@code{http://localhost:8080})."
33701 #: doc/guix.texi:15069
33703 msgid "(service tailon-service-type)\n"
33706 #. type: Plain text
33707 #: doc/guix.texi:15073
33709 "The following example customises more of the Tailon configuration, adding "
33710 "@command{sed} to the list of allowed commands."
33714 #: doc/guix.texi:15080
33717 "(service tailon-service-type\n"
33718 " (tailon-configuration\n"
33720 " (tailon-configuration-file\n"
33721 " (allowed-commands '(\"tail\" \"grep\" \"awk\" \"sed\"))))))\n"
33725 #: doc/guix.texi:15083
33727 msgid "{Data Type} tailon-configuration"
33731 #: doc/guix.texi:15086
33733 "Data type representing the configuration of Tailon. This type has the "
33734 "following parameters:"
33738 #: doc/guix.texi:15088
33740 msgid "@code{config-file} (default: @code{(tailon-configuration-file)})"
33744 #: doc/guix.texi:15092
33746 "The configuration file to use for Tailon. This can be set to a @dfn{tailon-"
33747 "configuration-file} record value, or any gexp (@pxref{G-Expressions})."
33751 #: doc/guix.texi:15095
33753 "For example, to instead use a local file, the @code{local-file} function can "
33758 #: doc/guix.texi:15100
33761 "(service tailon-service-type\n"
33762 " (tailon-configuration\n"
33763 " (config-file (local-file \"./my-tailon.conf\"))))\n"
33767 #: doc/guix.texi:15102
33769 msgid "@code{package} (default: @code{tailon})"
33773 #: doc/guix.texi:15104
33774 msgid "The tailon package to use."
33778 #: doc/guix.texi:15108
33780 msgid "{Data Type} tailon-configuration-file"
33784 #: doc/guix.texi:15111
33786 "Data type representing the configuration options for Tailon. This type has "
33787 "the following parameters:"
33791 #: doc/guix.texi:15113
33793 msgid "@code{files} (default: @code{(list \"/var/log\")})"
33797 #: doc/guix.texi:15118
33799 "List of files to display. The list can include strings for a single file or "
33800 "directory, or a list, where the first item is the name of a subsection, and "
33801 "the remaining items are the files or directories in that subsection."
33805 #: doc/guix.texi:15119
33807 msgid "@code{bind} (default: @code{\"localhost:8080\"})"
33811 #: doc/guix.texi:15121
33812 msgid "Address and port to which Tailon should bind on."
33816 #: doc/guix.texi:15122
33818 msgid "@code{relative-root} (default: @code{#f})"
33822 #: doc/guix.texi:15124
33823 msgid "URL path to use for Tailon, set to @code{#f} to not use a path."
33827 #: doc/guix.texi:15125
33829 msgid "@code{allow-transfers?} (default: @code{#t})"
33833 #: doc/guix.texi:15127
33834 msgid "Allow downloading the log files in the web interface."
33838 #: doc/guix.texi:15128
33840 msgid "@code{follow-names?} (default: @code{#t})"
33844 #: doc/guix.texi:15130
33845 msgid "Allow tailing of not-yet existent files."
33849 #: doc/guix.texi:15131
33851 msgid "@code{tail-lines} (default: @code{200})"
33855 #: doc/guix.texi:15133
33856 msgid "Number of lines to read initially from each file."
33860 #: doc/guix.texi:15134
33862 msgid "@code{allowed-commands} (default: @code{(list \"tail\" \"grep\" \"awk\")})"
33866 #: doc/guix.texi:15136
33867 msgid "Commands to allow running. By default, @code{sed} is disabled."
33871 #: doc/guix.texi:15137
33873 msgid "@code{debug?} (default: @code{#f})"
33877 #: doc/guix.texi:15139
33878 msgid "Set @code{debug?} to @code{#t} to show debug messages."
33882 #: doc/guix.texi:15140
33884 msgid "@code{wrap-lines} (default: @code{#t})"
33888 #: doc/guix.texi:15144
33890 "Initial line wrapping state in the web interface. Set to @code{#t} to "
33891 "initially wrap lines (the default), or to @code{#f} to initially not wrap "
33896 #: doc/guix.texi:15145
33898 msgid "@code{http-auth} (default: @code{#f})"
33902 #: doc/guix.texi:15149
33904 "HTTP authentication type to use. Set to @code{#f} to disable authentication "
33905 "(the default). Supported values are @code{\"digest\"} or @code{\"basic\"}."
33909 #: doc/guix.texi:15150
33911 msgid "@code{users} (default: @code{#f})"
33915 #: doc/guix.texi:15155
33917 "If HTTP authentication is enabled (see @code{http-auth}), access will be "
33918 "restricted to the credentials provided here. To configure users, use a list "
33919 "of pairs, where the first element of the pair is the username, and the 2nd "
33920 "element of the pair is the password."
33924 #: doc/guix.texi:15161
33927 "(tailon-configuration-file\n"
33928 " (http-auth \"basic\")\n"
33929 " (users '((\"user1\" . \"password1\")\n"
33930 " (\"user2\" . \"password2\"))))\n"
33933 #. type: subsubheading
33934 #: doc/guix.texi:15167
33936 msgid "Darkstat Service"
33940 #: doc/guix.texi:15168
33945 #. type: Plain text
33946 #: doc/guix.texi:15171
33948 "Darkstat is a packet sniffer that captures network traffic, calculates "
33949 "statistics about usage, and serves reports over HTTP."
33953 #: doc/guix.texi:15172
33955 msgid "{Scheme Variable} darkstat-service-type"
33959 #: doc/guix.texi:15177
33961 "This is the service type for the @uref{https://unix4lyfe.org/darkstat/, "
33962 "darkstat} service, its value must be a @code{darkstat-configuration} record "
33963 "as in this example:"
33967 #: doc/guix.texi:15182
33970 "(service darkstat-service-type\n"
33971 " (darkstat-configuration\n"
33972 " (interface \"eno1\")))\n"
33976 #: doc/guix.texi:15185
33978 msgid "{Data Type} darkstat-configuration"
33982 #: doc/guix.texi:15187
33983 msgid "Data type representing the configuration of @command{darkstat}."
33987 #: doc/guix.texi:15189
33989 msgid "@code{package} (default: @code{darkstat})"
33993 #: doc/guix.texi:15191
33994 msgid "The darkstat package to use."
33998 #: doc/guix.texi:15192
34004 #: doc/guix.texi:15194
34005 msgid "Capture traffic on the specified network interface."
34009 #: doc/guix.texi:15195
34011 msgid "@code{port} (default: @code{\"667\"})"
34015 #: doc/guix.texi:15197
34016 msgid "Bind the web interface to the specified port."
34020 #: doc/guix.texi:15198
34022 msgid "@code{bind-address} (default: @code{\"127.0.0.1\"})"
34026 #: doc/guix.texi:15200
34027 msgid "Bind the web interface to the specified address."
34031 #: doc/guix.texi:15201
34033 msgid "@code{base} (default: @code{\"/\"})"
34037 #: doc/guix.texi:15204
34039 "Specify the path of the base URL. This can be useful if @command{darkstat} "
34040 "is accessed via a reverse proxy."
34044 #: doc/guix.texi:15211
34049 #. type: Plain text
34050 #: doc/guix.texi:15215
34052 "The @code{(gnu services kerberos)} module provides services relating to the "
34053 "authentication protocol @dfn{Kerberos}."
34056 #. type: subsubheading
34057 #: doc/guix.texi:15216
34059 msgid "Krb5 Service"
34062 #. type: Plain text
34063 #: doc/guix.texi:15223
34065 "Programs using a Kerberos client library normally expect a configuration "
34066 "file in @file{/etc/krb5.conf}. This service generates such a file from a "
34067 "definition provided in the operating system declaration. It does not cause "
34068 "any daemon to be started."
34071 #. type: Plain text
34072 #: doc/guix.texi:15227
34074 "No ``keytab'' files are provided by this service---you must explicitly "
34075 "create them. This service is known to work with the MIT client library, "
34076 "@code{mit-krb5}. Other implementations have not been tested."
34080 #: doc/guix.texi:15228
34082 msgid "{Scheme Variable} krb5-service-type"
34086 #: doc/guix.texi:15230
34087 msgid "A service type for Kerberos 5 clients."
34090 #. type: Plain text
34091 #: doc/guix.texi:15234
34092 msgid "Here is an example of its use:"
34096 #: doc/guix.texi:15248
34099 "(service krb5-service-type\n"
34100 " (krb5-configuration\n"
34101 " (default-realm \"EXAMPLE.COM\")\n"
34102 " (allow-weak-crypto? #t)\n"
34105 " (name \"EXAMPLE.COM\")\n"
34106 " (admin-server \"groucho.example.com\")\n"
34107 " (kdc \"karl.example.com\"))\n"
34109 " (name \"ARGRX.EDU\")\n"
34110 " (admin-server \"kerb-admin.argrx.edu\")\n"
34111 " (kdc \"keys.argrx.edu\"))))))\n"
34114 #. type: Plain text
34115 #: doc/guix.texi:15252
34116 msgid "This example provides a Kerberos@tie{}5 client configuration which:"
34120 #: doc/guix.texi:15253
34122 msgid "Recognizes two realms, @i{viz:} ``EXAMPLE.COM'' and ``ARGRX.EDU'', both"
34126 #: doc/guix.texi:15255
34128 "of which have distinct administration servers and key distribution centers;"
34132 #: doc/guix.texi:15255
34134 msgid "Will default to the realm ``EXAMPLE.COM'' if the realm is not explicitly"
34138 #: doc/guix.texi:15257
34139 msgid "specified by clients;"
34143 #: doc/guix.texi:15257
34145 msgid "Accepts services which only support encryption types known to be weak."
34148 #. type: Plain text
34149 #: doc/guix.texi:15265
34151 "The @code{krb5-realm} and @code{krb5-configuration} types have many fields. "
34152 "Only the most commonly used ones are described here. For a full list, and "
34153 "more detailed explanation of each, see the MIT @uref{http://web.mit.edu/"
34154 "kerberos/krb5-devel/doc/admin/conf_files/krb5_conf.html,,krb5.conf} "
34159 #: doc/guix.texi:15267
34161 msgid "{Data Type} krb5-realm"
34165 #: doc/guix.texi:15268
34167 msgid "realm, kerberos"
34171 #: doc/guix.texi:15274
34173 "This field is a string identifying the name of the realm. A common "
34174 "convention is to use the fully qualified DNS name of your organization, "
34175 "converted to upper case."
34179 #: doc/guix.texi:15275
34181 msgid "admin-server"
34185 #: doc/guix.texi:15278
34187 "This field is a string identifying the host where the administration server "
34192 #: doc/guix.texi:15279
34198 #: doc/guix.texi:15282
34200 "This field is a string identifying the key distribution center for the realm."
34204 #: doc/guix.texi:15285
34206 msgid "{Data Type} krb5-configuration"
34210 #: doc/guix.texi:15288
34212 msgid "@code{allow-weak-crypto?} (default: @code{#f})"
34216 #: doc/guix.texi:15291
34218 "If this flag is @code{#t} then services which only offer encryption "
34219 "algorithms known to be weak will be accepted."
34223 #: doc/guix.texi:15292
34225 msgid "@code{default-realm} (default: @code{#f})"
34229 #: doc/guix.texi:15299
34231 "This field should be a string identifying the default Kerberos realm for the "
34232 "client. You should set this field to the name of your Kerberos realm. If "
34233 "this value is @code{#f} then a realm must be specified with every Kerberos "
34234 "principal when invoking programs such as @command{kinit}."
34238 #: doc/guix.texi:15300
34244 #: doc/guix.texi:15305
34246 "This should be a non-empty list of @code{krb5-realm} objects, which clients "
34247 "may access. Normally, one of them will have a @code{name} field matching "
34248 "the @code{default-realm} field."
34251 #. type: subsubheading
34252 #: doc/guix.texi:15309
34254 msgid "PAM krb5 Service"
34258 #: doc/guix.texi:15310
34263 #. type: Plain text
34264 #: doc/guix.texi:15316
34266 "The @code{pam-krb5} service allows for login authentication and password "
34267 "management via Kerberos. You will need this service if you want PAM enabled "
34268 "applications to authenticate users using Kerberos."
34272 #: doc/guix.texi:15317
34274 msgid "{Scheme Variable} pam-krb5-service-type"
34278 #: doc/guix.texi:15319
34279 msgid "A service type for the Kerberos 5 PAM module."
34283 #: doc/guix.texi:15321
34285 msgid "{Data Type} pam-krb5-configuration"
34289 #: doc/guix.texi:15324
34291 "Data type representing the configuration of the Kerberos 5 PAM module This "
34292 "type has the following parameters:"
34296 #: doc/guix.texi:15325
34298 msgid "@code{pam-krb5} (default: @code{pam-krb5})"
34302 #: doc/guix.texi:15327
34303 msgid "The pam-krb5 package to use."
34307 #: doc/guix.texi:15328
34309 msgid "@code{minimum-uid} (default: @code{1000})"
34313 #: doc/guix.texi:15331
34315 "The smallest user ID for which Kerberos authentications should be "
34316 "attempted. Local accounts with lower values will silently fail to "
34321 #: doc/guix.texi:15338
34327 #: doc/guix.texi:15339
34333 #: doc/guix.texi:15340
34338 #. type: Plain text
34339 #: doc/guix.texi:15343
34341 "The @code{(gnu services web)} module provides the Apache HTTP Server, the "
34342 "nginx web server, and also a fastcgi wrapper daemon."
34345 #. type: subsubheading
34346 #: doc/guix.texi:15344
34348 msgid "Apache HTTP Server"
34352 #: doc/guix.texi:15346
34354 msgid "{Scheme Variable} httpd-service-type"
34358 #: doc/guix.texi:15350
34360 "Service type for the @uref{https://httpd.apache.org/,Apache HTTP} server "
34361 "(@dfn{httpd}). The value for this service type is a @code{https-"
34362 "configuration} record."
34366 #: doc/guix.texi:15352 doc/guix.texi:15503
34367 msgid "A simple example configuration is given below."
34371 #: doc/guix.texi:15360
34374 "(service httpd-service-type\n"
34375 " (httpd-configuration\n"
34377 " (httpd-config-file\n"
34378 " (server-name \"www.example.com\")\n"
34379 " (document-root \"/srv/http/www.example.com\")))))\n"
34383 #: doc/guix.texi:15364
34385 "Other services can also extend the @code{httpd-service-type} to add to the "
34390 #: doc/guix.texi:15373 doc/guix.texi:15483
34393 "(simple-service 'my-extra-server httpd-service-type\n"
34395 " (httpd-virtualhost\n"
34397 " (list (string-append\n"
34398 " \"ServerName \"www.example.com\n"
34399 " DocumentRoot \\\"/srv/http/www.example.com\\\"\")))))\n"
34402 #. type: Plain text
34403 #: doc/guix.texi:15379
34405 "The details for the @code{httpd-configuration}, @code{httpd-module}, "
34406 "@code{httpd-config-file} and @code{httpd-virtualhost} record types are given "
34411 #: doc/guix.texi:15380
34413 msgid "{Data Type} httpd-configuration"
34417 #: doc/guix.texi:15382
34418 msgid "This data type represents the configuration for the httpd service."
34422 #: doc/guix.texi:15384
34424 msgid "@code{package} (default: @code{httpd})"
34428 #: doc/guix.texi:15386
34429 msgid "The httpd package to use."
34433 #: doc/guix.texi:15387 doc/guix.texi:15446
34435 msgid "@code{pid-file} (default: @code{\"/var/run/httpd\"})"
34439 #: doc/guix.texi:15389
34440 msgid "The pid file used by the shepherd-service."
34444 #: doc/guix.texi:15390
34446 msgid "@code{config} (default: @code{(httpd-config-file)})"
34450 #: doc/guix.texi:15395
34452 "The configuration file to use with the httpd service. The default value is a "
34453 "@code{httpd-config-file} record, but this can also be a different G-"
34454 "expression that generates a file, for example a @code{plain-file}. A file "
34455 "outside of the store can also be specified through a string."
34459 #: doc/guix.texi:15399
34461 msgid "{Data Type} httpd-module"
34465 #: doc/guix.texi:15401
34466 msgid "This data type represents a module for the httpd service."
34470 #: doc/guix.texi:15405
34471 msgid "The name of the module."
34475 #: doc/guix.texi:15411
34477 "The file for the module. This can be relative to the httpd package being "
34478 "used, the absolute location of a file, or a G-expression for a file within "
34479 "the store, for example @code{(file-append mod-wsgi \"/modules/mod_wsgi.so"
34484 #: doc/guix.texi:15415
34486 msgid "{Data Type} httpd-config-file"
34490 #: doc/guix.texi:15417
34491 msgid "This data type represents a configuration file for the httpd service."
34495 #: doc/guix.texi:15419
34497 msgid "@code{modules} (default: @code{%default-httpd-modules})"
34501 #: doc/guix.texi:15422
34503 "The modules to load. Additional modules can be added here, or loaded by "
34504 "additional configuration."
34508 #: doc/guix.texi:15423
34510 msgid "@code{server-root} (default: @code{httpd})"
34514 #: doc/guix.texi:15427
34516 "The @code{ServerRoot} in the configuration file, defaults to the httpd "
34517 "package. Directives including @code{Include} and @code{LoadModule} are taken "
34518 "as relative to the server root."
34522 #: doc/guix.texi:15428
34524 msgid "@code{server-name} (default: @code{#f})"
34528 #: doc/guix.texi:15432
34530 "The @code{ServerName} in the configuration file, used to specify the request "
34531 "scheme, hostname and port that the server uses to identify itself."
34535 #: doc/guix.texi:15436
34537 "This doesn't need to be set in the server config, and can be specifyed in "
34538 "virtual hosts. The default is @code{#f} to not specify a @code{ServerName}."
34542 #: doc/guix.texi:15437
34544 msgid "@code{document-root} (default: @code{\"/srv/http\"})"
34548 #: doc/guix.texi:15439
34549 msgid "The @code{DocumentRoot} from which files will be served."
34553 #: doc/guix.texi:15440
34555 msgid "@code{listen} (default: @code{'(\"80\")})"
34559 #: doc/guix.texi:15445
34561 "The list of values for the @code{Listen} directives in the config file. The "
34562 "value should be a list of strings, when each string can specify the port "
34563 "number to listen on, and optionally the IP address and protocol to use."
34567 #: doc/guix.texi:15450
34569 "The @code{PidFile} to use. This should match the @code{pid-file} set in the "
34570 "@code{httpd-configuration} so that the Shepherd service is configured "
34575 #: doc/guix.texi:15451
34577 msgid "@code{error-log} (default: @code{\"/var/log/httpd/error_log\"})"
34581 #: doc/guix.texi:15453
34582 msgid "The @code{ErrorLog} to which the server will log errors."
34586 #: doc/guix.texi:15454
34588 msgid "@code{user} (default: @code{\"httpd\"})"
34592 #: doc/guix.texi:15456
34593 msgid "The @code{User} which the server will answer requests as."
34597 #: doc/guix.texi:15457
34599 msgid "@code{group} (default: @code{\"httpd\"})"
34603 #: doc/guix.texi:15459
34604 msgid "The @code{Group} which the server will answer requests as."
34608 #: doc/guix.texi:15460
34610 msgid "@code{extra-config} (default: @code{(list \"TypesConfig etc/httpd/mime.types\")})"
34614 #: doc/guix.texi:15463
34616 "A flat list of strings and G-expressions which will be added to the end of "
34617 "the configuration file."
34621 #: doc/guix.texi:15466
34623 "Any values which the service is extended with will be appended to this list."
34627 #: doc/guix.texi:15470
34629 msgid "{Data Type} httpd-virtualhost"
34633 #: doc/guix.texi:15472
34635 "This data type represents a virtualhost configuration block for the httpd "
34640 #: doc/guix.texi:15474
34641 msgid "These should be added to the extra-config for the httpd-service."
34645 #: doc/guix.texi:15486
34647 msgid "addresses-and-ports"
34651 #: doc/guix.texi:15488
34652 msgid "The addresses and ports for the @code{VirtualHost} directive."
34656 #: doc/guix.texi:15489
34662 #: doc/guix.texi:15492
34664 "The contents of the @code{VirtualHost} directive, this should be a list of "
34665 "strings and G-expressions."
34668 #. type: subsubheading
34669 #: doc/guix.texi:15496
34675 #: doc/guix.texi:15498
34677 msgid "{Scheme Variable} nginx-service-type"
34681 #: doc/guix.texi:15501
34683 "Service type for the @uref{https://nginx.org/,NGinx} web server. The value "
34684 "for this service type is a @code{<nginx-configuration>} record."
34688 #: doc/guix.texi:15511 doc/guix.texi:15565
34691 "(service nginx-service-type\n"
34692 " (nginx-configuration\n"
34693 " (server-blocks\n"
34694 " (list (nginx-server-configuration\n"
34695 " (server-name '(\"www.example.com\"))\n"
34696 " (root \"/srv/http/www.example.com\"))))))\n"
34700 #: doc/guix.texi:15516
34702 "In addition to adding server blocks to the service configuration directly, "
34703 "this service can be extended by other services to add server blocks, as in "
34708 #: doc/guix.texi:15522
34711 "(simple-service 'my-extra-server nginx-service-type\n"
34712 " (list (nginx-server-configuration\n"
34713 " (root \"/srv/http/extra-website\")\n"
34714 " (try-files (list \"$uri\" \"$uri/index.html\")))))\n"
34717 #. type: Plain text
34718 #: doc/guix.texi:15533
34720 "At startup, @command{nginx} has not yet read its configuration file, so it "
34721 "uses a default file to log error messages. If it fails to load its "
34722 "configuration file, that is where error messages are logged. After the "
34723 "configuration file is loaded, the default error log file changes as per "
34724 "configuration. In our case, startup error messages can be found in @file{/"
34725 "var/run/nginx/logs/error.log}, and after configuration in @file{/var/log/"
34726 "nginx/error.log}. The second location can be changed with the @var{log-"
34727 "directory} configuration option."
34731 #: doc/guix.texi:15534
34733 msgid "{Data Type} nginx-configuration"
34737 #: doc/guix.texi:15538
34739 "This data type represents the configuration for NGinx. Some configuration "
34740 "can be done through this and the other provided record types, or "
34741 "alternatively, a config file can be provided."
34745 #: doc/guix.texi:15540
34747 msgid "@code{nginx} (default: @code{nginx})"
34751 #: doc/guix.texi:15542
34752 msgid "The nginx package to use."
34756 #: doc/guix.texi:15543
34758 msgid "@code{log-directory} (default: @code{\"/var/log/nginx\"})"
34762 #: doc/guix.texi:15545
34763 msgid "The directory to which NGinx will write log files."
34767 #: doc/guix.texi:15546
34769 msgid "@code{run-directory} (default: @code{\"/var/run/nginx\"})"
34773 #: doc/guix.texi:15549
34775 "The directory in which NGinx will create a pid file, and write temporary "
34780 #: doc/guix.texi:15550
34782 msgid "@code{server-blocks} (default: @code{'()})"
34786 #: doc/guix.texi:15554
34788 "A list of @dfn{server blocks} to create in the generated configuration file, "
34789 "the elements should be of type @code{<nginx-server-configuration>}."
34793 #: doc/guix.texi:15558
34795 "The following example would setup NGinx to serve @code{www.example.com} from "
34796 "the @code{/srv/http/www.example.com} directory, without using HTTPS."
34800 #: doc/guix.texi:15567
34802 msgid "@code{upstream-blocks} (default: @code{'()})"
34806 #: doc/guix.texi:15571
34808 "A list of @dfn{upstream blocks} to create in the generated configuration "
34809 "file, the elements should be of type @code{<nginx-upstream-configuration>}."
34813 #: doc/guix.texi:15578
34815 "Configuring upstreams through the @code{upstream-blocks} can be useful when "
34816 "combined with @code{locations} in the @code{<nginx-server-configuration>} "
34817 "records. The following example creates a server configuration with one "
34818 "location configuration, that will proxy requests to a upstream "
34819 "configuration, which will handle requests with two servers."
34823 #: doc/guix.texi:15597
34827 " nginx-service-type\n"
34828 " (nginx-configuration\n"
34829 " (server-blocks\n"
34830 " (list (nginx-server-configuration\n"
34831 " (server-name '(\"www.example.com\"))\n"
34832 " (root \"/srv/http/www.example.com\")\n"
34835 " (nginx-location-configuration\n"
34836 " (uri \"/path1\")\n"
34837 " (body '(\"proxy_pass http://server-proxy;\"))))))))\n"
34838 " (upstream-blocks\n"
34839 " (list (nginx-upstream-configuration\n"
34840 " (name \"server-proxy\")\n"
34841 " (servers (list \"server1.example.com\"\n"
34842 " \"server2.example.com\")))))))\n"
34846 #: doc/guix.texi:15605
34848 "If a configuration @var{file} is provided, this will be used, rather than "
34849 "generating a configuration file from the provided @code{log-directory}, "
34850 "@code{run-directory}, @code{server-blocks} and @code{upstream-blocks}. For "
34851 "proper operation, these arguments should match what is in @var{file} to "
34852 "ensure that the directories are created when the service is activated."
34856 #: doc/guix.texi:15609
34858 "This can be useful if you have an existing configuration file, or it's not "
34859 "possible to do what is required through the other parts of the nginx-"
34860 "configuration record."
34864 #: doc/guix.texi:15610
34866 msgid "@code{server-names-hash-bucket-size} (default: @code{#f})"
34870 #: doc/guix.texi:15613
34872 "Bucket size for the server names hash tables, defaults to @code{#f} to use "
34873 "the size of the processors cache line."
34877 #: doc/guix.texi:15614
34879 msgid "@code{server-names-hash-bucket-max-size} (default: @code{#f})"
34883 #: doc/guix.texi:15616
34884 msgid "Maximum bucket size for the server names hash tables."
34888 #: doc/guix.texi:15620
34890 msgid "{Data Type} nginx-server-configuration"
34894 #: doc/guix.texi:15623
34896 "Data type representing the configuration of an nginx server block. This "
34897 "type has the following parameters:"
34901 #: doc/guix.texi:15625
34903 msgid "@code{listen} (default: @code{'(\"80\" \"443 ssl\")})"
34907 #: doc/guix.texi:15630
34909 "Each @code{listen} directive sets the address and port for IP, or the path "
34910 "for a UNIX-domain socket on which the server will accept requests. Both "
34911 "address and port, or only address or only port can be specified. An address "
34912 "may also be a hostname, for example:"
34916 #: doc/guix.texi:15633
34918 msgid "'(\"127.0.0.1:8000\" \"127.0.0.1\" \"8000\" \"*:8000\" \"localhost:8000\")\n"
34922 #: doc/guix.texi:15635
34924 msgid "@code{server-name} (default: @code{(list 'default)})"
34928 #: doc/guix.texi:15638
34930 "A list of server names this server represents. @code{'default} represents "
34931 "the default server for connections matching no other server."
34935 #: doc/guix.texi:15639
34937 msgid "@code{root} (default: @code{\"/srv/http\"})"
34941 #: doc/guix.texi:15641
34942 msgid "Root of the website nginx will serve."
34946 #: doc/guix.texi:15642
34948 msgid "@code{locations} (default: @code{'()})"
34952 #: doc/guix.texi:15646
34954 "A list of @dfn{nginx-location-configuration} or @dfn{nginx-named-location-"
34955 "configuration} records to use within this server block."
34959 #: doc/guix.texi:15647
34961 msgid "@code{index} (default: @code{(list \"index.html\")})"
34965 #: doc/guix.texi:15650
34967 "Index files to look for when clients ask for a directory. If it cannot be "
34968 "found, Nginx will send the list of files in the directory."
34972 #: doc/guix.texi:15651
34974 msgid "@code{try-files} (default: @code{'()})"
34978 #: doc/guix.texi:15654
34980 "A list of files whose existence is checked in the specified order. "
34981 "@code{nginx} will use the first file it finds to process the request."
34985 #: doc/guix.texi:15655
34987 msgid "@code{ssl-certificate} (default: @code{#f})"
34991 #: doc/guix.texi:15658
34993 "Where to find the certificate for secure connections. Set it to @code{#f} "
34994 "if you don't have a certificate or you don't want to use HTTPS."
34998 #: doc/guix.texi:15659
35000 msgid "@code{ssl-certificate-key} (default: @code{#f})"
35004 #: doc/guix.texi:15662
35006 "Where to find the private key for secure connections. Set it to @code{#f} "
35007 "if you don't have a key or you don't want to use HTTPS."
35011 #: doc/guix.texi:15663
35013 msgid "@code{server-tokens?} (default: @code{#f})"
35017 #: doc/guix.texi:15665
35018 msgid "Whether the server should add its configuration to response."
35022 #: doc/guix.texi:15666
35024 msgid "@code{raw-content} (default: @code{'()})"
35028 #: doc/guix.texi:15668
35029 msgid "A list of raw lines added to the server block."
35033 #: doc/guix.texi:15672
35035 msgid "{Data Type} nginx-upstream-configuration"
35039 #: doc/guix.texi:15675
35041 "Data type representing the configuration of an nginx @code{upstream} block. "
35042 "This type has the following parameters:"
35046 #: doc/guix.texi:15679
35047 msgid "Name for this group of servers."
35051 #: doc/guix.texi:15680
35057 #: doc/guix.texi:15687
35059 "Specify the addresses of the servers in the group. The address can be "
35060 "specified as a IP address (e.g. @samp{127.0.0.1}), domain name (e.g. "
35061 "@samp{backend1.example.com}) or a path to a UNIX socket using the prefix "
35062 "@samp{unix:}. For addresses using an IP address or domain name, the default "
35063 "port is 80, and a different port can be specified explicitly."
35067 #: doc/guix.texi:15691
35069 msgid "{Data Type} nginx-location-configuration"
35073 #: doc/guix.texi:15694
35075 "Data type representing the configuration of an nginx @code{location} block. "
35076 "This type has the following parameters:"
35080 #: doc/guix.texi:15698
35081 msgid "URI which this location block matches."
35084 #. type: anchor{#1}
35085 #: doc/guix.texi:15700
35086 msgid "nginx-location-configuration body"
35090 #: doc/guix.texi:15700 doc/guix.texi:15721
35096 #: doc/guix.texi:15707
35098 "Body of the location block, specified as a list of strings. This can contain "
35099 "many configuration directives. For example, to pass requests to a upstream "
35100 "server group defined using an @code{nginx-upstream-configuration} block, the "
35101 "following directive would be specified in the body @samp{(list \"proxy_pass "
35102 "http://upstream-name;\")}."
35106 #: doc/guix.texi:15711
35108 msgid "{Data Type} nginx-named-location-configuration"
35112 #: doc/guix.texi:15716
35114 "Data type representing the configuration of an nginx named location block. "
35115 "Named location blocks are used for request redirection, and not used for "
35116 "regular request processing. This type has the following parameters:"
35120 #: doc/guix.texi:15720
35121 msgid "Name to identify this location block."
35125 #: doc/guix.texi:15726
35127 "@xref{nginx-location-configuration body}, as the body for named location "
35128 "blocks can be used in a similar way to the @code{nginx-location-"
35129 "configuration body}. One restriction is that the body of a named location "
35130 "block cannot contain location blocks."
35134 #: doc/guix.texi:15730
35140 #: doc/guix.texi:15731
35145 #. type: Plain text
35146 #: doc/guix.texi:15738
35148 "FastCGI is an interface between the front-end and the back-end of a web "
35149 "service. It is a somewhat legacy facility; new web services should "
35150 "generally just talk HTTP between the front-end and the back-end. However "
35151 "there are a number of back-end services such as PHP or the optimized HTTP "
35152 "Git repository access that use FastCGI, so we have support for it in Guix."
35155 #. type: Plain text
35156 #: doc/guix.texi:15745
35158 "To use FastCGI, you configure the front-end web server (e.g., nginx) to "
35159 "dispatch some subset of its requests to the fastcgi backend, which listens "
35160 "on a local TCP or UNIX socket. There is an intermediary @code{fcgiwrap} "
35161 "program that sits between the actual backend process and the web server. "
35162 "The front-end indicates which backend program to run, passing that "
35163 "information to the @code{fcgiwrap} process."
35167 #: doc/guix.texi:15746
35169 msgid "{Scheme Variable} fcgiwrap-service-type"
35173 #: doc/guix.texi:15748
35174 msgid "A service type for the @code{fcgiwrap} FastCGI proxy."
35178 #: doc/guix.texi:15750
35180 msgid "{Data Type} fcgiwrap-configuration"
35184 #: doc/guix.texi:15753
35186 "Data type representing the configuration of the @code{fcgiwrap} serice. "
35187 "This type has the following parameters:"
35191 #: doc/guix.texi:15754
35193 msgid "@code{package} (default: @code{fcgiwrap})"
35197 #: doc/guix.texi:15756
35198 msgid "The fcgiwrap package to use."
35202 #: doc/guix.texi:15757
35204 msgid "@code{socket} (default: @code{tcp:127.0.0.1:9000})"
35208 #: doc/guix.texi:15763
35210 "The socket on which the @code{fcgiwrap} process should listen, as a string. "
35211 "Valid @var{socket} values include @code{unix:@var{/path/to/unix/socket}}, "
35212 "@code{tcp:@var{dot.ted.qu.ad}:@var{port}} and @code{tcp6:[@var{ipv6_addr}]:"
35217 #: doc/guix.texi:15764
35219 msgid "@code{user} (default: @code{fcgiwrap})"
35223 #: doc/guix.texi:15765
35225 msgid "@code{group} (default: @code{fcgiwrap})"
35229 #: doc/guix.texi:15770
35231 "The user and group names, as strings, under which to run the @code{fcgiwrap} "
35232 "process. The @code{fastcgi} service will ensure that if the user asks for "
35233 "the specific user or group names @code{fcgiwrap} that the corresponding user "
35234 "and/or group is present on the system."
35238 #: doc/guix.texi:15777
35240 "It is possible to configure a FastCGI-backed web service to pass HTTP "
35241 "authentication information from the front-end to the back-end, and to allow "
35242 "@code{fcgiwrap} to run the back-end process as a corresponding local user. "
35243 "To enable this capability on the back-end., run @code{fcgiwrap} as the "
35244 "@code{root} user and group. Note that this capability also has to be "
35245 "configured on the front-end as well."
35249 #: doc/guix.texi:15780
35254 #. type: Plain text
35255 #: doc/guix.texi:15783
35257 "PHP-FPM (FastCGI Process Manager) is an alternative PHP FastCGI "
35258 "implementation with some additional features useful for sites of any size."
35261 #. type: Plain text
35262 #: doc/guix.texi:15785
35263 msgid "These features include:"
35267 #: doc/guix.texi:15786
35269 msgid "Adaptive process spawning"
35273 #: doc/guix.texi:15787
35275 msgid "Basic statistics (similar to Apache's mod_status)"
35279 #: doc/guix.texi:15788
35281 msgid "Advanced process management with graceful stop/start"
35285 #: doc/guix.texi:15789
35287 msgid "Ability to start workers with different uid/gid/chroot/environment"
35291 #: doc/guix.texi:15791
35292 msgid "and different php.ini (replaces safe_mode)"
35296 #: doc/guix.texi:15791
35298 msgid "Stdout & stderr logging"
35302 #: doc/guix.texi:15792
35304 msgid "Emergency restart in case of accidental opcode cache destruction"
35308 #: doc/guix.texi:15793
35310 msgid "Accelerated upload support"
35314 #: doc/guix.texi:15794
35316 msgid "Support for a \"slowlog\""
35320 #: doc/guix.texi:15795
35322 msgid "Enhancements to FastCGI, such as fastcgi_finish_request() -"
35326 #: doc/guix.texi:15798
35328 "a special function to finish request & flush all data while continuing to do "
35329 "something time-consuming (video converting, stats processing, etc.)"
35332 #. type: Plain text
35333 #: doc/guix.texi:15800
35334 msgid "... and much more."
35338 #: doc/guix.texi:15801
35340 msgid "{Scheme Variable} php-fpm-service-type"
35344 #: doc/guix.texi:15803
35345 msgid "A Service type for @code{php-fpm}."
35349 #: doc/guix.texi:15805
35351 msgid "{Data Type} php-fpm-configuration"
35355 #: doc/guix.texi:15807
35356 msgid "Data Type for php-fpm service configuration."
35360 #: doc/guix.texi:15808
35362 msgid "@code{php} (default: @code{php})"
35366 #: doc/guix.texi:15810
35367 msgid "The php package to use."
35371 #: doc/guix.texi:15810
35373 msgid "@code{socket} (default: @code{(string-append \"/var/run/php\" (version-major (package-version php)) \"-fpm.sock\")})"
35377 #: doc/guix.texi:15812
35378 msgid "The address on which to accept FastCGI requests. Valid syntaxes are:"
35382 #: doc/guix.texi:15813
35384 msgid "\"ip.add.re.ss:port\""
35388 #: doc/guix.texi:15815
35389 msgid "Listen on a TCP socket to a specific address on a specific port."
35393 #: doc/guix.texi:15815
35399 #: doc/guix.texi:15817
35400 msgid "Listen on a TCP socket to all addresses on a specific port."
35404 #: doc/guix.texi:15817
35406 msgid "\"/path/to/unix/socket\""
35410 #: doc/guix.texi:15819
35411 msgid "Listen on a unix socket."
35415 #: doc/guix.texi:15821
35417 msgid "@code{user} (default: @code{php-fpm})"
35421 #: doc/guix.texi:15823
35422 msgid "User who will own the php worker processes."
35426 #: doc/guix.texi:15823
35428 msgid "@code{group} (default: @code{php-fpm})"
35432 #: doc/guix.texi:15825
35433 msgid "Group of the worker processes."
35437 #: doc/guix.texi:15825
35439 msgid "@code{socket-user} (default: @code{php-fpm})"
35443 #: doc/guix.texi:15827
35444 msgid "User who can speak to the php-fpm socket."
35448 #: doc/guix.texi:15827
35450 msgid "@code{socket-group} (default: @code{php-fpm})"
35454 #: doc/guix.texi:15829
35455 msgid "Group that can speak to the php-fpm socket."
35459 #: doc/guix.texi:15829
35461 msgid "@code{pid-file} (default: @code{(string-append \"/var/run/php\" (version-major (package-version php)) \"-fpm.pid\")})"
35465 #: doc/guix.texi:15832
35467 "The process id of the php-fpm process is written to this file once the "
35468 "service has started."
35472 #: doc/guix.texi:15832
35474 msgid "@code{log-file} (default: @code{(string-append \"/var/log/php\" (version-major (package-version php)) \"-fpm.log\")})"
35478 #: doc/guix.texi:15834
35479 msgid "Log for the php-fpm master process."
35483 #: doc/guix.texi:15834
35485 msgid "@code{process-manager} (default: @code{(php-fpm-dynamic-process-manager-configuration)})"
35489 #: doc/guix.texi:15837
35490 msgid "Detailed settings for the php-fpm process manager. Must be either:"
35494 #: doc/guix.texi:15838
35496 msgid "<php-fpm-dynamic-process-manager-configuration>"
35500 #: doc/guix.texi:15839
35502 msgid "<php-fpm-static-process-manager-configuration>"
35506 #: doc/guix.texi:15840
35508 msgid "<php-fpm-on-demand-process-manager-configuration>"
35512 #: doc/guix.texi:15842
35514 msgid "@code{display-errors} (default @code{#f})"
35518 #: doc/guix.texi:15847
35520 "Determines whether php errors and warning should be sent to clients and "
35521 "displayed in their browsers. This is useful for local php development, but "
35522 "a security risk for public sites, as error messages can reveal passwords and "
35527 #: doc/guix.texi:15847
35529 msgid "@code{workers-logfile} (default @code{(string-append \"/var/log/php\" (version-major (package-version php)) \"-fpm.www.log\")})"
35533 #: doc/guix.texi:15850
35535 "This file will log the @code{stderr} outputs of php worker processes. Can "
35536 "be set to @code{#f} to disable logging."
35540 #: doc/guix.texi:15850
35542 msgid "@code{file} (default @code{#f})"
35546 #: doc/guix.texi:15853
35548 "An optional override of the whole configuration. You can use the "
35549 "@code{mixed-text-file} function or an absolute filepath for it."
35553 #: doc/guix.texi:15856
35555 msgid "{Data type} php-fpm-dynamic-process-manager-configuration"
35559 #: doc/guix.texi:15860
35561 "Data Type for the @code{dynamic} php-fpm process manager. With the "
35562 "@code{dynamic} process manager, spare worker processes are kept around based "
35563 "on it's configured limits."
35567 #: doc/guix.texi:15861 doc/guix.texi:15877 doc/guix.texi:15887
35569 msgid "@code{max-children} (default: @code{5})"
35573 #: doc/guix.texi:15863 doc/guix.texi:15879 doc/guix.texi:15889
35574 msgid "Maximum of worker processes."
35578 #: doc/guix.texi:15863
35580 msgid "@code{start-servers} (default: @code{2})"
35584 #: doc/guix.texi:15865
35585 msgid "How many worker processes should be started on start-up."
35589 #: doc/guix.texi:15865
35591 msgid "@code{min-spare-servers} (default: @code{1})"
35595 #: doc/guix.texi:15867
35596 msgid "How many spare worker processes should be kept around at minimum."
35600 #: doc/guix.texi:15867
35602 msgid "@code{max-spare-servers} (default: @code{3})"
35606 #: doc/guix.texi:15869
35607 msgid "How many spare worker processes should be kept around at maximum."
35611 #: doc/guix.texi:15872
35613 msgid "{Data type} php-fpm-static-process-manager-configuration"
35617 #: doc/guix.texi:15876
35619 "Data Type for the @code{static} php-fpm process manager. With the "
35620 "@code{static} process manager, an unchanging number of worker processes are "
35625 #: doc/guix.texi:15882
35627 msgid "{Data type} php-fpm-on-demand-process-manager-configuration"
35631 #: doc/guix.texi:15886
35633 "Data Type for the @code{on-demand} php-fpm process manager. With the "
35634 "@code{on-demand} process manager, worker processes are only created as "
35639 #: doc/guix.texi:15889
35641 msgid "@code{process-idle-timeout} (default: @code{10})"
35645 #: doc/guix.texi:15891
35646 msgid "The time in seconds after which a process with no requests is killed."
35650 #: doc/guix.texi:15895
35652 msgid "{Scheme Procedure} nginx-php-fpm-location @"
35656 #: doc/guix.texi:15901
35658 "[#:nginx-package nginx] @ [socket (string-append \"/var/run/php\" @ (version-"
35659 "major (package-version php)) @ \"-fpm.sock\")] A helper function to quickly "
35660 "add php to an @code{nginx-server-configuration}."
35663 #. type: Plain text
35664 #: doc/guix.texi:15904
35665 msgid "A simple services setup for nginx with php can look like this:"
35669 #: doc/guix.texi:15917
35672 "(services (cons* (dhcp-client-service)\n"
35673 " (service php-fpm-service-type)\n"
35674 " (service nginx-service-type\n"
35675 " (nginx-server-configuration\n"
35676 " (server-name '(\"example.com\"))\n"
35677 " (root \"/srv/http/\")\n"
35679 " (list (nginx-php-location)))\n"
35680 " (https-port #f)\n"
35681 " (ssl-certificate #f)\n"
35682 " (ssl-certificate-key #f)))\n"
35683 " %base-services))\n"
35687 #: doc/guix.texi:15919
35689 msgid "cat-avatar-generator"
35692 #. type: Plain text
35693 #: doc/guix.texi:15923
35695 "The cat avatar generator is a simple service to demonstrate the use of php-"
35696 "fpm in @code{Nginx}. It is used to generate cat avatar from a seed, for "
35697 "instance the hash of a user's email address."
35701 #: doc/guix.texi:15924
35703 msgid "{Scheme Procedure} cat-avatar-generator-serice @"
35707 #: doc/guix.texi:15932
35709 "[#:cache-dir \"/var/cache/cat-avatar-generator\"] @ [#:package cat-avatar-"
35710 "generator] @ [#:configuration (nginx-server-configuration)] Returns an nginx-"
35711 "server-configuration that inherits @code{configuration}. It extends the "
35712 "nginx configuration to add a server block that serves @code{package}, a "
35713 "version of cat-avatar-generator. During execution, cat-avatar-generator "
35714 "will be able to use @code{cache-dir} as its cache directory."
35717 #. type: Plain text
35718 #: doc/guix.texi:15935
35719 msgid "A simple setup for cat-avatar-generator can look like this:"
35723 #: doc/guix.texi:15942
35726 "(services (cons* (cat-avatar-generator-service\n"
35727 " #:configuration\n"
35728 " (nginx-server-configuration\n"
35729 " (server-name '(\"example.com\"))))\n"
35731 " %base-services))\n"
35735 #: doc/guix.texi:15947
35741 #: doc/guix.texi:15948
35743 msgid "HTTP, HTTPS"
35747 #: doc/guix.texi:15949
35749 msgid "Let's Encrypt"
35753 #: doc/guix.texi:15950
35755 msgid "TLS certificates"
35758 #. type: Plain text
35759 #: doc/guix.texi:15957
35761 "The @code{(gnu services certbot)} module provides a service to automatically "
35762 "obtain a valid TLS certificate from the Let's Encrypt certificate "
35763 "authority. These certificates can then be used to serve content securely "
35764 "over HTTPS or other TLS-based protocols, with the knowledge that the client "
35765 "will be able to verify the server's authenticity."
35768 #. type: Plain text
35769 #: doc/guix.texi:15969
35771 "@url{https://letsencrypt.org/, Let's Encrypt} provides the @code{certbot} "
35772 "tool to automate the certification process. This tool first securely "
35773 "generates a key on the server. It then makes a request to the Let's Encrypt "
35774 "certificate authority (CA) to sign the key. The CA checks that the request "
35775 "originates from the host in question by using a challenge-response protocol, "
35776 "requiring the server to provide its response over HTTP. If that protocol "
35777 "completes successfully, the CA signs the key, resulting in a certificate. "
35778 "That certificate is valid for a limited period of time, and therefore to "
35779 "continue to provide TLS services, the server needs to periodically ask the "
35780 "CA to renew its signature."
35783 #. type: Plain text
35784 #: doc/guix.texi:15976
35786 "The certbot service automates this process: the initial key generation, the "
35787 "initial certification request to the Let's Encrypt service, the web server "
35788 "challenge/response integration, writing the certificate to disk, the "
35789 "automated periodic renewals, and the deployment tasks associated with the "
35790 "renewal (e.g. reloading services, copying keys with different permissions)."
35793 #. type: Plain text
35794 #: doc/guix.texi:15982
35796 "Certbot is run twice a day, at a random minute within the hour. It won't do "
35797 "anything until your certificates are due for renewal or revoked, but running "
35798 "it regularly would give your service a chance of staying online in case a "
35799 "Let's Encrypt-initiated revocation happened for some reason."
35802 #. type: Plain text
35803 #: doc/guix.texi:15986
35805 "By using this service, you agree to the ACME Subscriber Agreement, which can "
35806 "be found there: @url{https://acme-v01.api.letsencrypt.org/directory}."
35810 #: doc/guix.texi:15987
35812 msgid "{Scheme Variable} certbot-service-type"
35816 #: doc/guix.texi:15990
35818 "A service type for the @code{certbot} Let's Encrypt client. Its value must "
35819 "be a @code{certbot-configuration} record as in this example:"
35823 #: doc/guix.texi:15997
35826 "(define %nginx-deploy-hook\n"
35828 " \"nginx-deploy-hook\"\n"
35829 " #~(let ((pid (call-with-input-file \"/var/run/nginx/pid\" read)))\n"
35830 " (kill pid SIGHUP))))\n"
35835 #: doc/guix.texi:16008
35838 "(service certbot-service-type\n"
35839 " (certbot-configuration\n"
35840 " (email \"foo@@example.net\")\n"
35843 " (certificate-configuration\n"
35844 " (domains '(\"example.net\" \"www.example.net\"))\n"
35845 " (deploy-hook %nginx-deploy-hook))\n"
35846 " (certificate-configuration\n"
35847 " (domains '(\"bar.example.net\")))))))\n"
35851 #: doc/guix.texi:16011
35852 msgid "See below for details about @code{certbot-configuration}."
35856 #: doc/guix.texi:16013
35858 msgid "{Data Type} certbot-configuration"
35862 #: doc/guix.texi:16016
35864 "Data type representing the configuration of the @code{certbot} service. "
35865 "This type has the following parameters:"
35869 #: doc/guix.texi:16018
35871 msgid "@code{package} (default: @code{certbot})"
35875 #: doc/guix.texi:16020
35876 msgid "The certbot package to use."
35880 #: doc/guix.texi:16021
35882 msgid "@code{webroot} (default: @code{/var/www})"
35886 #: doc/guix.texi:16024
35888 "The directory from which to serve the Let's Encrypt challenge/response files."
35892 #: doc/guix.texi:16025
35894 msgid "@code{certificates} (default: @code{()})"
35898 #: doc/guix.texi:16029
35900 "A list of @code{certificates-configuration}s for which to generate "
35901 "certificates and request signatures. Each certificate has a @code{name} and "
35902 "several @code{domains}."
35906 #: doc/guix.texi:16033
35908 "Mandatory email used for registration, recovery contact, and important "
35909 "account notifications."
35913 #: doc/guix.texi:16034
35915 msgid "@code{rsa-key-size} (default: @code{2048})"
35919 #: doc/guix.texi:16036
35920 msgid "Size of the RSA key."
35924 #: doc/guix.texi:16037
35926 msgid "@code{default-location} (default: @i{see below})"
35930 #: doc/guix.texi:16046
35932 "The default @code{nginx-location-configuration}. Because @code{certbot} "
35933 "needs to be able to serve challenges and responses, it needs to be able to "
35934 "run a web server. It does so by extending the @code{nginx} web service with "
35935 "an @code{nginx-server-configuration} listening on the @var{domains} on port "
35936 "80, and which has a @code{nginx-location-configuration} for the @code{/.well-"
35937 "known/} URI path subspace used by Let's Encrypt. @xref{Web Services}, for "
35938 "more on these nginx configuration data types."
35942 #: doc/guix.texi:16050
35944 "Requests to other URL paths will be matched by the @code{default-location}, "
35945 "which if present is added to all @code{nginx-server-configuration}s."
35949 #: doc/guix.texi:16054
35951 "By default, the @code{default-location} will issue a redirect from "
35952 "@code{http://@var{domain}/...} to @code{https://@var{domain}/...}, leaving "
35953 "you to define what to serve on your site via @code{https}."
35957 #: doc/guix.texi:16056
35958 msgid "Pass @code{#f} to not issue a default location."
35962 #: doc/guix.texi:16059
35964 msgid "{Data Type} certificate-configuration"
35968 #: doc/guix.texi:16062
35970 "Data type representing the configuration of a certificate. This type has "
35971 "the following parameters:"
35975 #: doc/guix.texi:16064
35977 msgid "@code{name} (default: @i{see below})"
35981 #: doc/guix.texi:16068
35983 "This name is used by Certbot for housekeeping and in file paths; it doesn't "
35984 "affect the content of the certificate itself. To see certificate names, run "
35985 "@code{certbot certificates}."
35989 #: doc/guix.texi:16070
35990 msgid "Its default is the first provided domain."
35994 #: doc/guix.texi:16071
35996 msgid "@code{domains} (default: @code{()})"
36000 #: doc/guix.texi:16074
36002 "The first domain provided will be the subject CN of the certificate, and all "
36003 "domains will be Subject Alternative Names on the certificate."
36007 #: doc/guix.texi:16075
36009 msgid "@code{deploy-hook} (default: @code{#f})"
36013 #: doc/guix.texi:16083
36015 "Command to be run in a shell once for each successfully issued certificate. "
36016 "For this command, the shell variable @code{$RENEWED_LINEAGE} will point to "
36017 "the config live subdirectory (for example, @samp{\"/etc/letsencrypt/live/"
36018 "example.com\"}) containing the new certificates and keys; the shell variable "
36019 "@code{$RENEWED_DOMAINS} will contain a space-delimited list of renewed "
36020 "certificate domains (for example, @samp{\"example.com www.example.com\"}."
36023 #. type: Plain text
36024 #: doc/guix.texi:16090
36026 "For each @code{certificate-configuration}, the certificate is saved to "
36027 "@code{/etc/letsencrypt/live/@var{name}/fullchain.pem} and the key is saved "
36028 "to @code{/etc/letsencrypt/live/@var{name}/privkey.pem}."
36032 #: doc/guix.texi:16092
36034 msgid "DNS (domain name system)"
36038 #: doc/guix.texi:16093
36040 msgid "domain name system (DNS)"
36043 #. type: Plain text
36044 #: doc/guix.texi:16099
36046 "The @code{(gnu services dns)} module provides services related to the "
36047 "@dfn{domain name system} (DNS). It provides a server service for hosting an "
36048 "@emph{authoritative} DNS server for multiple zones, slave or master. This "
36049 "service uses @uref{https://www.knot-dns.cz/, Knot DNS}."
36052 #. type: Plain text
36053 #: doc/guix.texi:16102
36055 "An example configuration of an authoritative server for two zones, one "
36056 "master and one slave, is:"
36060 #: doc/guix.texi:16109
36063 "(define-zone-entries example.org.zone\n"
36064 ";; Name TTL Class Type Data\n"
36065 " (\"@@\" \"\" \"IN\" \"A\" \"127.0.0.1\")\n"
36066 " (\"@@\" \"\" \"IN\" \"NS\" \"ns\")\n"
36067 " (\"ns\" \"\" \"IN\" \"A\" \"127.0.0.1\"))\n"
36072 #: doc/guix.texi:16116
36075 "(define master-zone\n"
36076 " (knot-zone-configuration\n"
36077 " (domain \"example.org\")\n"
36078 " (zone (zone-file\n"
36079 " (origin \"example.org\")\n"
36080 " (entries example.org.zone)))))\n"
36085 #: doc/guix.texi:16122
36088 "(define slave-zone\n"
36089 " (knot-zone-configuration\n"
36090 " (domain \"plop.org\")\n"
36091 " (dnssec-policy \"default\")\n"
36092 " (master (list \"plop-master\"))))\n"
36097 #: doc/guix.texi:16127
36100 "(define plop-master\n"
36101 " (knot-remote-configuration\n"
36102 " (id \"plop-master\")\n"
36103 " (address (list \"208.76.58.171\"))))\n"
36108 #: doc/guix.texi:16136
36111 "(operating-system\n"
36113 " (services (cons* (service knot-service-type\n"
36114 " (knot-configuration\n"
36115 " (remotes (list plop-master))\n"
36116 " (zones (list master-zone slave-zone))))\n"
36118 " %base-services)))\n"
36122 #: doc/guix.texi:16138
36124 msgid "{Scheme Variable} knot-service-type"
36128 #: doc/guix.texi:16140
36129 msgid "This is the type for the Knot DNS server."
36133 #: doc/guix.texi:16148
36135 "Knot DNS is an authoritative DNS server, meaning that it can serve multiple "
36136 "zones, that is to say domain names you would buy from a registrar. This "
36137 "server is not a resolver, meaning that it can only resolve names for which "
36138 "it is authoritative. This server can be configured to serve zones as a "
36139 "master server or a slave server as a per-zone basis. Slave zones will get "
36140 "their data from masters, and will serve it as an authoritative server. From "
36141 "the point of view of a resolver, there is no difference between master and "
36146 #: doc/guix.texi:16150
36147 msgid "The following data types are used to configure the Knot DNS server:"
36151 #: doc/guix.texi:16152
36153 msgid "{Data Type} knot-key-configuration"
36157 #: doc/guix.texi:16155
36158 msgid "Data type representing a key. This type has the following parameters:"
36162 #: doc/guix.texi:16157 doc/guix.texi:16177 doc/guix.texi:16292
36163 #: doc/guix.texi:16318 doc/guix.texi:16353
36165 msgid "@code{id} (default: @code{\"\"})"
36169 #: doc/guix.texi:16160
36171 "An identifier for other configuration fields to refer to this key. IDs must "
36172 "be unique and must not be empty."
36176 #: doc/guix.texi:16161
36178 msgid "@code{algorithm} (default: @code{#f})"
36182 #: doc/guix.texi:16165
36184 "The algorithm to use. Choose between @code{#f}, @code{'hmac-md5}, "
36185 "@code{'hmac-sha1}, @code{'hmac-sha224}, @code{'hmac-sha256}, @code{'hmac-"
36186 "sha384} and @code{'hmac-sha512}."
36190 #: doc/guix.texi:16166
36192 msgid "@code{secret} (default: @code{\"\"})"
36196 #: doc/guix.texi:16168
36197 msgid "The secret key itself."
36201 #: doc/guix.texi:16172
36203 msgid "{Data Type} knot-acl-configuration"
36207 #: doc/guix.texi:16175
36209 "Data type representing an Access Control List (ACL) configuration. This "
36210 "type has the following parameters:"
36214 #: doc/guix.texi:16180
36216 "An identifier for ether configuration fields to refer to this key. IDs must "
36217 "be unique and must not be empty."
36221 #: doc/guix.texi:16181 doc/guix.texi:16296
36223 msgid "@code{address} (default: @code{'()})"
36227 #: doc/guix.texi:16185
36229 "An ordered list of IP addresses, network subnets, or network ranges "
36230 "represented with strings. The query must match one of them. Empty value "
36231 "means that address match is not required."
36235 #: doc/guix.texi:16186
36237 msgid "@code{key} (default: @code{'()})"
36241 #: doc/guix.texi:16190
36243 "An ordered list of references to keys represented with strings. The string "
36244 "must match a key ID defined in a @code{knot-key-configuration}. No key "
36245 "means that a key is not require to match that ACL."
36249 #: doc/guix.texi:16191
36251 msgid "@code{action} (default: @code{'()})"
36255 #: doc/guix.texi:16195
36257 "An ordered list of actions that are permitted or forbidden by this ACL. "
36258 "Possible values are lists of zero or more elements from @code{'transfer}, "
36259 "@code{'notify} and @code{'update}."
36263 #: doc/guix.texi:16196
36265 msgid "@code{deny?} (default: @code{#f})"
36269 #: doc/guix.texi:16199
36271 "When true, the ACL defines restrictions. Listed actions are forbidden. "
36272 "When false, listed actions are allowed."
36276 #: doc/guix.texi:16203
36278 msgid "{Data Type} zone-entry"
36282 #: doc/guix.texi:16206
36284 "Data type represnting a record entry in a zone file. This type has the "
36285 "following parameters:"
36289 #: doc/guix.texi:16208
36291 msgid "@code{name} (default: @code{\"@@\"})"
36295 #: doc/guix.texi:16214
36297 "The name of the record. @code{\"@@\"} refers to the origin of the zone. "
36298 "Names are relative to the origin of the zone. For example, in the "
36299 "@code{example.org} zone, @code{\"ns.example.org\"} actually refers to "
36300 "@code{ns.example.org.example.org}. Names ending with a dot are absolute, "
36301 "which means that @code{\"ns.example.org.\"} refers to @code{ns.example.org}."
36305 #: doc/guix.texi:16215
36307 msgid "@code{ttl} (default: @code{\"\"})"
36311 #: doc/guix.texi:16217
36313 "The Time-To-Live (TTL) of this record. If not set, the default TTL is used."
36317 #: doc/guix.texi:16218
36319 msgid "@code{class} (default: @code{\"IN\"})"
36323 #: doc/guix.texi:16221
36325 "The class of the record. Knot currently supports only @code{\"IN\"} and "
36326 "partially @code{\"CH\"}."
36330 #: doc/guix.texi:16222
36332 msgid "@code{type} (default: @code{\"A\"})"
36336 #: doc/guix.texi:16226
36338 "The type of the record. Common types include A (IPv4 address), AAAA (IPv6 "
36339 "address), NS (Name Server) and MX (Mail eXchange). Many other types are "
36344 #: doc/guix.texi:16227
36346 msgid "@code{data} (default: @code{\"\"})"
36350 #: doc/guix.texi:16231
36352 "The data contained in the record. For instance an IP address associated "
36353 "with an A record, or a domain name associated with an NS record. Remember "
36354 "that domain names are relative to the origin unless they end with a dot."
36358 #: doc/guix.texi:16235
36360 msgid "{Data Type} zone-file"
36364 #: doc/guix.texi:16238
36366 "Data type representing the content of a zone file. This type has the "
36367 "following parameters:"
36371 #: doc/guix.texi:16247
36373 "The list of entries. The SOA record is taken care of, so you don't need to "
36374 "put it in the list of entries. This list should probably contain an entry "
36375 "for your primary authoritative DNS server. Other than using a list of "
36376 "entries directly, you can use @code{define-zone-entries} to define a object "
36377 "containing the list of entries more easily, that you can later pass to the "
36378 "@code{entries} field of the @code{zone-file}."
36382 #: doc/guix.texi:16248
36384 msgid "@code{origin} (default: @code{\"\"})"
36388 #: doc/guix.texi:16250
36389 msgid "The name of your zone. This parameter cannot be empty."
36393 #: doc/guix.texi:16251
36395 msgid "@code{ns} (default: @code{\"ns\"})"
36399 #: doc/guix.texi:16256
36401 "The domain of your primary authoritative DNS server. The name is relative "
36402 "to the origin, unless it ends with a dot. It is mandatory that this primary "
36403 "DNS server corresponds to an NS record in the zone and that it is associated "
36404 "to an IP address in the list of entries."
36408 #: doc/guix.texi:16257
36410 msgid "@code{mail} (default: @code{\"hostmaster\"})"
36414 #: doc/guix.texi:16260
36416 "An email address people can contact you at, as the owner of the zone. This "
36417 "is translated as @code{<mail>@@<origin>}."
36421 #: doc/guix.texi:16261
36423 msgid "@code{serial} (default: @code{1})"
36427 #: doc/guix.texi:16265
36429 "The serial number of the zone. As this is used to keep track of changes by "
36430 "both slaves and resolvers, it is mandatory that it @emph{never} decreases. "
36431 "Always increment it when you make a change in your zone."
36435 #: doc/guix.texi:16266
36437 msgid "@code{refresh} (default: @code{(* 2 24 3600)})"
36441 #: doc/guix.texi:16270
36443 "The frequency at which slaves will do a zone transfer. This value is a "
36444 "number of seconds. It can be computed by multiplications or with "
36445 "@code{(string->duration)}."
36449 #: doc/guix.texi:16271
36451 msgid "@code{retry} (default: @code{(* 15 60)})"
36455 #: doc/guix.texi:16274
36457 "The period after which a slave will retry to contact its master when it "
36458 "fails to do so a first time."
36462 #: doc/guix.texi:16275
36464 msgid "@code{expiry} (default: @code{(* 14 24 3600)})"
36468 #: doc/guix.texi:16279
36470 "Default TTL of records. Existing records are considered correct for at most "
36471 "this amount of time. After this period, resolvers will invalidate their "
36472 "cache and check again that it still exists."
36476 #: doc/guix.texi:16280
36478 msgid "@code{nx} (default: @code{3600})"
36482 #: doc/guix.texi:16283
36484 "Default TTL of inexistant records. This delay is usually short because you "
36485 "want your new domains to reach everyone quickly."
36489 #: doc/guix.texi:16287
36491 msgid "{Data Type} knot-remote-configuration"
36495 #: doc/guix.texi:16290
36497 "Data type representing a remote configuration. This type has the following "
36502 #: doc/guix.texi:16295
36504 "An identifier for other configuration fields to refer to this remote. IDs "
36505 "must be unique and must not be empty."
36509 #: doc/guix.texi:16300
36511 "An ordered list of destination IP addresses. Addresses are tried in "
36512 "sequence. An optional port can be given with the @@ separator. For "
36513 "instance: @code{(list \"1.2.3.4\" \"2.3.4.5@@53\")}. Default port is 53."
36517 #: doc/guix.texi:16301
36519 msgid "@code{via} (default: @code{'()})"
36523 #: doc/guix.texi:16305
36525 "An ordered list of source IP addresses. An empty list will have Knot choose "
36526 "an appropriate source IP. An optional port can be given with the @@ "
36527 "separator. The default is to choose at random."
36531 #: doc/guix.texi:16306
36533 msgid "@code{key} (default: @code{#f})"
36537 #: doc/guix.texi:16309
36539 "A reference to a key, that is a string containing the identifier of a key "
36540 "defined in a @code{knot-key-configuration} field."
36544 #: doc/guix.texi:16313
36546 msgid "{Data Type} knot-keystore-configuration"
36550 #: doc/guix.texi:16316
36552 "Data type representing a keystore to hold dnssec keys. This type has the "
36553 "following parameters:"
36557 #: doc/guix.texi:16320
36558 msgid "The id of the keystore. It must not be empty."
36562 #: doc/guix.texi:16321
36564 msgid "@code{backend} (default: @code{'pem})"
36568 #: doc/guix.texi:16323
36570 "The backend to store the keys in. Can be @code{'pem} or @code{'pkcs11}."
36574 #: doc/guix.texi:16324
36576 msgid "@code{config} (default: @code{\"/var/lib/knot/keys/keys\"})"
36580 #: doc/guix.texi:16328
36582 "The configuration string of the backend. An example for the PKCS#11 is: "
36583 "@code{\"pkcs11:token=knot;pin-value=1234 /gnu/store/.../lib/pkcs11/"
36584 "libsofthsm2.so\"}. For the pem backend, the string reprensents a path in "
36589 #: doc/guix.texi:16332
36591 msgid "{Data Type} knot-policy-configuration"
36595 #: doc/guix.texi:16336
36597 "Data type representing a dnssec policy. Knot DNS is able to automatically "
36598 "sign your zones. It can either generate and manage your keys automatically "
36599 "or use keys that you generate."
36603 #: doc/guix.texi:16343
36605 "Dnssec is usually implemented using two keys: a Key Signing Key (KSK) that "
36606 "is used to sign the second, and a Zone Signing Key (ZSK) that is used to "
36607 "sign the zone. In order to be trusted, the KSK needs to be present in the "
36608 "parent zone (usually a top-level domain). If your registrar supports "
36609 "dnssec, you will have to send them your KSK's hash so they can add a DS "
36610 "record in their zone. This is not automated and need to be done each time "
36611 "you change your KSK."
36615 #: doc/guix.texi:16349
36617 "The policy also defines the lifetime of keys. Usually, ZSK can be changed "
36618 "easily and use weaker cryptographic functions (they use lower parameters) in "
36619 "order to sign records quickly, so they are changed often. The KSK however "
36620 "requires manual interaction with the registrar, so they are changed less "
36621 "often and use stronger parameters because they sign only one record."
36625 #: doc/guix.texi:16351
36626 msgid "This type has the following parameters:"
36630 #: doc/guix.texi:16355
36631 msgid "The id of the policy. It must not be empty."
36635 #: doc/guix.texi:16356
36637 msgid "@code{keystore} (default: @code{\"default\"})"
36641 #: doc/guix.texi:16361
36643 "A reference to a keystore, that is a string containing the identifier of a "
36644 "keystore defined in a @code{knot-keystore-configuration} field. The "
36645 "@code{\"default\"} identifier means the default keystore (a kasp database "
36646 "that was setup by this service)."
36650 #: doc/guix.texi:16362
36652 msgid "@code{manual?} (default: @code{#f})"
36656 #: doc/guix.texi:16364
36657 msgid "Whether the key management is manual or automatic."
36661 #: doc/guix.texi:16365
36663 msgid "@code{single-type-signing?} (default: @code{#f})"
36667 #: doc/guix.texi:16367
36668 msgid "When @code{#t}, use the Single-Type Signing Scheme."
36672 #: doc/guix.texi:16368
36674 msgid "@code{algorithm} (default: @code{\"ecdsap256sha256\"})"
36678 #: doc/guix.texi:16370
36679 msgid "An algorithm of signing keys and issued signatures."
36683 #: doc/guix.texi:16371
36685 msgid "@code{ksk-size} (default: @code{256})"
36689 #: doc/guix.texi:16374
36691 "The length of the KSK. Note that this value is correct for the default "
36692 "algorithm, but would be unsecure for other algorithms."
36696 #: doc/guix.texi:16375
36698 msgid "@code{zsk-size} (default: @code{256})"
36702 #: doc/guix.texi:16378
36704 "The length of the ZSK. Note that this value is correct for the default "
36705 "algorithm, but would be unsecure for other algorithms."
36709 #: doc/guix.texi:16379
36711 msgid "@code{dnskey-ttl} (default: @code{'default})"
36715 #: doc/guix.texi:16382
36717 "The TTL value for DNSKEY records added into zone apex. The special "
36718 "@code{'default} value means same as the zone SOA TTL."
36722 #: doc/guix.texi:16383
36724 msgid "@code{zsk-lifetime} (default: @code{(* 30 24 3600)})"
36728 #: doc/guix.texi:16385
36729 msgid "The period between ZSK publication and the next rollover initiation."
36733 #: doc/guix.texi:16386
36735 msgid "@code{propagation-delay} (default: @code{(* 24 3600)})"
36739 #: doc/guix.texi:16389
36741 "An extra delay added for each key rollover step. This value should be high "
36742 "enough to cover propagation of data from the master server to all slaves."
36746 #: doc/guix.texi:16390
36748 msgid "@code{rrsig-lifetime} (default: @code{(* 14 24 3600)})"
36752 #: doc/guix.texi:16392
36753 msgid "A validity period of newly issued signatures."
36757 #: doc/guix.texi:16393
36759 msgid "@code{rrsig-refresh} (default: @code{(* 7 24 3600)})"
36763 #: doc/guix.texi:16395
36765 "A period how long before a signature expiration the signature will be "
36770 #: doc/guix.texi:16396
36772 msgid "@code{nsec3?} (default: @code{#f})"
36776 #: doc/guix.texi:16398
36777 msgid "When @code{#t}, NSEC3 will be used instead of NSEC."
36781 #: doc/guix.texi:16399
36783 msgid "@code{nsec3-iterations} (default: @code{5})"
36787 #: doc/guix.texi:16401
36788 msgid "The number of additional times the hashing is performed."
36792 #: doc/guix.texi:16402
36794 msgid "@code{nsec3-salt-length} (default: @code{8})"
36798 #: doc/guix.texi:16405
36800 "The length of a salt field in octets, which is appended to the original "
36801 "owner name before hashing."
36805 #: doc/guix.texi:16406
36807 msgid "@code{nsec3-salt-lifetime} (default: @code{(* 30 24 3600)})"
36811 #: doc/guix.texi:16408
36812 msgid "The validity period of newly issued salt field."
36816 #: doc/guix.texi:16412
36818 msgid "{Data Type} knot-zone-configuration"
36822 #: doc/guix.texi:16415
36824 "Data type representing a zone served by Knot. This type has the following "
36829 #: doc/guix.texi:16417
36831 msgid "@code{domain} (default: @code{\"\"})"
36835 #: doc/guix.texi:16419
36836 msgid "The domain served by this configuration. It must not be empty."
36840 #: doc/guix.texi:16420
36842 msgid "@code{file} (default: @code{\"\"})"
36846 #: doc/guix.texi:16423
36848 "The file where this zone is saved. This parameter is ignored by master "
36849 "zones. Empty means default location that depends on the domain name."
36853 #: doc/guix.texi:16424
36855 msgid "@code{zone} (default: @code{(zone-file)})"
36859 #: doc/guix.texi:16427
36861 "The content of the zone file. This parameter is ignored by slave zones. It "
36862 "must contain a zone-file record."
36866 #: doc/guix.texi:16428
36868 msgid "@code{master} (default: @code{'()})"
36872 #: doc/guix.texi:16431
36874 "A list of master remotes. When empty, this zone is a master. When set, "
36875 "this zone is a slave. This is a list of remotes identifiers."
36879 #: doc/guix.texi:16432
36881 msgid "@code{ddns-master} (default: @code{#f})"
36885 #: doc/guix.texi:16435
36887 "The main master. When empty, it defaults to the first master in the list of "
36892 #: doc/guix.texi:16436
36894 msgid "@code{notify} (default: @code{'()})"
36898 #: doc/guix.texi:16438
36899 msgid "A list of slave remote identifiers."
36903 #: doc/guix.texi:16439
36905 msgid "@code{acl} (default: @code{'()})"
36909 #: doc/guix.texi:16441
36910 msgid "A list of acl identifiers."
36914 #: doc/guix.texi:16442
36916 msgid "@code{semantic-checks?} (default: @code{#f})"
36920 #: doc/guix.texi:16444
36921 msgid "When set, this adds more semantic checks to the zone."
36925 #: doc/guix.texi:16445
36927 msgid "@code{disable-any?} (default: @code{#f})"
36931 #: doc/guix.texi:16447
36932 msgid "When set, this forbids queries of the ANY type."
36936 #: doc/guix.texi:16448
36938 msgid "@code{zonefile-sync} (default: @code{0})"
36942 #: doc/guix.texi:16451
36944 "The delay between a modification in memory and on disk. 0 means immediate "
36949 #: doc/guix.texi:16452
36951 msgid "@code{serial-policy} (default: @code{'increment})"
36955 #: doc/guix.texi:16454
36956 msgid "A policy between @code{'increment} and @code{'unixtime}."
36960 #: doc/guix.texi:16458
36962 msgid "{Data Type} knot-configuration"
36966 #: doc/guix.texi:16461
36968 "Data type representing the Knot configuration. This type has the following "
36973 #: doc/guix.texi:16463
36975 msgid "@code{knot} (default: @code{knot})"
36979 #: doc/guix.texi:16465
36980 msgid "The Knot package."
36984 #: doc/guix.texi:16466
36986 msgid "@code{run-directory} (default: @code{\"/var/run/knot\"})"
36990 #: doc/guix.texi:16468
36992 "The run directory. This directory will be used for pid file and sockets."
36996 #: doc/guix.texi:16469
36998 msgid "@code{listen-v4} (default: @code{\"0.0.0.0\"})"
37002 #: doc/guix.texi:16471 doc/guix.texi:16474
37003 msgid "An ip address on which to listen."
37007 #: doc/guix.texi:16472
37009 msgid "@code{listen-v6} (default: @code{\"::\"})"
37013 #: doc/guix.texi:16475
37015 msgid "@code{listen-port} (default: @code{53})"
37019 #: doc/guix.texi:16477
37020 msgid "A port on which to listen."
37024 #: doc/guix.texi:16478
37026 msgid "@code{keys} (default: @code{'()})"
37030 #: doc/guix.texi:16480
37031 msgid "The list of knot-key-configuration used by this configuration."
37035 #: doc/guix.texi:16481
37037 msgid "@code{acls} (default: @code{'()})"
37041 #: doc/guix.texi:16483
37042 msgid "The list of knot-acl-configuration used by this configuration."
37046 #: doc/guix.texi:16484
37048 msgid "@code{remotes} (default: @code{'()})"
37052 #: doc/guix.texi:16486
37053 msgid "The list of knot-remote-configuration used by this configuration."
37057 #: doc/guix.texi:16487
37059 msgid "@code{zones} (default: @code{'()})"
37063 #: doc/guix.texi:16489
37064 msgid "The list of knot-zone-configuration used by this configuration."
37068 #: doc/guix.texi:16496
37070 msgid "VPN (virtual private network)"
37074 #: doc/guix.texi:16497
37076 msgid "virtual private network (VPN)"
37079 #. type: Plain text
37080 #: doc/guix.texi:16503
37082 "The @code{(gnu services vpn)} module provides services related to "
37083 "@dfn{virtual private networks} (VPNs). It provides a @emph{client} service "
37084 "for your machine to connect to a VPN, and a @emph{servire} service for your "
37085 "machine to host a VPN. Both services use @uref{https://openvpn.net/, "
37090 #: doc/guix.texi:16504
37092 msgid "{Scheme Procedure} openvpn-client-service @"
37096 #: doc/guix.texi:16506
37097 msgid "[#:config (openvpn-client-configuration)]"
37101 #: doc/guix.texi:16508
37103 "Return a service that runs @command{openvpn}, a VPN daemon, as a client."
37107 #: doc/guix.texi:16510
37109 msgid "{Scheme Procedure} openvpn-server-service @"
37113 #: doc/guix.texi:16512
37114 msgid "[#:config (openvpn-server-configuration)]"
37118 #: doc/guix.texi:16514
37120 "Return a service that runs @command{openvpn}, a VPN daemon, as a server."
37124 #: doc/guix.texi:16516
37125 msgid "Both can be run simultaneously."
37128 #. type: Plain text
37129 #: doc/guix.texi:16521
37130 msgid "Available @code{openvpn-client-configuration} fields are:"
37134 #: doc/guix.texi:16522
37136 msgid "{@code{openvpn-client-configuration} parameter} package openvpn"
37140 #: doc/guix.texi:16524 doc/guix.texi:16660
37141 msgid "The OpenVPN package."
37145 #: doc/guix.texi:16527
37147 msgid "{@code{openvpn-client-configuration} parameter} string pid-file"
37151 #: doc/guix.texi:16529 doc/guix.texi:16665
37152 msgid "The OpenVPN pid file."
37156 #: doc/guix.texi:16531 doc/guix.texi:16667
37157 msgid "Defaults to @samp{\"/var/run/openvpn/openvpn.pid\"}."
37161 #: doc/guix.texi:16534
37163 msgid "{@code{openvpn-client-configuration} parameter} proto proto"
37167 #: doc/guix.texi:16537 doc/guix.texi:16673
37169 "The protocol (UDP or TCP) used to open a channel between clients and servers."
37173 #: doc/guix.texi:16539 doc/guix.texi:16675
37174 msgid "Defaults to @samp{udp}."
37178 #: doc/guix.texi:16542
37180 msgid "{@code{openvpn-client-configuration} parameter} dev dev"
37184 #: doc/guix.texi:16544 doc/guix.texi:16680
37185 msgid "The device type used to represent the VPN connection."
37189 #: doc/guix.texi:16546 doc/guix.texi:16682
37190 msgid "Defaults to @samp{tun}."
37194 #: doc/guix.texi:16549
37196 msgid "{@code{openvpn-client-configuration} parameter} string ca"
37200 #: doc/guix.texi:16551 doc/guix.texi:16687
37201 msgid "The certificate authority to check connections against."
37205 #: doc/guix.texi:16553 doc/guix.texi:16689
37206 msgid "Defaults to @samp{\"/etc/openvpn/ca.crt\"}."
37210 #: doc/guix.texi:16556
37212 msgid "{@code{openvpn-client-configuration} parameter} string cert"
37216 #: doc/guix.texi:16559 doc/guix.texi:16695
37218 "The certificate of the machine the daemon is running on. It should be "
37219 "signed by the authority given in @code{ca}."
37223 #: doc/guix.texi:16561 doc/guix.texi:16697
37224 msgid "Defaults to @samp{\"/etc/openvpn/client.crt\"}."
37228 #: doc/guix.texi:16564
37230 msgid "{@code{openvpn-client-configuration} parameter} string key"
37234 #: doc/guix.texi:16567 doc/guix.texi:16703
37236 "The key of the machine the daemon is running on. It must be the key whose "
37237 "certificate is @code{cert}."
37241 #: doc/guix.texi:16569 doc/guix.texi:16705
37242 msgid "Defaults to @samp{\"/etc/openvpn/client.key\"}."
37246 #: doc/guix.texi:16572
37248 msgid "{@code{openvpn-client-configuration} parameter} boolean comp-lzo?"
37252 #: doc/guix.texi:16574 doc/guix.texi:16710
37253 msgid "Whether to use the lzo compression algorithm."
37257 #: doc/guix.texi:16579
37259 msgid "{@code{openvpn-client-configuration} parameter} boolean persist-key?"
37263 #: doc/guix.texi:16581 doc/guix.texi:16717
37264 msgid "Don't re-read key files across SIGUSR1 or --ping-restart."
37268 #: doc/guix.texi:16586
37270 msgid "{@code{openvpn-client-configuration} parameter} boolean persist-tun?"
37274 #: doc/guix.texi:16589 doc/guix.texi:16725
37276 "Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 "
37277 "or --ping-restart restarts."
37281 #: doc/guix.texi:16594
37283 msgid "{@code{openvpn-client-configuration} parameter} number verbosity"
37287 #: doc/guix.texi:16596 doc/guix.texi:16732
37288 msgid "Verbosity level."
37292 #: doc/guix.texi:16598 doc/guix.texi:16734 doc/guix.texi:18011
37293 #: doc/guix.texi:18234
37294 msgid "Defaults to @samp{3}."
37298 #: doc/guix.texi:16601
37300 msgid "{@code{openvpn-client-configuration} parameter} tls-auth-client tls-auth"
37304 #: doc/guix.texi:16604 doc/guix.texi:16740
37306 "Add an additional layer of HMAC authentication on top of the TLS control "
37307 "channel to protect against DoS attacks."
37311 #: doc/guix.texi:16609
37313 msgid "{@code{openvpn-client-configuration} parameter} key-usage verify-key-usage?"
37317 #: doc/guix.texi:16611
37318 msgid "Whether to check the server certificate has server usage extension."
37322 #: doc/guix.texi:16616
37324 msgid "{@code{openvpn-client-configuration} parameter} bind bind?"
37328 #: doc/guix.texi:16618
37329 msgid "Bind to a specific local port number."
37333 #: doc/guix.texi:16623
37335 msgid "{@code{openvpn-client-configuration} parameter} resolv-retry resolv-retry?"
37339 #: doc/guix.texi:16625
37340 msgid "Retry resolving server address."
37344 #: doc/guix.texi:16630
37346 msgid "{@code{openvpn-client-configuration} parameter} openvpn-remote-list remote"
37350 #: doc/guix.texi:16632
37351 msgid "A list of remote servers to connect to."
37355 #: doc/guix.texi:16636
37356 msgid "Available @code{openvpn-remote-configuration} fields are:"
37360 #: doc/guix.texi:16637
37362 msgid "{@code{openvpn-remote-configuration} parameter} string name"
37366 #: doc/guix.texi:16639
37367 msgid "Server name."
37371 #: doc/guix.texi:16641
37372 msgid "Defaults to @samp{\"my-server\"}."
37376 #: doc/guix.texi:16644
37378 msgid "{@code{openvpn-remote-configuration} parameter} number port"
37382 #: doc/guix.texi:16646
37383 msgid "Port number the server listens to."
37387 #: doc/guix.texi:16648 doc/guix.texi:16749
37388 msgid "Defaults to @samp{1194}."
37391 #. type: Plain text
37392 #: doc/guix.texi:16657
37393 msgid "Available @code{openvpn-server-configuration} fields are:"
37397 #: doc/guix.texi:16658
37399 msgid "{@code{openvpn-server-configuration} parameter} package openvpn"
37403 #: doc/guix.texi:16663
37405 msgid "{@code{openvpn-server-configuration} parameter} string pid-file"
37409 #: doc/guix.texi:16670
37411 msgid "{@code{openvpn-server-configuration} parameter} proto proto"
37415 #: doc/guix.texi:16678
37417 msgid "{@code{openvpn-server-configuration} parameter} dev dev"
37421 #: doc/guix.texi:16685
37423 msgid "{@code{openvpn-server-configuration} parameter} string ca"
37427 #: doc/guix.texi:16692
37429 msgid "{@code{openvpn-server-configuration} parameter} string cert"
37433 #: doc/guix.texi:16700
37435 msgid "{@code{openvpn-server-configuration} parameter} string key"
37439 #: doc/guix.texi:16708
37441 msgid "{@code{openvpn-server-configuration} parameter} boolean comp-lzo?"
37445 #: doc/guix.texi:16715
37447 msgid "{@code{openvpn-server-configuration} parameter} boolean persist-key?"
37451 #: doc/guix.texi:16722
37453 msgid "{@code{openvpn-server-configuration} parameter} boolean persist-tun?"
37457 #: doc/guix.texi:16730
37459 msgid "{@code{openvpn-server-configuration} parameter} number verbosity"
37463 #: doc/guix.texi:16737
37465 msgid "{@code{openvpn-server-configuration} parameter} tls-auth-server tls-auth"
37469 #: doc/guix.texi:16745
37471 msgid "{@code{openvpn-server-configuration} parameter} number port"
37475 #: doc/guix.texi:16747
37476 msgid "Specifies the port number on which the server listens."
37480 #: doc/guix.texi:16752
37482 msgid "{@code{openvpn-server-configuration} parameter} ip-mask server"
37486 #: doc/guix.texi:16754
37487 msgid "An ip and mask specifying the subnet inside the virtual network."
37491 #: doc/guix.texi:16756
37492 msgid "Defaults to @samp{\"10.8.0.0 255.255.255.0\"}."
37496 #: doc/guix.texi:16759
37498 msgid "{@code{openvpn-server-configuration} parameter} cidr6 server-ipv6"
37502 #: doc/guix.texi:16761
37503 msgid "A CIDR notation specifying the IPv6 subnet inside the virtual network."
37507 #: doc/guix.texi:16766
37509 msgid "{@code{openvpn-server-configuration} parameter} string dh"
37513 #: doc/guix.texi:16768
37514 msgid "The Diffie-Hellman parameters file."
37518 #: doc/guix.texi:16770
37519 msgid "Defaults to @samp{\"/etc/openvpn/dh2048.pem\"}."
37523 #: doc/guix.texi:16773
37525 msgid "{@code{openvpn-server-configuration} parameter} string ifconfig-pool-persist"
37529 #: doc/guix.texi:16775
37530 msgid "The file that records client IPs."
37534 #: doc/guix.texi:16777
37535 msgid "Defaults to @samp{\"/etc/openvpn/ipp.txt\"}."
37539 #: doc/guix.texi:16780
37541 msgid "{@code{openvpn-server-configuration} parameter} gateway redirect-gateway?"
37545 #: doc/guix.texi:16782
37546 msgid "When true, the server will act as a gateway for its clients."
37550 #: doc/guix.texi:16787
37552 msgid "{@code{openvpn-server-configuration} parameter} boolean client-to-client?"
37556 #: doc/guix.texi:16789
37557 msgid "When true, clients are allowed to talk to each other inside the VPN."
37561 #: doc/guix.texi:16794
37563 msgid "{@code{openvpn-server-configuration} parameter} keepalive keepalive"
37567 #: doc/guix.texi:16800
37569 "Causes ping-like messages to be sent back and forth over the link so that "
37570 "each side knows when the other side has gone down. @code{keepalive} "
37571 "requires a pair. The first element is the period of the ping sending, and "
37572 "the second element is the timeout before considering the other side down."
37576 #: doc/guix.texi:16803
37578 msgid "{@code{openvpn-server-configuration} parameter} number max-clients"
37582 #: doc/guix.texi:16805
37583 msgid "The maximum number of clients."
37587 #: doc/guix.texi:16810
37589 msgid "{@code{openvpn-server-configuration} parameter} string status"
37593 #: doc/guix.texi:16813
37595 "The status file. This file shows a small report on current connection. It "
37596 "is truncated and rewritten every minute."
37600 #: doc/guix.texi:16815
37601 msgid "Defaults to @samp{\"/var/run/openvpn/status\"}."
37605 #: doc/guix.texi:16818
37607 msgid "{@code{openvpn-server-configuration} parameter} openvpn-ccd-list client-config-dir"
37611 #: doc/guix.texi:16820
37612 msgid "The list of configuration for some clients."
37616 #: doc/guix.texi:16824
37617 msgid "Available @code{openvpn-ccd-configuration} fields are:"
37621 #: doc/guix.texi:16825
37623 msgid "{@code{openvpn-ccd-configuration} parameter} string name"
37627 #: doc/guix.texi:16827
37628 msgid "Client name."
37632 #: doc/guix.texi:16829
37633 msgid "Defaults to @samp{\"client\"}."
37637 #: doc/guix.texi:16832
37639 msgid "{@code{openvpn-ccd-configuration} parameter} ip-mask iroute"
37643 #: doc/guix.texi:16834
37644 msgid "Client own network"
37648 #: doc/guix.texi:16839
37650 msgid "{@code{openvpn-ccd-configuration} parameter} ip-mask ifconfig-push"
37654 #: doc/guix.texi:16841
37655 msgid "Client VPN IP."
37659 #: doc/guix.texi:16854
37664 #. type: Plain text
37665 #: doc/guix.texi:16859
37667 "The @code{(gnu services nfs)} module provides the following services, which "
37668 "are most commonly used in relation to mounting or exporting directory trees "
37669 "as @dfn{network file systems} (NFS)."
37672 #. type: subsubheading
37673 #: doc/guix.texi:16860
37675 msgid "RPC Bind Service"
37679 #: doc/guix.texi:16861
37684 #. type: Plain text
37685 #: doc/guix.texi:16867
37687 "The RPC Bind service provides a facility to map program numbers into "
37688 "universal addresses. Many NFS related services use this facility. Hence it "
37689 "is automatically started when a dependent service starts."
37693 #: doc/guix.texi:16868
37695 msgid "{Scheme Variable} rpcbind-service-type"
37699 #: doc/guix.texi:16870
37700 msgid "A service type for the RPC portmapper daemon."
37704 #: doc/guix.texi:16873
37706 msgid "{Data Type} rpcbind-configuration"
37710 #: doc/guix.texi:16876
37712 "Data type representing the configuration of the RPC Bind Service. This type "
37713 "has the following parameters:"
37717 #: doc/guix.texi:16877
37719 msgid "@code{rpcbind} (default: @code{rpcbind})"
37723 #: doc/guix.texi:16879
37724 msgid "The rpcbind package to use."
37728 #: doc/guix.texi:16880
37730 msgid "@code{warm-start?} (default: @code{#t})"
37734 #: doc/guix.texi:16884
37736 "If this parameter is @code{#t}, then the daemon will read a state file on "
37737 "startup thus reloading state information saved by a previous instance."
37740 #. type: subsubheading
37741 #: doc/guix.texi:16888
37743 msgid "Pipefs Pseudo File System"
37747 #: doc/guix.texi:16889
37753 #: doc/guix.texi:16890
37758 #. type: Plain text
37759 #: doc/guix.texi:16894
37761 "The pipefs file system is used to transfer NFS related data between the "
37762 "kernel and user space programs."
37766 #: doc/guix.texi:16895
37768 msgid "{Scheme Variable} pipefs-service-type"
37772 #: doc/guix.texi:16897
37773 msgid "A service type for the pipefs pseudo file system."
37777 #: doc/guix.texi:16899
37779 msgid "{Data Type} pipefs-configuration"
37783 #: doc/guix.texi:16902
37785 "Data type representing the configuration of the pipefs pseudo file system "
37786 "service. This type has the following parameters:"
37790 #: doc/guix.texi:16903
37792 msgid "@code{mount-point} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})"
37796 #: doc/guix.texi:16905
37797 msgid "The directory to which the file system is to be attached."
37800 #. type: subsubheading
37801 #: doc/guix.texi:16909
37803 msgid "GSS Daemon Service"
37807 #: doc/guix.texi:16910
37813 #: doc/guix.texi:16911
37819 #: doc/guix.texi:16912
37821 msgid "global security system"
37824 #. type: Plain text
37825 #: doc/guix.texi:16919
37827 "The @dfn{global security system} (GSS) daemon provides strong security for "
37828 "RPC based protocols. Before exchanging RPC requests an RPC client must "
37829 "establish a security context. Typically this is done using the Kerberos "
37830 "command @command{kinit} or automatically at login time using PAM services "
37831 "(@pxref{Kerberos Services})."
37835 #: doc/guix.texi:16920
37837 msgid "{Scheme Variable} gss-service-type"
37841 #: doc/guix.texi:16922
37842 msgid "A service type for the Global Security System (GSS) daemon."
37846 #: doc/guix.texi:16924
37848 msgid "{Data Type} gss-configuration"
37852 #: doc/guix.texi:16927
37854 "Data type representing the configuration of the GSS daemon service. This "
37855 "type has the following parameters:"
37859 #: doc/guix.texi:16928 doc/guix.texi:16953
37861 msgid "@code{nfs-utils} (default: @code{nfs-utils})"
37865 #: doc/guix.texi:16930
37866 msgid "The package in which the @command{rpc.gssd} command is to be found."
37870 #: doc/guix.texi:16931 doc/guix.texi:16956
37872 msgid "@code{pipefs-directory} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})"
37876 #: doc/guix.texi:16933 doc/guix.texi:16958
37877 msgid "The directory where the pipefs file system is mounted."
37880 #. type: subsubheading
37881 #: doc/guix.texi:16938
37883 msgid "IDMAP Daemon Service"
37887 #: doc/guix.texi:16939
37893 #: doc/guix.texi:16940
37895 msgid "name mapper"
37898 #. type: Plain text
37899 #: doc/guix.texi:16944
37901 "The idmap daemon service provides mapping between user IDs and user names. "
37902 "Typically it is required in order to access file systems mounted via NFSv4."
37906 #: doc/guix.texi:16945
37908 msgid "{Scheme Variable} idmap-service-type"
37912 #: doc/guix.texi:16947
37913 msgid "A service type for the Identity Mapper (IDMAP) daemon."
37917 #: doc/guix.texi:16949
37919 msgid "{Data Type} idmap-configuration"
37923 #: doc/guix.texi:16952
37925 "Data type representing the configuration of the IDMAP daemon service. This "
37926 "type has the following parameters:"
37930 #: doc/guix.texi:16955
37931 msgid "The package in which the @command{rpc.idmapd} command is to be found."
37935 #: doc/guix.texi:16959
37937 msgid "@code{domain} (default: @code{#f})"
37941 #: doc/guix.texi:16963
37943 "The local NFSv4 domain name. This must be a string or @code{#f}. If it is "
37944 "@code{#f} then the daemon will use the host's fully qualified domain name."
37948 #: doc/guix.texi:16970
37950 msgid "continuous integration"
37953 #. type: Plain text
37954 #: doc/guix.texi:16974
37956 "@uref{https://notabug.org/mthl/cuirass, Cuirass} is a continuous integration "
37957 "tool for Guix. It can be used both for development and for providing "
37958 "substitutes to others (@pxref{Substitutes})."
37960 "@uref{https://notabug.org/mthl/cuirass, Cuirass} est un outil d'intégration "
37961 "continue pour Guix. On peut l'utiliser aussi bien pour le développement que "
37962 "pour fournir des substituts à d'autres (@pxref{Substituts})."
37964 #. type: Plain text
37965 #: doc/guix.texi:16976
37967 "The @code{(gnu services cuirass)} module provides the following service."
37971 #: doc/guix.texi:16977
37973 msgid "{Scheme Procedure} cuirass-service-type"
37977 #: doc/guix.texi:16980
37979 "The type of the Cuirass service. Its value must be a @code{cuirass-"
37980 "configuration} object, as described below."
37983 #. type: Plain text
37984 #: doc/guix.texi:16987
37986 "To add build jobs, you have to set the @code{specifications} field of the "
37987 "configuration. Here is an example of a service defining a build job based "
37988 "on a specification that can be found in Cuirass source tree. This service "
37989 "polls the Guix repository and builds a subset of the Guix packages, as "
37990 "prescribed in the @file{gnu-system.scm} example spec:"
37994 #: doc/guix.texi:16999
37997 "(let ((spec #~((#:name . \"guix\")\n"
37998 " (#:url . \"git://git.savannah.gnu.org/guix.git\")\n"
37999 " (#:load-path . \".\")\n"
38000 " (#:file . \"build-aux/cuirass/gnu-system.scm\")\n"
38001 " (#:proc . cuirass-jobs)\n"
38002 " (#:arguments (subset . \"hello\"))\n"
38003 " (#:branch . \"master\"))))\n"
38004 " (service cuirass-service-type\n"
38005 " (cuirass-configuration\n"
38006 " (specifications #~(list '#$spec)))))\n"
38009 #. type: Plain text
38010 #: doc/guix.texi:17004
38012 "While information related to build jobs is located directly in the "
38013 "specifications, global settings for the @command{cuirass} process are "
38014 "accessible in other @code{cuirass-configuration} fields."
38018 #: doc/guix.texi:17005
38020 msgid "{Data Type} cuirass-configuration"
38024 #: doc/guix.texi:17007
38025 msgid "Data type representing the configuration of Cuirass."
38029 #: doc/guix.texi:17009
38031 msgid "@code{log-file} (default: @code{\"/var/log/cuirass.log\"})"
38035 #: doc/guix.texi:17011
38036 msgid "Location of the log file."
38040 #: doc/guix.texi:17012
38042 msgid "@code{cache-directory} (default: @code{\"/var/cache/cuirass\"})"
38046 #: doc/guix.texi:17014
38047 msgid "Location of the repository cache."
38051 #: doc/guix.texi:17015
38053 msgid "@code{user} (default: @code{\"cuirass\"})"
38057 #: doc/guix.texi:17017
38058 msgid "Owner of the @code{cuirass} process."
38062 #: doc/guix.texi:17018
38064 msgid "@code{group} (default: @code{\"cuirass\"})"
38068 #: doc/guix.texi:17020
38069 msgid "Owner's group of the @code{cuirass} process."
38073 #: doc/guix.texi:17021
38075 msgid "@code{interval} (default: @code{60})"
38079 #: doc/guix.texi:17024
38081 "Number of seconds between the poll of the repositories followed by the "
38086 #: doc/guix.texi:17025
38088 msgid "@code{database} (default: @code{\"/var/run/cuirass/cuirass.db\"})"
38092 #: doc/guix.texi:17028
38094 "Location of sqlite database which contains the build results and previously "
38095 "added specifications."
38099 #: doc/guix.texi:17029
38101 msgid "@code{port} (default: @code{8081})"
38105 #: doc/guix.texi:17031
38106 msgid "Port number used by the HTTP server."
38110 #: doc/guix.texi:17035
38112 "Listen on the network interface for @var{host}. The default is to accept "
38113 "connections from localhost."
38117 #: doc/guix.texi:17036
38119 msgid "@code{specifications} (default: @code{#~'()})"
38123 #: doc/guix.texi:17042
38125 "A gexp (@pxref{G-Expressions}) that evaluates to a list of specifications, "
38126 "where a specification is an association list (@pxref{Associations Lists,,, "
38127 "guile, GNU Guile Reference Manual}) whose keys are keywords (@code{#:keyword-"
38128 "example}) as shown in the example above."
38132 #: doc/guix.texi:17043
38134 msgid "@code{use-substitutes?} (default: @code{#f})"
38138 #: doc/guix.texi:17046
38140 "This allows using substitutes to avoid building every dependencies of a job "
38145 #: doc/guix.texi:17047
38147 msgid "@code{one-shot?} (default: @code{#f})"
38151 #: doc/guix.texi:17049
38152 msgid "Only evaluate specifications and build derivations once."
38156 #: doc/guix.texi:17050
38158 msgid "@code{fallback?} (default: @code{#f})"
38162 #: doc/guix.texi:17053
38164 "When substituting a pre-built binary fails, fall back to building packages "
38169 #: doc/guix.texi:17054
38171 msgid "@code{load-path} (default: @code{'()})"
38175 #: doc/guix.texi:17057
38177 "This allows users to define their own packages and make them visible to "
38178 "cuirass as in @command{guix build} command."
38182 #: doc/guix.texi:17058
38184 msgid "@code{cuirass} (default: @code{cuirass})"
38188 #: doc/guix.texi:17060
38189 msgid "The Cuirass package to use."
38193 #: doc/guix.texi:17066
38195 msgid "power management with TLP"
38198 #. type: Plain text
38199 #: doc/guix.texi:17069
38201 "The @code{(gnu services pm)} module provides a Guix service definition for "
38202 "the Linux power management tool TLP."
38205 #. type: Plain text
38206 #: doc/guix.texi:17075
38208 "TLP enables various powersaving modes in userspace and kernel. Contrary to "
38209 "@code{upower-service}, it is not a passive, monitoring tool, as it will "
38210 "apply custom settings each time a new power source is detected. More "
38211 "information can be found at @uref{http://linrunner.de/en/tlp/tlp.html, TLP "
38216 #: doc/guix.texi:17076
38218 msgid "{Scheme Variable} tlp-service-type"
38222 #: doc/guix.texi:17080
38224 "The service type for the TLP tool. Its value should be a valid TLP "
38225 "configuration (see below). To use the default settings, simply write:"
38229 #: doc/guix.texi:17082
38231 msgid "(service tlp-service-type)\n"
38234 #. type: Plain text
38235 #: doc/guix.texi:17087
38237 "By default TLP does not need much configuration but most TLP parameters can "
38238 "be tweaked using @code{tlp-configuration}."
38241 #. type: Plain text
38242 #: doc/guix.texi:17093
38244 "Each parameter definition is preceded by its type; for example, "
38245 "@samp{boolean foo} indicates that the @code{foo} parameter should be "
38246 "specified as a boolean. Types starting with @code{maybe-} denote parameters "
38247 "that won't show up in TLP config file when their value is @code{'disabled}."
38250 #. type: Plain text
38251 #: doc/guix.texi:17103
38252 msgid "Available @code{tlp-configuration} fields are:"
38256 #: doc/guix.texi:17104
38258 msgid "{@code{tlp-configuration} parameter} package tlp"
38262 #: doc/guix.texi:17106
38263 msgid "The TLP package."
38267 #: doc/guix.texi:17109
38269 msgid "{@code{tlp-configuration} parameter} boolean tlp-enable?"
38273 #: doc/guix.texi:17111
38274 msgid "Set to true if you wish to enable TLP."
38278 #: doc/guix.texi:17116
38280 msgid "{@code{tlp-configuration} parameter} string tlp-default-mode"
38284 #: doc/guix.texi:17119
38286 "Default mode when no power supply can be detected. Alternatives are AC and "
38291 #: doc/guix.texi:17121
38292 msgid "Defaults to @samp{\"AC\"}."
38296 #: doc/guix.texi:17124
38298 msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-ac"
38302 #: doc/guix.texi:17127
38304 "Number of seconds Linux kernel has to wait after the disk goes idle, before "
38309 #: doc/guix.texi:17132
38311 msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-bat"
38315 #: doc/guix.texi:17134
38316 msgid "Same as @code{disk-idle-ac} but on BAT mode."
38320 #: doc/guix.texi:17136
38321 msgid "Defaults to @samp{2}."
38325 #: doc/guix.texi:17139
38327 msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-ac"
38331 #: doc/guix.texi:17141
38332 msgid "Dirty pages flushing periodicity, expressed in seconds."
38336 #: doc/guix.texi:17143 doc/guix.texi:17366 doc/guix.texi:18683
38337 #: doc/guix.texi:18691
38338 msgid "Defaults to @samp{15}."
38342 #: doc/guix.texi:17146
38344 msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-bat"
38348 #: doc/guix.texi:17148
38349 msgid "Same as @code{max-lost-work-secs-on-ac} but on BAT mode."
38353 #: doc/guix.texi:17150
38354 msgid "Defaults to @samp{60}."
38358 #: doc/guix.texi:17153
38360 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-ac"
38364 #: doc/guix.texi:17157
38366 "CPU frequency scaling governor on AC mode. With intel_pstate driver, "
38367 "alternatives are powersave and performance. With acpi-cpufreq driver, "
38368 "alternatives are ondemand, powersave, performance and conservative."
38372 #: doc/guix.texi:17159 doc/guix.texi:17166 doc/guix.texi:17173
38373 #: doc/guix.texi:17180 doc/guix.texi:17187 doc/guix.texi:17194
38374 #: doc/guix.texi:17202 doc/guix.texi:17210 doc/guix.texi:17217
38375 #: doc/guix.texi:17224 doc/guix.texi:17231 doc/guix.texi:17238
38376 #: doc/guix.texi:17268 doc/guix.texi:17306 doc/guix.texi:17313
38377 #: doc/guix.texi:17322 doc/guix.texi:17344 doc/guix.texi:17352
38378 #: doc/guix.texi:17359 doc/guix.texi:17514 doc/guix.texi:17534
38379 #: doc/guix.texi:17549 doc/guix.texi:17556
38380 msgid "Defaults to @samp{disabled}."
38384 #: doc/guix.texi:17162
38386 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-bat"
38390 #: doc/guix.texi:17164
38391 msgid "Same as @code{cpu-scaling-governor-on-ac} but on BAT mode."
38395 #: doc/guix.texi:17169
38397 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-ac"
38401 #: doc/guix.texi:17171
38402 msgid "Set the min available frequency for the scaling governor on AC."
38406 #: doc/guix.texi:17176
38408 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-ac"
38412 #: doc/guix.texi:17178
38413 msgid "Set the max available frequency for the scaling governor on AC."
38417 #: doc/guix.texi:17183
38419 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-bat"
38423 #: doc/guix.texi:17185
38424 msgid "Set the min available frequency for the scaling governor on BAT."
38428 #: doc/guix.texi:17190
38430 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-bat"
38434 #: doc/guix.texi:17192
38435 msgid "Set the max available frequency for the scaling governor on BAT."
38439 #: doc/guix.texi:17197
38441 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-ac"
38445 #: doc/guix.texi:17200
38447 "Limit the min P-state to control the power dissipation of the CPU, in AC "
38448 "mode. Values are stated as a percentage of the available performance."
38452 #: doc/guix.texi:17205
38454 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-ac"
38458 #: doc/guix.texi:17208
38460 "Limit the max P-state to control the power dissipation of the CPU, in AC "
38461 "mode. Values are stated as a percentage of the available performance."
38465 #: doc/guix.texi:17213
38467 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-bat"
38471 #: doc/guix.texi:17215
38472 msgid "Same as @code{cpu-min-perf-on-ac} on BAT mode."
38476 #: doc/guix.texi:17220
38478 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-bat"
38482 #: doc/guix.texi:17222
38483 msgid "Same as @code{cpu-max-perf-on-ac} on BAT mode."
38487 #: doc/guix.texi:17227
38489 msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-ac?"
38493 #: doc/guix.texi:17229
38494 msgid "Enable CPU turbo boost feature on AC mode."
38498 #: doc/guix.texi:17234
38500 msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-bat?"
38504 #: doc/guix.texi:17236
38505 msgid "Same as @code{cpu-boost-on-ac?} on BAT mode."
38509 #: doc/guix.texi:17241
38511 msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-ac?"
38515 #: doc/guix.texi:17244
38517 "Allow Linux kernel to minimize the number of CPU cores/hyper-threads used "
38518 "under light load conditions."
38522 #: doc/guix.texi:17249
38524 msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-bat?"
38528 #: doc/guix.texi:17251
38529 msgid "Same as @code{sched-powersave-on-ac?} but on BAT mode."
38533 #: doc/guix.texi:17256
38535 msgid "{@code{tlp-configuration} parameter} boolean nmi-watchdog?"
38539 #: doc/guix.texi:17258
38540 msgid "Enable Linux kernel NMI watchdog."
38544 #: doc/guix.texi:17263
38546 msgid "{@code{tlp-configuration} parameter} maybe-string phc-controls"
38550 #: doc/guix.texi:17266
38552 "For Linux kernels with PHC patch applied, change CPU voltages. An example "
38553 "value would be @samp{\"F:V F:V F:V F:V\"}."
38557 #: doc/guix.texi:17271
38559 msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-ac"
38563 #: doc/guix.texi:17274
38565 "Set CPU performance versus energy saving policy on AC. Alternatives are "
38566 "performance, normal, powersave."
38570 #: doc/guix.texi:17276 doc/guix.texi:17374 doc/guix.texi:17404
38571 msgid "Defaults to @samp{\"performance\"}."
38575 #: doc/guix.texi:17279
38577 msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-bat"
38581 #: doc/guix.texi:17281
38582 msgid "Same as @code{energy-perf-policy-ac} but on BAT mode."
38586 #: doc/guix.texi:17283 doc/guix.texi:17381
38587 msgid "Defaults to @samp{\"powersave\"}."
38591 #: doc/guix.texi:17286
38593 msgid "{@code{tlp-configuration} parameter} space-separated-string-list disks-devices"
38597 #: doc/guix.texi:17288
38598 msgid "Hard disk devices."
38602 #: doc/guix.texi:17291
38604 msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-ac"
38608 #: doc/guix.texi:17293
38609 msgid "Hard disk advanced power management level."
38613 #: doc/guix.texi:17296
38615 msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-bat"
38619 #: doc/guix.texi:17298
38620 msgid "Same as @code{disk-apm-bat} but on BAT mode."
38624 #: doc/guix.texi:17301
38626 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-ac"
38630 #: doc/guix.texi:17304
38632 "Hard disk spin down timeout. One value has to be specified for each "
38633 "declared hard disk."
38637 #: doc/guix.texi:17309
38639 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-bat"
38643 #: doc/guix.texi:17311
38644 msgid "Same as @code{disk-spindown-timeout-on-ac} but on BAT mode."
38648 #: doc/guix.texi:17316
38650 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-iosched"
38654 #: doc/guix.texi:17320
38656 "Select IO scheduler for disk devices. One value has to be specified for "
38657 "each declared hard disk. Example alternatives are cfq, deadline and noop."
38661 #: doc/guix.texi:17325
38663 msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-ac"
38667 #: doc/guix.texi:17328
38669 "SATA aggressive link power management (ALPM) level. Alternatives are "
38670 "min_power, medium_power, max_performance."
38674 #: doc/guix.texi:17330
38675 msgid "Defaults to @samp{\"max_performance\"}."
38679 #: doc/guix.texi:17333
38681 msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-bat"
38685 #: doc/guix.texi:17335
38686 msgid "Same as @code{sata-linkpwr-ac} but on BAT mode."
38690 #: doc/guix.texi:17337
38691 msgid "Defaults to @samp{\"min_power\"}."
38695 #: doc/guix.texi:17340
38697 msgid "{@code{tlp-configuration} parameter} maybe-string sata-linkpwr-blacklist"
38701 #: doc/guix.texi:17342
38702 msgid "Exclude specified SATA host devices for link power management."
38706 #: doc/guix.texi:17347
38708 msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-ac?"
38712 #: doc/guix.texi:17350
38714 "Enable Runtime Power Management for AHCI controller and disks on AC mode."
38718 #: doc/guix.texi:17355
38720 msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-bat?"
38724 #: doc/guix.texi:17357
38725 msgid "Same as @code{ahci-runtime-pm-on-ac} on BAT mode."
38729 #: doc/guix.texi:17362
38731 msgid "{@code{tlp-configuration} parameter} non-negative-integer ahci-runtime-pm-timeout"
38735 #: doc/guix.texi:17364
38736 msgid "Seconds of inactivity before disk is suspended."
38740 #: doc/guix.texi:17369
38742 msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-ac"
38746 #: doc/guix.texi:17372
38748 "PCI Express Active State Power Management level. Alternatives are default, "
38749 "performance, powersave."
38753 #: doc/guix.texi:17377
38755 msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-bat"
38759 #: doc/guix.texi:17379
38760 msgid "Same as @code{pcie-aspm-ac} but on BAT mode."
38764 #: doc/guix.texi:17384
38766 msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-ac"
38770 #: doc/guix.texi:17387
38772 "Radeon graphics clock speed level. Alternatives are low, mid, high, auto, "
38777 #: doc/guix.texi:17389
38778 msgid "Defaults to @samp{\"high\"}."
38782 #: doc/guix.texi:17392
38784 msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-bat"
38788 #: doc/guix.texi:17394
38789 msgid "Same as @code{radeon-power-ac} but on BAT mode."
38793 #: doc/guix.texi:17396
38794 msgid "Defaults to @samp{\"low\"}."
38798 #: doc/guix.texi:17399
38800 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-ac"
38804 #: doc/guix.texi:17402
38806 "Radeon dynamic power management method (DPM). Alternatives are battery, "
38811 #: doc/guix.texi:17407
38813 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-bat"
38817 #: doc/guix.texi:17409
38818 msgid "Same as @code{radeon-dpm-state-ac} but on BAT mode."
38822 #: doc/guix.texi:17411
38823 msgid "Defaults to @samp{\"battery\"}."
38827 #: doc/guix.texi:17414
38829 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-ac"
38833 #: doc/guix.texi:17416
38834 msgid "Radeon DPM performance level. Alternatives are auto, low, high."
38838 #: doc/guix.texi:17418 doc/guix.texi:17425 doc/guix.texi:17499
38839 msgid "Defaults to @samp{\"auto\"}."
38843 #: doc/guix.texi:17421
38845 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-bat"
38849 #: doc/guix.texi:17423
38850 msgid "Same as @code{radeon-dpm-perf-ac} but on BAT mode."
38854 #: doc/guix.texi:17428
38856 msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-ac?"
38860 #: doc/guix.texi:17430
38861 msgid "Wifi power saving mode."
38865 #: doc/guix.texi:17435
38867 msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-bat?"
38871 #: doc/guix.texi:17437
38872 msgid "Same as @code{wifi-power-ac?} but on BAT mode."
38876 #: doc/guix.texi:17442
38878 msgid "{@code{tlp-configuration} parameter} y-n-boolean wol-disable?"
38882 #: doc/guix.texi:17444
38883 msgid "Disable wake on LAN."
38887 #: doc/guix.texi:17449
38889 msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-ac"
38893 #: doc/guix.texi:17452
38895 "Timeout duration in seconds before activating audio power saving on Intel "
38896 "HDA and AC97 devices. A value of 0 disables power saving."
38900 #: doc/guix.texi:17457
38902 msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-bat"
38906 #: doc/guix.texi:17459
38907 msgid "Same as @code{sound-powersave-ac} but on BAT mode."
38911 #: doc/guix.texi:17461 doc/guix.texi:17976 doc/guix.texi:18120
38912 msgid "Defaults to @samp{1}."
38916 #: doc/guix.texi:17464
38918 msgid "{@code{tlp-configuration} parameter} y-n-boolean sound-power-save-controller?"
38922 #: doc/guix.texi:17466
38923 msgid "Disable controller in powersaving mode on Intel HDA devices."
38927 #: doc/guix.texi:17471
38929 msgid "{@code{tlp-configuration} parameter} boolean bay-poweroff-on-bat?"
38933 #: doc/guix.texi:17475
38935 "Enable optical drive in UltraBay/MediaBay on BAT mode. Drive can be powered "
38936 "on again by releasing (and reinserting) the eject lever or by pressing the "
38937 "disc eject button on newer models."
38941 #: doc/guix.texi:17480
38943 msgid "{@code{tlp-configuration} parameter} string bay-device"
38947 #: doc/guix.texi:17482
38948 msgid "Name of the optical drive device to power off."
38952 #: doc/guix.texi:17484
38953 msgid "Defaults to @samp{\"sr0\"}."
38957 #: doc/guix.texi:17487
38959 msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-ac"
38963 #: doc/guix.texi:17490
38965 "Runtime Power Management for PCI(e) bus devices. Alternatives are on and "
38970 #: doc/guix.texi:17492
38971 msgid "Defaults to @samp{\"on\"}."
38975 #: doc/guix.texi:17495
38977 msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-bat"
38981 #: doc/guix.texi:17497
38982 msgid "Same as @code{runtime-pm-ac} but on BAT mode."
38986 #: doc/guix.texi:17502
38988 msgid "{@code{tlp-configuration} parameter} boolean runtime-pm-all?"
38992 #: doc/guix.texi:17505
38994 "Runtime Power Management for all PCI(e) bus devices, except blacklisted ones."
38998 #: doc/guix.texi:17510
39000 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list runtime-pm-blacklist"
39004 #: doc/guix.texi:17512
39006 "Exclude specified PCI(e) device addresses from Runtime Power Management."
39010 #: doc/guix.texi:17517
39012 msgid "{@code{tlp-configuration} parameter} space-separated-string-list runtime-pm-driver-blacklist"
39016 #: doc/guix.texi:17520
39018 "Exclude PCI(e) devices assigned to the specified drivers from Runtime Power "
39023 #: doc/guix.texi:17523
39025 msgid "{@code{tlp-configuration} parameter} boolean usb-autosuspend?"
39029 #: doc/guix.texi:17525
39030 msgid "Enable USB autosuspend feature."
39034 #: doc/guix.texi:17530
39036 msgid "{@code{tlp-configuration} parameter} maybe-string usb-blacklist"
39040 #: doc/guix.texi:17532
39041 msgid "Exclude specified devices from USB autosuspend."
39045 #: doc/guix.texi:17537
39047 msgid "{@code{tlp-configuration} parameter} boolean usb-blacklist-wwan?"
39051 #: doc/guix.texi:17539
39052 msgid "Exclude WWAN devices from USB autosuspend."
39056 #: doc/guix.texi:17544
39058 msgid "{@code{tlp-configuration} parameter} maybe-string usb-whitelist"
39062 #: doc/guix.texi:17547
39064 "Include specified devices into USB autosuspend, even if they are already "
39065 "excluded by the driver or via @code{usb-blacklist-wwan?}."
39069 #: doc/guix.texi:17552
39071 msgid "{@code{tlp-configuration} parameter} maybe-boolean usb-autosuspend-disable-on-shutdown?"
39075 #: doc/guix.texi:17554
39076 msgid "Enable USB autosuspend before shutdown."
39080 #: doc/guix.texi:17559
39082 msgid "{@code{tlp-configuration} parameter} boolean restore-device-state-on-startup?"
39086 #: doc/guix.texi:17562
39088 "Restore radio device state (bluetooth, wifi, wwan) from previous shutdown on "
39092 #. type: Plain text
39093 #: doc/guix.texi:17570
39095 "The @code{(gnu services pm)} module provides an interface to thermald, a CPU "
39096 "frequency scaling service which helps prevent overheating."
39100 #: doc/guix.texi:17571
39102 msgid "{Scheme Variable} thermald-service-type"
39106 #: doc/guix.texi:17576
39108 "This is the service type for @uref{https://01.org/linux-thermal-daemon/, "
39109 "thermald}, the Linux Thermal Daemon, which is responsible for controlling "
39110 "the thermal state of processors and preventing overheating."
39114 #: doc/guix.texi:17578
39116 msgid "{Data Type} thermald-configuration"
39120 #: doc/guix.texi:17580
39122 "Data type representing the configuration of @code{thermald-service-type}."
39126 #: doc/guix.texi:17582
39128 msgid "@code{ignore-cpuid-check?} (default: @code{#f})"
39132 #: doc/guix.texi:17584
39133 msgid "Ignore cpuid check for supported CPU models."
39137 #: doc/guix.texi:17585
39139 msgid "@code{thermald} (default: @var{thermald})"
39143 #: doc/guix.texi:17587
39144 msgid "Package object of thermald."
39147 #. type: Plain text
39148 #: doc/guix.texi:17596
39150 "The @code{(gnu services audio)} module provides a service to start MPD (the "
39151 "Music Player Daemon)."
39155 #: doc/guix.texi:17597
39160 #. type: subsubheading
39161 #: doc/guix.texi:17598
39163 msgid "Music Player Daemon"
39166 #. type: Plain text
39167 #: doc/guix.texi:17603
39169 "The Music Player Daemon (MPD) is a service that can play music while being "
39170 "controlled from the local machine or over the network by a variety of "
39174 #. type: Plain text
39175 #: doc/guix.texi:17606
39177 "The following example shows how one might run @code{mpd} as user @code{\"bob"
39178 "\"} on port @code{6666}. It uses pulseaudio for output."
39182 #: doc/guix.texi:17612
39185 "(service mpd-service-type\n"
39186 " (mpd-configuration\n"
39187 " (user \"bob\")\n"
39188 " (port \"6666\")))\n"
39192 #: doc/guix.texi:17614
39194 msgid "{Scheme Variable} mpd-service-type"
39198 #: doc/guix.texi:17616
39199 msgid "The service type for @command{mpd}"
39203 #: doc/guix.texi:17618
39205 msgid "{Data Type} mpd-configuration"
39209 #: doc/guix.texi:17620
39210 msgid "Data type representing the configuration of @command{mpd}."
39214 #: doc/guix.texi:17622
39216 msgid "@code{user} (default: @code{\"mpd\"})"
39220 #: doc/guix.texi:17624
39221 msgid "The user to run mpd as."
39225 #: doc/guix.texi:17625
39227 msgid "@code{music-dir} (default: @code{\"~/Music\"})"
39231 #: doc/guix.texi:17627
39232 msgid "The directory to scan for music files."
39236 #: doc/guix.texi:17628
39238 msgid "@code{playlist-dir} (default: @code{\"~/.mpd/playlists\"})"
39242 #: doc/guix.texi:17630
39243 msgid "The directory to store playlists."
39247 #: doc/guix.texi:17631
39249 msgid "@code{port} (default: @code{\"6600\"})"
39253 #: doc/guix.texi:17633
39254 msgid "The port to run mpd on."
39258 #: doc/guix.texi:17634
39260 msgid "@code{address} (default: @code{\"any\"})"
39264 #: doc/guix.texi:17637
39266 "The address that mpd will bind to. To use a Unix domain socket, an absolute "
39267 "path can be specified here."
39270 #. type: subsubsection
39271 #: doc/guix.texi:17642
39273 msgid "Virtualization services"
39276 #. type: Plain text
39277 #: doc/guix.texi:17647
39279 "The @code{(gnu services virtualization)} module provides services for the "
39280 "libvirt and virtlog daemons, as well as other virtualization-related "
39284 #. type: subsubheading
39285 #: doc/guix.texi:17648
39287 msgid "Libvirt daemon"
39290 #. type: Plain text
39291 #: doc/guix.texi:17652
39293 "@code{libvirtd} is the server side daemon component of the libvirt "
39294 "virtualization management system. This daemon runs on host servers and "
39295 "performs required management tasks for virtualized guests."
39299 #: doc/guix.texi:17653
39301 msgid "{Scheme Variable} libvirt-service-type"
39305 #: doc/guix.texi:17656
39307 "This is the type of the @uref{https://libvirt.org, libvirt daemon}. Its "
39308 "value must be a @code{libvirt-configuration}."
39312 #: doc/guix.texi:17662
39315 "(service libvirt-service-type\n"
39316 " (libvirt-configuration\n"
39317 " (unix-sock-group \"libvirt\")\n"
39318 " (tls-port \"16555\")))\n"
39321 #. type: Plain text
39322 #: doc/guix.texi:17667
39323 msgid "Available @code{libvirt-configuration} fields are:"
39327 #: doc/guix.texi:17668
39329 msgid "{@code{libvirt-configuration} parameter} package libvirt"
39333 #: doc/guix.texi:17670
39334 msgid "Libvirt package."
39338 #: doc/guix.texi:17673
39340 msgid "{@code{libvirt-configuration} parameter} boolean listen-tls?"
39344 #: doc/guix.texi:17676
39346 "Flag listening for secure TLS connections on the public TCP/IP port. must "
39347 "set @code{listen} for this to have any effect."
39351 #: doc/guix.texi:17679
39353 "It is necessary to setup a CA and issue server certificates before using "
39358 #: doc/guix.texi:17684
39360 msgid "{@code{libvirt-configuration} parameter} boolean listen-tcp?"
39364 #: doc/guix.texi:17687
39366 "Listen for unencrypted TCP connections on the public TCP/IP port. must set "
39367 "@code{listen} for this to have any effect."
39371 #: doc/guix.texi:17691
39373 "Using the TCP socket requires SASL authentication by default. Only SASL "
39374 "mechanisms which support data encryption are allowed. This is DIGEST_MD5 "
39375 "and GSSAPI (Kerberos5)"
39379 #: doc/guix.texi:17696
39381 msgid "{@code{libvirt-configuration} parameter} string tls-port"
39385 #: doc/guix.texi:17699
39387 "Port for accepting secure TLS connections This can be a port number, or "
39392 #: doc/guix.texi:17701
39393 msgid "Defaults to @samp{\"16514\"}."
39397 #: doc/guix.texi:17704
39399 msgid "{@code{libvirt-configuration} parameter} string tcp-port"
39403 #: doc/guix.texi:17707
39405 "Port for accepting insecure TCP connections This can be a port number, or "
39410 #: doc/guix.texi:17709
39411 msgid "Defaults to @samp{\"16509\"}."
39415 #: doc/guix.texi:17712
39417 msgid "{@code{libvirt-configuration} parameter} string listen-addr"
39421 #: doc/guix.texi:17714
39422 msgid "IP address or hostname used for client connections."
39426 #: doc/guix.texi:17716
39427 msgid "Defaults to @samp{\"0.0.0.0\"}."
39431 #: doc/guix.texi:17719
39433 msgid "{@code{libvirt-configuration} parameter} boolean mdns-adv?"
39437 #: doc/guix.texi:17721
39438 msgid "Flag toggling mDNS advertisement of the libvirt service."
39442 #: doc/guix.texi:17724
39444 "Alternatively can disable for all services on a host by stopping the Avahi "
39449 #: doc/guix.texi:17729
39451 msgid "{@code{libvirt-configuration} parameter} string mdns-name"
39455 #: doc/guix.texi:17732
39457 "Default mDNS advertisement name. This must be unique on the immediate "
39458 "broadcast network."
39462 #: doc/guix.texi:17734
39463 msgid "Defaults to @samp{\"Virtualization Host <hostname>\"}."
39467 #: doc/guix.texi:17737
39469 msgid "{@code{libvirt-configuration} parameter} string unix-sock-group"
39473 #: doc/guix.texi:17741
39475 "UNIX domain socket group ownership. This can be used to allow a 'trusted' "
39476 "set of users access to management capabilities without becoming root."
39480 #: doc/guix.texi:17743
39481 msgid "Defaults to @samp{\"root\"}."
39485 #: doc/guix.texi:17746
39487 msgid "{@code{libvirt-configuration} parameter} string unix-sock-ro-perms"
39491 #: doc/guix.texi:17749
39493 "UNIX socket permissions for the R/O socket. This is used for monitoring VM "
39498 #: doc/guix.texi:17751 doc/guix.texi:17769
39499 msgid "Defaults to @samp{\"0777\"}."
39503 #: doc/guix.texi:17754
39505 msgid "{@code{libvirt-configuration} parameter} string unix-sock-rw-perms"
39509 #: doc/guix.texi:17758
39511 "UNIX socket permissions for the R/W socket. Default allows only root. If "
39512 "PolicyKit is enabled on the socket, the default will change to allow "
39513 "everyone (eg, 0777)"
39517 #: doc/guix.texi:17760
39518 msgid "Defaults to @samp{\"0770\"}."
39522 #: doc/guix.texi:17763
39524 msgid "{@code{libvirt-configuration} parameter} string unix-sock-admin-perms"
39528 #: doc/guix.texi:17767
39530 "UNIX socket permissions for the admin socket. Default allows only owner "
39531 "(root), do not change it unless you are sure to whom you are exposing the "
39536 #: doc/guix.texi:17772
39538 msgid "{@code{libvirt-configuration} parameter} string unix-sock-dir"
39542 #: doc/guix.texi:17774
39543 msgid "The directory in which sockets will be found/created."
39547 #: doc/guix.texi:17776
39548 msgid "Defaults to @samp{\"/var/run/libvirt\"}."
39552 #: doc/guix.texi:17779
39554 msgid "{@code{libvirt-configuration} parameter} string auth-unix-ro"
39558 #: doc/guix.texi:17782
39560 "Authentication scheme for UNIX read-only sockets. By default socket "
39561 "permissions allow anyone to connect"
39565 #: doc/guix.texi:17784 doc/guix.texi:17793
39566 msgid "Defaults to @samp{\"polkit\"}."
39570 #: doc/guix.texi:17787
39572 msgid "{@code{libvirt-configuration} parameter} string auth-unix-rw"
39576 #: doc/guix.texi:17791
39578 "Authentication scheme for UNIX read-write sockets. By default socket "
39579 "permissions only allow root. If PolicyKit support was compiled into "
39580 "libvirt, the default will be to use 'polkit' auth."
39584 #: doc/guix.texi:17796
39586 msgid "{@code{libvirt-configuration} parameter} string auth-tcp"
39590 #: doc/guix.texi:17800
39592 "Authentication scheme for TCP sockets. If you don't enable SASL, then all "
39593 "TCP traffic is cleartext. Don't do this outside of a dev/test scenario."
39597 #: doc/guix.texi:17802
39598 msgid "Defaults to @samp{\"sasl\"}."
39602 #: doc/guix.texi:17805
39604 msgid "{@code{libvirt-configuration} parameter} string auth-tls"
39608 #: doc/guix.texi:17809
39610 "Authentication scheme for TLS sockets. TLS sockets already have encryption "
39611 "provided by the TLS layer, and limited authentication is done by "
39616 #: doc/guix.texi:17812
39618 "It is possible to make use of any SASL authentication mechanism as well, by "
39619 "using 'sasl' for this option"
39623 #: doc/guix.texi:17814
39624 msgid "Defaults to @samp{\"none\"}."
39628 #: doc/guix.texi:17817
39630 msgid "{@code{libvirt-configuration} parameter} optional-list access-drivers"
39634 #: doc/guix.texi:17819
39635 msgid "API access control scheme."
39639 #: doc/guix.texi:17822
39641 "By default an authenticated user is allowed access to all APIs. Access "
39642 "drivers can place restrictions on this."
39646 #: doc/guix.texi:17827
39648 msgid "{@code{libvirt-configuration} parameter} string key-file"
39652 #: doc/guix.texi:17830
39654 "Server key file path. If set to an empty string, then no private key is "
39659 #: doc/guix.texi:17835
39661 msgid "{@code{libvirt-configuration} parameter} string cert-file"
39665 #: doc/guix.texi:17838
39667 "Server key file path. If set to an empty string, then no certificate is "
39672 #: doc/guix.texi:17843
39674 msgid "{@code{libvirt-configuration} parameter} string ca-file"
39678 #: doc/guix.texi:17846
39680 "Server key file path. If set to an empty string, then no CA certificate is "
39685 #: doc/guix.texi:17851
39687 msgid "{@code{libvirt-configuration} parameter} string crl-file"
39691 #: doc/guix.texi:17854
39693 "Certificate revocation list path. If set to an empty string, then no CRL is "
39698 #: doc/guix.texi:17859
39700 msgid "{@code{libvirt-configuration} parameter} boolean tls-no-sanity-cert"
39704 #: doc/guix.texi:17861
39705 msgid "Disable verification of our own server certificates."
39709 #: doc/guix.texi:17864
39711 "When libvirtd starts it performs some sanity checks against its own "
39716 #: doc/guix.texi:17869
39718 msgid "{@code{libvirt-configuration} parameter} boolean tls-no-verify-cert"
39722 #: doc/guix.texi:17871
39723 msgid "Disable verification of client certificates."
39727 #: doc/guix.texi:17875
39729 "Client certificate verification is the primary authentication mechanism. "
39730 "Any client which does not present a certificate signed by the CA will be "
39735 #: doc/guix.texi:17880
39737 msgid "{@code{libvirt-configuration} parameter} optional-list tls-allowed-dn-list"
39741 #: doc/guix.texi:17882
39742 msgid "Whitelist of allowed x509 Distinguished Name."
39746 #: doc/guix.texi:17887
39748 msgid "{@code{libvirt-configuration} parameter} optional-list sasl-allowed-usernames"
39752 #: doc/guix.texi:17890
39754 "Whitelist of allowed SASL usernames. The format for username depends on the "
39755 "SASL authentication mechanism."
39759 #: doc/guix.texi:17895
39761 msgid "{@code{libvirt-configuration} parameter} string tls-priority"
39765 #: doc/guix.texi:17899
39767 "Override the compile time default TLS priority string. The default is "
39768 "usually \"NORMAL\" unless overridden at build time. Only set this is it is "
39769 "desired for libvirt to deviate from the global default settings."
39773 #: doc/guix.texi:17901
39774 msgid "Defaults to @samp{\"NORMAL\"}."
39778 #: doc/guix.texi:17904
39780 msgid "{@code{libvirt-configuration} parameter} integer max-clients"
39784 #: doc/guix.texi:17907 doc/guix.texi:18330
39786 "Maximum number of concurrent client connections to allow over all sockets "
39791 #: doc/guix.texi:17909
39792 msgid "Defaults to @samp{5000}."
39796 #: doc/guix.texi:17912
39798 msgid "{@code{libvirt-configuration} parameter} integer max-queued-clients"
39802 #: doc/guix.texi:17916
39804 "Maximum length of queue of connections waiting to be accepted by the "
39805 "daemon. Note, that some protocols supporting retransmission may obey this "
39806 "so that a later reattempt at connection succeeds."
39810 #: doc/guix.texi:17921
39812 msgid "{@code{libvirt-configuration} parameter} integer max-anonymous-clients"
39816 #: doc/guix.texi:17924
39818 "Maximum length of queue of accepted but not yet authenticated clients. Set "
39819 "this to zero to turn this feature off"
39823 #: doc/guix.texi:17926 doc/guix.texi:17944 doc/guix.texi:17960
39824 msgid "Defaults to @samp{20}."
39828 #: doc/guix.texi:17929
39830 msgid "{@code{libvirt-configuration} parameter} integer min-workers"
39834 #: doc/guix.texi:17931
39835 msgid "Number of workers to start up initially."
39839 #: doc/guix.texi:17936
39841 msgid "{@code{libvirt-configuration} parameter} integer max-workers"
39845 #: doc/guix.texi:17938
39846 msgid "Maximum number of worker threads."
39850 #: doc/guix.texi:17942
39852 "If the number of active clients exceeds @code{min-workers}, then more "
39853 "threads are spawned, up to max_workers limit. Typically you'd want "
39854 "max_workers to equal maximum number of clients allowed."
39858 #: doc/guix.texi:17947
39860 msgid "{@code{libvirt-configuration} parameter} integer prio-workers"
39864 #: doc/guix.texi:17951
39866 "Number of priority workers. If all workers from above pool are stuck, some "
39867 "calls marked as high priority (notably domainDestroy) can be executed in "
39872 #: doc/guix.texi:17956
39874 msgid "{@code{libvirt-configuration} parameter} integer max-requests"
39878 #: doc/guix.texi:17958
39879 msgid "Total global limit on concurrent RPC calls."
39883 #: doc/guix.texi:17963
39885 msgid "{@code{libvirt-configuration} parameter} integer max-client-requests"
39889 #: doc/guix.texi:17967
39891 "Limit on concurrent requests from a single client connection. To avoid one "
39892 "client monopolizing the server this should be a small fraction of the global "
39893 "max_requests and max_workers parameter."
39897 #: doc/guix.texi:17972
39899 msgid "{@code{libvirt-configuration} parameter} integer admin-min-workers"
39903 #: doc/guix.texi:17974
39904 msgid "Same as @code{min-workers} but for the admin interface."
39908 #: doc/guix.texi:17979
39910 msgid "{@code{libvirt-configuration} parameter} integer admin-max-workers"
39914 #: doc/guix.texi:17981
39915 msgid "Same as @code{max-workers} but for the admin interface."
39919 #: doc/guix.texi:17986
39921 msgid "{@code{libvirt-configuration} parameter} integer admin-max-clients"
39925 #: doc/guix.texi:17988
39926 msgid "Same as @code{max-clients} but for the admin interface."
39930 #: doc/guix.texi:17993
39932 msgid "{@code{libvirt-configuration} parameter} integer admin-max-queued-clients"
39936 #: doc/guix.texi:17995
39937 msgid "Same as @code{max-queued-clients} but for the admin interface."
39941 #: doc/guix.texi:18000
39943 msgid "{@code{libvirt-configuration} parameter} integer admin-max-client-requests"
39947 #: doc/guix.texi:18002
39948 msgid "Same as @code{max-client-requests} but for the admin interface."
39952 #: doc/guix.texi:18007
39954 msgid "{@code{libvirt-configuration} parameter} integer log-level"
39958 #: doc/guix.texi:18009 doc/guix.texi:18232
39959 msgid "Logging level. 4 errors, 3 warnings, 2 information, 1 debug."
39963 #: doc/guix.texi:18014
39965 msgid "{@code{libvirt-configuration} parameter} string log-filters"
39969 #: doc/guix.texi:18016 doc/guix.texi:18239
39970 msgid "Logging filters."
39974 #: doc/guix.texi:18019 doc/guix.texi:18242
39976 "A filter allows to select a different logging level for a given category of "
39977 "logs The format for a filter is one of:"
39981 #: doc/guix.texi:18023 doc/guix.texi:18246
39986 #: doc/guix.texi:18026 doc/guix.texi:18249
39991 #: doc/guix.texi:18036 doc/guix.texi:18259
39993 "where @code{name} is a string which is matched against the category given in "
39994 "the @code{VIR_LOG_INIT()} at the top of each libvirt source file, e.g., "
39995 "\"remote\", \"qemu\", or \"util.json\" (the name in the filter can be a "
39996 "substring of the full category name, in order to match multiple similar "
39997 "categories), the optional \"+\" prefix tells libvirt to log stack trace for "
39998 "each message matching name, and @code{x} is the minimal level where matching "
39999 "messages should be logged:"
40003 #: doc/guix.texi:18040 doc/guix.texi:18085 doc/guix.texi:18263
40004 #: doc/guix.texi:18308
40009 #: doc/guix.texi:18043 doc/guix.texi:18088 doc/guix.texi:18266
40010 #: doc/guix.texi:18311
40015 #: doc/guix.texi:18046 doc/guix.texi:18091 doc/guix.texi:18269
40016 #: doc/guix.texi:18314
40021 #: doc/guix.texi:18049 doc/guix.texi:18094 doc/guix.texi:18272
40022 #: doc/guix.texi:18317
40027 #: doc/guix.texi:18054 doc/guix.texi:18277
40029 "Multiple filters can be defined in a single filters statement, they just "
40030 "need to be separated by spaces."
40034 #: doc/guix.texi:18056 doc/guix.texi:18279
40035 msgid "Defaults to @samp{\"3:remote 4:event\"}."
40039 #: doc/guix.texi:18059
40041 msgid "{@code{libvirt-configuration} parameter} string log-outputs"
40045 #: doc/guix.texi:18061 doc/guix.texi:18284
40046 msgid "Logging outputs."
40050 #: doc/guix.texi:18064 doc/guix.texi:18287
40052 "An output is one of the places to save logging information The format for an "
40057 #: doc/guix.texi:18066 doc/guix.texi:18289
40063 #: doc/guix.texi:18068 doc/guix.texi:18291
40064 msgid "output goes to stderr"
40068 #: doc/guix.texi:18069 doc/guix.texi:18292
40070 msgid "x:syslog:name"
40074 #: doc/guix.texi:18071 doc/guix.texi:18294
40075 msgid "use syslog for the output and use the given name as the ident"
40079 #: doc/guix.texi:18072 doc/guix.texi:18295
40081 msgid "x:file:file_path"
40085 #: doc/guix.texi:18074 doc/guix.texi:18297
40086 msgid "output to a file, with the given filepath"
40090 #: doc/guix.texi:18075 doc/guix.texi:18298
40096 #: doc/guix.texi:18077 doc/guix.texi:18300
40097 msgid "output to journald logging system"
40101 #: doc/guix.texi:18081 doc/guix.texi:18304
40102 msgid "In all case the x prefix is the minimal level, acting as a filter"
40106 #: doc/guix.texi:18099 doc/guix.texi:18322
40108 "Multiple outputs can be defined, they just need to be separated by spaces."
40112 #: doc/guix.texi:18101 doc/guix.texi:18324
40113 msgid "Defaults to @samp{\"3:stderr\"}."
40117 #: doc/guix.texi:18104
40119 msgid "{@code{libvirt-configuration} parameter} integer audit-level"
40123 #: doc/guix.texi:18106
40124 msgid "Allows usage of the auditing subsystem to be altered"
40128 #: doc/guix.texi:18110
40129 msgid "0: disable all auditing"
40133 #: doc/guix.texi:18113
40134 msgid "1: enable auditing, only if enabled on host"
40138 #: doc/guix.texi:18116
40139 msgid "2: enable auditing, and exit if disabled on host."
40143 #: doc/guix.texi:18123
40145 msgid "{@code{libvirt-configuration} parameter} boolean audit-logging"
40149 #: doc/guix.texi:18125
40150 msgid "Send audit messages via libvirt logging infrastructure."
40154 #: doc/guix.texi:18130
40156 msgid "{@code{libvirt-configuration} parameter} optional-string host-uuid"
40160 #: doc/guix.texi:18132
40161 msgid "Host UUID. UUID must not have all digits be the same."
40165 #: doc/guix.texi:18137
40167 msgid "{@code{libvirt-configuration} parameter} string host-uuid-source"
40171 #: doc/guix.texi:18139
40172 msgid "Source to read host UUID."
40176 #: doc/guix.texi:18143
40177 msgid "@code{smbios}: fetch the UUID from @code{dmidecode -s system-uuid}"
40181 #: doc/guix.texi:18146
40182 msgid "@code{machine-id}: fetch the UUID from @code{/etc/machine-id}"
40186 #: doc/guix.texi:18151
40188 "If @code{dmidecode} does not provide a valid UUID a temporary UUID will be "
40193 #: doc/guix.texi:18153
40194 msgid "Defaults to @samp{\"smbios\"}."
40198 #: doc/guix.texi:18156
40200 msgid "{@code{libvirt-configuration} parameter} integer keepalive-interval"
40204 #: doc/guix.texi:18161
40206 "A keepalive message is sent to a client after @code{keepalive_interval} "
40207 "seconds of inactivity to check if the client is still responding. If set to "
40208 "-1, libvirtd will never send keepalive requests; however clients can still "
40209 "send them and the daemon will send responses."
40213 #: doc/guix.texi:18166
40215 msgid "{@code{libvirt-configuration} parameter} integer keepalive-count"
40219 #: doc/guix.texi:18170
40221 "Maximum number of keepalive messages that are allowed to be sent to the "
40222 "client without getting any response before the connection is considered "
40227 #: doc/guix.texi:18177
40229 "In other words, the connection is automatically closed approximately after "
40230 "@code{keepalive_interval * (keepalive_count + 1)} seconds since the last "
40231 "message received from the client. When @code{keepalive-count} is set to 0, "
40232 "connections will be automatically closed after @code{keepalive-interval} "
40233 "seconds of inactivity without sending any keepalive messages."
40237 #: doc/guix.texi:18182
40239 msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-interval"
40243 #: doc/guix.texi:18184 doc/guix.texi:18191
40244 msgid "Same as above but for admin interface."
40248 #: doc/guix.texi:18189
40250 msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-count"
40254 #: doc/guix.texi:18196
40256 msgid "{@code{libvirt-configuration} parameter} integer ovs-timeout"
40260 #: doc/guix.texi:18198
40261 msgid "Timeout for Open vSwitch calls."
40265 #: doc/guix.texi:18202
40267 "The @code{ovs-vsctl} utility is used for the configuration and its timeout "
40268 "option is set by default to 5 seconds to avoid potential infinite waits "
40269 "blocking libvirt."
40272 #. type: subsubheading
40273 #: doc/guix.texi:18209
40275 msgid "Virtlog daemon"
40278 #. type: Plain text
40279 #: doc/guix.texi:18212
40281 "The virtlogd service is a server side daemon component of libvirt that is "
40282 "used to manage logs from virtual machine consoles."
40285 #. type: Plain text
40286 #: doc/guix.texi:18218
40288 "This daemon is not used directly by libvirt client applications, rather it "
40289 "is called on their behalf by @code{libvirtd}. By maintaining the logs in a "
40290 "standalone daemon, the main @code{libvirtd} daemon can be restarted without "
40291 "risk of losing logs. The @code{virtlogd} daemon has the ability to re-"
40292 "exec() itself upon receiving @code{SIGUSR1}, to allow live upgrades without "
40297 #: doc/guix.texi:18219
40299 msgid "{Scheme Variable} virtlog-service-type"
40303 #: doc/guix.texi:18222
40305 "This is the type of the virtlog daemon. Its value must be a @code{virtlog-"
40310 #: doc/guix.texi:18227
40313 "(service virtlog-service-type\n"
40314 " (virtlog-configuration\n"
40315 " (max-clients 1000)))\n"
40319 #: doc/guix.texi:18230
40321 msgid "{@code{virtlog-configuration} parameter} integer log-level"
40325 #: doc/guix.texi:18237
40327 msgid "{@code{virtlog-configuration} parameter} string log-filters"
40331 #: doc/guix.texi:18282
40333 msgid "{@code{virtlog-configuration} parameter} string log-outputs"
40337 #: doc/guix.texi:18327
40339 msgid "{@code{virtlog-configuration} parameter} integer max-clients"
40343 #: doc/guix.texi:18332
40344 msgid "Defaults to @samp{1024}."
40348 #: doc/guix.texi:18335
40350 msgid "{@code{virtlog-configuration} parameter} integer max-size"
40354 #: doc/guix.texi:18337
40355 msgid "Maximum file size before rolling over."
40359 #: doc/guix.texi:18339
40360 msgid "Defaults to @samp{2MB}"
40364 #: doc/guix.texi:18342
40366 msgid "{@code{virtlog-configuration} parameter} integer max-backups"
40370 #: doc/guix.texi:18344
40371 msgid "Maximum number of backup files to keep."
40375 #: doc/guix.texi:18346
40376 msgid "Defaults to @samp{3}"
40379 #. type: subsubheading
40380 #: doc/guix.texi:18349
40382 msgid "Transparent Emulation with QEMU"
40386 #: doc/guix.texi:18351
40392 #: doc/guix.texi:18352
40394 msgid "binfmt_misc"
40397 #. type: Plain text
40398 #: doc/guix.texi:18358
40400 "@code{qemu-binfmt-service-type} provides support for transparent emulation "
40401 "of program binaries built for different architectures---e.g., it allows you "
40402 "to transparently execute an ARMv7 program on an x86_64 machine. It achieves "
40403 "this by combining the @uref{https://www.qemu.org, QEMU} emulator and the "
40404 "@code{binfmt_misc} feature of the kernel Linux."
40408 #: doc/guix.texi:18359
40410 msgid "{Scheme Variable} qemu-binfmt-service-type"
40414 #: doc/guix.texi:18364
40416 "This is the type of the QEMU/binfmt service for transparent emulation. Its "
40417 "value must be a @code{qemu-binfmt-configuration} object, which specifies the "
40418 "QEMU package to use as well as the architecture we want to emulated:"
40422 #: doc/guix.texi:18369
40425 "(service qemu-binfmt-service-type\n"
40426 " (qemu-binfmt-configuration\n"
40427 " (platforms (lookup-qemu-platforms \"arm\" \"aarch64\" \"ppc\"))))\n"
40431 #: doc/guix.texi:18375
40433 "In this example, we enable transparent emulation for the ARM and aarch64 "
40434 "platforms. Running @code{herd stop qemu-binfmt} turns it off, and running "
40435 "@code{herd start qemu-binfmt} turns it back on (@pxref{Invoking herd, the "
40436 "@command{herd} command,, shepherd, The GNU Shepherd Manual})."
40440 #: doc/guix.texi:18377
40442 msgid "{Data Type} qemu-binfmt-configuration"
40446 #: doc/guix.texi:18379
40447 msgid "This is the configuration for the @code{qemu-binfmt} service."
40451 #: doc/guix.texi:18381
40453 msgid "@code{platforms} (default: @code{'()})"
40457 #: doc/guix.texi:18384
40459 "The list of emulated QEMU platforms. Each item must be a @dfn{platform "
40460 "object} as returned by @code{lookup-qemu-platforms} (see below)."
40464 #: doc/guix.texi:18385
40466 msgid "@code{guix-support?} (default: @code{#f})"
40470 #: doc/guix.texi:18391
40472 "When it is true, QEMU and all its dependencies are added to the build "
40473 "environment of @command{guix-daemon} (@pxref{Invoking guix-daemon, @code{--"
40474 "chroot-directory} option}). This allows the @code{binfmt_misc} handlers to "
40475 "be used within the build environment, which in turn means that you can "
40476 "transparently build programs for another architecture."
40480 #: doc/guix.texi:18394
40482 "For example, let's suppose you're on an x86_64 machine and you have this "
40487 #: doc/guix.texi:18400
40490 "(service qemu-binfmt-service-type\n"
40491 " (qemu-binfmt-configuration\n"
40492 " (platforms (lookup-qemu-platforms \"arm\"))\n"
40493 " (guix-support? #t)))\n"
40497 #: doc/guix.texi:18403
40498 msgid "You can run:"
40502 #: doc/guix.texi:18406
40504 msgid "guix build -s armhf-linux inkscape\n"
40508 #: doc/guix.texi:18413
40510 "and it will build Inkscape for ARMv7 @emph{as if it were a native build}, "
40511 "transparently using QEMU to emulate the ARMv7 CPU. Pretty handy if you'd "
40512 "like to test a package build for an architecture you don't have access to!"
40516 #: doc/guix.texi:18414
40518 msgid "@code{qemu} (default: @code{qemu})"
40522 #: doc/guix.texi:18416
40523 msgid "The QEMU package to use."
40527 #: doc/guix.texi:18419
40529 msgid "{Scheme Procedure} lookup-qemu-platforms @var{platforms}@dots{}"
40533 #: doc/guix.texi:18424
40535 "Return the list of QEMU platform objects corresponding to @var{platforms}"
40536 "@dots{}. @var{platforms} must be a list of strings corresponding to "
40537 "platform names, such as @code{\"arm\"}, @code{\"sparc\"}, @code{\"mips64el"
40542 #: doc/guix.texi:18426
40544 msgid "{Scheme Procedure} qemu-platform? @var{obj}"
40548 #: doc/guix.texi:18428
40549 msgid "Return true if @var{obj} is a platform object."
40553 #: doc/guix.texi:18430
40555 msgid "{Scheme Procedure} qemu-platform-name @var{platform}"
40559 #: doc/guix.texi:18432
40560 msgid "Return the name of @var{platform}---a string such as @code{\"arm\"}."
40563 #. type: Plain text
40564 #: doc/guix.texi:18444
40566 "The @code{(gnu services version-control)} module provides a service to allow "
40567 "remote access to local Git repositories. There are three options: the "
40568 "@code{git-daemon-service}, which provides access to repositories via the "
40569 "@code{git://} unsecured TCP-based protocol, extending the @code{nginx} web "
40570 "server to proxy some requests to @code{git-http-backend}, or providing a web "
40571 "interface with @code{cgit-service-type}."
40575 #: doc/guix.texi:18445
40577 msgid "{Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)]"
40581 #: doc/guix.texi:18449
40583 "Return a service that runs @command{git daemon}, a simple TCP server to "
40584 "expose repositories over the Git protocol for anonymous access."
40588 #: doc/guix.texi:18455
40590 "The optional @var{config} argument should be a @code{<git-daemon-"
40591 "configuration>} object, by default it allows read-only access to "
40592 "exported@footnote{By creating the magic file \"git-daemon-export-ok\" in the "
40593 "repository directory.} repositories under @file{/srv/git}."
40597 #: doc/guix.texi:18458
40599 msgid "{Data Type} git-daemon-configuration"
40603 #: doc/guix.texi:18460
40604 msgid "Data type representing the configuration for @code{git-daemon-service}."
40608 #: doc/guix.texi:18462 doc/guix.texi:18518
40610 msgid "@code{package} (default: @var{git})"
40614 #: doc/guix.texi:18464 doc/guix.texi:18520
40615 msgid "Package object of the Git distributed version control system."
40619 #: doc/guix.texi:18465 doc/guix.texi:18524
40621 msgid "@code{export-all?} (default: @var{#f})"
40625 #: doc/guix.texi:18468
40627 "Whether to allow access for all Git repositories, even if they do not have "
40628 "the @file{git-daemon-export-ok} file."
40632 #: doc/guix.texi:18469
40634 msgid "@code{base-path} (default: @file{/srv/git})"
40638 #: doc/guix.texi:18474
40640 "Whether to remap all the path requests as relative to the given path. If "
40641 "you run git daemon with @var{(base-path \"/srv/git\")} on example.com, then "
40642 "if you later try to pull @code{git://example.com/hello.git}, git daemon will "
40643 "interpret the path as @code{/srv/git/hello.git}."
40647 #: doc/guix.texi:18475
40649 msgid "@code{user-path} (default: @var{#f})"
40653 #: doc/guix.texi:18482
40655 "Whether to allow @code{~user} notation to be used in requests. When "
40656 "specified with empty string, requests to @code{git://host/~alice/foo} is "
40657 "taken as a request to access @code{foo} repository in the home directory of "
40658 "user @code{alice}. If @var{(user-path \"path\")} is specified, the same "
40659 "request is taken as a request to access @code{path/foo} repository in the "
40660 "home directory of user @code{alice}."
40664 #: doc/guix.texi:18483
40666 msgid "@code{listen} (default: @var{'()})"
40670 #: doc/guix.texi:18486
40672 "Whether to listen on specific IP addresses or hostnames, defaults to all."
40676 #: doc/guix.texi:18487
40678 msgid "@code{port} (default: @var{#f})"
40682 #: doc/guix.texi:18489
40683 msgid "Whether to listen on an alternative port, which defaults to 9418."
40687 #: doc/guix.texi:18490
40689 msgid "@code{whitelist} (default: @var{'()})"
40693 #: doc/guix.texi:18492
40694 msgid "If not empty, only allow access to this list of directories."
40698 #: doc/guix.texi:18493
40700 msgid "@code{extra-options} (default: @var{'()})"
40704 #: doc/guix.texi:18496
40706 "Extra options will be passed to @code{git daemon}, please run @command{man "
40707 "git-daemon} for more information."
40710 #. type: Plain text
40711 #: doc/guix.texi:18510
40713 "The @code{git://} protocol lacks authentication. When you pull from a "
40714 "repository fetched via @code{git://}, you don't know that the data you "
40715 "receive was modified is really coming from the specified host, and you have "
40716 "your connection is subject to eavesdropping. It's better to use an "
40717 "authenticated and encrypted transport, such as @code{https}. Although Git "
40718 "allows you to serve repositories using unsophisticated file-based web "
40719 "servers, there is a faster protocol implemented by the @code{git-http-"
40720 "backend} program. This program is the back-end of a proper Git web "
40721 "service. It is designed to sit behind a FastCGI proxy. @xref{Web "
40722 "Services}, for more on running the necessary @code{fcgiwrap} daemon."
40725 #. type: Plain text
40726 #: doc/guix.texi:18513
40728 "Guix has a separate configuration data type for serving Git repositories "
40733 #: doc/guix.texi:18514
40735 msgid "{Data Type} git-http-configuration"
40739 #: doc/guix.texi:18516
40740 msgid "Data type representing the configuration for @code{git-http-service}."
40744 #: doc/guix.texi:18521
40746 msgid "@code{git-root} (default: @file{/srv/git})"
40750 #: doc/guix.texi:18523
40751 msgid "Directory containing the Git repositories to expose to the world."
40755 #: doc/guix.texi:18527
40757 "Whether to expose access for all Git repositories in @var{git-root}, even if "
40758 "they do not have the @file{git-daemon-export-ok} file."
40762 #: doc/guix.texi:18528
40764 msgid "@code{uri-path} (default: @file{/git/})"
40768 #: doc/guix.texi:18533
40770 "Path prefix for Git access. With the default @code{/git/} prefix, this will "
40771 "map @code{http://@var{server}/git/@var{repo}.git} to @code{/srv/git/"
40772 "@var{repo}.git}. Requests whose URI paths do not begin with this prefix are "
40773 "not passed on to this Git instance."
40777 #: doc/guix.texi:18534
40779 msgid "@code{fcgiwrap-socket} (default: @code{127.0.0.1:9000})"
40783 #: doc/guix.texi:18537
40785 "The socket on which the @code{fcgiwrap} daemon is listening. @xref{Web "
40789 #. type: Plain text
40790 #: doc/guix.texi:18544
40792 "There is no @code{git-http-service-type}, currently; instead you can create "
40793 "an @code{nginx-location-configuration} from a @code{git-http-configuration} "
40794 "and then add that location to a web server."
40798 #: doc/guix.texi:18545
40800 msgid "{Scheme Procedure} git-http-nginx-location-configuration @"
40804 #: doc/guix.texi:18550
40806 "[config=(git-http-configuration)] Compute an @code{nginx-location-"
40807 "configuration} that corresponds to the given Git http configuration. An "
40808 "example nginx service definition to serve the default @file{/srv/git} over "
40813 #: doc/guix.texi:18567
40816 "(service nginx-service-type\n"
40817 " (nginx-configuration\n"
40818 " (server-blocks\n"
40820 " (nginx-server-configuration\n"
40821 " (listen '(\"443 ssl\"))\n"
40822 " (server-name \"git.my-host.org\")\n"
40823 " (ssl-certificate\n"
40824 " \"/etc/letsencrypt/live/git.my-host.org/fullchain.pem\")\n"
40825 " (ssl-certificate-key\n"
40826 " \"/etc/letsencrypt/live/git.my-host.org/privkey.pem\")\n"
40829 " (git-http-nginx-location-configuration\n"
40830 " (git-http-configuration (uri-path \"/\"))))))))))\n"
40834 #: doc/guix.texi:18574
40836 "This example assumes that you are using Let's Encrypt to get your TLS "
40837 "certificate. @xref{Certificate Services}. The default @code{certbot} "
40838 "service will redirect all HTTP traffic on @code{git.my-host.org} to HTTPS. "
40839 "You will also need to add an @code{fcgiwrap} proxy to your system services. "
40840 "@xref{Web Services}."
40843 #. type: subsubheading
40844 #: doc/guix.texi:18576
40846 msgid "Cgit Service"
40850 #: doc/guix.texi:18578
40852 msgid "Cgit service"
40856 #: doc/guix.texi:18579
40858 msgid "Git, web interface"
40861 #. type: Plain text
40862 #: doc/guix.texi:18582
40864 "@uref{https://git.zx2c4.com/cgit/, Cgit} is a web frontend for Git "
40865 "repositories written in C."
40868 #. type: Plain text
40869 #: doc/guix.texi:18585
40871 "The following example will configure the service with default values. By "
40872 "default, Cgit can be accessed on port 80 (@code{http://localhost:80})."
40876 #: doc/guix.texi:18588
40878 msgid "(service cgit-service-type)\n"
40881 #. type: Plain text
40882 #: doc/guix.texi:18592
40884 "The @code{file-object} type designates either a file-like object (@pxref{G-"
40885 "Expressions, file-like objects}) or a string."
40888 #. type: Plain text
40889 #: doc/guix.texi:18596
40890 msgid "Available @code{cgit-configuration} fields are:"
40894 #: doc/guix.texi:18597
40896 msgid "{@code{cgit-configuration} parameter} package package"
40900 #: doc/guix.texi:18599
40901 msgid "The CGIT package."
40905 #: doc/guix.texi:18602
40907 msgid "{@code{cgit-configuration} parameter} nginx-server-configuration-list nginx"
40911 #: doc/guix.texi:18604
40912 msgid "NGINX configuration."
40916 #: doc/guix.texi:18607
40918 msgid "{@code{cgit-configuration} parameter} file-object about-filter"
40922 #: doc/guix.texi:18610
40924 "Specifies a command which will be invoked to format the content of about "
40925 "pages (both top-level and for each repository)."
40929 #: doc/guix.texi:18615
40931 msgid "{@code{cgit-configuration} parameter} string agefile"
40935 #: doc/guix.texi:18618
40937 "Specifies a path, relative to each repository path, which can be used to "
40938 "specify the date and time of the youngest commit in the repository."
40942 #: doc/guix.texi:18623
40944 msgid "{@code{cgit-configuration} parameter} file-object auth-filter"
40948 #: doc/guix.texi:18626
40950 "Specifies a command that will be invoked for authenticating repository "
40955 #: doc/guix.texi:18631
40957 msgid "{@code{cgit-configuration} parameter} string branch-sort"
40961 #: doc/guix.texi:18634
40963 "Flag which, when set to @samp{age}, enables date ordering in the branch ref "
40964 "list, and when set @samp{name} enables ordering by branch name."
40968 #: doc/guix.texi:18636
40969 msgid "Defaults to @samp{\"name\"}."
40973 #: doc/guix.texi:18639
40975 msgid "{@code{cgit-configuration} parameter} string cache-root"
40979 #: doc/guix.texi:18641
40980 msgid "Path used to store the cgit cache entries."
40984 #: doc/guix.texi:18643
40985 msgid "Defaults to @samp{\"/var/cache/cgit\"}."
40989 #: doc/guix.texi:18646
40991 msgid "{@code{cgit-configuration} parameter} integer cache-static-ttl"
40995 #: doc/guix.texi:18649
40997 "Number which specifies the time-to-live, in minutes, for the cached version "
40998 "of repository pages accessed with a fixed SHA1."
41002 #: doc/guix.texi:18651 doc/guix.texi:19094
41003 msgid "Defaults to @samp{-1}."
41007 #: doc/guix.texi:18654
41009 msgid "{@code{cgit-configuration} parameter} integer cache-dynamic-ttl"
41013 #: doc/guix.texi:18657
41015 "Number which specifies the time-to-live, in minutes, for the cached version "
41016 "of repository pages accessed without a fixed SHA1."
41020 #: doc/guix.texi:18662
41022 msgid "{@code{cgit-configuration} parameter} integer cache-repo-ttl"
41026 #: doc/guix.texi:18665
41028 "Number which specifies the time-to-live, in minutes, for the cached version "
41029 "of the repository summary page."
41033 #: doc/guix.texi:18670
41035 msgid "{@code{cgit-configuration} parameter} integer cache-root-ttl"
41039 #: doc/guix.texi:18673
41041 "Number which specifies the time-to-live, in minutes, for the cached version "
41042 "of the repository index page."
41046 #: doc/guix.texi:18678
41048 msgid "{@code{cgit-configuration} parameter} integer cache-scanrc-ttl"
41052 #: doc/guix.texi:18681
41054 "Number which specifies the time-to-live, in minutes, for the result of "
41055 "scanning a path for Git repositories."
41059 #: doc/guix.texi:18686
41061 msgid "{@code{cgit-configuration} parameter} integer cache-about-ttl"
41065 #: doc/guix.texi:18689
41067 "Number which specifies the time-to-live, in minutes, for the cached version "
41068 "of the repository about page."
41072 #: doc/guix.texi:18694
41074 msgid "{@code{cgit-configuration} parameter} integer cache-snapshot-ttl"
41078 #: doc/guix.texi:18697
41080 "Number which specifies the time-to-live, in minutes, for the cached version "
41085 #: doc/guix.texi:18702
41087 msgid "{@code{cgit-configuration} parameter} integer cache-size"
41091 #: doc/guix.texi:18705
41093 "The maximum number of entries in the cgit cache. When set to @samp{0}, "
41094 "caching is disabled."
41098 #: doc/guix.texi:18710
41100 msgid "{@code{cgit-configuration} parameter} boolean case-sensitive-sort?"
41104 #: doc/guix.texi:18712
41105 msgid "Sort items in the repo list case sensitively."
41109 #: doc/guix.texi:18717
41111 msgid "{@code{cgit-configuration} parameter} list clone-prefix"
41115 #: doc/guix.texi:18720
41117 "List of common prefixes which, when combined with a repository URL, "
41118 "generates valid clone URLs for the repository."
41122 #: doc/guix.texi:18725
41124 msgid "{@code{cgit-configuration} parameter} list clone-url"
41128 #: doc/guix.texi:18727
41129 msgid "List of @code{clone-url} templates."
41133 #: doc/guix.texi:18732
41135 msgid "{@code{cgit-configuration} parameter} file-object commit-filter"
41139 #: doc/guix.texi:18734
41140 msgid "Command which will be invoked to format commit messages."
41144 #: doc/guix.texi:18739
41146 msgid "{@code{cgit-configuration} parameter} string commit-sort"
41150 #: doc/guix.texi:18743 doc/guix.texi:19301
41152 "Flag which, when set to @samp{date}, enables strict date ordering in the "
41153 "commit log, and when set to @samp{topo} enables strict topological ordering."
41157 #: doc/guix.texi:18745
41158 msgid "Defaults to @samp{\"git log\"}."
41162 #: doc/guix.texi:18748
41164 msgid "{@code{cgit-configuration} parameter} file-object css"
41168 #: doc/guix.texi:18750
41169 msgid "URL which specifies the css document to include in all cgit pages."
41173 #: doc/guix.texi:18752
41174 msgid "Defaults to @samp{\"/share/cgit/cgit.css\"}."
41178 #: doc/guix.texi:18755
41180 msgid "{@code{cgit-configuration} parameter} file-object email-filter"
41184 #: doc/guix.texi:18759
41186 "Specifies a command which will be invoked to format names and email address "
41187 "of committers, authors, and taggers, as represented in various places "
41188 "throughout the cgit interface."
41192 #: doc/guix.texi:18764
41194 msgid "{@code{cgit-configuration} parameter} boolean embedded?"
41198 #: doc/guix.texi:18767
41200 "Flag which, when set to @samp{#t}, will make cgit generate a HTML fragment "
41201 "suitable for embedding in other HTML pages."
41205 #: doc/guix.texi:18772
41207 msgid "{@code{cgit-configuration} parameter} boolean enable-commit-graph?"
41211 #: doc/guix.texi:18776
41213 "Flag which, when set to @samp{#t}, will make cgit print an ASCII-art commit "
41214 "history graph to the left of the commit messages in the repository log page."
41218 #: doc/guix.texi:18781
41220 msgid "{@code{cgit-configuration} parameter} boolean enable-filter-overrides?"
41224 #: doc/guix.texi:18784
41226 "Flag which, when set to @samp{#t}, allows all filter settings to be "
41227 "overridden in repository-specific cgitrc files."
41231 #: doc/guix.texi:18789
41233 msgid "{@code{cgit-configuration} parameter} boolean enable-follow-links?"
41237 #: doc/guix.texi:18792
41239 "Flag which, when set to @samp{#t}, allows users to follow a file in the log "
41244 #: doc/guix.texi:18797
41246 msgid "{@code{cgit-configuration} parameter} boolean enable-http-clone?"
41250 #: doc/guix.texi:18800
41252 "If set to @samp{#t}, cgit will act as an dumb HTTP endpoint for Git clones."
41256 #: doc/guix.texi:18805
41258 msgid "{@code{cgit-configuration} parameter} boolean enable-index-links?"
41262 #: doc/guix.texi:18808
41264 "Flag which, when set to @samp{#t}, will make cgit generate extra links "
41265 "\"summary\", \"commit\", \"tree\" for each repo in the repository index."
41269 #: doc/guix.texi:18813
41271 msgid "{@code{cgit-configuration} parameter} boolean enable-index-owner?"
41275 #: doc/guix.texi:18816
41277 "Flag which, when set to @samp{#t}, will make cgit display the owner of each "
41278 "repo in the repository index."
41282 #: doc/guix.texi:18821
41284 msgid "{@code{cgit-configuration} parameter} boolean enable-log-filecount?"
41288 #: doc/guix.texi:18824
41290 "Flag which, when set to @samp{#t}, will make cgit print the number of "
41291 "modified files for each commit on the repository log page."
41295 #: doc/guix.texi:18829
41297 msgid "{@code{cgit-configuration} parameter} boolean enable-log-linecount?"
41301 #: doc/guix.texi:18832
41303 "Flag which, when set to @samp{#t}, will make cgit print the number of added "
41304 "and removed lines for each commit on the repository log page."
41308 #: doc/guix.texi:18837
41310 msgid "{@code{cgit-configuration} parameter} boolean enable-remote-branches?"
41314 #: doc/guix.texi:18840 doc/guix.texi:19364
41316 "Flag which, when set to @code{#t}, will make cgit display remote branches in "
41317 "the summary and refs views."
41321 #: doc/guix.texi:18845
41323 msgid "{@code{cgit-configuration} parameter} boolean enable-subject-links?"
41327 #: doc/guix.texi:18849
41329 "Flag which, when set to @code{1}, will make cgit use the subject of the "
41330 "parent commit as link text when generating links to parent commits in commit "
41335 #: doc/guix.texi:18854
41337 msgid "{@code{cgit-configuration} parameter} boolean enable-html-serving?"
41341 #: doc/guix.texi:18858
41343 "Flag which, when set to @samp{#t}, will make cgit use the subject of the "
41344 "parent commit as link text when generating links to parent commits in commit "
41349 #: doc/guix.texi:18863
41351 msgid "{@code{cgit-configuration} parameter} boolean enable-tree-linenumbers?"
41355 #: doc/guix.texi:18866
41357 "Flag which, when set to @samp{#t}, will make cgit generate linenumber links "
41358 "for plaintext blobs printed in the tree view."
41362 #: doc/guix.texi:18871
41364 msgid "{@code{cgit-configuration} parameter} boolean enable-git-config?"
41368 #: doc/guix.texi:18874
41370 "Flag which, when set to @samp{#f}, will allow cgit to use Git config to set "
41371 "any repo specific settings."
41375 #: doc/guix.texi:18879
41377 msgid "{@code{cgit-configuration} parameter} file-object favicon"
41381 #: doc/guix.texi:18881
41382 msgid "URL used as link to a shortcut icon for cgit."
41386 #: doc/guix.texi:18883
41387 msgid "Defaults to @samp{\"/favicon.ico\"}."
41391 #: doc/guix.texi:18886
41393 msgid "{@code{cgit-configuration} parameter} string footer"
41397 #: doc/guix.texi:18890
41399 "The content of the file specified with this option will be included verbatim "
41400 "at the bottom of all pages (i.e. it replaces the standard \"generated by..."
41405 #: doc/guix.texi:18895
41407 msgid "{@code{cgit-configuration} parameter} string head-include"
41411 #: doc/guix.texi:18898
41413 "The content of the file specified with this option will be included verbatim "
41414 "in the HTML HEAD section on all pages."
41418 #: doc/guix.texi:18903
41420 msgid "{@code{cgit-configuration} parameter} string header"
41424 #: doc/guix.texi:18906
41426 "The content of the file specified with this option will be included verbatim "
41427 "at the top of all pages."
41431 #: doc/guix.texi:18911
41433 msgid "{@code{cgit-configuration} parameter} file-object include"
41437 #: doc/guix.texi:18914
41439 "Name of a configfile to include before the rest of the current config- file "
41444 #: doc/guix.texi:18919
41446 msgid "{@code{cgit-configuration} parameter} string index-header"
41450 #: doc/guix.texi:18922
41452 "The content of the file specified with this option will be included verbatim "
41453 "above the repository index."
41457 #: doc/guix.texi:18927
41459 msgid "{@code{cgit-configuration} parameter} string index-info"
41463 #: doc/guix.texi:18930
41465 "The content of the file specified with this option will be included verbatim "
41466 "below the heading on the repository index page."
41470 #: doc/guix.texi:18935
41472 msgid "{@code{cgit-configuration} parameter} boolean local-time?"
41476 #: doc/guix.texi:18938
41478 "Flag which, if set to @samp{#t}, makes cgit print commit and tag times in "
41479 "the servers timezone."
41483 #: doc/guix.texi:18943
41485 msgid "{@code{cgit-configuration} parameter} file-object logo"
41489 #: doc/guix.texi:18946
41491 "URL which specifies the source of an image which will be used as a logo on "
41496 #: doc/guix.texi:18948
41497 msgid "Defaults to @samp{\"/share/cgit/cgit.png\"}."
41501 #: doc/guix.texi:18951
41503 msgid "{@code{cgit-configuration} parameter} string logo-link"
41507 #: doc/guix.texi:18953 doc/guix.texi:19410
41508 msgid "URL loaded when clicking on the cgit logo image."
41512 #: doc/guix.texi:18958
41514 msgid "{@code{cgit-configuration} parameter} file-object owner-filter"
41518 #: doc/guix.texi:18961
41520 "Command which will be invoked to format the Owner column of the main page."
41524 #: doc/guix.texi:18966
41526 msgid "{@code{cgit-configuration} parameter} integer max-atom-items"
41530 #: doc/guix.texi:18968
41531 msgid "Number of items to display in atom feeds view."
41535 #: doc/guix.texi:18970 doc/guix.texi:19205 doc/guix.texi:19213
41536 #: doc/guix.texi:19221
41537 msgid "Defaults to @samp{10}."
41541 #: doc/guix.texi:18973
41543 msgid "{@code{cgit-configuration} parameter} integer max-commit-count"
41547 #: doc/guix.texi:18975
41548 msgid "Number of entries to list per page in \"log\" view."
41552 #: doc/guix.texi:18977 doc/guix.texi:18992
41553 msgid "Defaults to @samp{50}."
41557 #: doc/guix.texi:18980
41559 msgid "{@code{cgit-configuration} parameter} integer max-message-length"
41563 #: doc/guix.texi:18982
41564 msgid "Number of commit message characters to display in \"log\" view."
41568 #: doc/guix.texi:18984 doc/guix.texi:19000
41569 msgid "Defaults to @samp{80}."
41573 #: doc/guix.texi:18987
41575 msgid "{@code{cgit-configuration} parameter} integer max-repo-count"
41579 #: doc/guix.texi:18990
41581 "Specifies the number of entries to list per page on the repository index "
41586 #: doc/guix.texi:18995
41588 msgid "{@code{cgit-configuration} parameter} integer max-repodesc-length"
41592 #: doc/guix.texi:18998
41594 "Specifies the maximum number of repo description characters to display on "
41595 "the repository index page."
41599 #: doc/guix.texi:19003
41601 msgid "{@code{cgit-configuration} parameter} integer max-blob-size"
41605 #: doc/guix.texi:19005
41606 msgid "Specifies the maximum size of a blob to display HTML for in KBytes."
41610 #: doc/guix.texi:19010
41612 msgid "{@code{cgit-configuration} parameter} string max-stats"
41616 #: doc/guix.texi:19013
41618 "Maximum statistics period. Valid values are @samp{week},@samp{month}, "
41619 "@samp{quarter} and @samp{year}."
41623 #: doc/guix.texi:19018
41625 msgid "{@code{cgit-configuration} parameter} mimetype-alist mimetype"
41629 #: doc/guix.texi:19020
41630 msgid "Mimetype for the specified filename extension."
41634 #: doc/guix.texi:19024
41636 "Defaults to @samp{((gif \"image/gif\") (html \"text/html\") (jpg \"image/jpeg"
41637 "\") (jpeg \"image/jpeg\") (pdf \"application/pdf\") (png \"image/png\") (svg "
41638 "\"image/svg+xml\"))}."
41642 #: doc/guix.texi:19027
41644 msgid "{@code{cgit-configuration} parameter} file-object mimetype-file"
41648 #: doc/guix.texi:19029
41649 msgid "Specifies the file to use for automatic mimetype lookup."
41653 #: doc/guix.texi:19034
41655 msgid "{@code{cgit-configuration} parameter} string module-link"
41659 #: doc/guix.texi:19037
41661 "Text which will be used as the formatstring for a hyperlink when a submodule "
41662 "is printed in a directory listing."
41666 #: doc/guix.texi:19042
41668 msgid "{@code{cgit-configuration} parameter} boolean nocache?"
41672 #: doc/guix.texi:19044
41673 msgid "If set to the value @samp{#t} caching will be disabled."
41677 #: doc/guix.texi:19049
41679 msgid "{@code{cgit-configuration} parameter} boolean noplainemail?"
41683 #: doc/guix.texi:19052
41685 "If set to @samp{#t} showing full author email addresses will be disabled."
41689 #: doc/guix.texi:19057
41691 msgid "{@code{cgit-configuration} parameter} boolean noheader?"
41695 #: doc/guix.texi:19060
41697 "Flag which, when set to @samp{#t}, will make cgit omit the standard header "
41702 #: doc/guix.texi:19065
41704 msgid "{@code{cgit-configuration} parameter} list project-list"
41708 #: doc/guix.texi:19069
41710 "A list of subdirectories inside of @code{repository-directory}, relative to "
41711 "it, that should loaded as Git repositories. An empty list means that all "
41712 "subdirectories will be loaded."
41716 #: doc/guix.texi:19074
41718 msgid "{@code{cgit-configuration} parameter} file-object readme"
41722 #: doc/guix.texi:19076
41723 msgid "Text which will be used as default value for @code{cgit-repo-readme}."
41727 #: doc/guix.texi:19081
41729 msgid "{@code{cgit-configuration} parameter} boolean remove-suffix?"
41733 #: doc/guix.texi:19085
41735 "If set to @code{#t} and @code{repository-directory} is enabled, if any "
41736 "repositories are found with a suffix of @code{.git}, this suffix will be "
41737 "removed for the URL and name."
41741 #: doc/guix.texi:19090
41743 msgid "{@code{cgit-configuration} parameter} integer renamelimit"
41747 #: doc/guix.texi:19092
41748 msgid "Maximum number of files to consider when detecting renames."
41752 #: doc/guix.texi:19097
41754 msgid "{@code{cgit-configuration} parameter} string repository-sort"
41758 #: doc/guix.texi:19099
41759 msgid "The way in which repositories in each section are sorted."
41763 #: doc/guix.texi:19104
41765 msgid "{@code{cgit-configuration} parameter} robots-list robots"
41769 #: doc/guix.texi:19106
41770 msgid "Text used as content for the @code{robots} meta-tag."
41774 #: doc/guix.texi:19108
41775 msgid "Defaults to @samp{(\"noindex\" \"nofollow\")}."
41779 #: doc/guix.texi:19111
41781 msgid "{@code{cgit-configuration} parameter} string root-desc"
41785 #: doc/guix.texi:19113
41786 msgid "Text printed below the heading on the repository index page."
41790 #: doc/guix.texi:19115
41791 msgid "Defaults to @samp{\"a fast webinterface for the git dscm\"}."
41795 #: doc/guix.texi:19118
41797 msgid "{@code{cgit-configuration} parameter} string root-readme"
41801 #: doc/guix.texi:19121
41803 "The content of the file specified with this option will be included verbatim "
41804 "below thef \"about\" link on the repository index page."
41808 #: doc/guix.texi:19126
41810 msgid "{@code{cgit-configuration} parameter} string root-title"
41814 #: doc/guix.texi:19128
41815 msgid "Text printed as heading on the repository index page."
41819 #: doc/guix.texi:19133
41821 msgid "{@code{cgit-configuration} parameter} boolean scan-hidden-path"
41825 #: doc/guix.texi:19139
41827 "If set to @samp{#t} and repository-directory is enabled, repository-"
41828 "directory will recurse into directories whose name starts with a period. "
41829 "Otherwise, repository-directory will stay away from such directories, "
41830 "considered as \"hidden\". Note that this does not apply to the \".git\" "
41831 "directory in non-bare repos."
41835 #: doc/guix.texi:19144
41837 msgid "{@code{cgit-configuration} parameter} list snapshots"
41841 #: doc/guix.texi:19147
41843 "Text which specifies the default set of snapshot formats that cgit generates "
41848 #: doc/guix.texi:19152
41850 msgid "{@code{cgit-configuration} parameter} repository-directory repository-directory"
41854 #: doc/guix.texi:19155
41856 "Name of the directory to scan for repositories (represents @code{scan-path})."
41860 #: doc/guix.texi:19157
41861 msgid "Defaults to @samp{\"/srv/git\"}."
41865 #: doc/guix.texi:19160
41867 msgid "{@code{cgit-configuration} parameter} string section"
41871 #: doc/guix.texi:19163 doc/guix.texi:19479
41873 "The name of the current repository section - all repositories defined after "
41874 "this option will inherit the current section name."
41878 #: doc/guix.texi:19168
41880 msgid "{@code{cgit-configuration} parameter} string section-sort"
41884 #: doc/guix.texi:19171
41886 "Flag which, when set to @samp{1}, will sort the sections on the repository "
41891 #: doc/guix.texi:19176
41893 msgid "{@code{cgit-configuration} parameter} integer section-from-path"
41897 #: doc/guix.texi:19179
41899 "A number which, if defined prior to repository-directory, specifies how many "
41900 "path elements from each repo path to use as a default section name."
41904 #: doc/guix.texi:19184
41906 msgid "{@code{cgit-configuration} parameter} boolean side-by-side-diffs?"
41910 #: doc/guix.texi:19187
41912 "If set to @samp{#t} shows side-by-side diffs instead of unidiffs per default."
41916 #: doc/guix.texi:19192
41918 msgid "{@code{cgit-configuration} parameter} file-object source-filter"
41922 #: doc/guix.texi:19195
41924 "Specifies a command which will be invoked to format plaintext blobs in the "
41929 #: doc/guix.texi:19200
41931 msgid "{@code{cgit-configuration} parameter} integer summary-branches"
41935 #: doc/guix.texi:19203
41937 "Specifies the number of branches to display in the repository \"summary\" "
41942 #: doc/guix.texi:19208
41944 msgid "{@code{cgit-configuration} parameter} integer summary-log"
41948 #: doc/guix.texi:19211
41950 "Specifies the number of log entries to display in the repository \"summary\" "
41955 #: doc/guix.texi:19216
41957 msgid "{@code{cgit-configuration} parameter} integer summary-tags"
41961 #: doc/guix.texi:19219
41963 "Specifies the number of tags to display in the repository \"summary\" view."
41967 #: doc/guix.texi:19224
41969 msgid "{@code{cgit-configuration} parameter} string strict-export"
41973 #: doc/guix.texi:19227
41975 "Filename which, if specified, needs to be present within the repository for "
41976 "cgit to allow access to that repository."
41980 #: doc/guix.texi:19232
41982 msgid "{@code{cgit-configuration} parameter} string virtual-root"
41986 #: doc/guix.texi:19234
41987 msgid "URL which, if specified, will be used as root for all cgit links."
41991 #: doc/guix.texi:19236
41992 msgid "Defaults to @samp{\"/\"}."
41996 #: doc/guix.texi:19239
41998 msgid "{@code{cgit-configuration} parameter} repository-cgit-configuration-list repositories"
42002 #: doc/guix.texi:19241
42003 msgid "A list of @dfn{cgit-repo} records to use with config."
42007 #: doc/guix.texi:19245
42008 msgid "Available @code{repository-cgit-configuration} fields are:"
42012 #: doc/guix.texi:19246
42014 msgid "{@code{repository-cgit-configuration} parameter} repo-list snapshots"
42018 #: doc/guix.texi:19249
42020 "A mask of snapshot formats for this repo that cgit generates links for, "
42021 "restricted by the global @code{snapshots} setting."
42025 #: doc/guix.texi:19254
42027 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object source-filter"
42031 #: doc/guix.texi:19256
42032 msgid "Override the default @code{source-filter}."
42036 #: doc/guix.texi:19261
42038 msgid "{@code{repository-cgit-configuration} parameter} repo-string url"
42042 #: doc/guix.texi:19263
42043 msgid "The relative URL used to access the repository."
42047 #: doc/guix.texi:19268
42049 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object about-filter"
42053 #: doc/guix.texi:19270
42054 msgid "Override the default @code{about-filter}."
42058 #: doc/guix.texi:19275
42060 msgid "{@code{repository-cgit-configuration} parameter} repo-string branch-sort"
42064 #: doc/guix.texi:19278
42066 "Flag which, when set to @samp{age}, enables date ordering in the branch ref "
42067 "list, and when set to @samp{name} enables ordering by branch name."
42071 #: doc/guix.texi:19283
42073 msgid "{@code{repository-cgit-configuration} parameter} repo-list clone-url"
42077 #: doc/guix.texi:19285
42078 msgid "A list of URLs which can be used to clone repo."
42082 #: doc/guix.texi:19290
42084 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object commit-filter"
42088 #: doc/guix.texi:19292
42089 msgid "Override the default @code{commit-filter}."
42093 #: doc/guix.texi:19297
42095 msgid "{@code{repository-cgit-configuration} parameter} repo-string commit-sort"
42099 #: doc/guix.texi:19306
42101 msgid "{@code{repository-cgit-configuration} parameter} repo-string defbranch"
42105 #: doc/guix.texi:19311
42107 "The name of the default branch for this repository. If no such branch "
42108 "exists in the repository, the first branch name (when sorted) is used as "
42109 "default instead. By default branch pointed to by HEAD, or \"master\" if "
42110 "there is no suitable HEAD."
42114 #: doc/guix.texi:19316
42116 msgid "{@code{repository-cgit-configuration} parameter} repo-string desc"
42120 #: doc/guix.texi:19318
42121 msgid "The value to show as repository description."
42125 #: doc/guix.texi:19323
42127 msgid "{@code{repository-cgit-configuration} parameter} repo-string homepage"
42131 #: doc/guix.texi:19325
42132 msgid "The value to show as repository homepage."
42136 #: doc/guix.texi:19330
42138 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object email-filter"
42142 #: doc/guix.texi:19332
42143 msgid "Override the default @code{email-filter}."
42147 #: doc/guix.texi:19337
42149 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean enable-commit-graph?"
42153 #: doc/guix.texi:19340
42155 "A flag which can be used to disable the global setting @code{enable-commit-"
42160 #: doc/guix.texi:19345
42162 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean enable-log-filecount?"
42166 #: doc/guix.texi:19348
42168 "A flag which can be used to disable the global setting @code{enable-log-"
42173 #: doc/guix.texi:19353
42175 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean enable-log-linecount?"
42179 #: doc/guix.texi:19356
42181 "A flag which can be used to disable the global setting @code{enable-log-"
42186 #: doc/guix.texi:19361
42188 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean enable-remote-branches?"
42192 #: doc/guix.texi:19369
42194 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean enable-subject-links?"
42198 #: doc/guix.texi:19372
42200 "A flag which can be used to override the global setting @code{enable-subject-"
42205 #: doc/guix.texi:19377
42207 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean enable-html-serving?"
42211 #: doc/guix.texi:19380
42213 "A flag which can be used to override the global setting @code{enable-html-"
42218 #: doc/guix.texi:19385
42220 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean hide?"
42224 #: doc/guix.texi:19388
42226 "Flag which, when set to @code{#t}, hides the repository from the repository "
42231 #: doc/guix.texi:19393
42233 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean ignore?"
42237 #: doc/guix.texi:19395
42238 msgid "Flag which, when set to @samp{#t}, ignores the repository."
42242 #: doc/guix.texi:19400
42244 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object logo"
42248 #: doc/guix.texi:19403
42250 "URL which specifies the source of an image which will be used as a logo on "
42251 "this repo’s pages."
42255 #: doc/guix.texi:19408
42257 msgid "{@code{repository-cgit-configuration} parameter} repo-string logo-link"
42261 #: doc/guix.texi:19415
42263 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object owner-filter"
42267 #: doc/guix.texi:19417
42268 msgid "Override the default @code{owner-filter}."
42272 #: doc/guix.texi:19422
42274 msgid "{@code{repository-cgit-configuration} parameter} repo-string module-link"
42278 #: doc/guix.texi:19426
42280 "Text which will be used as the formatstring for a hyperlink when a submodule "
42281 "is printed in a directory listing. The arguments for the formatstring are "
42282 "the path and SHA1 of the submodule commit."
42286 #: doc/guix.texi:19431
42288 msgid "{@code{repository-cgit-configuration} parameter} module-link-path module-link-path"
42292 #: doc/guix.texi:19435
42294 "Text which will be used as the formatstring for a hyperlink when a submodule "
42295 "with the specified subdirectory path is printed in a directory listing."
42299 #: doc/guix.texi:19440
42301 msgid "{@code{repository-cgit-configuration} parameter} repo-string max-stats"
42305 #: doc/guix.texi:19442
42306 msgid "Override the default maximum statistics period."
42310 #: doc/guix.texi:19447
42312 msgid "{@code{repository-cgit-configuration} parameter} repo-string name"
42316 #: doc/guix.texi:19449
42317 msgid "The value to show as repository name."
42321 #: doc/guix.texi:19454
42323 msgid "{@code{repository-cgit-configuration} parameter} repo-string owner"
42327 #: doc/guix.texi:19456
42328 msgid "A value used to identify the owner of the repository."
42332 #: doc/guix.texi:19461
42334 msgid "{@code{repository-cgit-configuration} parameter} repo-string path"
42338 #: doc/guix.texi:19463
42339 msgid "An absolute path to the repository directory."
42343 #: doc/guix.texi:19468
42345 msgid "{@code{repository-cgit-configuration} parameter} repo-string readme"
42349 #: doc/guix.texi:19471
42351 "A path (relative to repo) which specifies a file to include verbatim as the "
42352 "\"About\" page for this repo."
42356 #: doc/guix.texi:19476
42358 msgid "{@code{repository-cgit-configuration} parameter} repo-string section"
42362 #: doc/guix.texi:19484
42364 msgid "{@code{repository-cgit-configuration} parameter} repo-list extra-options"
42368 #: doc/guix.texi:19486 doc/guix.texi:19495
42369 msgid "Extra options will be appended to cgitrc file."
42373 #: doc/guix.texi:19493
42375 msgid "{@code{cgit-configuration} parameter} list extra-options"
42378 #. type: Plain text
42379 #: doc/guix.texi:19507
42381 "However, it could be that you just want to get a @code{cgitrc} up and "
42382 "running. In that case, you can pass an @code{opaque-cgit-configuration} as "
42383 "a record to @code{cgit-service-type}. As its name indicates, an opaque "
42384 "configuration does not have easy reflective capabilities."
42387 #. type: Plain text
42388 #: doc/guix.texi:19509
42389 msgid "Available @code{opaque-cgit-configuration} fields are:"
42393 #: doc/guix.texi:19510
42395 msgid "{@code{opaque-cgit-configuration} parameter} package cgit"
42399 #: doc/guix.texi:19512
42400 msgid "The cgit package."
42404 #: doc/guix.texi:19514
42406 msgid "{@code{opaque-cgit-configuration} parameter} string string"
42410 #: doc/guix.texi:19516
42411 msgid "The contents of the @code{cgitrc}, as a string."
42414 #. type: Plain text
42415 #: doc/guix.texi:19520
42417 "For example, if your @code{cgitrc} is just the empty string, you could "
42418 "instantiate a cgit service like this:"
42422 #: doc/guix.texi:19525
42425 "(service cgit-service-type\n"
42426 " (opaque-cgit-configuration\n"
42427 " (cgitrc \"\")))\n"
42430 #. type: subsubheading
42431 #: doc/guix.texi:19531
42433 msgid "The Battle for Wesnoth Service"
42437 #: doc/guix.texi:19532
42442 #. type: Plain text
42443 #: doc/guix.texi:19536
42445 "@uref{https://wesnoth.org, The Battle for Wesnoth} is a fantasy, turn based "
42446 "tactical strategy game, with several single player campaigns, and "
42447 "multiplayer games (both networked and local)."
42451 #: doc/guix.texi:19537
42453 msgid "{Scheme Variable} wesnothd-service-type"
42457 #: doc/guix.texi:19541
42459 "Service type for the wesnothd service. Its value must be a @code{wesnothd-"
42460 "configuration} object. To run wesnothd in the default configuration, "
42461 "instantiate it as:"
42465 #: doc/guix.texi:19544
42467 msgid "(service wesnothd-service-type)\n"
42471 #: doc/guix.texi:19547
42473 msgid "{Data Type} wesnothd-configuration"
42477 #: doc/guix.texi:19549
42478 msgid "Data type representing the configuration of @command{wesnothd}."
42482 #: doc/guix.texi:19551
42484 msgid "@code{package} (default: @code{wesnoth-server})"
42488 #: doc/guix.texi:19553
42489 msgid "The wesnoth server package to use."
42493 #: doc/guix.texi:19554
42495 msgid "@code{port} (default: @code{15000})"
42499 #: doc/guix.texi:19556
42500 msgid "The port to bind the server to."
42504 #: doc/guix.texi:19562
42509 #. type: subsubheading
42510 #: doc/guix.texi:19563
42512 msgid "System Control Service"
42515 #. type: Plain text
42516 #: doc/guix.texi:19567
42518 "The @code{(gnu services sysctl)} provides a service to configure kernel "
42519 "parameters at boot."
42523 #: doc/guix.texi:19568
42525 msgid "{Scheme Variable} sysctl-service-type"
42529 #: doc/guix.texi:19572
42531 "The service type for @command{sysctl}, which modifies kernel parameters "
42532 "under @file{/proc/sys/}. To enable IPv4 forwarding, it can be instantiated "
42537 #: doc/guix.texi:19577
42540 "(service sysctl-service-type\n"
42541 " (sysctl-configuration\n"
42542 " (settings '((\"net.ipv4.ip_forward\" . \"1\")))))\n"
42546 #: doc/guix.texi:19580
42548 msgid "{Data Type} sysctl-configuration"
42552 #: doc/guix.texi:19582
42553 msgid "The data type representing the configuration of @command{sysctl}."
42557 #: doc/guix.texi:19584
42559 msgid "@code{sysctl} (default: @code{(file-append procps \"/sbin/sysctl\"})"
42563 #: doc/guix.texi:19586
42564 msgid "The @command{sysctl} executable to use."
42568 #: doc/guix.texi:19587
42570 msgid "@code{settings} (default: @code{'()})"
42574 #: doc/guix.texi:19589
42575 msgid "An association list specifies kernel parameters and their values."
42579 #: doc/guix.texi:19592
42584 #. type: subsubheading
42585 #: doc/guix.texi:19593
42587 msgid "Lirc Service"
42590 #. type: Plain text
42591 #: doc/guix.texi:19596
42592 msgid "The @code{(gnu services lirc)} module provides the following service."
42596 #: doc/guix.texi:19597
42598 msgid "{Scheme Procedure} lirc-service [#:lirc lirc] @"
42602 #: doc/guix.texi:19602
42604 "[#:device #f] [#:driver #f] [#:config-file #f] @ [#:extra-options '()] "
42605 "Return a service that runs @url{http://www.lirc.org,LIRC}, a daemon that "
42606 "decodes infrared signals from remote controls."
42610 #: doc/guix.texi:19606
42612 "Optionally, @var{device}, @var{driver} and @var{config-file} (configuration "
42613 "file name) may be specified. See @command{lircd} manual for details."
42617 #: doc/guix.texi:19609
42619 "Finally, @var{extra-options} is a list of additional command-line options "
42620 "passed to @command{lircd}."
42624 #: doc/guix.texi:19611
42629 #. type: subsubheading
42630 #: doc/guix.texi:19612
42632 msgid "Spice Service"
42635 #. type: Plain text
42636 #: doc/guix.texi:19615
42637 msgid "The @code{(gnu services spice)} module provides the following service."
42641 #: doc/guix.texi:19616
42643 msgid "{Scheme Procedure} spice-vdagent-service [#:spice-vdagent]"
42647 #: doc/guix.texi:19620
42649 "Returns a service that runs @url{http://www.spice-space.org,VDAGENT}, a "
42650 "daemon that enables sharing the clipboard with a vm and setting the guest "
42651 "display resolution when the graphical console window resizes."
42654 #. type: subsubsection
42655 #: doc/guix.texi:19622
42657 msgid "Dictionary Services"
42661 #: doc/guix.texi:19623
42666 #. type: Plain text
42667 #: doc/guix.texi:19625
42668 msgid "The @code{(gnu services dict)} module provides the following service:"
42672 #: doc/guix.texi:19626
42674 msgid "{Scheme Procedure} dicod-service [#:config (dicod-configuration)]"
42678 #: doc/guix.texi:19629
42680 "Return a service that runs the @command{dicod} daemon, an implementation of "
42681 "DICT server (@pxref{Dicod,,, dico, GNU Dico Manual})."
42685 #: doc/guix.texi:19633
42687 "The optional @var{config} argument specifies the configuration for "
42688 "@command{dicod}, which should be a @code{<dicod-configuration>} object, by "
42689 "default it serves the GNU Collaborative International Dictonary of English."
42693 #: doc/guix.texi:19637
42695 "You can add @command{open localhost} to your @file{~/.dico} file to make "
42696 "@code{localhost} the default server for @command{dico} client "
42697 "(@pxref{Initialization File,,, dico, GNU Dico Manual})."
42701 #: doc/guix.texi:19639
42703 msgid "{Data Type} dicod-configuration"
42707 #: doc/guix.texi:19641
42708 msgid "Data type representing the configuration of dicod."
42712 #: doc/guix.texi:19643
42714 msgid "@code{dico} (default: @var{dico})"
42718 #: doc/guix.texi:19645
42719 msgid "Package object of the GNU Dico dictionary server."
42723 #: doc/guix.texi:19646
42725 msgid "@code{interfaces} (default: @var{'(\"localhost\")})"
42729 #: doc/guix.texi:19650
42731 "This is the list of IP addresses and ports and possibly socket file names to "
42732 "listen to (@pxref{Server Settings, @code{listen} directive,, dico, GNU Dico "
42737 #: doc/guix.texi:19651
42739 msgid "@code{handlers} (default: @var{'()})"
42743 #: doc/guix.texi:19653
42745 "List of @code{<dicod-handler>} objects denoting handlers (module instances)."
42749 #: doc/guix.texi:19654
42751 msgid "@code{databases} (default: @var{(list %dicod-database:gcide)})"
42755 #: doc/guix.texi:19656
42757 "List of @code{<dicod-database>} objects denoting dictionaries to be served."
42761 #: doc/guix.texi:19659
42763 msgid "{Data Type} dicod-handler"
42767 #: doc/guix.texi:19661
42768 msgid "Data type representing a dictionary handler (module instance)."
42772 #: doc/guix.texi:19665
42773 msgid "Name of the handler (module instance)."
42777 #: doc/guix.texi:19666
42779 msgid "@code{module} (default: @var{#f})"
42783 #: doc/guix.texi:19670
42785 "Name of the dicod module of the handler (instance). If it is @code{#f}, the "
42786 "module has the same name as the handler. (@pxref{Modules,,, dico, GNU Dico "
42791 #: doc/guix.texi:19671 doc/guix.texi:19691
42797 #: doc/guix.texi:19673
42799 "List of strings or gexps representing the arguments for the module handler"
42803 #: doc/guix.texi:19676
42805 msgid "{Data Type} dicod-database"
42809 #: doc/guix.texi:19678
42810 msgid "Data type representing a dictionary database."
42814 #: doc/guix.texi:19682
42815 msgid "Name of the database, will be used in DICT commands."
42819 #: doc/guix.texi:19683
42825 #: doc/guix.texi:19686
42827 "Name of the dicod handler (module instance) used by this database "
42828 "(@pxref{Handlers,,, dico, GNU Dico Manual})."
42832 #: doc/guix.texi:19687
42834 msgid "@code{complex?} (default: @var{#f})"
42838 #: doc/guix.texi:19690
42840 "Whether the database configuration complex. The complex configuration will "
42841 "need a corresponding @code{<dicod-handler>} object, otherwise not."
42845 #: doc/guix.texi:19694
42847 "List of strings or gexps representing the arguments for the database "
42848 "(@pxref{Databases,,, dico, GNU Dico Manual})."
42852 #: doc/guix.texi:19697
42854 msgid "{Scheme Variable} %dicod-database:gcide"
42858 #: doc/guix.texi:19700
42860 "A @code{<dicod-database>} object serving the GNU Collaborative International "
42861 "Dictionary of English using the @code{gcide} package."
42864 #. type: Plain text
42865 #: doc/guix.texi:19703
42866 msgid "The following is an example @code{dicod-service} configuration."
42870 #: doc/guix.texi:19718
42873 "(dicod-service #:config\n"
42874 " (dicod-configuration\n"
42875 " (handlers (list (dicod-handler\n"
42876 " (name \"wordnet\")\n"
42877 " (module \"dictorg\")\n"
42879 " (list #~(string-append \"dbdir=\" #$wordnet))))))\n"
42880 " (databases (list (dicod-database\n"
42881 " (name \"wordnet\")\n"
42883 " (handler \"wordnet\")\n"
42884 " (options '(\"database=wn\")))\n"
42885 " %dicod-database:gcide))))\n"
42889 #: doc/guix.texi:19723
42891 msgid "setuid programs"
42894 #. type: Plain text
42895 #: doc/guix.texi:19733
42897 "Some programs need to run with ``root'' privileges, even when they are "
42898 "launched by unprivileged users. A notorious example is the @command{passwd} "
42899 "program, which users can run to change their password, and which needs to "
42900 "access the @file{/etc/passwd} and @file{/etc/shadow} files---something "
42901 "normally restricted to root, for obvious security reasons. To address that, "
42902 "these executables are @dfn{setuid-root}, meaning that they always run with "
42903 "root privileges (@pxref{How Change Persona,,, libc, The GNU C Library "
42904 "Reference Manual}, for more info about the setuid mechanism.)"
42907 #. type: Plain text
42908 #: doc/guix.texi:19740
42910 "The store itself @emph{cannot} contain setuid programs: that would be a "
42911 "security issue since any user on the system can write derivations that "
42912 "populate the store (@pxref{The Store}). Thus, a different mechanism is "
42913 "used: instead of changing the setuid bit directly on files that are in the "
42914 "store, we let the system administrator @emph{declare} which programs should "
42918 #. type: Plain text
42919 #: doc/guix.texi:19746
42921 "The @code{setuid-programs} field of an @code{operating-system} declaration "
42922 "contains a list of G-expressions denoting the names of programs to be setuid-"
42923 "root (@pxref{Using the Configuration System}). For instance, the "
42924 "@command{passwd} program, which is part of the Shadow package, can be "
42925 "designated by this G-expression (@pxref{G-Expressions}):"
42929 #: doc/guix.texi:19749
42931 msgid "#~(string-append #$shadow \"/bin/passwd\")\n"
42934 #. type: Plain text
42935 #: doc/guix.texi:19753
42937 "A default set of setuid programs is defined by the @code{%setuid-programs} "
42938 "variable of the @code{(gnu system)} module."
42942 #: doc/guix.texi:19754
42944 msgid "{Scheme Variable} %setuid-programs"
42948 #: doc/guix.texi:19756
42949 msgid "A list of G-expressions denoting common programs that are setuid-root."
42953 #: doc/guix.texi:19759
42955 "The list includes commands such as @command{passwd}, @command{ping}, "
42956 "@command{su}, and @command{sudo}."
42959 #. type: Plain text
42960 #: doc/guix.texi:19765
42962 "Under the hood, the actual setuid programs are created in the @file{/run/"
42963 "setuid-programs} directory at system activation time. The files in this "
42964 "directory refer to the ``real'' binaries, which are in the store."
42968 #: doc/guix.texi:19769
42970 msgid "HTTPS, certificates"
42974 #: doc/guix.texi:19770
42976 msgid "X.509 certificates"
42980 #: doc/guix.texi:19771
42985 #. type: Plain text
42986 #: doc/guix.texi:19778
42988 "Web servers available over HTTPS (that is, HTTP over the transport-layer "
42989 "security mechanism, TLS) send client programs an @dfn{X.509 certificate} "
42990 "that the client can then use to @emph{authenticate} the server. To do that, "
42991 "clients verify that the server's certificate is signed by a so-called "
42992 "@dfn{certificate authority} (CA). But to verify the CA's signature, clients "
42993 "must have first acquired the CA's certificate."
42996 #. type: Plain text
42997 #: doc/guix.texi:19782
42999 "Web browsers such as GNU@tie{}IceCat include their own set of CA "
43000 "certificates, such that they are able to verify CA signatures out-of-the-box."
43003 #. type: Plain text
43004 #: doc/guix.texi:19786
43006 "However, most other programs that can talk HTTPS---@command{wget}, "
43007 "@command{git}, @command{w3m}, etc.---need to be told where CA certificates "
43011 #. type: Plain text
43012 #: doc/guix.texi:19793
43014 "In GuixSD, this is done by adding a package that provides certificates to "
43015 "the @code{packages} field of the @code{operating-system} declaration "
43016 "(@pxref{operating-system Reference}). GuixSD includes one such package, "
43017 "@code{nss-certs}, which is a set of CA certificates provided as part of "
43018 "Mozilla's Network Security Services."
43021 #. type: Plain text
43022 #: doc/guix.texi:19798
43024 "Note that it is @emph{not} part of @var{%base-packages}, so you need to "
43025 "explicitly add it. The @file{/etc/ssl/certs} directory, which is where most "
43026 "applications and libraries look for certificates by default, points to the "
43027 "certificates installed globally."
43030 #. type: Plain text
43031 #: doc/guix.texi:19808
43033 "Unprivileged users, including users of Guix on a foreign distro, can also "
43034 "install their own certificate package in their profile. A number of "
43035 "environment variables need to be defined so that applications and libraries "
43036 "know where to find them. Namely, the OpenSSL library honors the "
43037 "@code{SSL_CERT_DIR} and @code{SSL_CERT_FILE} variables. Some applications "
43038 "add their own environment variables; for instance, the Git version control "
43039 "system honors the certificate bundle pointed to by the @code{GIT_SSL_CAINFO} "
43040 "environment variable. Thus, you would typically run something like:"
43044 #: doc/guix.texi:19814
43047 "$ guix package -i nss-certs\n"
43048 "$ export SSL_CERT_DIR=\"$HOME/.guix-profile/etc/ssl/certs\"\n"
43049 "$ export SSL_CERT_FILE=\"$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt\"\n"
43050 "$ export GIT_SSL_CAINFO=\"$SSL_CERT_FILE\"\n"
43053 #. type: Plain text
43054 #: doc/guix.texi:19819
43056 "As another example, R requires the @code{CURL_CA_BUNDLE} environment "
43057 "variable to point to a certificate bundle, so you would have to run "
43058 "something like this:"
43062 #: doc/guix.texi:19823
43065 "$ guix package -i nss-certs\n"
43066 "$ export CURL_CA_BUNDLE=\"$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt\"\n"
43069 #. type: Plain text
43070 #: doc/guix.texi:19827
43072 "For other applications you may want to look up the required environment "
43073 "variable in the relevant documentation."
43077 #: doc/guix.texi:19832
43079 msgid "name service switch"
43083 #: doc/guix.texi:19833
43088 #. type: Plain text
43089 #: doc/guix.texi:19842
43091 "The @code{(gnu system nss)} module provides bindings to the configuration "
43092 "file of the libc @dfn{name service switch} or @dfn{NSS} (@pxref{NSS "
43093 "Configuration File,,, libc, The GNU C Library Reference Manual}). In a "
43094 "nutshell, the NSS is a mechanism that allows libc to be extended with new "
43095 "``name'' lookup methods for system databases, which includes host names, "
43096 "service names, user accounts, and more (@pxref{Name Service Switch, System "
43097 "Databases and Name Service Switch,, libc, The GNU C Library Reference "
43101 #. type: Plain text
43102 #: doc/guix.texi:19849
43104 "The NSS configuration specifies, for each system database, which lookup "
43105 "method is to be used, and how the various methods are chained together---for "
43106 "instance, under which circumstances NSS should try the next method in the "
43107 "list. The NSS configuration is given in the @code{name-service-switch} "
43108 "field of @code{operating-system} declarations (@pxref{operating-system "
43109 "Reference, @code{name-service-switch}})."
43113 #: doc/guix.texi:19850
43119 #: doc/guix.texi:19851
43121 msgid ".local, host name lookup"
43124 #. type: Plain text
43125 #: doc/guix.texi:19856
43127 "As an example, the declaration below configures the NSS to use the "
43128 "@uref{http://0pointer.de/lennart/projects/nss-mdns/, @code{nss-mdns} back-"
43129 "end}, which supports host name lookups over multicast DNS (mDNS) for host "
43130 "names ending in @code{.local}:"
43134 #: doc/guix.texi:19860
43137 "(name-service-switch\n"
43138 " (hosts (list %files ;first, check /etc/hosts\n"
43143 #: doc/guix.texi:19865
43146 " ;; If the above did not succeed, try\n"
43147 " ;; with 'mdns_minimal'.\n"
43149 " (name \"mdns_minimal\")\n"
43154 #: doc/guix.texi:19871
43157 " ;; 'mdns_minimal' is authoritative for\n"
43158 " ;; '.local'. When it returns \"not found\",\n"
43159 " ;; no need to try the next methods.\n"
43160 " (reaction (lookup-specification\n"
43161 " (not-found => return))))\n"
43166 #: doc/guix.texi:19875
43169 " ;; Then fall back to DNS.\n"
43171 " (name \"dns\"))\n"
43176 #: doc/guix.texi:19879
43179 " ;; Finally, try with the \"full\" 'mdns'.\n"
43181 " (name \"mdns\")))))\n"
43184 #. type: Plain text
43185 #: doc/guix.texi:19884
43187 "Do not worry: the @code{%mdns-host-lookup-nss} variable (see below) "
43188 "contains this configuration, so you will not have to type it if all you want "
43189 "is to have @code{.local} host lookup working."
43192 #. type: Plain text
43193 #: doc/guix.texi:19892
43195 "Note that, in this case, in addition to setting the @code{name-service-"
43196 "switch} of the @code{operating-system} declaration, you also need to use "
43197 "@code{avahi-service} (@pxref{Networking Services, @code{avahi-service}}), or "
43198 "@var{%desktop-services}, which includes it (@pxref{Desktop Services}). "
43199 "Doing this makes @code{nss-mdns} accessible to the name service cache daemon "
43200 "(@pxref{Base Services, @code{nscd-service}})."
43203 #. type: Plain text
43204 #: doc/guix.texi:19895
43206 "For convenience, the following variables provide typical NSS configurations."
43210 #: doc/guix.texi:19896
43212 msgid "{Scheme Variable} %default-nss"
43216 #: doc/guix.texi:19899
43218 "This is the default name service switch configuration, a @code{name-service-"
43223 #: doc/guix.texi:19901
43225 msgid "{Scheme Variable} %mdns-host-lookup-nss"
43229 #: doc/guix.texi:19904
43231 "This is the name service switch configuration with support for host name "
43232 "lookup over multicast DNS (mDNS) for host names ending in @code{.local}."
43235 #. type: Plain text
43236 #: doc/guix.texi:19914
43238 "The reference for name service switch configuration is given below. It is a "
43239 "direct mapping of the configuration file format of the C library , so please "
43240 "refer to the C library manual for more information (@pxref{NSS Configuration "
43241 "File,,, libc, The GNU C Library Reference Manual}). Compared to the "
43242 "configuration file format of libc NSS, it has the advantage not only of "
43243 "adding this warm parenthetic feel that we like, but also static checks: you "
43244 "will know about syntax errors and typos as soon as you run @command{guix "
43249 #: doc/guix.texi:19915
43251 msgid "{Data Type} name-service-switch"
43255 #: doc/guix.texi:19920
43257 "This is the data type representation the configuration of libc's name "
43258 "service switch (NSS). Each field below represents one of the supported "
43259 "system databases."
43263 #: doc/guix.texi:19922
43269 #: doc/guix.texi:19923
43275 #: doc/guix.texi:19925
43281 #: doc/guix.texi:19926
43287 #: doc/guix.texi:19927
43293 #: doc/guix.texi:19928
43299 #: doc/guix.texi:19929
43305 #: doc/guix.texi:19931
43311 #: doc/guix.texi:19932
43317 #: doc/guix.texi:19934
43323 #: doc/guix.texi:19937
43325 "The system databases handled by the NSS. Each of these fields must be a "
43326 "list of @code{<name-service>} objects (see below)."
43330 #: doc/guix.texi:19940
43332 msgid "{Data Type} name-service"
43336 #: doc/guix.texi:19944
43338 "This is the data type representing an actual name service and the associated "
43343 #: doc/guix.texi:19949
43345 "A string denoting the name service (@pxref{Services in the NSS "
43346 "configuration,,, libc, The GNU C Library Reference Manual})."
43350 #: doc/guix.texi:19954
43352 "Note that name services listed here must be visible to nscd. This is "
43353 "achieved by passing the @code{#:name-services} argument to @code{nscd-"
43354 "service} the list of packages providing the needed name services "
43355 "(@pxref{Base Services, @code{nscd-service}})."
43359 #: doc/guix.texi:19955
43365 #: doc/guix.texi:19959
43367 "An action specified using the @code{lookup-specification} macro "
43368 "(@pxref{Actions in the NSS configuration,,, libc, The GNU C Library "
43369 "Reference Manual}). For example:"
43373 #: doc/guix.texi:19963
43376 "(lookup-specification (unavailable => continue)\n"
43377 " (success => return))\n"
43380 #. type: Plain text
43381 #: doc/guix.texi:19977
43383 "For bootstrapping purposes, the Linux-Libre kernel is passed an @dfn{initial "
43384 "RAM disk}, or @dfn{initrd}. An initrd contains a temporary root file system "
43385 "as well as an initialization script. The latter is responsible for mounting "
43386 "the real root file system, and for loading any kernel modules that may be "
43387 "needed to achieve that."
43390 #. type: Plain text
43391 #: doc/guix.texi:19986
43393 "The @code{initrd-modules} field of an @code{operating-system} declaration "
43394 "allows you to specify Linux-libre kernel modules that must be available in "
43395 "the initrd. In particular, this is where you would list modules needed to "
43396 "actually drive the hard disk where your root partition is---although the "
43397 "default value of @code{initrd-modules} should cover most use cases. For "
43398 "example, assuming you need the @code{megaraid_sas} module in addition to the "
43399 "default modules to be able to access your root file system, you would write:"
43403 #: doc/guix.texi:19991
43406 "(operating-system\n"
43408 " (initrd-modules (cons \"megaraid_sas\" %base-initrd-modules)))\n"
43412 #: doc/guix.texi:19993
43414 msgid "{Scheme Variable} %base-initrd-modules"
43418 #: doc/guix.texi:19995
43419 msgid "This is the list of kernel modules included in the initrd by default."
43422 #. type: Plain text
43423 #: doc/guix.texi:20003
43425 "Furthermore, if you need lower-level customization, the @code{initrd} field "
43426 "of an @code{operating-system} declaration allows you to specify which initrd "
43427 "you would like to use. The @code{(gnu system linux-initrd)} module provides "
43428 "three ways to build an initrd: the high-level @code{base-initrd} procedure "
43429 "and the low-level @code{raw-initrd} and @code{expression->initrd} procedures."
43432 #. type: Plain text
43433 #: doc/guix.texi:20008
43435 "The @code{base-initrd} procedure is intended to cover most common uses. For "
43436 "example, if you want to add a bunch of kernel modules to be loaded at boot "
43437 "time, you can define the @code{initrd} field of the operating system "
43438 "declaration like this:"
43442 #: doc/guix.texi:20016
43445 "(initrd (lambda (file-systems . rest)\n"
43446 " ;; Create a standard initrd but set up networking\n"
43447 " ;; with the parameters QEMU expects by default.\n"
43448 " (apply base-initrd file-systems\n"
43449 " #:qemu-networking? #t\n"
43453 #. type: Plain text
43454 #: doc/guix.texi:20021
43456 "The @code{base-initrd} procedure also handles common use cases that involves "
43457 "using the system as a QEMU guest, or as a ``live'' system with volatile root "
43461 #. type: Plain text
43462 #: doc/guix.texi:20028
43464 "The @code{base-initrd} procedure is built from @code{raw-initrd} procedure. "
43465 "Unlike @code{base-initrd}, @code{raw-initrd} doesn't do anything high-level, "
43466 "such as trying to guess which kernel modules and packages should be included "
43467 "to the initrd. An example use of @code{raw-initrd} is when a user has a "
43468 "custom Linux kernel configuration and default kernel modules included by "
43469 "@code{base-initrd} are not available."
43472 #. type: Plain text
43473 #: doc/guix.texi:20033
43475 "The initial RAM disk produced by @code{base-initrd} or @code{raw-initrd} "
43476 "honors several options passed on the Linux kernel command line (that is, "
43477 "arguments passed @i{via} the @code{linux} command of GRUB, or the @code{-"
43478 "append} option of QEMU), notably:"
43482 #: doc/guix.texi:20035
43484 msgid "--load=@var{boot}"
43488 #: doc/guix.texi:20038
43490 "Tell the initial RAM disk to load @var{boot}, a file containing a Scheme "
43491 "program, once it has mounted the root file system."
43495 #: doc/guix.texi:20042
43497 "GuixSD uses this option to yield control to a boot program that runs the "
43498 "service activation programs and then spawns the GNU@tie{}Shepherd, the "
43499 "initialization system."
43503 #: doc/guix.texi:20043
43505 msgid "--root=@var{root}"
43509 #: doc/guix.texi:20047
43511 "Mount @var{root} as the root file system. @var{root} can be a device name "
43512 "like @code{/dev/sda1}, a file system label, or a file system UUID."
43516 #: doc/guix.texi:20051
43518 "Have @file{/run/booted-system} and @file{/run/current-system} point to "
43523 #: doc/guix.texi:20052
43525 msgid "modprobe.blacklist=@var{modules}@dots{}"
43529 #: doc/guix.texi:20053
43531 msgid "module, black-listing"
43535 #: doc/guix.texi:20054
43537 msgid "black list, of kernel modules"
43541 #: doc/guix.texi:20059
43543 "Instruct the initial RAM disk as well as the @command{modprobe} command "
43544 "(from the kmod package) to refuse to load @var{modules}. @var{modules} must "
43545 "be a comma-separated list of module names---e.g., @code{usbkbd,9pnet}."
43549 #: doc/guix.texi:20060
43555 #: doc/guix.texi:20066
43557 "Start a read-eval-print loop (REPL) from the initial RAM disk before it "
43558 "tries to load kernel modules and to mount the root file system. Our "
43559 "marketing team calls it @dfn{boot-to-Guile}. The Schemer in you will love "
43560 "it. @xref{Using Guile Interactively,,, guile, GNU Guile Reference Manual}, "
43561 "for more information on Guile's REPL."
43564 #. type: Plain text
43565 #: doc/guix.texi:20072
43567 "Now that you know all the features that initial RAM disks produced by "
43568 "@code{base-initrd} and @code{raw-initrd} provide, here is how to use it and "
43569 "customize it further."
43573 #: doc/guix.texi:20075
43575 msgid "{Monadic Procedure} raw-initrd @var{file-systems} @"
43579 #: doc/guix.texi:20087
43581 "[#:linux-modules '()] [#:mapped-devices '()] @ [#:helper-packages '()] [#:"
43582 "qemu-networking? #f] [#:volatile-root? #f] Return a monadic derivation that "
43583 "builds a raw initrd. @var{file-systems} is a list of file systems to be "
43584 "mounted by the initrd, possibly in addition to the root file system "
43585 "specified on the kernel command line via @code{--root}. @var{linux-modules} "
43586 "is a list of kernel modules to be loaded at boot time. @var{mapped-devices} "
43587 "is a list of device mappings to realize before @var{file-systems} are "
43588 "mounted (@pxref{Mapped Devices}). @var{helper-packages} is a list of "
43589 "packages to be copied in the initrd. It may include @code{e2fsck/static} or "
43590 "other packages needed by the initrd to check the root file system."
43594 #: doc/guix.texi:20091
43596 "When @var{qemu-networking?} is true, set up networking with the standard "
43597 "QEMU parameters. When @var{virtio?} is true, load additional modules so "
43598 "that the initrd can be used as a QEMU guest with para-virtualized I/O "
43603 #: doc/guix.texi:20094
43605 "When @var{volatile-root?} is true, the root file system is writable but any "
43606 "changes to it are lost."
43610 #: doc/guix.texi:20096
43612 msgid "{Monadic Procedure} base-initrd @var{file-systems} @"
43616 #: doc/guix.texi:20104
43618 "[#:mapped-devices '()] [#:qemu-networking? #f] [#:volatile-root? #f]@ [#:"
43619 "linux-modules '()] Return a monadic derivation that builds a generic initrd, "
43620 "with kernel modules taken from @var{linux}. @var{file-systems} is a list of "
43621 "file-systems to be mounted by the initrd, possibly in addition to the root "
43622 "file system specified on the kernel command line via @code{--root}. "
43623 "@var{mapped-devices} is a list of device mappings to realize before "
43624 "@var{file-systems} are mounted."
43628 #: doc/guix.texi:20106
43630 "@var{qemu-networking?} and @var{volatile-root?} behaves as in @code{raw-"
43635 #: doc/guix.texi:20111
43637 "The initrd is automatically populated with all the kernel modules necessary "
43638 "for @var{file-systems} and for the given options. Additional kernel modules "
43639 "can be listed in @var{linux-modules}. They will be added to the initrd, and "
43640 "loaded at boot time in the order in which they appear."
43643 #. type: Plain text
43644 #: doc/guix.texi:20118
43646 "Needless to say, the initrds we produce and use embed a statically-linked "
43647 "Guile, and the initialization program is a Guile program. That gives a lot "
43648 "of flexibility. The @code{expression->initrd} procedure builds such an "
43649 "initrd, given the program to run in that initrd."
43653 #: doc/guix.texi:20119
43655 msgid "{Monadic Procedure} expression->initrd @var{exp} @"
43659 #: doc/guix.texi:20125
43661 "[#:guile %guile-static-stripped] [#:name \"guile-initrd\"] Return a "
43662 "derivation that builds a Linux initrd (a gzipped cpio archive) containing "
43663 "@var{guile} and that evaluates @var{exp}, a G-expression, upon booting. All "
43664 "the derivations referenced by @var{exp} are automatically copied to the "
43669 #: doc/guix.texi:20131
43671 msgid "boot loader"
43674 #. type: Plain text
43675 #: doc/guix.texi:20138
43677 "The operating system supports multiple bootloaders. The bootloader is "
43678 "configured using @code{bootloader-configuration} declaration. All the "
43679 "fields of this structure are bootloader agnostic except for one field, "
43680 "@code{bootloader} that indicates the bootloader to be configured and "
43684 #. type: Plain text
43685 #: doc/guix.texi:20143
43687 "Some of the bootloaders do not honor every field of @code{bootloader-"
43688 "configuration}. For instance, the extlinux bootloader does not support "
43689 "themes and thus ignores the @code{theme} field."
43693 #: doc/guix.texi:20144
43695 msgid "{Data Type} bootloader-configuration"
43699 #: doc/guix.texi:20146
43700 msgid "The type of a bootloader configuration declaration."
43704 #: doc/guix.texi:20150
43706 msgid "EFI, bootloader"
43710 #: doc/guix.texi:20151
43712 msgid "UEFI, bootloader"
43716 #: doc/guix.texi:20152
43718 msgid "BIOS, bootloader"
43722 #: doc/guix.texi:20158
43724 "The bootloader to use, as a @code{bootloader} object. For now @code{grub-"
43725 "bootloader}, @code{grub-efi-bootloader}, @code{extlinux-bootloader} and "
43726 "@code{u-boot-bootloader} are supported. @code{grub-efi-bootloader} allows "
43727 "to boot on modern systems using the @dfn{Unified Extensible Firmware "
43728 "Interface} (UEFI)."
43732 #: doc/guix.texi:20161
43734 "Available bootloaders are described in @code{(gnu bootloader @dots{})} "
43739 #: doc/guix.texi:20171
43741 "This is a string denoting the target onto which to install the bootloader. "
43742 "The exact interpretation depends on the bootloader in question; for "
43743 "@code{grub-bootloader}, for example, it should be a device name understood "
43744 "by the bootloader @command{installer} command, such as @code{/dev/sda} or "
43745 "@code{(hd0)} (for GRUB, @pxref{Invoking grub-install,,, grub, GNU GRUB "
43746 "Manual}). For @code{grub-efi-bootloader}, it should be the path to a "
43747 "mounted EFI file system."
43751 #: doc/guix.texi:20172
43753 msgid "@code{menu-entries} (default: @code{()})"
43757 #: doc/guix.texi:20176
43759 "A possibly empty list of @code{menu-entry} objects (see below), denoting "
43760 "entries to appear in the bootloader menu, in addition to the current system "
43761 "entry and the entry pointing to previous system generations."
43765 #: doc/guix.texi:20177
43767 msgid "@code{default-entry} (default: @code{0})"
43771 #: doc/guix.texi:20180
43773 "The index of the default boot menu entry. Index 0 is for the entry of the "
43778 #: doc/guix.texi:20181
43780 msgid "@code{timeout} (default: @code{5})"
43784 #: doc/guix.texi:20184
43786 "The number of seconds to wait for keyboard input before booting. Set to 0 "
43787 "to boot immediately, and to -1 to wait indefinitely."
43791 #: doc/guix.texi:20185
43793 msgid "@code{theme} (default: @var{#f})"
43797 #: doc/guix.texi:20189
43799 "The bootloader theme object describing the theme to use. If no theme is "
43800 "provided, some bootloaders might use a default theme, that's true for GRUB."
43804 #: doc/guix.texi:20190
43806 msgid "@code{terminal-outputs} (default: @code{'gfxterm})"
43810 #: doc/guix.texi:20197
43812 "The output terminals used for the bootloader boot menu, as a list of "
43813 "symbols. GRUB accepts the values: @code{console}, @code{serial}, "
43814 "@code{serial_@{0-3@}}, @code{gfxterm}, @code{vga_text}, @code{mda_text}, "
43815 "@code{morse}, and @code{pkmodem}. This field corresponds to the GRUB "
43816 "variable GRUB_TERMINAL_OUTPUT (@pxref{Simple configuration,,, grub,GNU GRUB "
43821 #: doc/guix.texi:20198
43823 msgid "@code{terminal-inputs} (default: @code{'()})"
43827 #: doc/guix.texi:20206
43829 "The input terminals used for the bootloader boot menu, as a list of "
43830 "symbols. For GRUB, the default is the native platform terminal as "
43831 "determined at run-time. GRUB accepts the values: @code{console}, "
43832 "@code{serial}, @code{serial_@{0-3@}}, @code{at_keyboard}, and "
43833 "@code{usb_keyboard}. This field corresponds to the GRUB variable "
43834 "GRUB_TERMINAL_INPUT (@pxref{Simple configuration,,, grub,GNU GRUB manual})."
43838 #: doc/guix.texi:20207
43840 msgid "@code{serial-unit} (default: @code{#f})"
43844 #: doc/guix.texi:20211
43846 "The serial unit used by the bootloader, as an integer from 0 to 3. For "
43847 "GRUB, it is chosen at run-time; currently GRUB chooses 0, which corresponds "
43848 "to COM1 (@pxref{Serial terminal,,, grub,GNU GRUB manual})."
43852 #: doc/guix.texi:20212
43854 msgid "@code{serial-speed} (default: @code{#f})"
43858 #: doc/guix.texi:20216
43860 "The speed of the serial interface, as an integer. For GRUB, the default "
43861 "value is chosen at run-time; currently GRUB chooses 9600@tie{}bps "
43862 "(@pxref{Serial terminal,,, grub,GNU GRUB manual})."
43866 #: doc/guix.texi:20220
43872 #: doc/guix.texi:20221
43877 #. type: Plain text
43878 #: doc/guix.texi:20227
43880 "Should you want to list additional boot menu entries @i{via} the @code{menu-"
43881 "entries} field above, you will need to create them with the @code{menu-"
43882 "entry} form. For example, imagine you want to be able to boot another "
43883 "distro (hard to imagine!), you can define a menu entry along these lines:"
43887 #: doc/guix.texi:20234
43891 " (label \"The Other Distro\")\n"
43892 " (linux \"/boot/old/vmlinux-2.6.32\")\n"
43893 " (linux-arguments '(\"root=/dev/sda2\"))\n"
43894 " (initrd \"/boot/old/initrd\"))\n"
43897 #. type: Plain text
43898 #: doc/guix.texi:20237
43899 msgid "Details below."
43903 #: doc/guix.texi:20238
43905 msgid "{Data Type} menu-entry"
43909 #: doc/guix.texi:20240
43910 msgid "The type of an entry in the bootloader menu."
43914 #: doc/guix.texi:20243
43920 #: doc/guix.texi:20245
43921 msgid "The label to show in the menu---e.g., @code{\"GNU\"}."
43925 #: doc/guix.texi:20246
43931 #: doc/guix.texi:20248
43932 msgid "The Linux kernel image to boot, for example:"
43936 #: doc/guix.texi:20251
43938 msgid "(file-append linux-libre \"/bzImage\")\n"
43942 #: doc/guix.texi:20256
43944 "For GRUB, it is also possible to specify a device explicitly in the file "
43945 "path using GRUB's device naming convention (@pxref{Naming convention,,, "
43946 "grub, GNU GRUB manual}), for example:"
43950 #: doc/guix.texi:20259
43952 msgid "\"(hd0,msdos1)/boot/vmlinuz\"\n"
43956 #: doc/guix.texi:20263
43958 "If the device is specified explicitly as above, then the @code{device} field "
43959 "is ignored entirely."
43963 #: doc/guix.texi:20264
43965 msgid "@code{linux-arguments} (default: @code{()})"
43969 #: doc/guix.texi:20267
43971 "The list of extra Linux kernel command-line arguments---e.g., "
43972 "@code{(\"console=ttyS0\")}."
43976 #: doc/guix.texi:20271
43978 "A G-Expression or string denoting the file name of the initial RAM disk to "
43979 "use (@pxref{G-Expressions})."
43983 #: doc/guix.texi:20271
43985 msgid "@code{device} (default: @code{#f})"
43989 #: doc/guix.texi:20274
43991 "The device where the kernel and initrd are to be found---i.e., for GRUB, "
43992 "@dfn{root} for this menu entry (@pxref{root,,, grub, GNU GRUB manual})."
43996 #: doc/guix.texi:20280
43998 "This may be a file system label (a string), a file system UUID (a "
43999 "bytevector, @pxref{File Systems}), or @code{#f}, in which case the "
44000 "bootloader will search the device containing the file specified by the "
44001 "@code{linux} field (@pxref{search,,, grub, GNU GRUB manual}). It must "
44002 "@emph{not} be an OS device name such as @file{/dev/sda1}."
44005 #. type: Plain text
44006 #: doc/guix.texi:20287
44008 "Fow now only GRUB has theme support. GRUB themes are created using the "
44009 "@code{grub-theme} form, which is not documented yet."
44013 #: doc/guix.texi:20292
44015 "This is the default GRUB theme used by the operating system if no "
44016 "@code{theme} field is specified in @code{bootloader-configuration} record."
44020 #: doc/guix.texi:20295
44022 "It comes with a fancy background image displaying the GNU and Guix logos."
44025 #. type: subsection
44026 #: doc/guix.texi:20299
44028 msgid "Invoking @code{guix system}"
44031 #. type: Plain text
44032 #: doc/guix.texi:20304
44034 "Once you have written an operating system declaration as seen in the "
44035 "previous section, it can be @dfn{instantiated} using the @command{guix "
44036 "system} command. The synopsis is:"
44040 #: doc/guix.texi:20307
44042 msgid "guix system @var{options}@dots{} @var{action} @var{file}\n"
44045 #. type: Plain text
44046 #: doc/guix.texi:20313
44048 "@var{file} must be the name of a file containing an @code{operating-system} "
44049 "declaration. @var{action} specifies how the operating system is "
44050 "instantiated. Currently the following values are supported:"
44054 #: doc/guix.texi:20315
44060 #: doc/guix.texi:20318
44062 "Display available service type definitions that match the given regular "
44063 "expressions, sorted by relevance:"
44067 #: doc/guix.texi:20330
44070 "$ guix system search console font\n"
44071 "name: console-fonts\n"
44072 "location: gnu/services/base.scm:729:2\n"
44073 "extends: shepherd-root\n"
44074 "description: Install the given fonts on the specified ttys (fonts are\n"
44075 "+ per virtual console on GNU/Linux). The value of this service is a list\n"
44076 "+ of tty/font pairs like:\n"
44078 "+ '((\"tty1\" . \"LatGrkCyr-8x16\"))\n"
44084 #: doc/guix.texi:20336
44088 "location: gnu/services/base.scm:1048:2\n"
44089 "extends: shepherd-root\n"
44090 "description: Provide console login using the `mingetty' program.\n"
44096 #: doc/guix.texi:20343
44100 "location: gnu/services/base.scm:775:2\n"
44102 "description: Provide a console log-in service as specified by its\n"
44103 "+ configuration value, a `login-configuration' object.\n"
44109 #: doc/guix.texi:20345
44115 #: doc/guix.texi:20350
44117 "As for @command{guix package --search}, the result is written in "
44118 "@code{recutils} format, which makes it easy to filter the output "
44119 "(@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual})."
44123 #: doc/guix.texi:20351
44125 msgid "reconfigure"
44129 #: doc/guix.texi:20356
44131 "Build the operating system described in @var{file}, activate it, and switch "
44132 "to it@footnote{This action (and the related actions @code{switch-generation} "
44133 "and @code{roll-back}) are usable only on systems already running GuixSD.}."
44137 #: doc/guix.texi:20363
44139 "This effects all the configuration specified in @var{file}: user accounts, "
44140 "system services, global package list, setuid programs, etc. The command "
44141 "starts system services specified in @var{file} that are not currently "
44142 "running; if a service is currently running, it does not attempt to upgrade "
44143 "it since this would not be possible without stopping it first."
44147 #: doc/guix.texi:20369
44149 "This command creates a new generation whose number is one greater than the "
44150 "current generation (as reported by @command{guix system list-generations}). "
44151 "If that generation already exists, it will be overwritten. This behavior "
44152 "mirrors that of @command{guix package} (@pxref{Invoking guix package})."
44156 #: doc/guix.texi:20374
44158 "It also adds a bootloader menu entry for the new OS configuration, ---unless "
44159 "@option{--no-bootloader} is passed. For GRUB, it moves entries for older "
44160 "configurations to a submenu, allowing you to choose an older system "
44161 "generation at boot time should you need it."
44165 #: doc/guix.texi:20382
44167 "It is highly recommended to run @command{guix pull} once before you run "
44168 "@command{guix system reconfigure} for the first time (@pxref{Invoking guix "
44169 "pull}). Failing to do that you would see an older version of Guix once "
44170 "@command{reconfigure} has completed."
44174 #: doc/guix.texi:20384
44176 msgid "switch-generation"
44180 #: doc/guix.texi:20393
44182 "Switch to an existing system generation. This action atomically switches "
44183 "the system profile to the specified system generation. It also rearranges "
44184 "the system's existing bootloader menu entries. It makes the menu entry for "
44185 "the specified system generation the default, and it moves the entries for "
44186 "the other generatiors to a submenu, if supported by the bootloader being "
44187 "used. The next time the system boots, it will use the specified system "
44192 #: doc/guix.texi:20397
44194 "The bootloader itself is not being reinstalled when using this command. "
44195 "Thus, the installed bootloader is used with an updated configuration file."
44199 #: doc/guix.texi:20401
44201 "The target generation can be specified explicitly by its generation number. "
44202 "For example, the following invocation would switch to system generation 7:"
44206 #: doc/guix.texi:20404
44208 msgid "guix system switch-generation 7\n"
44212 #: doc/guix.texi:20412
44214 "The target generation can also be specified relative to the current "
44215 "generation with the form @code{+N} or @code{-N}, where @code{+3} means ``3 "
44216 "generations ahead of the current generation,'' and @code{-1} means ``1 "
44217 "generation prior to the current generation.'' When specifying a negative "
44218 "value such as @code{-1}, you must precede it with @code{--} to prevent it "
44219 "from being parsed as an option. For example:"
44223 #: doc/guix.texi:20415
44225 msgid "guix system switch-generation -- -1\n"
44229 #: doc/guix.texi:20423
44231 "Currently, the effect of invoking this action is @emph{only} to switch the "
44232 "system profile to an existing generation and rearrange the bootloader menu "
44233 "entries. To actually start using the target system generation, you must "
44234 "reboot after running this action. In the future, it will be updated to do "
44235 "the same things as @command{reconfigure}, like activating and deactivating "
44240 #: doc/guix.texi:20425
44241 msgid "This action will fail if the specified generation does not exist."
44245 #: doc/guix.texi:20426
44251 #: doc/guix.texi:20432
44253 "Switch to the preceding system generation. The next time the system boots, "
44254 "it will use the preceding system generation. This is the inverse of "
44255 "@command{reconfigure}, and it is exactly the same as invoking "
44256 "@command{switch-generation} with an argument of @code{-1}."
44260 #: doc/guix.texi:20436
44262 "Currently, as with @command{switch-generation}, you must reboot after "
44263 "running this action to actually start using the preceding system generation."
44267 #: doc/guix.texi:20441
44269 "Build the derivation of the operating system, which includes all the "
44270 "configuration files and programs needed to boot and run the system. This "
44271 "action does not actually install anything."
44275 #: doc/guix.texi:20442
44281 #: doc/guix.texi:20446
44283 "Populate the given directory with all the files necessary to run the "
44284 "operating system specified in @var{file}. This is useful for first-time "
44285 "installations of GuixSD. For instance:"
44289 #: doc/guix.texi:20449
44291 msgid "guix system init my-os-config.scm /mnt\n"
44295 #: doc/guix.texi:20456
44297 "copies to @file{/mnt} all the store items required by the configuration "
44298 "specified in @file{my-os-config.scm}. This includes configuration files, "
44299 "packages, and so on. It also creates other essential files needed for the "
44300 "system to operate correctly---e.g., the @file{/etc}, @file{/var}, and @file{/"
44301 "run} directories, and the @file{/bin/sh} file."
44305 #: doc/guix.texi:20460
44307 "This command also installs bootloader on the target specified in @file{my-os-"
44308 "config}, unless the @option{--no-bootloader} option was passed."
44312 #: doc/guix.texi:20461
44318 #: doc/guix.texi:20462 doc/guix.texi:20726
44320 msgid "virtual machine"
44324 #: doc/guix.texi:20463
44329 #. type: anchor{#1}
44330 #: doc/guix.texi:20470
44331 msgid "guix system vm"
44335 #: doc/guix.texi:20470
44337 "Build a virtual machine that contains the operating system declared in "
44338 "@var{file}, and return a script to run that virtual machine (VM). Arguments "
44339 "given to the script are passed to QEMU as in the example below, which "
44340 "enables networking and requests 1@tie{}GiB of RAM for the emulated machine:"
44344 #: doc/guix.texi:20473
44346 msgid "$ /gnu/store/@dots{}-run-vm.sh -m 1024 -net user\n"
44350 #: doc/guix.texi:20476
44351 msgid "The VM shares its store with the host system."
44355 #: doc/guix.texi:20481
44357 "Additional file systems can be shared between the host and the VM using the "
44358 "@code{--share} and @code{--expose} command-line options: the former "
44359 "specifies a directory to be shared with write access, while the latter "
44360 "provides read-only access to the shared directory."
44364 #: doc/guix.texi:20485
44366 "The example below creates a VM in which the user's home directory is "
44367 "accessible read-only, and where the @file{/exchange} directory is a read-"
44368 "write mapping of @file{$HOME/tmp} on the host:"
44372 #: doc/guix.texi:20489
44375 "guix system vm my-config.scm \\\n"
44376 " --expose=$HOME --share=$HOME/tmp=/exchange\n"
44380 #: doc/guix.texi:20494
44382 "On GNU/Linux, the default is to boot directly to the kernel; this has the "
44383 "advantage of requiring only a very tiny root disk image since the store of "
44384 "the host can then be mounted."
44388 #: doc/guix.texi:20500
44390 "The @code{--full-boot} option forces a complete boot sequence, starting with "
44391 "the bootloader. This requires more disk space since a root image containing "
44392 "at least the kernel, initrd, and bootloader data files must be created. The "
44393 "@code{--image-size} option can be used to specify the size of the image."
44397 #: doc/guix.texi:20501
44399 msgid "System images, creation in various formats"
44403 #: doc/guix.texi:20502
44405 msgid "Creating system images in various formats"
44409 #: doc/guix.texi:20503
44415 #: doc/guix.texi:20504
44421 #: doc/guix.texi:20505
44423 msgid "docker-image"
44427 #: doc/guix.texi:20513
44429 "Return a virtual machine, disk image, or Docker image of the operating "
44430 "system declared in @var{file} that stands alone. By default, @command{guix "
44431 "system} estimates the size of the image needed to store the system, but you "
44432 "can use the @option{--image-size} option to specify a value. Docker images "
44433 "are built to contain exactly what they need, so the @option{--image-size} "
44434 "option is ignored in the case of @code{docker-image}."
44438 #: doc/guix.texi:20516
44440 "You can specify the root file system type by using the @option{--file-system-"
44441 "type} option. It defaults to @code{ext4}."
44445 #: doc/guix.texi:20520
44447 "When using @code{vm-image}, the returned image is in qcow2 format, which the "
44448 "QEMU emulator can efficiently use. @xref{Running GuixSD in a VM}, for more "
44449 "information on how to run the image in a virtual machine."
44453 #: doc/guix.texi:20525
44455 "When using @code{disk-image}, a raw disk image is produced; it can be copied "
44456 "as is to a USB stick, for instance. Assuming @code{/dev/sdc} is the device "
44457 "corresponding to a USB stick, one can copy the image to it using the "
44458 "following command:"
44462 #: doc/guix.texi:20528
44464 msgid "# dd if=$(guix system disk-image my-os.scm) of=/dev/sdc\n"
44468 #: doc/guix.texi:20535
44470 "When using @code{docker-image}, a Docker image is produced. Guix builds the "
44471 "image from scratch, not from a pre-existing Docker base image. As a result, "
44472 "it contains @emph{exactly} what you define in the operating system "
44473 "configuration file. You can then load the image and launch a Docker "
44474 "container using commands like the following:"
44478 #: doc/guix.texi:20541
44481 "image_id=\"$(docker load < guixsd-docker-image.tar.gz)\"\n"
44482 "docker run -e GUIX_NEW_SYSTEM=/var/guix/profiles/system \\\\\n"
44483 " --entrypoint /var/guix/profiles/system/profile/bin/guile \\\\\n"
44484 " $image_id /var/guix/profiles/system/boot\n"
44488 #: doc/guix.texi:20551
44490 "This command starts a new Docker container from the specified image. It "
44491 "will boot the GuixSD system in the usual manner, which means it will start "
44492 "any services you have defined in the operating system configuration. "
44493 "Depending on what you run in the Docker container, it may be necessary to "
44494 "give the container additional permissions. For example, if you intend to "
44495 "build software using Guix inside of the Docker container, you may need to "
44496 "pass the @option{--privileged} option to @code{docker run}."
44500 #: doc/guix.texi:20559
44502 "Return a script to run the operating system declared in @var{file} within a "
44503 "container. Containers are a set of lightweight isolation mechanisms "
44504 "provided by the kernel Linux-libre. Containers are substantially less "
44505 "resource-demanding than full virtual machines since the kernel, shared "
44506 "objects, and other resources can be shared with the host system; this also "
44507 "means they provide thinner isolation."
44511 #: doc/guix.texi:20563
44513 "Currently, the script must be run as root in order to support more than a "
44514 "single user and group. The container shares its store with the host system."
44518 #: doc/guix.texi:20567
44520 "As with the @code{vm} action (@pxref{guix system vm}), additional file "
44521 "systems to be shared between the host and container can be specified using "
44522 "the @option{--share} and @option{--expose} options:"
44526 #: doc/guix.texi:20571
44529 "guix system container my-config.scm \\\n"
44530 " --expose=$HOME --share=$HOME/tmp=/exchange\n"
44534 #: doc/guix.texi:20575
44535 msgid "This option requires Linux-libre 3.19 or newer."
44538 #. type: Plain text
44539 #: doc/guix.texi:20582
44541 "@var{options} can contain any of the common build options (@pxref{Common "
44542 "Build Options}). In addition, @var{options} can contain one of the "
44547 #: doc/guix.texi:20591
44549 "Consider the operating-system @var{expr} evaluates to. This is an "
44550 "alternative to specifying a file which evaluates to an operating system. "
44551 "This is used to generate the GuixSD installer @pxref{Building the "
44552 "Installation Image})."
44556 #: doc/guix.texi:20596
44558 "Attempt to build for @var{system} instead of the host system type. This "
44559 "works as per @command{guix build} (@pxref{Invoking guix build})."
44563 #: doc/guix.texi:20597
44565 msgid "--derivation"
44569 #: doc/guix.texi:20601
44571 "Return the derivation file name of the given operating system without "
44572 "building anything."
44576 #: doc/guix.texi:20602
44578 msgid "--file-system-type=@var{type}"
44582 #: doc/guix.texi:20606
44584 "For the @code{disk-image} action, create a file system of the given "
44585 "@var{type} on the image."
44589 #: doc/guix.texi:20608
44590 msgid "When this option is omitted, @command{guix system} uses @code{ext4}."
44594 #: doc/guix.texi:20609
44596 msgid "ISO-9660 format"
44600 #: doc/guix.texi:20610
44602 msgid "CD image format"
44606 #: doc/guix.texi:20611
44608 msgid "DVD image format"
44612 #: doc/guix.texi:20614
44614 "@code{--file-system-type=iso9660} produces an ISO-9660 image, suitable for "
44615 "burning on CDs and DVDs."
44619 #: doc/guix.texi:20615
44621 msgid "--image-size=@var{size}"
44625 #: doc/guix.texi:20620
44627 "For the @code{vm-image} and @code{disk-image} actions, create an image of "
44628 "the given @var{size}. @var{size} may be a number of bytes, or it may "
44629 "include a unit as a suffix (@pxref{Block size, size specifications,, "
44630 "coreutils, GNU Coreutils})."
44634 #: doc/guix.texi:20624
44636 "When this option is omitted, @command{guix system} computes an estimate of "
44637 "the image size as a function of the size of the system declared in "
44642 #: doc/guix.texi:20630
44644 msgid "--skip-checks"
44645 msgstr "--skip-checks"
44648 #: doc/guix.texi:20632
44649 msgid "Skip pre-installation safety checks."
44653 #: doc/guix.texi:20639
44655 "By default, @command{guix system init} and @command{guix system reconfigure} "
44656 "perform safety checks: they make sure the file systems that appear in the "
44657 "@code{operating-system} declaration actually exist (@pxref{File Systems}), "
44658 "and that any Linux kernel modules that may be needed at boot time are listed "
44659 "in @code{initrd-modules} (@pxref{Initial RAM Disk}). Passing this option "
44660 "skips these tests altogether."
44664 #: doc/guix.texi:20640
44666 msgid "--on-error=@var{strategy}"
44670 #: doc/guix.texi:20643
44672 "Apply @var{strategy} when an error occurs when reading @var{file}. "
44673 "@var{strategy} may be one of the following:"
44677 #: doc/guix.texi:20645
44679 msgid "nothing-special"
44683 #: doc/guix.texi:20647
44684 msgid "Report the error concisely and exit. This is the default strategy."
44688 #: doc/guix.texi:20648
44694 #: doc/guix.texi:20650
44695 msgid "Likewise, but also display a backtrace."
44699 #: doc/guix.texi:20651
44705 #: doc/guix.texi:20657
44707 "Report the error and enter Guile's debugger. From there, you can run "
44708 "commands such as @code{,bt} to get a backtrace, @code{,locals} to display "
44709 "local variable values, and more generally inspect the state of the program. "
44710 "@xref{Debug Commands,,, guile, GNU Guile Reference Manual}, for a list of "
44711 "available debugging commands."
44715 #: doc/guix.texi:20667
44717 "All the actions above, except @code{build} and @code{init}, can use KVM "
44718 "support in the Linux-libre kernel. Specifically, if the machine has "
44719 "hardware virtualization support, the corresponding KVM kernel module should "
44720 "be loaded, and the @file{/dev/kvm} device node must exist and be readable "
44721 "and writable by the user and by the build users of the daemon (@pxref{Build "
44722 "Environment Setup})."
44725 #. type: Plain text
44726 #: doc/guix.texi:20673
44728 "Once you have built, configured, re-configured, and re-re-configured your "
44729 "GuixSD installation, you may find it useful to list the operating system "
44730 "generations available on disk---and that you can choose from the bootloader "
44735 #: doc/guix.texi:20676
44737 msgid "list-generations"
44741 #: doc/guix.texi:20681
44743 "List a summary of each generation of the operating system available on disk, "
44744 "in a human-readable way. This is similar to the @option{--list-generations} "
44745 "option of @command{guix package} (@pxref{Invoking guix package})."
44749 #: doc/guix.texi:20686
44751 "Optionally, one can specify a pattern, with the same syntax that is used in "
44752 "@command{guix package --list-generations}, to restrict the list of "
44753 "generations displayed. For instance, the following command displays "
44754 "generations that are up to 10 days old:"
44758 #: doc/guix.texi:20689
44760 msgid "$ guix system list-generations 10d\n"
44763 #. type: Plain text
44764 #: doc/guix.texi:20696
44766 "The @command{guix system} command has even more to offer! The following sub-"
44767 "commands allow you to visualize how your system services relate to each "
44771 #. type: anchor{#1}
44772 #: doc/guix.texi:20698
44773 msgid "system-extension-graph"
44777 #: doc/guix.texi:20700
44779 msgid "extension-graph"
44783 #: doc/guix.texi:20705
44785 "Emit in Dot/Graphviz format to standard output the @dfn{service extension "
44786 "graph} of the operating system defined in @var{file} (@pxref{Service "
44787 "Composition}, for more information on service extensions.)"
44791 #: doc/guix.texi:20707
44792 msgid "The command:"
44796 #: doc/guix.texi:20710
44798 msgid "$ guix system extension-graph @var{file} | dot -Tpdf > services.pdf\n"
44802 #: doc/guix.texi:20713
44803 msgid "produces a PDF file showing the extension relations among services."
44806 #. type: anchor{#1}
44807 #: doc/guix.texi:20715
44808 msgid "system-shepherd-graph"
44812 #: doc/guix.texi:20715
44814 msgid "shepherd-graph"
44818 #: doc/guix.texi:20720
44820 "Emit in Dot/Graphviz format to standard output the @dfn{dependency graph} of "
44821 "shepherd services of the operating system defined in @var{file}. "
44822 "@xref{Shepherd Services}, for more information and for an example graph."
44825 #. type: subsection
44826 #: doc/guix.texi:20724
44828 msgid "Running GuixSD in a Virtual Machine"
44831 #. type: Plain text
44832 #: doc/guix.texi:20734
44834 "To run GuixSD in a virtual machine (VM), one can either use the pre-built "
44835 "GuixSD VM image distributed at @indicateurl{ftp://alpha.gnu.org/guix/guixsd-"
44836 "vm-image-@value{VERSION}.@var{system}.tar.xz} , or build their own virtual "
44837 "machine image using @command{guix system vm-image} (@pxref{Invoking guix "
44838 "system}). The returned image is in qcow2 format, which the @uref{http://"
44839 "qemu.org/, QEMU emulator} can efficiently use."
44843 #: doc/guix.texi:20735
44848 #. type: Plain text
44849 #: doc/guix.texi:20742
44851 "If you built your own image, you must copy it out of the store (@pxref{The "
44852 "Store}) and give yourself permission to write to the copy before you can use "
44853 "it. When invoking QEMU, you must choose a system emulator that is suitable "
44854 "for your hardware platform. Here is a minimal QEMU invocation that will "
44855 "boot the result of @command{guix system vm-image} on x86_64 hardware:"
44859 #: doc/guix.texi:20747
44862 "$ qemu-system-x86_64 \\\n"
44863 " -net user -net nic,model=virtio \\\n"
44864 " -enable-kvm -m 256 /tmp/qemu-image\n"
44867 #. type: Plain text
44868 #: doc/guix.texi:20750
44869 msgid "Here is what each of these options means:"
44873 #: doc/guix.texi:20752
44875 msgid "qemu-system-x86_64"
44879 #: doc/guix.texi:20755
44881 "This specifies the hardware platform to emulate. This should match the host."
44885 #: doc/guix.texi:20756
44891 #: doc/guix.texi:20760
44893 "Enable the unprivileged user-mode network stack. The guest OS can access "
44894 "the host but not vice versa. This is the simplest way to get the guest OS "
44899 #: doc/guix.texi:20761
44901 msgid "-net nic,model=virtio"
44905 #: doc/guix.texi:20766
44907 "You must create a network interface of a given model. If you do not create "
44908 "a NIC, the boot will fail. Assuming your hardware platform is x86_64, you "
44909 "can get a list of available NIC models by running @command{qemu-system-"
44910 "x86_64 -net nic,model=help}."
44914 #: doc/guix.texi:20767
44916 msgid "-enable-kvm"
44920 #: doc/guix.texi:20771
44922 "If your system has hardware virtualization extensions, enabling the virtual "
44923 "machine support (KVM) of the Linux kernel will make things run faster."
44927 #: doc/guix.texi:20772
44933 #: doc/guix.texi:20775
44935 "RAM available to the guest OS, in mebibytes. Defaults to 128@tie{}MiB, "
44936 "which may be insufficient for some operations."
44940 #: doc/guix.texi:20776
44942 msgid "/tmp/qemu-image"
44946 #: doc/guix.texi:20778
44947 msgid "The file name of the qcow2 image."
44950 #. type: Plain text
44951 #: doc/guix.texi:20788
44953 "The default @command{run-vm.sh} script that is returned by an invocation of "
44954 "@command{guix system vm} does not add a @command{-net user} flag by "
44955 "default. To get network access from within the vm add the @code{(dhcp-"
44956 "client-service)} to your system definition and start the VM using "
44957 "@command{`guix system vm config.scm` -net user}. An important caveat of "
44958 "using @command{-net user} for networking is that @command{ping} will not "
44959 "work, because it uses the ICMP protocol. You'll have to use a different "
44960 "command to check for network connectivity, for example @command{guix "
44964 #. type: subsubsection
44965 #: doc/guix.texi:20789
44967 msgid "Connecting Through SSH"
44970 #. type: Plain text
44971 #: doc/guix.texi:20798
44973 "To enable SSH inside a VM you need to add a SSH server like @code{(dropbear-"
44974 "service)} or @code{(lsh-service)} to your VM. The @code{(lsh-service}) "
44975 "doesn't currently boot unsupervised. It requires you to type some "
44976 "characters to initialize the randomness generator. In addition you need to "
44977 "forward the SSH port, 22 by default, to the host. You can do this with"
44981 #: doc/guix.texi:20801
44983 msgid "`guix system vm config.scm` -net user,hostfwd=tcp::10022-:22\n"
44986 #. type: Plain text
44987 #: doc/guix.texi:20804
44988 msgid "To connect to the VM you can run"
44992 #: doc/guix.texi:20807
44994 msgid "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 10022\n"
44997 #. type: Plain text
44998 #: doc/guix.texi:20814
45000 "The @command{-p} tells @command{ssh} the port you want to connect to. "
45001 "@command{-o UserKnownHostsFile=/dev/null} prevents @command{ssh} from "
45002 "complaining every time you modify your @command{config.scm} file and the "
45003 "@command{-o StrictHostKeyChecking=no} prevents you from having to allow a "
45004 "connection to an unknown host every time you connect."
45007 #. type: subsubsection
45008 #: doc/guix.texi:20815
45010 msgid "Using @command{virt-viewer} with Spice"
45013 #. type: Plain text
45014 #: doc/guix.texi:20821
45016 "As an alternative to the default @command{qemu} graphical client you can use "
45017 "the @command{remote-viewer} from the @command{virt-viewer} package. To "
45018 "connect pass the @command{-spice port=5930,disable-ticketing} flag to "
45019 "@command{qemu}. See previous section for further information on how to do "
45023 #. type: Plain text
45024 #: doc/guix.texi:20824
45026 "Spice also allows you to do some nice stuff like share your clipboard with "
45027 "your VM. To enable that you'll also have to pass the following flags to "
45032 #: doc/guix.texi:20830
45035 "-device virtio-serial-pci,id=virtio-serial0,max_ports=16,bus=pci.0,addr=0x5\n"
45036 "-chardev spicevmc,name=vdagent,id=vdagent\n"
45037 "-device virtserialport,nr=1,bus=virtio-serial0.0,chardev=vdagent,\n"
45038 "name=com.redhat.spice.0\n"
45041 #. type: Plain text
45042 #: doc/guix.texi:20833
45044 "You'll also need to add the @pxref{Miscellaneous Services, Spice service}."
45047 #. type: Plain text
45048 #: doc/guix.texi:20840
45050 "The previous sections show the available services and how one can combine "
45051 "them in an @code{operating-system} declaration. But how do we define them "
45052 "in the first place? And what is a service anyway?"
45056 #: doc/guix.texi:20852
45061 #. type: Plain text
45062 #: doc/guix.texi:20865
45064 "Here we define a @dfn{service} as, broadly, something that extends the "
45065 "functionality of the operating system. Often a service is a process---a "
45066 "@dfn{daemon}---started when the system boots: a secure shell server, a Web "
45067 "server, the Guix build daemon, etc. Sometimes a service is a daemon whose "
45068 "execution can be triggered by another daemon---e.g., an FTP server started "
45069 "by @command{inetd} or a D-Bus service activated by @command{dbus-daemon}. "
45070 "Occasionally, a service does not map to a daemon. For instance, the "
45071 "``account'' service collects user accounts and makes sure they exist when "
45072 "the system runs; the ``udev'' service collects device management rules and "
45073 "makes them available to the eudev daemon; the @file{/etc} service populates "
45074 "the @file{/etc} directory of the system."
45078 #: doc/guix.texi:20866
45080 msgid "service extensions"
45083 #. type: Plain text
45084 #: doc/guix.texi:20878
45086 "GuixSD services are connected by @dfn{extensions}. For instance, the secure "
45087 "shell service @emph{extends} the Shepherd---the GuixSD initialization "
45088 "system, running as PID@tie{}1---by giving it the command lines to start and "
45089 "stop the secure shell daemon (@pxref{Networking Services, @code{lsh-"
45090 "service}}); the UPower service extends the D-Bus service by passing it its "
45091 "@file{.service} specification, and extends the udev service by passing it "
45092 "device management rules (@pxref{Desktop Services, @code{upower-service}}); "
45093 "the Guix daemon service extends the Shepherd by passing it the command lines "
45094 "to start and stop the daemon, and extends the account service by passing it "
45095 "a list of required build user accounts (@pxref{Base Services})."
45098 #. type: Plain text
45099 #: doc/guix.texi:20882
45101 "All in all, services and their ``extends'' relations form a directed acyclic "
45102 "graph (DAG). If we represent services as boxes and extensions as arrows, a "
45103 "typical system might provide something like this:"
45106 #. type: Plain text
45107 #: doc/guix.texi:20884
45108 msgid "@image{images/service-graph,,5in,Typical service extension graph.}"
45112 #: doc/guix.texi:20885
45114 msgid "system service"
45117 #. type: Plain text
45118 #: doc/guix.texi:20893
45120 "At the bottom, we see the @dfn{system service}, which produces the directory "
45121 "containing everything to run and boot the system, as returned by the "
45122 "@command{guix system build} command. @xref{Service Reference}, to learn "
45123 "about the other service types shown here. @xref{system-extension-graph, the "
45124 "@command{guix system extension-graph} command}, for information on how to "
45125 "generate this representation for a particular operating system definition."
45129 #: doc/guix.texi:20894
45131 msgid "service types"
45134 #. type: Plain text
45135 #: doc/guix.texi:20900
45137 "Technically, developers can define @dfn{service types} to express these "
45138 "relations. There can be any number of services of a given type on the "
45139 "system---for instance, a system running two instances of the GNU secure "
45140 "shell server (lsh) has two instances of @var{lsh-service-type}, with "
45141 "different parameters."
45144 #. type: Plain text
45145 #: doc/guix.texi:20903
45147 "The following section describes the programming interface for service types "
45151 #. type: Plain text
45152 #: doc/guix.texi:20910
45154 "A @dfn{service type} is a node in the DAG described above. Let us start "
45155 "with a simple example, the service type for the Guix build daemon "
45156 "(@pxref{Invoking guix-daemon}):"
45160 #: doc/guix.texi:20920
45163 "(define guix-service-type\n"
45167 " (list (service-extension shepherd-root-service-type guix-shepherd-service)\n"
45168 " (service-extension account-service-type guix-accounts)\n"
45169 " (service-extension activation-service-type guix-activation)))\n"
45170 " (default-value (guix-configuration))))\n"
45173 #. type: Plain text
45174 #: doc/guix.texi:20924
45175 msgid "It defines three things:"
45179 #: doc/guix.texi:20928
45180 msgid "A name, whose sole purpose is to make inspection and debugging easier."
45184 #: doc/guix.texi:20933
45186 "A list of @dfn{service extensions}, where each extension designates the "
45187 "target service type and a procedure that, given the parameters of the "
45188 "service, returns a list of objects to extend the service of that type."
45192 #: doc/guix.texi:20936
45194 "Every service type has at least one service extension. The only exception "
45195 "is the @dfn{boot service type}, which is the ultimate service."
45199 #: doc/guix.texi:20939
45200 msgid "Optionally, a default value for instances of this type."
45203 #. type: Plain text
45204 #: doc/guix.texi:20942
45205 msgid "In this example, @var{guix-service-type} extends three services:"
45209 #: doc/guix.texi:20944
45211 msgid "shepherd-root-service-type"
45215 #: doc/guix.texi:20949
45217 "The @var{guix-shepherd-service} procedure defines how the Shepherd service "
45218 "is extended. Namely, it returns a @code{<shepherd-service>} object that "
45219 "defines how @command{guix-daemon} is started and stopped (@pxref{Shepherd "
45224 #: doc/guix.texi:20950
45226 msgid "account-service-type"
45230 #: doc/guix.texi:20955
45232 "This extension for this service is computed by @var{guix-accounts}, which "
45233 "returns a list of @code{user-group} and @code{user-account} objects "
45234 "representing the build user accounts (@pxref{Invoking guix-daemon})."
45238 #: doc/guix.texi:20956
45240 msgid "activation-service-type"
45244 #: doc/guix.texi:20960
45246 "Here @var{guix-activation} is a procedure that returns a gexp, which is a "
45247 "code snippet to run at ``activation time''---e.g., when the service is "
45251 #. type: Plain text
45252 #: doc/guix.texi:20963
45253 msgid "A service of this type is instantiated like this:"
45257 #: doc/guix.texi:20969
45260 "(service guix-service-type\n"
45261 " (guix-configuration\n"
45262 " (build-accounts 5)\n"
45263 " (use-substitutes? #f)))\n"
45266 #. type: Plain text
45267 #: doc/guix.texi:20977
45269 "The second argument to the @code{service} form is a value representing the "
45270 "parameters of this specific service instance. @xref{guix-configuration-"
45271 "type, @code{guix-configuration}}, for information about the @code{guix-"
45272 "configuration} data type. When the value is omitted, the default value "
45273 "specified by @code{guix-service-type} is used:"
45277 #: doc/guix.texi:20980
45279 msgid "(service guix-service-type)\n"
45282 #. type: Plain text
45283 #: doc/guix.texi:20984
45285 "@var{guix-service-type} is quite simple because it extends other services "
45286 "but is not extensible itself."
45289 #. type: Plain text
45290 #: doc/guix.texi:20988
45291 msgid "The service type for an @emph{extensible} service looks like this:"
45295 #: doc/guix.texi:20995
45298 "(define udev-service-type\n"
45299 " (service-type (name 'udev)\n"
45301 " (list (service-extension shepherd-root-service-type\n"
45302 " udev-shepherd-service)))\n"
45307 #: doc/guix.texi:21003
45310 " (compose concatenate) ;concatenate the list of rules\n"
45311 " (extend (lambda (config rules)\n"
45313 " (($ <udev-configuration> udev initial-rules)\n"
45314 " (udev-configuration\n"
45315 " (udev udev) ;the udev package to use\n"
45316 " (rules (append initial-rules rules)))))))))\n"
45319 #. type: Plain text
45320 #: doc/guix.texi:21009
45322 "This is the service type for the @uref{https://wiki.gentoo.org/wiki/Project:"
45323 "Eudev, eudev device management daemon}. Compared to the previous example, "
45324 "in addition to an extension of @var{shepherd-root-service-type}, we see two "
45329 #: doc/guix.texi:21011
45335 #: doc/guix.texi:21014
45337 "This is the procedure to @dfn{compose} the list of extensions to services of "
45342 #: doc/guix.texi:21017
45344 "Services can extend the udev service by passing it lists of rules; we "
45345 "compose those extensions simply by concatenating them."
45349 #: doc/guix.texi:21018
45355 #: doc/guix.texi:21021
45357 "This procedure defines how the value of the service is @dfn{extended} with "
45358 "the composition of the extensions."
45362 #: doc/guix.texi:21026
45364 "Udev extensions are composed into a list of rules, but the udev service "
45365 "value is itself a @code{<udev-configuration>} record. So here, we extend "
45366 "that record by appending the list of rules it contains to the list of "
45367 "contributed rules."
45371 #: doc/guix.texi:21032
45373 "This is a string giving an overview of the service type. The string can "
45374 "contain Texinfo markup (@pxref{Overview,,, texinfo, GNU Texinfo}). The "
45375 "@command{guix system search} command searches these strings and displays "
45376 "them (@pxref{Invoking guix system})."
45379 #. type: Plain text
45380 #: doc/guix.texi:21037
45382 "There can be only one instance of an extensible service type such as "
45383 "@var{udev-service-type}. If there were more, the @code{service-extension} "
45384 "specifications would be ambiguous."
45387 #. type: Plain text
45388 #: doc/guix.texi:21040
45390 "Still here? The next section provides a reference of the programming "
45391 "interface for services."
45394 #. type: Plain text
45395 #: doc/guix.texi:21048
45397 "We have seen an overview of service types (@pxref{Service Types and "
45398 "Services}). This section provides a reference on how to manipulate services "
45399 "and service types. This interface is provided by the @code{(gnu services)} "
45404 #: doc/guix.texi:21049
45406 msgid "{Scheme Procedure} service @var{type} [@var{value}]"
45410 #: doc/guix.texi:21053
45412 "Return a new service of @var{type}, a @code{<service-type>} object (see "
45413 "below.) @var{value} can be any object; it represents the parameters of this "
45414 "particular service instance."
45418 #: doc/guix.texi:21057
45420 "When @var{value} is omitted, the default value specified by @var{type} is "
45421 "used; if @var{type} does not specify a default value, an error is raised."
45425 #: doc/guix.texi:21059
45426 msgid "For instance, this:"
45430 #: doc/guix.texi:21062
45432 msgid "(service openssh-service-type)\n"
45436 #: doc/guix.texi:21066
45437 msgid "is equivalent to this:"
45441 #: doc/guix.texi:21070
45444 "(service openssh-service-type\n"
45445 " (openssh-configuration))\n"
45449 #: doc/guix.texi:21074
45451 "In both cases the result is an instance of @code{openssh-service-type} with "
45452 "the default configuration."
45456 #: doc/guix.texi:21076
45458 msgid "{Scheme Procedure} service? @var{obj}"
45462 #: doc/guix.texi:21078
45463 msgid "Return true if @var{obj} is a service."
45467 #: doc/guix.texi:21080
45469 msgid "{Scheme Procedure} service-kind @var{service}"
45473 #: doc/guix.texi:21082
45475 "Return the type of @var{service}---i.e., a @code{<service-type>} object."
45479 #: doc/guix.texi:21084
45481 msgid "{Scheme Procedure} service-value @var{service}"
45485 #: doc/guix.texi:21087
45487 "Return the value associated with @var{service}. It represents its "
45491 #. type: Plain text
45492 #: doc/guix.texi:21090
45493 msgid "Here is an example of how a service is created and manipulated:"
45497 #: doc/guix.texi:21099
45501 " (service nginx-service-type\n"
45502 " (nginx-configuration\n"
45504 " (log-directory log-directory)\n"
45505 " (run-directory run-directory)\n"
45506 " (file config-file))))\n"
45511 #: doc/guix.texi:21102
45520 #: doc/guix.texi:21105
45523 "(eq? (service-kind s) nginx-service-type)\n"
45527 #. type: Plain text
45528 #: doc/guix.texi:21115
45530 "The @code{modify-services} form provides a handy way to change the "
45531 "parameters of some of the services of a list such as @var{%base-services} "
45532 "(@pxref{Base Services, @code{%base-services}}). It evaluates to a list of "
45533 "services. Of course, you could always use standard list combinators such as "
45534 "@code{map} and @code{fold} to do that (@pxref{SRFI-1, List Library,, guile, "
45535 "GNU Guile Reference Manual}); @code{modify-services} simply provides a more "
45536 "concise form for this common pattern."
45540 #: doc/guix.texi:21116
45542 msgid "{Scheme Syntax} modify-services @var{services} @"
45546 #: doc/guix.texi:21118
45547 msgid "(@var{type} @var{variable} => @var{body}) @dots{}"
45551 #: doc/guix.texi:21121
45553 "Modify the services listed in @var{services} according to the given "
45554 "clauses. Each clause has the form:"
45558 #: doc/guix.texi:21124
45560 msgid "(@var{type} @var{variable} => @var{body})\n"
45564 #: doc/guix.texi:21131
45566 "where @var{type} is a service type---e.g., @code{guix-service-type}---and "
45567 "@var{variable} is an identifier that is bound within the @var{body} to the "
45568 "service parameters---e.g., a @code{guix-configuration} instance---of the "
45569 "original service of that @var{type}."
45573 #: doc/guix.texi:21138
45575 "The @var{body} should evaluate to the new service parameters, which will be "
45576 "used to configure the new service. This new service will replace the "
45577 "original in the resulting list. Because a service's service parameters are "
45578 "created using @code{define-record-type*}, you can write a succinct "
45579 "@var{body} that evaluates to the new service parameters by using the "
45580 "@code{inherit} feature that @code{define-record-type*} provides."
45584 #: doc/guix.texi:21140
45585 msgid "@xref{Using the Configuration System}, for example usage."
45588 #. type: Plain text
45589 #: doc/guix.texi:21147
45591 "Next comes the programming interface for service types. This is something "
45592 "you want to know when writing new service definitions, but not necessarily "
45593 "when simply looking for ways to customize your @code{operating-system} "
45598 #: doc/guix.texi:21148
45600 msgid "{Data Type} service-type"
45604 #: doc/guix.texi:21149
45606 msgid "service type"
45610 #: doc/guix.texi:21152
45612 "This is the representation of a @dfn{service type} (@pxref{Service Types and "
45617 #: doc/guix.texi:21156
45618 msgid "This is a symbol, used only to simplify inspection and debugging."
45622 #: doc/guix.texi:21157
45628 #: doc/guix.texi:21159
45629 msgid "A non-empty list of @code{<service-extension>} objects (see below)."
45633 #: doc/guix.texi:21160
45635 msgid "@code{compose} (default: @code{#f})"
45639 #: doc/guix.texi:21164
45641 "If this is @code{#f}, then the service type denotes services that cannot be "
45642 "extended---i.e., services that do not receive ``values'' from other services."
45646 #: doc/guix.texi:21168
45648 "Otherwise, it must be a one-argument procedure. The procedure is called by "
45649 "@code{fold-services} and is passed a list of values collected from "
45650 "extensions. It may return any single value."
45654 #: doc/guix.texi:21169
45656 msgid "@code{extend} (default: @code{#f})"
45660 #: doc/guix.texi:21171
45661 msgid "If this is @code{#f}, services of this type cannot be extended."
45665 #: doc/guix.texi:21177
45667 "Otherwise, it must be a two-argument procedure: @code{fold-services} calls "
45668 "it, passing it the initial value of the service as the first argument and "
45669 "the result of applying @code{compose} to the extension values as the second "
45670 "argument. It must return a value that is a valid parameter value for the "
45671 "service instance."
45675 #: doc/guix.texi:21180
45676 msgid "@xref{Service Types and Services}, for examples."
45680 #: doc/guix.texi:21182
45682 msgid "{Scheme Procedure} service-extension @var{target-type} @"
45686 #: doc/guix.texi:21188
45688 "@var{compute} Return a new extension for services of type @var{target-"
45689 "type}. @var{compute} must be a one-argument procedure: @code{fold-services} "
45690 "calls it, passing it the value associated with the service that provides the "
45691 "extension; it must return a valid value for the target service."
45695 #: doc/guix.texi:21190
45697 msgid "{Scheme Procedure} service-extension? @var{obj}"
45701 #: doc/guix.texi:21192
45702 msgid "Return true if @var{obj} is a service extension."
45705 #. type: Plain text
45706 #: doc/guix.texi:21198
45708 "Occasionally, you might want to simply extend an existing service. This "
45709 "involves creating a new service type and specifying the extension of "
45710 "interest, which can be verbose; the @code{simple-service} procedure provides "
45711 "a shorthand for this."
45715 #: doc/guix.texi:21199
45717 msgid "{Scheme Procedure} simple-service @var{name} @var{target} @var{value}"
45721 #: doc/guix.texi:21203
45723 "Return a service that extends @var{target} with @var{value}. This works by "
45724 "creating a singleton service type @var{name}, of which the returned service "
45729 #: doc/guix.texi:21206
45731 "For example, this extends mcron (@pxref{Scheduled Job Execution}) with an "
45736 #: doc/guix.texi:21210
45739 "(simple-service 'my-mcron-job mcron-service-type\n"
45740 " #~(job '(next-hour (3)) \"guix gc -F 2G\"))\n"
45743 #. type: Plain text
45744 #: doc/guix.texi:21220
45746 "At the core of the service abstraction lies the @code{fold-services} "
45747 "procedure, which is responsible for ``compiling'' a list of services down to "
45748 "a single directory that contains everything needed to boot and run the "
45749 "system---the directory shown by the @command{guix system build} command "
45750 "(@pxref{Invoking guix system}). In essence, it propagates service "
45751 "extensions down the service graph, updating each node parameters on the way, "
45752 "until it reaches the root node."
45756 #: doc/guix.texi:21221
45758 msgid "{Scheme Procedure} fold-services @var{services} @"
45762 #: doc/guix.texi:21225
45764 "[#:target-type @var{system-service-type}] Fold @var{services} by propagating "
45765 "their extensions down to the root of type @var{target-type}; return the root "
45766 "service adjusted accordingly."
45769 #. type: Plain text
45770 #: doc/guix.texi:21229
45772 "Lastly, the @code{(gnu services)} module also defines several essential "
45773 "service types, some of which are listed below."
45777 #: doc/guix.texi:21230
45779 msgid "{Scheme Variable} system-service-type"
45783 #: doc/guix.texi:21233
45785 "This is the root of the service graph. It produces the system directory as "
45786 "returned by the @command{guix system build} command."
45790 #: doc/guix.texi:21235
45792 msgid "{Scheme Variable} boot-service-type"
45796 #: doc/guix.texi:21238
45798 "The type of the ``boot service'', which produces the @dfn{boot script}. The "
45799 "boot script is what the initial RAM disk runs when booting."
45803 #: doc/guix.texi:21240
45805 msgid "{Scheme Variable} etc-service-type"
45809 #: doc/guix.texi:21244
45811 "The type of the @file{/etc} service. This service is used to create files "
45812 "under @file{/etc} and can be extended by passing it name/file tuples such as:"
45816 #: doc/guix.texi:21247
45818 msgid "(list `(\"issue\" ,(plain-file \"issue\" \"Welcome!\\n\")))\n"
45822 #: doc/guix.texi:21251
45824 "In this example, the effect would be to add an @file{/etc/issue} file "
45825 "pointing to the given file."
45829 #: doc/guix.texi:21253
45831 msgid "{Scheme Variable} setuid-program-service-type"
45835 #: doc/guix.texi:21257
45837 "Type for the ``setuid-program service''. This service collects lists of "
45838 "executable file names, passed as gexps, and adds them to the set of setuid-"
45839 "root programs on the system (@pxref{Setuid Programs})."
45843 #: doc/guix.texi:21259
45845 msgid "{Scheme Variable} profile-service-type"
45849 #: doc/guix.texi:21263
45851 "Type of the service that populates the @dfn{system profile}---i.e., the "
45852 "programs under @file{/run/current-system/profile}. Other services can "
45853 "extend it by passing it lists of packages to add to the system profile."
45857 #: doc/guix.texi:21269
45859 msgid "shepherd services"
45863 #: doc/guix.texi:21270
45869 #: doc/guix.texi:21271
45871 msgid "init system"
45874 #. type: Plain text
45875 #: doc/guix.texi:21277
45877 "The @code{(gnu services shepherd)} module provides a way to define services "
45878 "managed by the GNU@tie{}Shepherd, which is the GuixSD initialization "
45879 "system---the first process that is started when the system boots, also known "
45880 "as PID@tie{}1 (@pxref{Introduction,,, shepherd, The GNU Shepherd Manual})."
45883 #. type: Plain text
45884 #: doc/guix.texi:21283
45886 "Services in the Shepherd can depend on each other. For instance, the SSH "
45887 "daemon may need to be started after the syslog daemon has been started, "
45888 "which in turn can only happen once all the file systems have been mounted. "
45889 "The simple operating system defined earlier (@pxref{Using the Configuration "
45890 "System}) results in a service graph like this:"
45893 #. type: Plain text
45894 #: doc/guix.texi:21285
45895 msgid "@image{images/shepherd-graph,,5in,Typical shepherd service graph.}"
45898 #. type: Plain text
45899 #: doc/guix.texi:21289
45901 "You can actually generate such a graph for any operating system definition "
45902 "using the @command{guix system shepherd-graph} command (@pxref{system-"
45903 "shepherd-graph, @command{guix system shepherd-graph}})."
45906 #. type: Plain text
45907 #: doc/guix.texi:21293
45909 "The @var{%shepherd-root-service} is a service object representing PID@tie{}"
45910 "1, of type @var{shepherd-root-service-type}; it can be extended by passing "
45911 "it lists of @code{<shepherd-service>} objects."
45915 #: doc/guix.texi:21294
45917 msgid "{Data Type} shepherd-service"
45921 #: doc/guix.texi:21296
45922 msgid "The data type representing a service managed by the Shepherd."
45926 #: doc/guix.texi:21298
45932 #: doc/guix.texi:21300
45933 msgid "This is a list of symbols denoting what the service provides."
45937 #: doc/guix.texi:21305
45939 "These are the names that may be passed to @command{herd start}, "
45940 "@command{herd status}, and similar commands (@pxref{Invoking herd,,, "
45941 "shepherd, The GNU Shepherd Manual}). @xref{Slots of services, the "
45942 "@code{provides} slot,, shepherd, The GNU Shepherd Manual}, for details."
45946 #: doc/guix.texi:21306
45948 msgid "@code{requirements} (default: @code{'()})"
45952 #: doc/guix.texi:21308
45953 msgid "List of symbols denoting the Shepherd services this one depends on."
45957 #: doc/guix.texi:21309
45959 msgid "@code{respawn?} (default: @code{#t})"
45963 #: doc/guix.texi:21312
45965 "Whether to restart the service when it stops, for instance when the "
45966 "underlying process dies."
45970 #: doc/guix.texi:21313
45976 #: doc/guix.texi:21314
45978 msgid "@code{stop} (default: @code{#~(const #f)})"
45982 #: doc/guix.texi:21320
45984 "The @code{start} and @code{stop} fields refer to the Shepherd's facilities "
45985 "to start and stop processes (@pxref{Service De- and Constructors,,, "
45986 "shepherd, The GNU Shepherd Manual}). They are given as G-expressions that "
45987 "get expanded in the Shepherd configuration file (@pxref{G-Expressions})."
45991 #: doc/guix.texi:21323
45992 msgid "A documentation string, as shown when running:"
45996 #: doc/guix.texi:21326
45998 msgid "herd doc @var{service-name}\n"
46002 #: doc/guix.texi:21330
46004 "where @var{service-name} is one of the symbols in @var{provision} "
46005 "(@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual})."
46009 #: doc/guix.texi:21331
46011 msgid "@code{modules} (default: @var{%default-modules})"
46015 #: doc/guix.texi:21334
46017 "This is the list of modules that must be in scope when @code{start} and "
46018 "@code{stop} are evaluated."
46022 #: doc/guix.texi:21338
46024 msgid "{Scheme Variable} shepherd-root-service-type"
46028 #: doc/guix.texi:21340
46029 msgid "The service type for the Shepherd ``root service''---i.e., PID@tie{}1."
46033 #: doc/guix.texi:21344
46035 "This is the service type that extensions target when they want to create "
46036 "shepherd services (@pxref{Service Types and Services}, for an example). "
46037 "Each extension must pass a list of @code{<shepherd-service>}."
46041 #: doc/guix.texi:21346
46043 msgid "{Scheme Variable} %shepherd-root-service"
46047 #: doc/guix.texi:21348
46048 msgid "This service represents PID@tie{}1."
46052 #: doc/guix.texi:21354
46054 msgid "documentation, searching for"
46058 #: doc/guix.texi:21355
46060 msgid "searching for documentation"
46064 #: doc/guix.texi:21356
46066 msgid "Info, documentation format"
46070 #: doc/guix.texi:21357
46076 #: doc/guix.texi:21358
46078 msgid "manual pages"
46081 #. type: Plain text
46082 #: doc/guix.texi:21365
46084 "In most cases packages installed with Guix come with documentation. There "
46085 "are two main documentation formats: ``Info'', a browseable hypertext format "
46086 "used for GNU software, and ``manual pages'' (or ``man pages''), the linear "
46087 "documentation format traditionally found on Unix. Info manuals are accessed "
46088 "with the @command{info} command or with Emacs, and man pages are accessed "
46089 "using @command{man}."
46092 #. type: Plain text
46093 #: doc/guix.texi:21369
46095 "You can look for documentation of software installed on your system by "
46096 "keyword. For example, the following command searches for information about "
46097 "``TLS'' in Info manuals:"
46101 #: doc/guix.texi:21377
46105 "\"(emacs)Network Security\" -- STARTTLS\n"
46106 "\"(emacs)Network Security\" -- TLS\n"
46107 "\"(gnutls)Core TLS API\" -- gnutls_certificate_set_verify_flags\n"
46108 "\"(gnutls)Core TLS API\" -- gnutls_certificate_set_verify_function\n"
46112 #. type: Plain text
46113 #: doc/guix.texi:21381
46114 msgid "The command below searches for the same keyword in man pages:"
46118 #: doc/guix.texi:21387
46122 "SSL (7) - OpenSSL SSL/TLS library\n"
46123 "certtool (1) - GnuTLS certificate tool\n"
46127 #. type: Plain text
46128 #: doc/guix.texi:21393
46130 "These searches are purely local to your computer so you have the guarantee "
46131 "that documentation you find corresponds to what you have actually installed, "
46132 "you can access it off-line, and your privacy is respected."
46135 #. type: Plain text
46136 #: doc/guix.texi:21396
46138 "Once you have these results, you can view the relevant documentation by "
46143 #: doc/guix.texi:21399
46145 msgid "$ info \"(gnutls)Core TLS API\"\n"
46148 #. type: Plain text
46149 #: doc/guix.texi:21403
46154 #: doc/guix.texi:21406
46156 msgid "$ man certtool\n"
46159 #. type: Plain text
46160 #: doc/guix.texi:21414
46162 "Info manuals contain sections and indices as well as hyperlinks like those "
46163 "found in Web pages. The @command{info} reader (@pxref{Top, Info reader,, "
46164 "info-stnd, Stand-alone GNU Info}) and its Emacs counterpart (@pxref{Misc "
46165 "Help,,, emacs, The GNU Emacs Manual}) provide intuitive key bindings to "
46166 "navigate manuals. @xref{Getting Started,,, info, Info: An Introduction}, "
46167 "for an introduction to Info navigation."
46171 #: doc/guix.texi:21418
46173 msgid "debugging files"
46176 #. type: Plain text
46177 #: doc/guix.texi:21424
46179 "Program binaries, as produced by the GCC compilers for instance, are "
46180 "typically written in the ELF format, with a section containing "
46181 "@dfn{debugging information}. Debugging information is what allows the "
46182 "debugger, GDB, to map binary code to source code; it is required to debug a "
46183 "compiled program in good conditions."
46186 #. type: Plain text
46187 #: doc/guix.texi:21432
46189 "The problem with debugging information is that is takes up a fair amount of "
46190 "disk space. For example, debugging information for the GNU C Library weighs "
46191 "in at more than 60 MiB. Thus, as a user, keeping all the debugging info of "
46192 "all the installed programs is usually not an option. Yet, space savings "
46193 "should not come at the cost of an impediment to debugging---especially in "
46194 "the GNU system, which should make it easier for users to exert their "
46195 "computing freedom (@pxref{GNU Distribution})."
46197 "Le problème avec les informations de débogage est qu'elles prennent pas mal "
46198 "de place sur le disque. Par exemple, les informations de débogage de la "
46199 "bibliothèque C de GNU prend plus de 60 Mo. Ainsi, en tant qu'utilisateur, "
46200 "garder toutes les informations de débogage de tous les programmes installés "
46201 "n'est souvent pas une possibilité. Cependant, l'économie d'espace ne devrait "
46202 "pas empêcher le débogage — en particulier, dans le système GNU, qui devrait "
46203 "faciliter pour ses utilisateurs l'exercice de leurs libertés "
46204 "(@pxref{Distribution GNU})."
46206 #. type: Plain text
46207 #: doc/guix.texi:21439
46209 "Thankfully, the GNU Binary Utilities (Binutils) and GDB provide a mechanism "
46210 "that allows users to get the best of both worlds: debugging information can "
46211 "be stripped from the binaries and stored in separate files. GDB is then "
46212 "able to load debugging information from those files, when they are available "
46213 "(@pxref{Separate Debug Files,,, gdb, Debugging with GDB})."
46216 #. type: Plain text
46217 #: doc/guix.texi:21447
46219 "The GNU distribution takes advantage of this by storing debugging "
46220 "information in the @code{lib/debug} sub-directory of a separate package "
46221 "output unimaginatively called @code{debug} (@pxref{Packages with Multiple "
46222 "Outputs}). Users can choose to install the @code{debug} output of a package "
46223 "when they need it. For instance, the following command installs the "
46224 "debugging information for the GNU C Library and for GNU Guile:"
46228 #: doc/guix.texi:21450
46230 msgid "guix package -i glibc:debug guile:debug\n"
46233 #. type: Plain text
46234 #: doc/guix.texi:21456
46236 "GDB must then be told to look for debug files in the user's profile, by "
46237 "setting the @code{debug-file-directory} variable (consider setting it from "
46238 "the @file{~/.gdbinit} file, @pxref{Startup,,, gdb, Debugging with GDB}):"
46242 #: doc/guix.texi:21459
46244 msgid "(gdb) set debug-file-directory ~/.guix-profile/lib/debug\n"
46247 #. type: Plain text
46248 #: doc/guix.texi:21463
46250 "From there on, GDB will pick up debugging information from the @code{.debug} "
46251 "files under @file{~/.guix-profile/lib/debug}."
46254 #. type: Plain text
46255 #: doc/guix.texi:21470
46257 "In addition, you will most likely want GDB to be able to show the source "
46258 "code being debugged. To do that, you will have to unpack the source code of "
46259 "the package of interest (obtained with @code{guix build --source}, "
46260 "@pxref{Invoking guix build}), and to point GDB to that source directory "
46261 "using the @code{directory} command (@pxref{Source Path, @code{directory},, "
46262 "gdb, Debugging with GDB})."
46265 #. type: Plain text
46266 #: doc/guix.texi:21479
46268 "The @code{debug} output mechanism in Guix is implemented by the @code{gnu-"
46269 "build-system} (@pxref{Build Systems}). Currently, it is opt-in---debugging "
46270 "information is available only for the packages with definitions explicitly "
46271 "declaring a @code{debug} output. This may be changed to opt-out in the "
46272 "future if our build farm servers can handle the load. To check whether a "
46273 "package has a @code{debug} output, use @command{guix package --list-"
46274 "available} (@pxref{Invoking guix package})."
46278 #: doc/guix.texi:21484
46280 msgid "security updates"
46283 #. type: Plain text
46284 #: doc/guix.texi:21493
46286 "Occasionally, important security vulnerabilities are discovered in software "
46287 "packages and must be patched. Guix developers try hard to keep track of "
46288 "known vulnerabilities and to apply fixes as soon as possible in the "
46289 "@code{master} branch of Guix (we do not yet provide a ``stable'' branch "
46290 "containing only security updates.) The @command{guix lint} tool helps "
46291 "developers find out about vulnerable versions of software packages in the "
46295 #. type: smallexample
46296 #: doc/guix.texi:21500
46299 "$ guix lint -c cve\n"
46300 "gnu/packages/base.scm:652:2: glibc@@2.21: probably vulnerable to CVE-2015-1781, CVE-2015-7547\n"
46301 "gnu/packages/gcc.scm:334:2: gcc@@4.9.3: probably vulnerable to CVE-2015-5276\n"
46302 "gnu/packages/image.scm:312:2: openjpeg@@2.1.0: probably vulnerable to CVE-2016-1923, CVE-2016-1924\n"
46306 #. type: Plain text
46307 #: doc/guix.texi:21503
46308 msgid "@xref{Invoking guix lint}, for more information."
46312 #: doc/guix.texi:21507
46314 "As of version @value{VERSION}, the feature described below is considered "
46318 #. type: Plain text
46319 #: doc/guix.texi:21517
46321 "Guix follows a functional package management discipline "
46322 "(@pxref{Introduction}), which implies that, when a package is changed, "
46323 "@emph{every package that depends on it} must be rebuilt. This can "
46324 "significantly slow down the deployment of fixes in core packages such as "
46325 "libc or Bash, since basically the whole distribution would need to be "
46326 "rebuilt. Using pre-built binaries helps (@pxref{Substitutes}), but "
46327 "deployment may still take more time than desired."
46329 "Guix suit une discipline de gestion de paquets fonctionnelle "
46330 "(@pxref{Introduction}), ce qui implique que lorsqu'un paquet change, "
46331 "@emph{tous les paquets qui en dépendent} doivent être reconstruits. Cela "
46332 "peut grandement ralentir le déploiement de corrections dans les paquets du "
46333 "cœur comme libc ou bash comme presque toute la distribution aurait besoin "
46334 "d'être reconstruite. Cela aide d'utiliser des binaires pré-construits "
46335 "(@pxref{Substituts}), mais le déploiement peut toujours prendre plus de "
46336 "temps de souhaité."
46339 #: doc/guix.texi:21518
46344 #. type: Plain text
46345 #: doc/guix.texi:21526
46347 "To address this, Guix implements @dfn{grafts}, a mechanism that allows for "
46348 "fast deployment of critical updates without the costs associated with a "
46349 "whole-distribution rebuild. The idea is to rebuild only the package that "
46350 "needs to be patched, and then to ``graft'' it onto packages explicitly "
46351 "installed by the user and that were previously referring to the original "
46352 "package. The cost of grafting is typically very low, and order of "
46353 "magnitudes lower than a full rebuild of the dependency chain."
46357 #: doc/guix.texi:21527
46359 msgid "replacements of packages, for grafts"
46362 #. type: Plain text
46363 #: doc/guix.texi:21533
46365 "For instance, suppose a security update needs to be applied to Bash. Guix "
46366 "developers will provide a package definition for the ``fixed'' Bash, say "
46367 "@var{bash-fixed}, in the usual way (@pxref{Defining Packages}). Then, the "
46368 "original package definition is augmented with a @code{replacement} field "
46369 "pointing to the package containing the bug fix:"
46373 #: doc/guix.texi:21540
46378 " (name \"bash\")\n"
46380 " (replacement bash-fixed)))\n"
46383 #. type: Plain text
46384 #: doc/guix.texi:21550
46386 "From there on, any package depending directly or indirectly on Bash---as "
46387 "reported by @command{guix gc --requisites} (@pxref{Invoking guix gc})---that "
46388 "is installed is automatically ``rewritten'' to refer to @var{bash-fixed} "
46389 "instead of @var{bash}. This grafting process takes time proportional to the "
46390 "size of the package, usually less than a minute for an ``average'' package "
46391 "on a recent machine. Grafting is recursive: when an indirect dependency "
46392 "requires grafting, then grafting ``propagates'' up to the package that the "
46393 "user is installing."
46396 #. type: Plain text
46397 #: doc/guix.texi:21558
46399 "Currently, the length of the name and version of the graft and that of the "
46400 "package it replaces (@var{bash-fixed} and @var{bash} in the example above) "
46401 "must be equal. This restriction mostly comes from the fact that grafting "
46402 "works by patching files, including binary files, directly. Other "
46403 "restrictions may apply: for instance, when adding a graft to a package "
46404 "providing a shared library, the original shared library and its replacement "
46405 "must have the same @code{SONAME} and be binary-compatible."
46408 #. type: Plain text
46409 #: doc/guix.texi:21562
46411 "The @option{--no-grafts} command-line option allows you to forcefully avoid "
46412 "grafting (@pxref{Common Build Options, @option{--no-grafts}}). Thus, the "
46417 #: doc/guix.texi:21565
46419 msgid "guix build bash --no-grafts\n"
46422 #. type: Plain text
46423 #: doc/guix.texi:21569
46424 msgid "returns the store file name of the original Bash, whereas:"
46428 #: doc/guix.texi:21572
46430 msgid "guix build bash\n"
46433 #. type: Plain text
46434 #: doc/guix.texi:21577
46436 "returns the store file name of the ``fixed'', replacement Bash. This allows "
46437 "you to distinguish between the two variants of Bash."
46440 #. type: Plain text
46441 #: doc/guix.texi:21580
46443 "To verify which Bash your whole profile refers to, you can run "
46444 "(@pxref{Invoking guix gc}):"
46448 #: doc/guix.texi:21583
46450 msgid "guix gc -R `readlink -f ~/.guix-profile` | grep bash\n"
46453 #. type: Plain text
46454 #: doc/guix.texi:21588
46456 "@dots{} and compare the store file names that you get with those above. "
46457 "Likewise for a complete GuixSD system generation:"
46461 #: doc/guix.texi:21591
46463 msgid "guix gc -R `guix system build my-config.scm` | grep bash\n"
46466 #. type: Plain text
46467 #: doc/guix.texi:21595
46469 "Lastly, to check which Bash running processes are using, you can use the "
46470 "@command{lsof} command:"
46474 #: doc/guix.texi:21598
46476 msgid "lsof | grep /gnu/store/.*bash\n"
46479 #. type: Plain text
46480 #: doc/guix.texi:21615
46482 "From a programming viewpoint, the package definitions of the GNU "
46483 "distribution are provided by Guile modules in the @code{(gnu packages "
46484 "@dots{})} name space@footnote{Note that packages under the @code{(gnu "
46485 "packages @dots{})} module name space are not necessarily ``GNU packages''. "
46486 "This module naming scheme follows the usual Guile module naming convention: "
46487 "@code{gnu} means that these modules are distributed as part of the GNU "
46488 "system, and @code{packages} identifies modules that define packages.} "
46489 "(@pxref{Modules, Guile modules,, guile, GNU Guile Reference Manual}). For "
46490 "instance, the @code{(gnu packages emacs)} module exports a variable named "
46491 "@code{emacs}, which is bound to a @code{<package>} object (@pxref{Defining "
46495 #. type: Plain text
46496 #: doc/guix.texi:21622
46498 "The @code{(gnu packages @dots{})} module name space is automatically scanned "
46499 "for packages by the command-line tools. For instance, when running "
46500 "@code{guix package -i emacs}, all the @code{(gnu packages @dots{})} modules "
46501 "are scanned until one that exports a package object whose name is "
46502 "@code{emacs} is found. This package search facility is implemented in the "
46503 "@code{(gnu packages)} module."
46507 #: doc/guix.texi:21624
46509 msgid "package module search path"
46512 #. type: Plain text
46513 #: doc/guix.texi:21641
46515 "Users can store package definitions in modules with different names---e.g., "
46516 "@code{(my-packages emacs)}@footnote{Note that the file name and module name "
46517 "must match. For instance, the @code{(my-packages emacs)} module must be "
46518 "stored in a @file{my-packages/emacs.scm} file relative to the load path "
46519 "specified with @option{--load-path} or @code{GUIX_PACKAGE_PATH}. "
46520 "@xref{Modules and the File System,,, guile, GNU Guile Reference Manual}, for "
46521 "details.}. These package definitions will not be visible by default. Users "
46522 "can invoke commands such as @command{guix package} and @command{guix build} "
46523 "with the @code{-e} option so that they know where to find the package. "
46524 "Better yet, they can use the @code{-L} option of these commands to make "
46525 "those modules visible (@pxref{Invoking guix build, @code{--load-path}}), or "
46526 "define the @code{GUIX_PACKAGE_PATH} environment variable. This environment "
46527 "variable makes it easy to extend or customize the distribution and is "
46528 "honored by all the user interfaces."
46532 #: doc/guix.texi:21642
46534 msgid "{Environment Variable} GUIX_PACKAGE_PATH"
46538 #: doc/guix.texi:21646
46540 "This is a colon-separated list of directories to search for additional "
46541 "package modules. Directories listed in this variable take precedence over "
46542 "the own modules of the distribution."
46545 #. type: Plain text
46546 #: doc/guix.texi:21654
46548 "The distribution is fully @dfn{bootstrapped} and @dfn{self-contained}: each "
46549 "package is built based solely on other packages in the distribution. The "
46550 "root of this dependency graph is a small set of @dfn{bootstrap binaries}, "
46551 "provided by the @code{(gnu packages bootstrap)} module. For more "
46552 "information on bootstrapping, @pxref{Bootstrapping}."
46556 #: doc/guix.texi:21658
46558 msgid "packages, creating"
46561 #. type: Plain text
46562 #: doc/guix.texi:21663
46564 "The GNU distribution is nascent and may well lack some of your favorite "
46565 "packages. This section describes how you can help make the distribution "
46566 "grow. @xref{Contributing}, for additional information on how you can help."
46569 #. type: Plain text
46570 #: doc/guix.texi:21671
46572 "Free software packages are usually distributed in the form of @dfn{source "
46573 "code tarballs}---typically @file{tar.gz} files that contain all the source "
46574 "files. Adding a package to the distribution means essentially two things: "
46575 "adding a @dfn{recipe} that describes how to build the package, including a "
46576 "list of other packages required to build it, and adding @dfn{package "
46577 "metadata} along with that recipe, such as a description and licensing "
46581 #. type: Plain text
46582 #: doc/guix.texi:21680
46584 "In Guix all this information is embodied in @dfn{package definitions}. "
46585 "Package definitions provide a high-level view of the package. They are "
46586 "written using the syntax of the Scheme programming language; in fact, for "
46587 "each package we define a variable bound to the package definition, and "
46588 "export that variable from a module (@pxref{Package Modules}). However, in-"
46589 "depth Scheme knowledge is @emph{not} a prerequisite for creating packages. "
46590 "For more information on package definitions, @pxref{Defining Packages}."
46593 #. type: Plain text
46594 #: doc/guix.texi:21686
46596 "Once a package definition is in place, stored in a file in the Guix source "
46597 "tree, it can be tested using the @command{guix build} command "
46598 "(@pxref{Invoking guix build}). For example, assuming the new package is "
46599 "called @code{gnew}, you may run this command from the Guix build tree "
46600 "(@pxref{Running Guix Before It Is Installed}):"
46604 #: doc/guix.texi:21689
46606 msgid "./pre-inst-env guix build gnew --keep-failed\n"
46609 #. type: Plain text
46610 #: doc/guix.texi:21695
46612 "Using @code{--keep-failed} makes it easier to debug build failures since it "
46613 "provides access to the failed build tree. Another useful command-line "
46614 "option when debugging is @code{--log-file}, to access the build log."
46617 #. type: Plain text
46618 #: doc/guix.texi:21700
46620 "If the package is unknown to the @command{guix} command, it may be that the "
46621 "source file contains a syntax error, or lacks a @code{define-public} clause "
46622 "to export the package variable. To figure it out, you may load the module "
46623 "from Guile to get more information about the actual error:"
46627 #: doc/guix.texi:21703
46629 msgid "./pre-inst-env guile -c '(use-modules (gnu packages gnew))'\n"
46632 #. type: Plain text
46633 #: doc/guix.texi:21711
46635 "Once your package builds correctly, please send us a patch "
46636 "(@pxref{Contributing}). Well, if you need help, we will be happy to help "
46637 "you too. Once the patch is committed in the Guix repository, the new "
46638 "package automatically gets built on the supported platforms by @url{http://"
46639 "hydra.gnu.org/jobset/gnu/master, our continuous integration system}."
46643 #: doc/guix.texi:21712
46645 msgid "substituter"
46648 #. type: Plain text
46649 #: doc/guix.texi:21719
46651 "Users can obtain the new package definition simply by running @command{guix "
46652 "pull} (@pxref{Invoking guix pull}). When @code{hydra.gnu.org} is done "
46653 "building the package, installing the package automatically downloads "
46654 "binaries from there (@pxref{Substitutes}). The only place where human "
46655 "intervention is needed is to review and apply the patch."
46657 "On peut obtenir la nouvelle définition du paquet simplement en lançant "
46658 "@command{guix pull} (@pxref{Invoking guix pull}). Lorsque @code{hydra.gnu."
46659 "org} a fini de construire le paquet, l'installation du paquet y télécharge "
46660 "automatiquement les binaires (@pxref{Substituts}). La seule intervention "
46661 "humaine requise est pendant la revue et l'application du correctif."
46664 #: doc/guix.texi:21736
46666 msgid "free software"
46669 #. type: Plain text
46670 #: doc/guix.texi:21744
46672 "The GNU operating system has been developed so that users can have freedom "
46673 "in their computing. GNU is @dfn{free software}, meaning that users have the "
46674 "@url{http://www.gnu.org/philosophy/free-sw.html,four essential freedoms}: to "
46675 "run the program, to study and change the program in source code form, to "
46676 "redistribute exact copies, and to distribute modified versions. Packages "
46677 "found in the GNU distribution provide only software that conveys these four "
46681 #. type: Plain text
46682 #: doc/guix.texi:21750
46684 "In addition, the GNU distribution follow the @url{http://www.gnu.org/distros/"
46685 "free-system-distribution-guidelines.html,free software distribution "
46686 "guidelines}. Among other things, these guidelines reject non-free firmware, "
46687 "recommendations of non-free software, and discuss ways to deal with "
46688 "trademarks and patents."
46691 #. type: Plain text
46692 #: doc/guix.texi:21758
46694 "Some otherwise free upstream package sources contain a small and optional "
46695 "subset that violates the above guidelines, for instance because this subset "
46696 "is itself non-free code. When that happens, the offending items are removed "
46697 "with appropriate patches or code snippets in the @code{origin} form of the "
46698 "package (@pxref{Defining Packages}). This way, @code{guix build --source} "
46699 "returns the ``freed'' source rather than the unmodified upstream source."
46703 #: doc/guix.texi:21763
46705 msgid "package name"
46708 #. type: Plain text
46709 #: doc/guix.texi:21771
46711 "A package has actually two names associated with it: First, there is the "
46712 "name of the @emph{Scheme variable}, the one following @code{define-public}. "
46713 "By this name, the package can be made known in the Scheme code, for instance "
46714 "as input to another package. Second, there is the string in the @code{name} "
46715 "field of a package definition. This name is used by package management "
46716 "commands such as @command{guix package} and @command{guix build}."
46719 #. type: Plain text
46720 #: doc/guix.texi:21776
46722 "Both are usually the same and correspond to the lowercase conversion of the "
46723 "project name chosen upstream, with underscores replaced with hyphens. For "
46724 "instance, GNUnet is available as @code{gnunet}, and SDL_net as @code{sdl-"
46728 #. type: Plain text
46729 #: doc/guix.texi:21781
46731 "We do not add @code{lib} prefixes for library packages, unless these are "
46732 "already part of the official project name. But @pxref{Python Modules} and "
46733 "@ref{Perl Modules} for special rules concerning modules for the Python and "
46737 #. type: Plain text
46738 #: doc/guix.texi:21783
46739 msgid "Font package names are handled differently, @pxref{Fonts}."
46743 #: doc/guix.texi:21788
46745 msgid "package version"
46748 #. type: Plain text
46749 #: doc/guix.texi:21797
46751 "We usually package only the latest version of a given free software "
46752 "project. But sometimes, for instance for incompatible library versions, two "
46753 "(or more) versions of the same package are needed. These require different "
46754 "Scheme variable names. We use the name as defined in @ref{Package Naming} "
46755 "for the most recent version; previous versions use the same name, suffixed "
46756 "by @code{-} and the smallest prefix of the version number that may "
46757 "distinguish the two versions."
46760 #. type: Plain text
46761 #: doc/guix.texi:21800
46763 "The name inside the package definition is the same for all versions of a "
46764 "package and does not contain any version number."
46767 #. type: Plain text
46768 #: doc/guix.texi:21802
46770 "For instance, the versions 2.24.20 and 3.9.12 of GTK+ may be packaged as "
46775 #: doc/guix.texi:21814
46778 "(define-public gtk+\n"
46780 " (name \"gtk+\")\n"
46781 " (version \"3.9.12\")\n"
46783 "(define-public gtk+-2\n"
46785 " (name \"gtk+\")\n"
46786 " (version \"2.24.20\")\n"
46790 #. type: Plain text
46791 #: doc/guix.texi:21816
46792 msgid "If we also wanted GTK+ 3.8.2, this would be packaged as"
46796 #: doc/guix.texi:21822
46799 "(define-public gtk+-3.8\n"
46801 " (name \"gtk+\")\n"
46802 " (version \"3.8.2\")\n"
46807 #: doc/guix.texi:21826
46809 msgid "version number, for VCS snapshots"
46812 #. type: Plain text
46813 #: doc/guix.texi:21832
46815 "Occasionally, we package snapshots of upstream's version control system "
46816 "(VCS) instead of formal releases. This should remain exceptional, because "
46817 "it is up to upstream developers to clarify what the stable release is. Yet, "
46818 "it is sometimes necessary. So, what should we put in the @code{version} "
46822 #. type: Plain text
46823 #: doc/guix.texi:21840
46825 "Clearly, we need to make the commit identifier of the VCS snapshot visible "
46826 "in the version string, but we also need to make sure that the version string "
46827 "is monotonically increasing so that @command{guix package --upgrade} can "
46828 "determine which version is newer. Since commit identifiers, notably with "
46829 "Git, are not monotonically increasing, we add a revision number that we "
46830 "increase each time we upgrade to a newer snapshot. The resulting version "
46831 "string looks like this:"
46835 #: doc/guix.texi:21849
46838 "2.0.11-3.cabba9e\n"
46840 " | | `-- upstream commit ID\n"
46842 " | `--- Guix package revision\n"
46844 "latest upstream version\n"
46847 #. type: Plain text
46848 #: doc/guix.texi:21858
46850 "It is a good idea to strip commit identifiers in the @code{version} field "
46851 "to, say, 7 digits. It avoids an aesthetic annoyance (assuming aesthetics "
46852 "have a role to play here) as well as problems related to OS limits such as "
46853 "the maximum shebang length (127 bytes for the Linux kernel.) It is best to "
46854 "use the full commit identifiers in @code{origin}s, though, to avoid "
46855 "ambiguities. A typical package definition may look like this:"
46859 #: doc/guix.texi:21874
46862 "(define my-package\n"
46863 " (let ((commit \"c3f29bc928d5900971f65965feaae59e1272a3f7\")\n"
46864 " (revision \"1\")) ;Guix package revision\n"
46866 " (version (git-version \"0.9\" revision commit))\n"
46867 " (source (origin\n"
46868 " (method git-fetch)\n"
46869 " (uri (git-reference\n"
46870 " (url \"git://example.org/my-package.git\")\n"
46871 " (commit commit)))\n"
46872 " (sha256 (base32 \"1mbikn@dots{}\"))\n"
46873 " (file-name (git-file-name name version))))\n"
46879 #: doc/guix.texi:21879
46881 msgid "package description"
46885 #: doc/guix.texi:21880
46887 msgid "package synopsis"
46890 #. type: Plain text
46891 #: doc/guix.texi:21887
46893 "As we have seen before, each package in GNU@tie{}Guix includes a synopsis "
46894 "and a description (@pxref{Defining Packages}). Synopses and descriptions "
46895 "are important: They are what @command{guix package --search} searches, and a "
46896 "crucial piece of information to help users determine whether a given package "
46897 "suits their needs. Consequently, packagers should pay attention to what "
46901 #. type: Plain text
46902 #: doc/guix.texi:21895
46904 "Synopses must start with a capital letter and must not end with a period. "
46905 "They must not start with ``a'' or ``the'', which usually does not bring "
46906 "anything; for instance, prefer ``File-frobbing tool'' over ``A tool that "
46907 "frobs files''. The synopsis should say what the package is---e.g., ``Core "
46908 "GNU utilities (file, text, shell)''---or what it is used for---e.g., the "
46909 "synopsis for GNU@tie{}grep is ``Print lines matching a pattern''."
46912 #. type: Plain text
46913 #: doc/guix.texi:21905
46915 "Keep in mind that the synopsis must be meaningful for a very wide audience. "
46916 "For example, ``Manipulate alignments in the SAM format'' might make sense "
46917 "for a seasoned bioinformatics researcher, but might be fairly unhelpful or "
46918 "even misleading to a non-specialized audience. It is a good idea to come up "
46919 "with a synopsis that gives an idea of the application domain of the "
46920 "package. In this example, this might give something like ``Manipulate "
46921 "nucleotide sequence alignments'', which hopefully gives the user a better "
46922 "idea of whether this is what they are looking for."
46925 #. type: Plain text
46926 #: doc/guix.texi:21913
46928 "Descriptions should take between five and ten lines. Use full sentences, "
46929 "and avoid using acronyms without first introducing them. Please avoid "
46930 "marketing phrases such as ``world-leading'', ``industrial-strength'', and "
46931 "``next-generation'', and avoid superlatives like ``the most advanced''---"
46932 "they are not helpful to users looking for a package and may even sound "
46933 "suspicious. Instead, try to be factual, mentioning use cases and features."
46937 #: doc/guix.texi:21914
46939 msgid "Texinfo markup, in package descriptions"
46942 #. type: Plain text
46943 #: doc/guix.texi:21923
46945 "Descriptions can include Texinfo markup, which is useful to introduce "
46946 "ornaments such as @code{@@code} or @code{@@dfn}, bullet lists, or hyperlinks "
46947 "(@pxref{Overview,,, texinfo, GNU Texinfo}). However you should be careful "
46948 "when using some characters for example @samp{@@} and curly braces which are "
46949 "the basic special characters in Texinfo (@pxref{Special Characters,,, "
46950 "texinfo, GNU Texinfo}). User interfaces such as @command{guix package --"
46951 "show} take care of rendering it appropriately."
46954 #. type: Plain text
46955 #: doc/guix.texi:21929
46957 "Synopses and descriptions are translated by volunteers @uref{http://"
46958 "translationproject.org/domain/guix-packages.html, at the Translation "
46959 "Project} so that as many users as possible can read them in their native "
46960 "language. User interfaces search them and display them in the language "
46961 "specified by the current locale."
46964 #. type: Plain text
46965 #: doc/guix.texi:21934
46967 "To allow @command{xgettext} to extract them as translatable strings, "
46968 "synopses and descriptions @emph{must be literal strings}. This means that "
46969 "you cannot use @code{string-append} or @code{format} to construct these "
46974 #: doc/guix.texi:21940
46979 " (synopsis \"This is translatable\")\n"
46980 " (description (string-append \"This is \" \"*not*\" \" translatable.\")))\n"
46983 #. type: Plain text
46984 #: doc/guix.texi:21948
46986 "Translation is a lot of work so, as a packager, please pay even more "
46987 "attention to your synopses and descriptions as every change may entail "
46988 "additional work for translators. In order to help them, it is possible to "
46989 "make recommendations or instructions visible to them by inserting special "
46990 "comments like this (@pxref{xgettext Invocation,,, gettext, GNU Gettext}):"
46994 #: doc/guix.texi:21953
46997 ";; TRANSLATORS: \"X11 resize-and-rotate\" should not be translated.\n"
46998 "(description \"ARandR is designed to provide a simple visual front end\n"
46999 "for the X11 resize-and-rotate (RandR) extension. @dots{}\")\n"
47003 #: doc/guix.texi:21959
47008 #. type: Plain text
47009 #: doc/guix.texi:21965
47011 "We currently package Python 2 and Python 3, under the Scheme variable names "
47012 "@code{python-2} and @code{python} as explained in @ref{Version Numbers}. To "
47013 "avoid confusion and naming clashes with other programming languages, it "
47014 "seems desirable that the name of a package for a Python module contains the "
47015 "word @code{python}."
47018 #. type: Plain text
47019 #: doc/guix.texi:21971
47021 "Some modules are compatible with only one version of Python, others with "
47022 "both. If the package Foo compiles only with Python 3, we name it "
47023 "@code{python-foo}; if it compiles only with Python 2, we name it "
47024 "@code{python2-foo}. If it is compatible with both versions, we create two "
47025 "packages with the corresponding names."
47028 #. type: Plain text
47029 #: doc/guix.texi:21977
47031 "If a project already contains the word @code{python}, we drop this; for "
47032 "instance, the module python-dateutil is packaged under the names "
47033 "@code{python-dateutil} and @code{python2-dateutil}. If the project name "
47034 "starts with @code{py} (e.g. @code{pytz}), we keep it and prefix it as "
47038 #. type: subsubsection
47039 #: doc/guix.texi:21978
47041 msgid "Specifying Dependencies"
47045 #: doc/guix.texi:21979
47047 msgid "inputs, for Python packages"
47050 #. type: Plain text
47051 #: doc/guix.texi:21984
47053 "Dependency information for Python packages is usually available in the "
47054 "package source tree, with varying degrees of accuracy: in the @file{setup."
47055 "py} file, in @file{requirements.txt}, or in @file{tox.ini}."
47058 #. type: Plain text
47059 #: doc/guix.texi:21990
47061 "Your mission, when writing a recipe for a Python package, is to map these "
47062 "dependencies to the appropriate type of ``input'' (@pxref{package Reference, "
47063 "inputs}). Although the @code{pypi} importer normally does a good job "
47064 "(@pxref{Invoking guix import}), you may want to check the following check "
47065 "list to determine which dependency goes where."
47069 #: doc/guix.texi:21998
47071 "We currently package Python 2 with @code{setuptools} and @code{pip} "
47072 "installed like Python 3.4 has per default. Thus you don't need to specify "
47073 "either of these as an input. @command{guix lint} will warn you if you do."
47077 #: doc/guix.texi:22004
47079 "Python dependencies required at run time go into @code{propagated-inputs}. "
47080 "They are typically defined with the @code{install_requires} keyword in "
47081 "@file{setup.py}, or in the @file{requirements.txt} file."
47085 #: doc/guix.texi:22012
47087 "Python packages required only at build time---e.g., those listed with the "
47088 "@code{setup_requires} keyword in @file{setup.py}---or only for testing---e."
47089 "g., those in @code{tests_require}---go into @code{native-inputs}. The "
47090 "rationale is that (1) they do not need to be propagated because they are not "
47091 "needed at run time, and (2) in a cross-compilation context, it's the "
47092 "``native'' input that we'd want."
47096 #: doc/guix.texi:22016
47098 "Examples are the @code{pytest}, @code{mock}, and @code{nose} test "
47099 "frameworks. Of course if any of these packages is also required at run-"
47100 "time, it needs to go to @code{propagated-inputs}."
47104 #: doc/guix.texi:22021
47106 "Anything that does not fall in the previous categories goes to "
47107 "@code{inputs}, for example programs or C libraries required for building "
47108 "Python packages containing C extensions."
47112 #: doc/guix.texi:22027
47114 "If a Python package has optional dependencies (@code{extras_require}), it is "
47115 "up to you to decide whether to add them or not, based on their usefulness/"
47116 "overhead ratio (@pxref{Submitting Patches, @command{guix size}})."
47120 #: doc/guix.texi:22034
47125 #. type: Plain text
47126 #: doc/guix.texi:22045
47128 "Perl programs standing for themselves are named as any other package, using "
47129 "the lowercase upstream name. For Perl packages containing a single class, "
47130 "we use the lowercase class name, replace all occurrences of @code{::} by "
47131 "dashes and prepend the prefix @code{perl-}. So the class @code{XML::Parser} "
47132 "becomes @code{perl-xml-parser}. Modules containing several classes keep "
47133 "their lowercase upstream name and are also prepended by @code{perl-}. Such "
47134 "modules tend to have the word @code{perl} somewhere in their name, which "
47135 "gets dropped in favor of the prefix. For instance, @code{libwww-perl} "
47136 "becomes @code{perl-libwww}."
47140 #: doc/guix.texi:22050
47145 #. type: Plain text
47146 #: doc/guix.texi:22053
47148 "Java programs standing for themselves are named as any other package, using "
47149 "the lowercase upstream name."
47152 #. type: Plain text
47153 #: doc/guix.texi:22059
47155 "To avoid confusion and naming clashes with other programming languages, it "
47156 "is desirable that the name of a package for a Java package is prefixed with "
47157 "@code{java-}. If a project already contains the word @code{java}, we drop "
47158 "this; for instance, the package @code{ngsjava} is packaged under the name "
47162 #. type: Plain text
47163 #: doc/guix.texi:22065
47165 "For Java packages containing a single class or a small class hierarchy, we "
47166 "use the lowercase class name, replace all occurrences of @code{.} by dashes "
47167 "and prepend the prefix @code{java-}. So the class @code{apache.commons.cli} "
47168 "becomes package @code{java-apache-commons-cli}."
47171 #. type: Plain text
47172 #: doc/guix.texi:22076
47174 "For fonts that are in general not installed by a user for typesetting "
47175 "purposes, or that are distributed as part of a larger software package, we "
47176 "rely on the general packaging rules for software; for instance, this applies "
47177 "to the fonts delivered as part of the X.Org system or fonts that are part of "
47181 #. type: Plain text
47182 #: doc/guix.texi:22080
47184 "To make it easier for a user to search for fonts, names for other packages "
47185 "containing only fonts are constructed as follows, independently of the "
47186 "upstream package name."
47189 #. type: Plain text
47190 #: doc/guix.texi:22088
47192 "The name of a package containing only one font family starts with "
47193 "@code{font-}; it is followed by the foundry name and a dash @code{-} if the "
47194 "foundry is known, and the font family name, in which spaces are replaced by "
47195 "dashes (and as usual, all upper case letters are transformed to lower "
47196 "case). For example, the Gentium font family by SIL is packaged under the "
47197 "name @code{font-sil-gentium}."
47200 #. type: Plain text
47201 #: doc/guix.texi:22097
47203 "For a package containing several font families, the name of the collection "
47204 "is used in the place of the font family name. For instance, the Liberation "
47205 "fonts consist of three families, Liberation Sans, Liberation Serif and "
47206 "Liberation Mono. These could be packaged separately under the names "
47207 "@code{font-liberation-sans} and so on; but as they are distributed together "
47208 "under a common name, we prefer to package them together as @code{font-"
47212 #. type: Plain text
47213 #: doc/guix.texi:22103
47215 "In the case where several formats of the same font family or font collection "
47216 "are packaged separately, a short form of the format, prepended by a dash, is "
47217 "added to the package name. We use @code{-ttf} for TrueType fonts, @code{-"
47218 "otf} for OpenType fonts and @code{-type1} for PostScript Type 1 fonts."
47222 #: doc/guix.texi:22111
47224 msgid "bootstrapping"
47227 #. type: Plain text
47228 #: doc/guix.texi:22121
47230 "Bootstrapping in our context refers to how the distribution gets built "
47231 "``from nothing''. Remember that the build environment of a derivation "
47232 "contains nothing but its declared inputs (@pxref{Introduction}). So there's "
47233 "an obvious chicken-and-egg problem: how does the first package get built? "
47234 "How does the first compiler get compiled? Note that this is a question of "
47235 "interest only to the curious hacker, not to the regular user, so you can "
47236 "shamelessly skip this section if you consider yourself a ``regular user''."
47240 #: doc/guix.texi:22122 doc/guix.texi:22244
47242 msgid "bootstrap binaries"
47245 #. type: Plain text
47246 #: doc/guix.texi:22132
47248 "The GNU system is primarily made of C code, with libc at its core. The GNU "
47249 "build system itself assumes the availability of a Bourne shell and command-"
47250 "line tools provided by GNU Coreutils, Awk, Findutils, `sed', and `grep'. "
47251 "Furthermore, build programs---programs that run @code{./configure}, "
47252 "@code{make}, etc.---are written in Guile Scheme (@pxref{Derivations}). "
47253 "Consequently, to be able to build anything at all, from scratch, Guix relies "
47254 "on pre-built binaries of Guile, GCC, Binutils, libc, and the other packages "
47255 "mentioned above---the @dfn{bootstrap binaries}."
47258 #. type: Plain text
47259 #: doc/guix.texi:22135
47261 "These bootstrap binaries are ``taken for granted'', though we can also re-"
47262 "create them if needed (more on that later)."
47265 #. type: unnumberedsubsec
47266 #: doc/guix.texi:22136
47268 msgid "Preparing to Use the Bootstrap Binaries"
47271 #. type: Plain text
47272 #: doc/guix.texi:22141
47274 "@image{images/bootstrap-graph,6in,,Dependency graph of the early bootstrap "
47278 #. type: Plain text
47279 #: doc/guix.texi:22146
47281 "The figure above shows the very beginning of the dependency graph of the "
47282 "distribution, corresponding to the package definitions of the @code{(gnu "
47283 "packages bootstrap)} module. A similar figure can be generated with "
47284 "@command{guix graph} (@pxref{Invoking guix graph}), along the lines of:"
47288 #: doc/guix.texi:22151
47291 "guix graph -t derivation \\\n"
47292 " -e '(@@@@ (gnu packages bootstrap) %bootstrap-gcc)' \\\n"
47293 " | dot -Tps > t.ps\n"
47296 #. type: Plain text
47297 #: doc/guix.texi:22160
47299 "At this level of detail, things are slightly complex. First, Guile itself "
47300 "consists of an ELF executable, along with many source and compiled Scheme "
47301 "files that are dynamically loaded when it runs. This gets stored in the "
47302 "@file{guile-2.0.7.tar.xz} tarball shown in this graph. This tarball is part "
47303 "of Guix's ``source'' distribution, and gets inserted into the store with "
47304 "@code{add-to-store} (@pxref{The Store})."
47307 #. type: Plain text
47308 #: doc/guix.texi:22169
47310 "But how do we write a derivation that unpacks this tarball and adds it to "
47311 "the store? To solve this problem, the @code{guile-bootstrap-2.0.drv} "
47312 "derivation---the first one that gets built---uses @code{bash} as its "
47313 "builder, which runs @code{build-bootstrap-guile.sh}, which in turn calls "
47314 "@code{tar} to unpack the tarball. Thus, @file{bash}, @file{tar}, @file{xz}, "
47315 "and @file{mkdir} are statically-linked binaries, also part of the Guix "
47316 "source distribution, whose sole purpose is to allow the Guile tarball to be "
47320 #. type: Plain text
47321 #: doc/guix.texi:22181
47323 "Once @code{guile-bootstrap-2.0.drv} is built, we have a functioning Guile "
47324 "that can be used to run subsequent build programs. Its first task is to "
47325 "download tarballs containing the other pre-built binaries---this is what the "
47326 "@code{.tar.xz.drv} derivations do. Guix modules such as @code{ftp-client."
47327 "scm} are used for this purpose. The @code{module-import.drv} derivations "
47328 "import those modules in a directory in the store, using the original "
47329 "layout. The @code{module-import-compiled.drv} derivations compile those "
47330 "modules, and write them in an output directory with the right layout. This "
47331 "corresponds to the @code{#:modules} argument of @code{build-expression-"
47332 ">derivation} (@pxref{Derivations})."
47335 #. type: Plain text
47336 #: doc/guix.texi:22185
47338 "Finally, the various tarballs are unpacked by the derivations @code{gcc-"
47339 "bootstrap-0.drv}, @code{glibc-bootstrap-0.drv}, etc., at which point we have "
47340 "a working C tool chain."
47343 #. type: unnumberedsubsec
47344 #: doc/guix.texi:22187
47346 msgid "Building the Build Tools"
47349 #. type: Plain text
47350 #: doc/guix.texi:22196
47352 "Bootstrapping is complete when we have a full tool chain that does not "
47353 "depend on the pre-built bootstrap tools discussed above. This no-dependency "
47354 "requirement is verified by checking whether the files of the final tool "
47355 "chain contain references to the @file{/gnu/store} directories of the "
47356 "bootstrap inputs. The process that leads to this ``final'' tool chain is "
47357 "described by the package definitions found in the @code{(gnu packages "
47358 "commencement)} module."
47361 #. type: Plain text
47362 #: doc/guix.texi:22203
47364 "The @command{guix graph} command allows us to ``zoom out'' compared to the "
47365 "graph above, by looking at the level of package objects instead of "
47366 "individual derivations---remember that a package may translate to several "
47367 "derivations, typically one derivation to download its source, one to build "
47368 "the Guile modules it needs, and one to actually build the package from "
47369 "source. The command:"
47373 #: doc/guix.texi:22208
47376 "guix graph -t bag \\\n"
47377 " -e '(@@@@ (gnu packages commencement)\n"
47378 " glibc-final-with-bootstrap-bash)' | dot -Tps > t.ps\n"
47381 #. type: Plain text
47382 #: doc/guix.texi:22215
47384 "produces the dependency graph leading to the ``final'' C "
47385 "library@footnote{You may notice the @code{glibc-intermediate} label, "
47386 "suggesting that it is not @emph{quite} final, but as a good approximation, "
47387 "we will consider it final.}, depicted below."
47390 #. type: Plain text
47391 #: doc/guix.texi:22217
47393 "@image{images/bootstrap-packages,6in,,Dependency graph of the early packages}"
47396 #. type: Plain text
47397 #: doc/guix.texi:22223
47399 "The first tool that gets built with the bootstrap binaries is GNU@tie{}"
47400 "Make---noted @code{make-boot0} above---which is a prerequisite for all the "
47401 "following packages. From there Findutils and Diffutils get built."
47404 #. type: Plain text
47405 #: doc/guix.texi:22228
47407 "Then come the first-stage Binutils and GCC, built as pseudo cross tools---i."
47408 "e., with @code{--target} equal to @code{--host}. They are used to build "
47409 "libc. Thanks to this cross-build trick, this libc is guaranteed not to hold "
47410 "any reference to the initial tool chain."
47413 #. type: Plain text
47414 #: doc/guix.texi:22234
47416 "From there the final Binutils and GCC (not shown above) are built. GCC uses "
47417 "@code{ld} from the final Binutils, and links programs against the just-built "
47418 "libc. This tool chain is used to build the other packages used by Guix and "
47419 "by the GNU Build System: Guile, Bash, Coreutils, etc."
47422 #. type: Plain text
47423 #: doc/guix.texi:22240
47425 "And voilà! At this point we have the complete set of build tools that the "
47426 "GNU Build System expects. These are in the @code{%final-inputs} variable of "
47427 "the @code{(gnu packages commencement)} module, and are implicitly used by "
47428 "any package that uses @code{gnu-build-system} (@pxref{Build Systems, "
47429 "@code{gnu-build-system}})."
47432 #. type: unnumberedsubsec
47433 #: doc/guix.texi:22242
47435 msgid "Building the Bootstrap Binaries"
47438 #. type: Plain text
47439 #: doc/guix.texi:22249
47441 "Because the final tool chain does not depend on the bootstrap binaries, "
47442 "those rarely need to be updated. Nevertheless, it is useful to have an "
47443 "automated way to produce them, should an update occur, and this is what the "
47444 "@code{(gnu packages make-bootstrap)} module provides."
47447 #. type: Plain text
47448 #: doc/guix.texi:22253
47450 "The following command builds the tarballs containing the bootstrap binaries "
47451 "(Guile, Binutils, GCC, libc, and a tarball containing a mixture of Coreutils "
47452 "and other basic command-line tools):"
47456 #: doc/guix.texi:22256
47458 msgid "guix build bootstrap-tarballs\n"
47461 #. type: Plain text
47462 #: doc/guix.texi:22261
47464 "The generated tarballs are those that should be referred to in the "
47465 "@code{(gnu packages bootstrap)} module mentioned at the beginning of this "
47469 #. type: Plain text
47470 #: doc/guix.texi:22267
47472 "Still here? Then perhaps by now you've started to wonder: when do we reach a "
47473 "fixed point? That is an interesting question! The answer is unknown, but if "
47474 "you would like to investigate further (and have significant computational "
47475 "and storage resources to do so), then let us know."
47478 #. type: unnumberedsubsec
47479 #: doc/guix.texi:22268
47481 msgid "Reducing the Set of Bootstrap Binaries"
47484 #. type: Plain text
47485 #: doc/guix.texi:22276
47487 "Our bootstrap binaries currently include GCC, Guile, etc. That's a lot of "
47488 "binary code! Why is that a problem? It's a problem because these big chunks "
47489 "of binary code are practically non-auditable, which makes it hard to "
47490 "establish what source code produced them. Every unauditable binary also "
47491 "leaves us vulnerable to compiler backdoors as described by Ken Thompson in "
47492 "the 1984 paper @emph{Reflections on Trusting Trust}."
47495 #. type: Plain text
47496 #: doc/guix.texi:22282
47498 "This is mitigated by the fact that our bootstrap binaries were generated "
47499 "from an earlier Guix revision. Nevertheless it lacks the level of "
47500 "transparency that we get in the rest of the package dependency graph, where "
47501 "Guix always gives us a source-to-binary mapping. Thus, our goal is to "
47502 "reduce the set of bootstrap binaries to the bare minimum."
47505 #. type: Plain text
47506 #: doc/guix.texi:22288
47508 "The @uref{http://bootstrappable.org, Bootstrappable.org web site} lists on-"
47509 "going projects to do that. One of these is about replacing the bootstrap "
47510 "GCC with a sequence of assemblers, interpreters, and compilers of increasing "
47511 "complexity, which could be built from source starting from a simple and "
47512 "auditable assembler. Your help is welcome!"
47516 #: doc/guix.texi:22291
47518 msgid "Porting to a New Platform"
47521 #. type: Plain text
47522 #: doc/guix.texi:22300
47524 "As discussed above, the GNU distribution is self-contained, and self-"
47525 "containment is achieved by relying on pre-built ``bootstrap "
47526 "binaries'' (@pxref{Bootstrapping}). These binaries are specific to an "
47527 "operating system kernel, CPU architecture, and application binary interface "
47528 "(ABI). Thus, to port the distribution to a platform that is not yet "
47529 "supported, one must build those bootstrap binaries, and update the "
47530 "@code{(gnu packages bootstrap)} module to use them on that platform."
47533 #. type: Plain text
47534 #: doc/guix.texi:22305
47536 "Fortunately, Guix can @emph{cross compile} those bootstrap binaries. When "
47537 "everything goes well, and assuming the GNU tool chain supports the target "
47538 "platform, this can be as simple as running a command like this one:"
47542 #: doc/guix.texi:22308
47544 msgid "guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs\n"
47547 #. type: Plain text
47548 #: doc/guix.texi:22315
47550 "For this to work, the @code{glibc-dynamic-linker} procedure in @code{(gnu "
47551 "packages bootstrap)} must be augmented to return the right file name for "
47552 "libc's dynamic linker on that platform; likewise, @code{system->linux-"
47553 "architecture} in @code{(gnu packages linux)} must be taught about the new "
47557 #. type: Plain text
47558 #: doc/guix.texi:22324
47560 "Once these are built, the @code{(gnu packages bootstrap)} module needs to be "
47561 "updated to refer to these binaries on the target platform. That is, the "
47562 "hashes and URLs of the bootstrap tarballs for the new platform must be added "
47563 "alongside those of the currently supported platforms. The bootstrap Guile "
47564 "tarball is treated specially: it is expected to be available locally, and "
47565 "@file{gnu/local.mk} has rules do download it for the supported "
47566 "architectures; a rule for the new platform must be added as well."
47569 #. type: Plain text
47570 #: doc/guix.texi:22333
47572 "In practice, there may be some complications. First, it may be that the "
47573 "extended GNU triplet that specifies an ABI (like the @code{eabi} suffix "
47574 "above) is not recognized by all the GNU tools. Typically, glibc recognizes "
47575 "some of these, whereas GCC uses an extra @code{--with-abi} configure flag "
47576 "(see @code{gcc.scm} for examples of how to handle this). Second, some of "
47577 "the required packages could fail to build for that platform. Lastly, the "
47578 "generated binaries could be broken for some reason."
47582 #: doc/guix.texi:22335
47584 msgid "contributing.texi"
47585 msgstr "contributing.fr.texi"
47587 #. type: Plain text
47588 #: doc/guix.texi:22348
47590 "Guix is based on the @uref{http://nixos.org/nix/, Nix package manager}, "
47591 "which was designed and implemented by Eelco Dolstra, with contributions from "
47592 "other people (see the @file{nix/AUTHORS} file in Guix.) Nix pioneered "
47593 "functional package management, and promoted unprecedented features, such as "
47594 "transactional package upgrades and rollbacks, per-user profiles, and "
47595 "referentially transparent build processes. Without this work, Guix would "
47599 #. type: Plain text
47600 #: doc/guix.texi:22351
47602 "The Nix-based software distributions, Nixpkgs and NixOS, have also been an "
47603 "inspiration for Guix."
47606 #. type: Plain text
47607 #: doc/guix.texi:22357
47609 "GNU@tie{}Guix itself is a collective work with contributions from a number "
47610 "of people. See the @file{AUTHORS} file in Guix for more information on "
47611 "these fine people. The @file{THANKS} file lists people who have helped by "
47612 "reporting bugs, taking care of the infrastructure, providing artwork and "
47613 "themes, making suggestions, and more---thank you!"
47617 #: doc/guix.texi:22362
47619 msgid "license, GNU Free Documentation License"
47620 msgstr "license, GNU Free Documentation License"
47623 #: doc/guix.texi:22363
47625 msgid "fdl-1.3.texi"
47626 msgstr "fdl-1.3.texi"